1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.dd.DragDrop</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.dd.DragDrop-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.DragDrop-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.DragDrop-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.DragDrop-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_dd_DragDrop.js.html">Roo/dd/DragDrop.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">DragDrop</td></tr>
65 <tr><td class="label">Subclasses:</td><td class="hd-info">
66 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>, <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>, <a href="./Roo.dd.DDTarget.html#constructor" roo:cls="Roo.dd.DDTarget.html#constructor">Roo.dd.DDTarget</a>, <a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a>, <a href="./Roo.dd.DragZone.html#constructor" roo:cls="Roo.dd.DragZone.html#constructor">Roo.dd.DragZone</a>, <a href="./Roo.dd.DropTarget.html#constructor" roo:cls="Roo.dd.DropTarget.html#constructor">Roo.dd.DropTarget</a>, <a href="./Roo.dd.DropZone.html#constructor" roo:cls="Roo.dd.DropZone.html#constructor">Roo.dd.DropZone</a>
77 <!-- ============================== class summary ========================== -->
78 <div class="description">
79 Defines the interface and base operation of items that that can be<br/>dragged or can be drop targets. It was designed to be extended, overriding<br/>the event handlers for startDrag, onDrag, onDragOver and onDragOut.<br/>Up to three html elements can be associated with a DragDrop instance:<br/><ul><br/><li>linked element: the element that is passed into the constructor.<br/>This is the element which defines the boundaries for interaction with<br/>other DragDrop objects.</li><br/><li>handle element(s): The drag operation only occurs if the element that<br/>was clicked matches a handle element. By default this is the linked<br/>element, but there are times that you will want only a portion of the<br/>linked element to initiate the drag operation, and the setHandleElId()<br/>method provides a way to define this.</li><br/><li>drag element: this represents the element that would be moved along<br/>with the cursor during a drag operation. By default, this is the linked<br/>element itself as in {<b>link</b> Roo.dd.DD}. setDragElId() lets you define<br/>a separate element that would be moved, as in {<b>link</b> Roo.dd.DDProxy}.<br/></li><br/></ul><br/>This class should not be instantiated until the onload event to ensure that<br/>the associated elements are available.<br/>The following would define a DragDrop obj that would interact with any<br/>other DragDrop obj in the "group1" group:<br/><pre><br/> dd = new Roo.dd.DragDrop("div1", "group1");<br/></pre><br/>Since none of the event handlers have been implemented, nothing would<br/>actually happen if you were to run the code above. Normally you would<br/>override this class or one of the default implementations, but you can<br/>also override the methods you want on an instance of the class...<br/><pre><br/> dd.onDragDrop = function(e, id) {<br/> alert("dd was dropped on " + id);<br/> }<br/></pre>
83 <!-- ============================== Class comment block... ========================== -->
85 <div class="comments">
86 <b>Class Comments / Notes</B> =>
87 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DragDrop';">[Add Your comment/notes about this class]</u>
89 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
90 src="/blog.php/GtkDjsComments/Roo.dd.DragDrop.html"></iframe>
95 <!-- ============================== config options ========================== -->
100 <div class="hr"></div>
101 <a id="Roo.dd.DragDrop-configs"></a>
105 <table cellspacing="0" class="member-table">
106 <caption class="Empty">Config Options - Has None</caption>
120 <!-- ============================== public properties ==================== -->
124 <a id="Roo.dd.DragDrop-props"></a>
130 <table cellspacing="0" class="member-table">
131 <caption class="Empty">Public Properties - Has None</caption>
137 <!-- ============================== methods summary / details ======================== -->
140 <a id="Roo.dd.DragDrop-methods"></a>
141 <!-- constructor?? -->
148 <!-- then dynamics first -->
155 <table cellspacing="0" class="member-table">
156 <caption>Public Methods</caption>
158 <th class="sig-header" colspan="2">Method</th>
159 <th class="msource-header">Defined By</th>
169 <tr class="method-row config-row-alt0 expandable notInherited">
170 <td class="micon"><a class="exi" href="#expand"> </a></td>
174 <a id="Roo.dd-method-DragDrop" name=".DragDrop"></a>
175 <div class="fixedFont">
176 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragDrop</b>
178 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>sGroup</i></B>, object <B><i>config</i></B>)
186 <div class="short">Create a new Roo.dd.DragDrop</div>
193 Create a new Roo.dd.DragDrop
196 <dl class="detailList">
197 <dt class="heading">Parameters:</dt>
200 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
203 <dd>of the element that is linked to this instance</dd>
206 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
209 <dd>the group of related DragDrop objects</dd>
212 <span class="fixedFont">object</span> <b>config</b>
215 <dd>an object containing configurable attributes<br/> Valid properties for DragDrop:<br/> padding, isTarget, maintainOffset, primaryButtonOnly</dd>
239 <tr class="method-row config-row-alt1 expandable notInherited">
240 <td class="micon"><a class="exi" href="#expand"> </a></td>
244 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
245 <div class="fixedFont">
246 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
248 (string <B><i>cssClass</i></B>)
255 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
261 Lets you specify a css class of elements that will not initiate a drag
268 <dl class="detailList">
269 <dt class="heading">Parameters:</dt>
272 <span class="fixedFont">string</span> <b>cssClass</b>
275 <dd>the class of the elements you wish to ignore</dd>
301 <tr class="method-row config-row-alt0 expandable notInherited">
302 <td class="micon"><a class="exi" href="#expand"> </a></td>
306 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
307 <div class="fixedFont">
308 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
310 (string <B><i>id</i></B>)
317 <div class="short">Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag</div>
323 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
330 <dl class="detailList">
331 <dt class="heading">Parameters:</dt>
334 <span class="fixedFont">string</span> <b>id</b>
337 <dd>the element id of the element you wish to ignore</dd>
363 <tr class="method-row config-row-alt1 expandable notInherited">
364 <td class="micon"><a class="exi" href="#expand"> </a></td>
368 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
369 <div class="fixedFont">
370 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
372 (string <B><i>tagName</i></B>)
379 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
385 Allows you to specify a tag name that should not start a drag operation<br/>when clicked. This is designed to facilitate embedding links within a<br/>drag handle that do something other than start the drag.
392 <dl class="detailList">
393 <dt class="heading">Parameters:</dt>
396 <span class="fixedFont">string</span> <b>tagName</b>
399 <dd>the type of element to exclude</dd>
425 <tr class="method-row config-row-alt0 expandable notInherited">
426 <td class="micon"><a class="exi" href="#expand"> </a></td>
430 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
431 <div class="fixedFont">
432 <span class="attributes"></span><b class="itemname">addToGroup</b>
434 (<B><i>sGroup</i></B>)
441 <div class="short">Add this instance to a group of related drag/drop objects.</div>
447 Add this instance to a group of related drag/drop objects. All<br/>instances belong to at least one group, and can belong to as many<br/>groups as needed.
454 <dl class="detailList">
455 <dt class="heading">Parameters:</dt>
461 <dd>{string} the name of the group</dd>
487 <tr class="method-row config-row-alt1 expandable notInherited">
488 <td class="micon"><a class="exi" href="#expand"> </a></td>
492 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
493 <div class="fixedFont">
494 <span class="attributes"></span><b class="itemname">applyConfig</b>
503 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
509 Applies the configuration parameters that were passed into the constructor.<br/>This is supposed to happen at each level through the inheritance chain. So<br/>a DDProxy implentation will execute apply config on DDProxy, DD, and<br/>DragDrop in order to get all of the parameters that are available in<br/>each object.
538 <tr class="method-row config-row-alt0 expandable notInherited">
539 <td class="micon"><a class="exi" href="#expand"> </a></td>
543 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
544 <div class="fixedFont">
545 <span class="attributes"></span><b class="itemname">clearConstraints</b>
554 <div class="short">Clears any constraints applied to this instance.</div>
560 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
589 <tr class="method-row config-row-alt1 expandable notInherited">
590 <td class="micon"><a class="exi" href="#expand"> </a></td>
594 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
595 <div class="fixedFont">
596 <span class="attributes"></span><b class="itemname">clearTicks</b>
605 <div class="short">Clears any tick interval defined for this instance</div>
611 Clears any tick interval defined for this instance
640 <tr class="method-row config-row-alt0 expandable notInherited">
641 <td class="micon"><a class="exi" href="#expand"> </a></td>
645 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
646 <div class="fixedFont">
647 <span class="attributes"></span><b class="itemname">endDrag</b>
649 (Event <B><i>e</i></B>)
656 <div class="short">Fired when we are done dragging the object</div>
662 Fired when we are done dragging the object
669 <dl class="detailList">
670 <dt class="heading">Parameters:</dt>
673 <span class="fixedFont">Event</span> <b>e</b>
676 <dd>the mouseup event</dd>
702 <tr class="method-row config-row-alt1 expandable notInherited">
703 <td class="micon"><a class="exi" href="#expand"> </a></td>
707 <a id="Roo.dd.DragDrop-method-function toString() {
709 }" name=".function toString() {
712 <div class="fixedFont">
713 <span class="attributes"></span><b class="itemname">function toString() {
732 <div class="short">toString method</div>
749 <dl class="detailList">
750 <dt class="heading">Returns:</dt>
752 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
774 <tr class="method-row config-row-alt0 expandable notInherited">
775 <td class="micon"><a class="exi" href="#expand"> </a></td>
779 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
780 <div class="fixedFont">
781 <span class="attributes"></span><b class="itemname">getDragEl</b>
789 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
798 <div class="short">Returns a reference to the actual element to drag.</div>
804 Returns a reference to the actual element to drag. By default this is<br/>the same as the html element, but it can be assigned to another<br/>element. An example of this can be found in Roo.dd.DDProxy
815 <dl class="detailList">
816 <dt class="heading">Returns:</dt>
818 <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> the html element</dd>
840 <tr class="method-row config-row-alt1 expandable notInherited">
841 <td class="micon"><a class="exi" href="#expand"> </a></td>
845 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
846 <div class="fixedFont">
847 <span class="attributes"></span><b class="itemname">getEl</b>
855 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
864 <div class="short">Returns a reference to the linked element</div>
870 Returns a reference to the linked element
881 <dl class="detailList">
882 <dt class="heading">Returns:</dt>
884 <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> the html element</dd>
906 <tr class="method-row config-row-alt0 expandable notInherited">
907 <td class="micon"><a class="exi" href="#expand"> </a></td>
911 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
912 <div class="fixedFont">
913 <span class="attributes"></span><b class="itemname">init</b>
915 (<B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>sGroup</i></B>, object <B><i>config</i></B>)
922 <div class="short">Sets up the DragDrop object.</div>
928 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
935 <dl class="detailList">
936 <dt class="heading">Parameters:</dt>
942 <dd>the id of the linked element</dd>
945 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
948 <dd>the group of related items</dd>
951 <span class="fixedFont">object</span> <b>config</b>
954 <dd>configuration attributes</dd>
980 <tr class="method-row config-row-alt1 expandable notInherited">
981 <td class="micon"><a class="exi" href="#expand"> </a></td>
985 <a id="Roo.dd.DragDrop-method-initTarget" name=".initTarget"></a>
986 <div class="fixedFont">
987 <span class="attributes"></span><b class="itemname">initTarget</b>
989 (<B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>sGroup</i></B>, object <B><i>config</i></B>)
996 <div class="short">Initializes Targeting functionality only.</div>
1002 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1009 <dl class="detailList">
1010 <dt class="heading">Parameters:</dt>
1016 <dd>the id of the linked element</dd>
1019 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1022 <dd>the group of related items</dd>
1025 <span class="fixedFont">object</span> <b>config</b>
1028 <dd>configuration attributes</dd>
1046 <td class="msource">
1054 <tr class="method-row config-row-alt0 expandable notInherited">
1055 <td class="micon"><a class="exi" href="#expand"> </a></td>
1059 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
1060 <div class="fixedFont">
1061 <span class="attributes"></span><b class="itemname">isLocked</b>
1078 <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked<br/>(meaning that all drag/drop is disabled on the page.</div>
1084 Returns true if this instance is locked, or the drag drop mgr is locked<br/>(meaning that all drag/drop is disabled on the page.)
1095 <dl class="detailList">
1096 <dt class="heading">Returns:</dt>
1098 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
1112 <td class="msource">
1120 <tr class="method-row config-row-alt1 expandable notInherited">
1121 <td class="micon"><a class="exi" href="#expand"> </a></td>
1125 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
1126 <div class="fixedFont">
1127 <span class="attributes"></span><b class="itemname">isTarget</b>
1136 <div class="short">By default, all insances can be a drop target.</div>
1142 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
1163 <td class="msource">
1171 <tr class="method-row config-row-alt0 expandable notInherited">
1172 <td class="micon"><a class="exi" href="#expand"> </a></td>
1176 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
1177 <div class="fixedFont">
1178 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1180 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1195 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1201 Checks the tag exclusion list to see if this click should be ignored
1208 <dl class="detailList">
1209 <dt class="heading">Parameters:</dt>
1212 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1215 <dd>the HTMLElement to evaluate</dd>
1223 <dl class="detailList">
1224 <dt class="heading">Returns:</dt>
1226 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
1240 <td class="msource">
1248 <tr class="method-row config-row-alt1 expandable notInherited">
1249 <td class="micon"><a class="exi" href="#expand"> </a></td>
1253 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
1254 <div class="fixedFont">
1255 <span class="attributes"></span><b class="itemname">lock</b>
1264 <div class="short">Lock this instance</div>
1291 <td class="msource">
1299 <tr class="method-row config-row-alt0 expandable notInherited">
1300 <td class="micon"><a class="exi" href="#expand"> </a></td>
1304 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
1305 <div class="fixedFont">
1306 <span class="attributes"></span><b class="itemname">onAvailable</b>
1315 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
1321 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
1342 <td class="msource">
1350 <tr class="method-row config-row-alt1 expandable notInherited">
1351 <td class="micon"><a class="exi" href="#expand"> </a></td>
1355 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
1356 <div class="fixedFont">
1357 <span class="attributes"></span><b class="itemname">onDrag</b>
1359 (Event <B><i>e</i></B>)
1366 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
1372 Abstract method called during the onMouseMove event while dragging an<br/>object.
1379 <dl class="detailList">
1380 <dt class="heading">Parameters:</dt>
1383 <span class="fixedFont">Event</span> <b>e</b>
1386 <dd>the mousemove event</dd>
1404 <td class="msource">
1412 <tr class="method-row config-row-alt0 expandable notInherited">
1413 <td class="micon"><a class="exi" href="#expand"> </a></td>
1417 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
1418 <div class="fixedFont">
1419 <span class="attributes"></span><b class="itemname">onDragDrop</b>
1421 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1428 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
1434 Abstract method called when this item is dropped on another DragDrop<br/>obj
1441 <dl class="detailList">
1442 <dt class="heading">Parameters:</dt>
1445 <span class="fixedFont">Event</span> <b>e</b>
1448 <dd>the mouseup event</dd>
1451 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1454 <dd>In POINT mode, the element<br/>id this was dropped on. In INTERSECT mode, an array of dd items this<br/>was dropped on.</dd>
1472 <td class="msource">
1480 <tr class="method-row config-row-alt1 expandable notInherited">
1481 <td class="micon"><a class="exi" href="#expand"> </a></td>
1485 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
1486 <div class="fixedFont">
1487 <span class="attributes"></span><b class="itemname">onDragEnter</b>
1489 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1496 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
1502 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
1509 <dl class="detailList">
1510 <dt class="heading">Parameters:</dt>
1513 <span class="fixedFont">Event</span> <b>e</b>
1516 <dd>the mousemove event</dd>
1519 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1522 <dd>In POINT mode, the element<br/>id this is hovering over. In INTERSECT mode, an array of one or more<br/>dragdrop items being hovered over.</dd>
1540 <td class="msource">
1548 <tr class="method-row config-row-alt0 expandable notInherited">
1549 <td class="micon"><a class="exi" href="#expand"> </a></td>
1553 <a id="Roo.dd.DragDrop-method-onDragOut" name=".onDragOut"></a>
1554 <div class="fixedFont">
1555 <span class="attributes"></span><b class="itemname">onDragOut</b>
1557 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1564 <div class="short">Abstract method called when we are no longer hovering over an element</div>
1570 Abstract method called when we are no longer hovering over an element
1577 <dl class="detailList">
1578 <dt class="heading">Parameters:</dt>
1581 <span class="fixedFont">Event</span> <b>e</b>
1584 <dd>the mousemove event</dd>
1587 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1590 <dd>In POINT mode, the element<br/>id this was hovering over. In INTERSECT mode, an array of dd items<br/>that the mouse is no longer over.</dd>
1608 <td class="msource">
1616 <tr class="method-row config-row-alt1 expandable notInherited">
1617 <td class="micon"><a class="exi" href="#expand"> </a></td>
1621 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
1622 <div class="fixedFont">
1623 <span class="attributes"></span><b class="itemname">onDragOver</b>
1625 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1632 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
1638 Abstract method called when this element is hovering over another<br/>DragDrop obj
1645 <dl class="detailList">
1646 <dt class="heading">Parameters:</dt>
1649 <span class="fixedFont">Event</span> <b>e</b>
1652 <dd>the mousemove event</dd>
1655 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1658 <dd>In POINT mode, the element<br/>id this is hovering over. In INTERSECT mode, an array of dd items<br/>being hovered over.</dd>
1676 <td class="msource">
1684 <tr class="method-row config-row-alt0 expandable notInherited">
1685 <td class="micon"><a class="exi" href="#expand"> </a></td>
1689 <a id="Roo.dd.DragDrop-method-onInvalidDrop" name=".onInvalidDrop"></a>
1690 <div class="fixedFont">
1691 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
1693 (Event <B><i>e</i></B>)
1700 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
1706 Abstract method called when this item is dropped on an area with no<br/>drop target
1713 <dl class="detailList">
1714 <dt class="heading">Parameters:</dt>
1717 <span class="fixedFont">Event</span> <b>e</b>
1720 <dd>the mouseup event</dd>
1738 <td class="msource">
1746 <tr class="method-row config-row-alt1 expandable notInherited">
1747 <td class="micon"><a class="exi" href="#expand"> </a></td>
1751 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
1752 <div class="fixedFont">
1753 <span class="attributes"></span><b class="itemname">onMouseDown</b>
1755 (Event <B><i>e</i></B>)
1762 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
1768 Event handler that fires when a drag/drop obj gets a mousedown
1775 <dl class="detailList">
1776 <dt class="heading">Parameters:</dt>
1779 <span class="fixedFont">Event</span> <b>e</b>
1782 <dd>the mousedown event</dd>
1800 <td class="msource">
1808 <tr class="method-row config-row-alt0 expandable notInherited">
1809 <td class="micon"><a class="exi" href="#expand"> </a></td>
1813 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
1814 <div class="fixedFont">
1815 <span class="attributes"></span><b class="itemname">onMouseUp</b>
1817 (Event <B><i>e</i></B>)
1824 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
1830 Event handler that fires when a drag/drop obj gets a mouseup
1837 <dl class="detailList">
1838 <dt class="heading">Parameters:</dt>
1841 <span class="fixedFont">Event</span> <b>e</b>
1844 <dd>the mouseup event</dd>
1862 <td class="msource">
1870 <tr class="method-row config-row-alt1 expandable notInherited">
1871 <td class="micon"><a class="exi" href="#expand"> </a></td>
1875 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
1876 <div class="fixedFont">
1877 <span class="attributes"></span><b class="itemname">padding</b>
1886 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
1892 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
1913 <td class="msource">
1921 <tr class="method-row config-row-alt0 expandable notInherited">
1922 <td class="micon"><a class="exi" href="#expand"> </a></td>
1926 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
1927 <div class="fixedFont">
1928 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
1930 (string <B><i>sGroup</i></B>)
1937 <div class="short">Remove's this instance from the supplied interaction group</div>
1943 Remove's this instance from the supplied interaction group
1950 <dl class="detailList">
1951 <dt class="heading">Parameters:</dt>
1954 <span class="fixedFont">string</span> <b>sGroup</b>
1957 <dd>The group to drop</dd>
1975 <td class="msource">
1983 <tr class="method-row config-row-alt1 expandable notInherited">
1984 <td class="micon"><a class="exi" href="#expand"> </a></td>
1988 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
1989 <div class="fixedFont">
1990 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
1992 (string <B><i>cssClass</i></B>)
1999 <div class="short">Unsets an invalid css class</div>
2005 Unsets an invalid css class
2012 <dl class="detailList">
2013 <dt class="heading">Parameters:</dt>
2016 <span class="fixedFont">string</span> <b>cssClass</b>
2019 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2037 <td class="msource">
2045 <tr class="method-row config-row-alt0 expandable notInherited">
2046 <td class="micon"><a class="exi" href="#expand"> </a></td>
2050 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
2051 <div class="fixedFont">
2052 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2054 (string <B><i>id</i></B>)
2061 <div class="short">Unsets an invalid handle id</div>
2067 Unsets an invalid handle id
2074 <dl class="detailList">
2075 <dt class="heading">Parameters:</dt>
2078 <span class="fixedFont">string</span> <b>id</b>
2081 <dd>the id of the element to re-enable</dd>
2099 <td class="msource">
2107 <tr class="method-row config-row-alt1 expandable notInherited">
2108 <td class="micon"><a class="exi" href="#expand"> </a></td>
2112 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
2113 <div class="fixedFont">
2114 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2116 (string <B><i>tagName</i></B>)
2123 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2129 Unsets an excluded tag name set by addInvalidHandleType
2136 <dl class="detailList">
2137 <dt class="heading">Parameters:</dt>
2140 <span class="fixedFont">string</span> <b>tagName</b>
2143 <dd>the type of element to unexclude</dd>
2161 <td class="msource">
2169 <tr class="method-row config-row-alt0 expandable notInherited">
2170 <td class="micon"><a class="exi" href="#expand"> </a></td>
2174 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
2175 <div class="fixedFont">
2176 <span class="attributes"></span><b class="itemname">resetConstraints</b>
2178 (boolean <B><i>maintainOffset</i></B>)
2185 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
2191 resetConstraints must be called if you manually reposition a dd element.
2198 <dl class="detailList">
2199 <dt class="heading">Parameters:</dt>
2202 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
2223 <td class="msource">
2231 <tr class="method-row config-row-alt1 expandable notInherited">
2232 <td class="micon"><a class="exi" href="#expand"> </a></td>
2236 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
2237 <div class="fixedFont">
2238 <span class="attributes"></span><b class="itemname">setDragElId</b>
2247 <div class="short">Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag</div>
2253 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
2260 <dl class="detailList">
2261 <dt class="heading">Parameters:</dt>
2267 <dd>{string} the id of the element that will be used to initiate the drag</dd>
2285 <td class="msource">
2293 <tr class="method-row config-row-alt0 expandable notInherited">
2294 <td class="micon"><a class="exi" href="#expand"> </a></td>
2298 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
2299 <div class="fixedFont">
2300 <span class="attributes"></span><b class="itemname">setHandleElId</b>
2309 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
2315 Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation. An example of this would be if<br/>you have a content div with text and links. Clicking anywhere in the<br/>content area would normally start the drag operation. Use this method<br/>to specify that an element inside of the content div is the element<br/>that starts the drag operation.
2322 <dl class="detailList">
2323 <dt class="heading">Parameters:</dt>
2329 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
2347 <td class="msource">
2355 <tr class="method-row config-row-alt1 expandable notInherited">
2356 <td class="micon"><a class="exi" href="#expand"> </a></td>
2360 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
2361 <div class="fixedFont">
2362 <span class="attributes"></span><b class="itemname">setInitPosition</b>
2364 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
2371 <div class="short">Stores the initial placement of the linked element.</div>
2377 Stores the initial placement of the linked element.
2384 <dl class="detailList">
2385 <dt class="heading">Parameters:</dt>
2388 <span class="fixedFont">int</span> <b>diffX</b>
2391 <dd>the X offset, default 0</dd>
2394 <span class="fixedFont">int</span> <b>diffY</b>
2397 <dd>the Y offset, default 0</dd>
2415 <td class="msource">
2423 <tr class="method-row config-row-alt0 expandable notInherited">
2424 <td class="micon"><a class="exi" href="#expand"> </a></td>
2428 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
2429 <div class="fixedFont">
2430 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
2439 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
2445 Allows you to set an element outside of the linked element as a drag<br/>handle
2452 <dl class="detailList">
2453 <dt class="heading">Parameters:</dt>
2459 <dd>the id of the element that will be used to initiate the drag</dd>
2477 <td class="msource">
2485 <tr class="method-row config-row-alt1 expandable notInherited">
2486 <td class="micon"><a class="exi" href="#expand"> </a></td>
2490 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
2491 <div class="fixedFont">
2492 <span class="attributes"></span><b class="itemname">setPadding</b>
2494 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
2501 <div class="short">Configures the padding for the target zone in px.</div>
2507 Configures the padding for the target zone in px. Effectively expands<br/>(or reduces) the virtual object size for targeting calculations.<br/>Supports css-style shorthand; if only one parameter is passed, all sides<br/>will have that padding, and if only two are passed, the top and bottom<br/>will have the first param, the left and right the second.
2514 <dl class="detailList">
2515 <dt class="heading">Parameters:</dt>
2518 <span class="fixedFont">int</span> <b>iTop</b>
2524 <span class="fixedFont">int</span> <b>iRight</b>
2530 <span class="fixedFont">int</span> <b>iBot</b>
2536 <span class="fixedFont">int</span> <b>iLeft</b>
2557 <td class="msource">
2565 <tr class="method-row config-row-alt0 expandable notInherited">
2566 <td class="micon"><a class="exi" href="#expand"> </a></td>
2570 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
2571 <div class="fixedFont">
2572 <span class="attributes"></span><b class="itemname">setXConstraint</b>
2574 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
2581 <div class="short">By default, the element can be dragged any place on the screen.</div>
2587 By default, the element can be dragged any place on the screen. Use<br/>this method to limit the horizontal travel of the element. Pass in<br/>0,0 for the parameters if you want to lock the drag to the y axis.
2594 <dl class="detailList">
2595 <dt class="heading">Parameters:</dt>
2598 <span class="fixedFont">int</span> <b>iLeft</b>
2601 <dd>the number of pixels the element can move to the left</dd>
2604 <span class="fixedFont">int</span> <b>iRight</b>
2607 <dd>the number of pixels the element can move to the<br/>right</dd>
2610 <span class="fixedFont">int</span> <b>iTickSize</b>
2613 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
2631 <td class="msource">
2639 <tr class="method-row config-row-alt1 expandable notInherited">
2640 <td class="micon"><a class="exi" href="#expand"> </a></td>
2644 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
2645 <div class="fixedFont">
2646 <span class="attributes"></span><b class="itemname">setYConstraint</b>
2648 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
2655 <div class="short">By default, the element can be dragged any place on the screen.</div>
2661 By default, the element can be dragged any place on the screen. Set<br/>this to limit the vertical travel of the element. Pass in 0,0 for the<br/>parameters if you want to lock the drag to the x axis.
2668 <dl class="detailList">
2669 <dt class="heading">Parameters:</dt>
2672 <span class="fixedFont">int</span> <b>iUp</b>
2675 <dd>the number of pixels the element can move up</dd>
2678 <span class="fixedFont">int</span> <b>iDown</b>
2681 <dd>the number of pixels the element can move down</dd>
2684 <span class="fixedFont">int</span> <b>iTickSize</b>
2687 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
2705 <td class="msource">
2713 <tr class="method-row config-row-alt0 expandable notInherited">
2714 <td class="micon"><a class="exi" href="#expand"> </a></td>
2718 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
2719 <div class="fixedFont">
2720 <span class="attributes"></span><b class="itemname">startDrag</b>
2722 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
2729 <div class="short">Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.</div>
2735 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
2742 <dl class="detailList">
2743 <dt class="heading">Parameters:</dt>
2746 <span class="fixedFont">int</span> <b>X</b>
2749 <dd>click location</dd>
2752 <span class="fixedFont">int</span> <b>Y</b>
2755 <dd>click location</dd>
2773 <td class="msource">
2781 <tr class="method-row config-row-alt1 expandable notInherited">
2782 <td class="micon"><a class="exi" href="#expand"> </a></td>
2786 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
2787 <div class="fixedFont">
2788 <span class="attributes"></span><b class="itemname">unlock</b>
2797 <div class="short">Unlock this instace</div>
2824 <td class="msource">
2832 <tr class="method-row config-row-alt0 expandable notInherited">
2833 <td class="micon"><a class="exi" href="#expand"> </a></td>
2837 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
2838 <div class="fixedFont">
2839 <span class="attributes"></span><b class="itemname">unreg</b>
2848 <div class="short">Remove all drag and drop hooks for this element</div>
2854 Remove all drag and drop hooks for this element
2875 <td class="msource">
2886 <!-- ============================== events summary / details ======================== -->
2889 <a id="Roo.dd.DragDrop-events"></a>
2895 <table cellspacing="0" class="member-table">
2896 <caption class="Empty">Events - Has None</caption>
2907 <!-- ============================== footer ================================= -->
2908 <div class="fineprint" style="clear:both">
2910 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
2912 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob