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.DDTarget</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.DDTarget-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.DDTarget-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.DDTarget-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.DDTarget-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 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DDTarget
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_dd_DDTarget.js.html">Roo/dd/DDTarget.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">DDTarget</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <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>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 A DragDrop implementation that does not move, but can be a drop<br/>target. You would get the same result by simply omitting implementation<br/>for the event callbacks, but this way we reduce the processing cost of the<br/>event listener and the callbacks.
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DDTarget';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.dd.DDTarget.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.dd.DDTarget-configs"></a>
118 <table cellspacing="0" class="member-table">
119 <caption class="Empty">Config Options - Has None</caption>
133 <!-- ============================== public properties ==================== -->
137 <a id="Roo.dd.DDTarget-props"></a>
143 <table cellspacing="0" class="member-table">
144 <caption class="Empty">Public Properties - Has None</caption>
150 <!-- ============================== methods summary / details ======================== -->
153 <a id="Roo.dd.DDTarget-methods"></a>
154 <!-- constructor?? -->
161 <!-- then dynamics first -->
168 <table cellspacing="0" class="member-table">
169 <caption>Public Methods</caption>
171 <th class="sig-header" colspan="2">Method</th>
172 <th class="msource-header">Defined By</th>
182 <tr class="method-row config-row-alt0 expandable notInherited">
183 <td class="micon"><a class="exi" href="#expand"> </a></td>
187 <a id="Roo.dd-method-DDTarget" name=".DDTarget"></a>
188 <div class="fixedFont">
189 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DDTarget</b>
191 (<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>)
199 <div class="short">Create a new Roo.dd.DDTarget</div>
206 Create a new Roo.dd.DDTarget
209 <dl class="detailList">
210 <dt class="heading">Parameters:</dt>
213 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
216 <dd>the id of the element that is a drop target</dd>
219 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
222 <dd>the group of related DragDrop objects</dd>
225 <span class="fixedFont">object</span> <b>config</b>
228 <dd>an object containing configurable attributes<br/> Valid properties for DDTarget in addition to those in<br/> DragDrop:<br/> none</dd>
252 <tr class="method-row config-row-alt1 expandable">
253 <td class="micon"><a class="exi" href="#expand"> </a></td>
257 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
258 <div class="fixedFont">
259 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
261 (string <B><i>cssClass</i></B>)
268 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
274 Lets you specify a css class of elements that will not initiate a drag
281 <dl class="detailList">
282 <dt class="heading">Parameters:</dt>
285 <span class="fixedFont">string</span> <b>cssClass</b>
288 <dd>the class of the elements you wish to ignore</dd>
308 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
314 <tr class="method-row config-row-alt0 expandable">
315 <td class="micon"><a class="exi" href="#expand"> </a></td>
319 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
320 <div class="fixedFont">
321 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
323 (string <B><i>id</i></B>)
330 <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>
336 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
343 <dl class="detailList">
344 <dt class="heading">Parameters:</dt>
347 <span class="fixedFont">string</span> <b>id</b>
350 <dd>the element id of the element you wish to ignore</dd>
370 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
376 <tr class="method-row config-row-alt1 expandable">
377 <td class="micon"><a class="exi" href="#expand"> </a></td>
381 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
382 <div class="fixedFont">
383 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
385 (string <B><i>tagName</i></B>)
392 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
398 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.
405 <dl class="detailList">
406 <dt class="heading">Parameters:</dt>
409 <span class="fixedFont">string</span> <b>tagName</b>
412 <dd>the type of element to exclude</dd>
432 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
438 <tr class="method-row config-row-alt0 expandable">
439 <td class="micon"><a class="exi" href="#expand"> </a></td>
443 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
444 <div class="fixedFont">
445 <span class="attributes"></span><b class="itemname">addToGroup</b>
447 (<B><i>sGroup</i></B>)
454 <div class="short">Add this instance to a group of related drag/drop objects.</div>
460 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.
467 <dl class="detailList">
468 <dt class="heading">Parameters:</dt>
474 <dd>{string} the name of the group</dd>
494 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
500 <tr class="method-row config-row-alt1 expandable">
501 <td class="micon"><a class="exi" href="#expand"> </a></td>
505 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
506 <div class="fixedFont">
507 <span class="attributes"></span><b class="itemname">applyConfig</b>
516 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
522 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.
545 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
551 <tr class="method-row config-row-alt0 expandable">
552 <td class="micon"><a class="exi" href="#expand"> </a></td>
556 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
557 <div class="fixedFont">
558 <span class="attributes"></span><b class="itemname">clearConstraints</b>
567 <div class="short">Clears any constraints applied to this instance.</div>
573 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
596 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
602 <tr class="method-row config-row-alt1 expandable">
603 <td class="micon"><a class="exi" href="#expand"> </a></td>
607 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
608 <div class="fixedFont">
609 <span class="attributes"></span><b class="itemname">clearTicks</b>
618 <div class="short">Clears any tick interval defined for this instance</div>
624 Clears any tick interval defined for this instance
647 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
653 <tr class="method-row config-row-alt0 expandable">
654 <td class="micon"><a class="exi" href="#expand"> </a></td>
658 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
659 <div class="fixedFont">
660 <span class="attributes"></span><b class="itemname">endDrag</b>
662 (Event <B><i>e</i></B>)
669 <div class="short">Fired when we are done dragging the object</div>
675 Fired when we are done dragging the object
682 <dl class="detailList">
683 <dt class="heading">Parameters:</dt>
686 <span class="fixedFont">Event</span> <b>e</b>
689 <dd>the mouseup event</dd>
709 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
715 <tr class="method-row config-row-alt1 expandable">
716 <td class="micon"><a class="exi" href="#expand"> </a></td>
720 <a id="Roo.dd.DragDrop-method-function toString() {
722 }" name=".function toString() {
725 <div class="fixedFont">
726 <span class="attributes"></span><b class="itemname">function toString() {
745 <div class="short">toString method</div>
762 <dl class="detailList">
763 <dt class="heading">Returns:</dt>
765 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
781 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
787 <tr class="method-row config-row-alt0 expandable">
788 <td class="micon"><a class="exi" href="#expand"> </a></td>
792 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
793 <div class="fixedFont">
794 <span class="attributes"></span><b class="itemname">getDragEl</b>
802 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
811 <div class="short">Returns a reference to the actual element to drag.</div>
817 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
828 <dl class="detailList">
829 <dt class="heading">Returns:</dt>
831 <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>
847 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
853 <tr class="method-row config-row-alt1 expandable">
854 <td class="micon"><a class="exi" href="#expand"> </a></td>
858 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
859 <div class="fixedFont">
860 <span class="attributes"></span><b class="itemname">getEl</b>
868 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
877 <div class="short">Returns a reference to the linked element</div>
883 Returns a reference to the linked element
894 <dl class="detailList">
895 <dt class="heading">Returns:</dt>
897 <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>
913 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
919 <tr class="method-row config-row-alt0 expandable">
920 <td class="micon"><a class="exi" href="#expand"> </a></td>
924 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
925 <div class="fixedFont">
926 <span class="attributes"></span><b class="itemname">init</b>
928 (<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>)
935 <div class="short">Sets up the DragDrop object.</div>
941 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
948 <dl class="detailList">
949 <dt class="heading">Parameters:</dt>
955 <dd>the id of the linked element</dd>
958 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
961 <dd>the group of related items</dd>
964 <span class="fixedFont">object</span> <b>config</b>
967 <dd>configuration attributes</dd>
987 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
993 <tr class="method-row config-row-alt1 expandable">
994 <td class="micon"><a class="exi" href="#expand"> </a></td>
998 <a id="Roo.dd.DragDrop-method-initTarget" name=".initTarget"></a>
999 <div class="fixedFont">
1000 <span class="attributes"></span><b class="itemname">initTarget</b>
1002 (<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>)
1009 <div class="short">Initializes Targeting functionality only.</div>
1015 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1022 <dl class="detailList">
1023 <dt class="heading">Parameters:</dt>
1029 <dd>the id of the linked element</dd>
1032 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1035 <dd>the group of related items</dd>
1038 <span class="fixedFont">object</span> <b>config</b>
1041 <dd>configuration attributes</dd>
1059 <td class="msource">
1061 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1067 <tr class="method-row config-row-alt0 expandable">
1068 <td class="micon"><a class="exi" href="#expand"> </a></td>
1072 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
1073 <div class="fixedFont">
1074 <span class="attributes"></span><b class="itemname">isLocked</b>
1091 <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>
1097 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.)
1108 <dl class="detailList">
1109 <dt class="heading">Returns:</dt>
1111 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
1125 <td class="msource">
1127 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1133 <tr class="method-row config-row-alt1 expandable">
1134 <td class="micon"><a class="exi" href="#expand"> </a></td>
1138 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
1139 <div class="fixedFont">
1140 <span class="attributes"></span><b class="itemname">isTarget</b>
1149 <div class="short">By default, all insances can be a drop target.</div>
1155 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
1176 <td class="msource">
1178 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1184 <tr class="method-row config-row-alt0 expandable">
1185 <td class="micon"><a class="exi" href="#expand"> </a></td>
1189 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
1190 <div class="fixedFont">
1191 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1193 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1208 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1214 Checks the tag exclusion list to see if this click should be ignored
1221 <dl class="detailList">
1222 <dt class="heading">Parameters:</dt>
1225 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1228 <dd>the HTMLElement to evaluate</dd>
1236 <dl class="detailList">
1237 <dt class="heading">Returns:</dt>
1239 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
1253 <td class="msource">
1255 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1261 <tr class="method-row config-row-alt1 expandable">
1262 <td class="micon"><a class="exi" href="#expand"> </a></td>
1266 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
1267 <div class="fixedFont">
1268 <span class="attributes"></span><b class="itemname">lock</b>
1277 <div class="short">Lock this instance</div>
1304 <td class="msource">
1306 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1312 <tr class="method-row config-row-alt0 expandable">
1313 <td class="micon"><a class="exi" href="#expand"> </a></td>
1317 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
1318 <div class="fixedFont">
1319 <span class="attributes"></span><b class="itemname">onAvailable</b>
1328 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
1334 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
1355 <td class="msource">
1357 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1363 <tr class="method-row config-row-alt1 expandable">
1364 <td class="micon"><a class="exi" href="#expand"> </a></td>
1368 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
1369 <div class="fixedFont">
1370 <span class="attributes"></span><b class="itemname">onDrag</b>
1372 (Event <B><i>e</i></B>)
1379 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
1385 Abstract method called during the onMouseMove event while dragging an<br/>object.
1392 <dl class="detailList">
1393 <dt class="heading">Parameters:</dt>
1396 <span class="fixedFont">Event</span> <b>e</b>
1399 <dd>the mousemove event</dd>
1417 <td class="msource">
1419 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1425 <tr class="method-row config-row-alt0 expandable">
1426 <td class="micon"><a class="exi" href="#expand"> </a></td>
1430 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
1431 <div class="fixedFont">
1432 <span class="attributes"></span><b class="itemname">onDragDrop</b>
1434 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1441 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
1447 Abstract method called when this item is dropped on another DragDrop<br/>obj
1454 <dl class="detailList">
1455 <dt class="heading">Parameters:</dt>
1458 <span class="fixedFont">Event</span> <b>e</b>
1461 <dd>the mouseup event</dd>
1464 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1467 <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>
1485 <td class="msource">
1487 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1493 <tr class="method-row config-row-alt1 expandable">
1494 <td class="micon"><a class="exi" href="#expand"> </a></td>
1498 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
1499 <div class="fixedFont">
1500 <span class="attributes"></span><b class="itemname">onDragEnter</b>
1502 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1509 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
1515 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
1522 <dl class="detailList">
1523 <dt class="heading">Parameters:</dt>
1526 <span class="fixedFont">Event</span> <b>e</b>
1529 <dd>the mousemove event</dd>
1532 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1535 <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>
1553 <td class="msource">
1555 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1561 <tr class="method-row config-row-alt0 expandable">
1562 <td class="micon"><a class="exi" href="#expand"> </a></td>
1566 <a id="Roo.dd.DragDrop-method-onDragOut" name=".onDragOut"></a>
1567 <div class="fixedFont">
1568 <span class="attributes"></span><b class="itemname">onDragOut</b>
1570 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1577 <div class="short">Abstract method called when we are no longer hovering over an element</div>
1583 Abstract method called when we are no longer hovering over an element
1590 <dl class="detailList">
1591 <dt class="heading">Parameters:</dt>
1594 <span class="fixedFont">Event</span> <b>e</b>
1597 <dd>the mousemove event</dd>
1600 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1603 <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>
1621 <td class="msource">
1623 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1629 <tr class="method-row config-row-alt1 expandable">
1630 <td class="micon"><a class="exi" href="#expand"> </a></td>
1634 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
1635 <div class="fixedFont">
1636 <span class="attributes"></span><b class="itemname">onDragOver</b>
1638 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1645 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
1651 Abstract method called when this element is hovering over another<br/>DragDrop obj
1658 <dl class="detailList">
1659 <dt class="heading">Parameters:</dt>
1662 <span class="fixedFont">Event</span> <b>e</b>
1665 <dd>the mousemove event</dd>
1668 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1671 <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>
1689 <td class="msource">
1691 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1697 <tr class="method-row config-row-alt0 expandable">
1698 <td class="micon"><a class="exi" href="#expand"> </a></td>
1702 <a id="Roo.dd.DragDrop-method-onInvalidDrop" name=".onInvalidDrop"></a>
1703 <div class="fixedFont">
1704 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
1706 (Event <B><i>e</i></B>)
1713 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
1719 Abstract method called when this item is dropped on an area with no<br/>drop target
1726 <dl class="detailList">
1727 <dt class="heading">Parameters:</dt>
1730 <span class="fixedFont">Event</span> <b>e</b>
1733 <dd>the mouseup event</dd>
1751 <td class="msource">
1753 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1759 <tr class="method-row config-row-alt1 expandable">
1760 <td class="micon"><a class="exi" href="#expand"> </a></td>
1764 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
1765 <div class="fixedFont">
1766 <span class="attributes"></span><b class="itemname">onMouseDown</b>
1768 (Event <B><i>e</i></B>)
1775 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
1781 Event handler that fires when a drag/drop obj gets a mousedown
1788 <dl class="detailList">
1789 <dt class="heading">Parameters:</dt>
1792 <span class="fixedFont">Event</span> <b>e</b>
1795 <dd>the mousedown event</dd>
1813 <td class="msource">
1815 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1821 <tr class="method-row config-row-alt0 expandable">
1822 <td class="micon"><a class="exi" href="#expand"> </a></td>
1826 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
1827 <div class="fixedFont">
1828 <span class="attributes"></span><b class="itemname">onMouseUp</b>
1830 (Event <B><i>e</i></B>)
1837 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
1843 Event handler that fires when a drag/drop obj gets a mouseup
1850 <dl class="detailList">
1851 <dt class="heading">Parameters:</dt>
1854 <span class="fixedFont">Event</span> <b>e</b>
1857 <dd>the mouseup event</dd>
1875 <td class="msource">
1877 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1883 <tr class="method-row config-row-alt1 expandable">
1884 <td class="micon"><a class="exi" href="#expand"> </a></td>
1888 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
1889 <div class="fixedFont">
1890 <span class="attributes"></span><b class="itemname">padding</b>
1899 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
1905 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
1926 <td class="msource">
1928 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1934 <tr class="method-row config-row-alt0 expandable">
1935 <td class="micon"><a class="exi" href="#expand"> </a></td>
1939 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
1940 <div class="fixedFont">
1941 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
1943 (string <B><i>sGroup</i></B>)
1950 <div class="short">Remove's this instance from the supplied interaction group</div>
1956 Remove's this instance from the supplied interaction group
1963 <dl class="detailList">
1964 <dt class="heading">Parameters:</dt>
1967 <span class="fixedFont">string</span> <b>sGroup</b>
1970 <dd>The group to drop</dd>
1988 <td class="msource">
1990 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1996 <tr class="method-row config-row-alt1 expandable">
1997 <td class="micon"><a class="exi" href="#expand"> </a></td>
2001 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
2002 <div class="fixedFont">
2003 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
2005 (string <B><i>cssClass</i></B>)
2012 <div class="short">Unsets an invalid css class</div>
2018 Unsets an invalid css class
2025 <dl class="detailList">
2026 <dt class="heading">Parameters:</dt>
2029 <span class="fixedFont">string</span> <b>cssClass</b>
2032 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2050 <td class="msource">
2052 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2058 <tr class="method-row config-row-alt0 expandable">
2059 <td class="micon"><a class="exi" href="#expand"> </a></td>
2063 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
2064 <div class="fixedFont">
2065 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2067 (string <B><i>id</i></B>)
2074 <div class="short">Unsets an invalid handle id</div>
2080 Unsets an invalid handle id
2087 <dl class="detailList">
2088 <dt class="heading">Parameters:</dt>
2091 <span class="fixedFont">string</span> <b>id</b>
2094 <dd>the id of the element to re-enable</dd>
2112 <td class="msource">
2114 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2120 <tr class="method-row config-row-alt1 expandable">
2121 <td class="micon"><a class="exi" href="#expand"> </a></td>
2125 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
2126 <div class="fixedFont">
2127 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2129 (string <B><i>tagName</i></B>)
2136 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2142 Unsets an excluded tag name set by addInvalidHandleType
2149 <dl class="detailList">
2150 <dt class="heading">Parameters:</dt>
2153 <span class="fixedFont">string</span> <b>tagName</b>
2156 <dd>the type of element to unexclude</dd>
2174 <td class="msource">
2176 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2182 <tr class="method-row config-row-alt0 expandable">
2183 <td class="micon"><a class="exi" href="#expand"> </a></td>
2187 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
2188 <div class="fixedFont">
2189 <span class="attributes"></span><b class="itemname">resetConstraints</b>
2191 (boolean <B><i>maintainOffset</i></B>)
2198 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
2204 resetConstraints must be called if you manually reposition a dd element.
2211 <dl class="detailList">
2212 <dt class="heading">Parameters:</dt>
2215 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
2236 <td class="msource">
2238 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2244 <tr class="method-row config-row-alt1 expandable">
2245 <td class="micon"><a class="exi" href="#expand"> </a></td>
2249 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
2250 <div class="fixedFont">
2251 <span class="attributes"></span><b class="itemname">setDragElId</b>
2260 <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>
2266 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
2273 <dl class="detailList">
2274 <dt class="heading">Parameters:</dt>
2280 <dd>{string} the id of the element that will be used to initiate the drag</dd>
2298 <td class="msource">
2300 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2306 <tr class="method-row config-row-alt0 expandable">
2307 <td class="micon"><a class="exi" href="#expand"> </a></td>
2311 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
2312 <div class="fixedFont">
2313 <span class="attributes"></span><b class="itemname">setHandleElId</b>
2322 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
2328 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.
2335 <dl class="detailList">
2336 <dt class="heading">Parameters:</dt>
2342 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
2360 <td class="msource">
2362 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2368 <tr class="method-row config-row-alt1 expandable">
2369 <td class="micon"><a class="exi" href="#expand"> </a></td>
2373 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
2374 <div class="fixedFont">
2375 <span class="attributes"></span><b class="itemname">setInitPosition</b>
2377 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
2384 <div class="short">Stores the initial placement of the linked element.</div>
2390 Stores the initial placement of the linked element.
2397 <dl class="detailList">
2398 <dt class="heading">Parameters:</dt>
2401 <span class="fixedFont">int</span> <b>diffX</b>
2404 <dd>the X offset, default 0</dd>
2407 <span class="fixedFont">int</span> <b>diffY</b>
2410 <dd>the Y offset, default 0</dd>
2428 <td class="msource">
2430 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2436 <tr class="method-row config-row-alt0 expandable">
2437 <td class="micon"><a class="exi" href="#expand"> </a></td>
2441 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
2442 <div class="fixedFont">
2443 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
2452 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
2458 Allows you to set an element outside of the linked element as a drag<br/>handle
2465 <dl class="detailList">
2466 <dt class="heading">Parameters:</dt>
2472 <dd>the id of the element that will be used to initiate the drag</dd>
2490 <td class="msource">
2492 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2498 <tr class="method-row config-row-alt1 expandable">
2499 <td class="micon"><a class="exi" href="#expand"> </a></td>
2503 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
2504 <div class="fixedFont">
2505 <span class="attributes"></span><b class="itemname">setPadding</b>
2507 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
2514 <div class="short">Configures the padding for the target zone in px.</div>
2520 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.
2527 <dl class="detailList">
2528 <dt class="heading">Parameters:</dt>
2531 <span class="fixedFont">int</span> <b>iTop</b>
2537 <span class="fixedFont">int</span> <b>iRight</b>
2543 <span class="fixedFont">int</span> <b>iBot</b>
2549 <span class="fixedFont">int</span> <b>iLeft</b>
2570 <td class="msource">
2572 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2578 <tr class="method-row config-row-alt0 expandable">
2579 <td class="micon"><a class="exi" href="#expand"> </a></td>
2583 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
2584 <div class="fixedFont">
2585 <span class="attributes"></span><b class="itemname">setXConstraint</b>
2587 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
2594 <div class="short">By default, the element can be dragged any place on the screen.</div>
2600 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.
2607 <dl class="detailList">
2608 <dt class="heading">Parameters:</dt>
2611 <span class="fixedFont">int</span> <b>iLeft</b>
2614 <dd>the number of pixels the element can move to the left</dd>
2617 <span class="fixedFont">int</span> <b>iRight</b>
2620 <dd>the number of pixels the element can move to the<br/>right</dd>
2623 <span class="fixedFont">int</span> <b>iTickSize</b>
2626 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
2644 <td class="msource">
2646 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2652 <tr class="method-row config-row-alt1 expandable">
2653 <td class="micon"><a class="exi" href="#expand"> </a></td>
2657 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
2658 <div class="fixedFont">
2659 <span class="attributes"></span><b class="itemname">setYConstraint</b>
2661 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
2668 <div class="short">By default, the element can be dragged any place on the screen.</div>
2674 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.
2681 <dl class="detailList">
2682 <dt class="heading">Parameters:</dt>
2685 <span class="fixedFont">int</span> <b>iUp</b>
2688 <dd>the number of pixels the element can move up</dd>
2691 <span class="fixedFont">int</span> <b>iDown</b>
2694 <dd>the number of pixels the element can move down</dd>
2697 <span class="fixedFont">int</span> <b>iTickSize</b>
2700 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
2718 <td class="msource">
2720 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2726 <tr class="method-row config-row-alt0 expandable">
2727 <td class="micon"><a class="exi" href="#expand"> </a></td>
2731 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
2732 <div class="fixedFont">
2733 <span class="attributes"></span><b class="itemname">startDrag</b>
2735 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
2742 <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>
2748 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
2755 <dl class="detailList">
2756 <dt class="heading">Parameters:</dt>
2759 <span class="fixedFont">int</span> <b>X</b>
2762 <dd>click location</dd>
2765 <span class="fixedFont">int</span> <b>Y</b>
2768 <dd>click location</dd>
2786 <td class="msource">
2788 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2794 <tr class="method-row config-row-alt1 expandable">
2795 <td class="micon"><a class="exi" href="#expand"> </a></td>
2799 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
2800 <div class="fixedFont">
2801 <span class="attributes"></span><b class="itemname">unlock</b>
2810 <div class="short">Unlock this instace</div>
2837 <td class="msource">
2839 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2845 <tr class="method-row config-row-alt0 expandable">
2846 <td class="micon"><a class="exi" href="#expand"> </a></td>
2850 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
2851 <div class="fixedFont">
2852 <span class="attributes"></span><b class="itemname">unreg</b>
2861 <div class="short">Remove all drag and drop hooks for this element</div>
2867 Remove all drag and drop hooks for this element
2888 <td class="msource">
2890 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2899 <!-- ============================== events summary / details ======================== -->
2902 <a id="Roo.dd.DDTarget-events"></a>
2908 <table cellspacing="0" class="member-table">
2909 <caption class="Empty">Events - Has None</caption>
2920 <!-- ============================== footer ================================= -->
2921 <div class="fineprint" style="clear:both">
2923 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)
2925 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>