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.DragSource</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.DragSource-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.DragSource-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.DragSource-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.DragSource-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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DragSource
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.dd.DragSource
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_dd_DragSource.js.html">Roo/dd/DragSource.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">DragSource</td></tr>
74 <tr><td class="label">Subclasses:</td><td class="hd-info">
75 <a href="./Roo.dd.DragZone.html#constructor" roo:cls="Roo.dd.DragZone.html#constructor">Roo.dd.DragZone</a>
83 <tr><td class="label">Extends:</td><td class="hd-info">
84 <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
92 <!-- ============================== class summary ========================== -->
93 <div class="description">
94 A simple class that provides the basic implementation needed to make any element draggable.
98 <!-- ============================== Class comment block... ========================== -->
100 <div class="comments">
101 <b>Class Comments / Notes</B> =>
102 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DragSource';">[Add Your comment/notes about this class]</u>
104 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
105 src="/blog.php/GtkDjsComments/Roo.dd.DragSource.html"></iframe>
110 <!-- ============================== config options ========================== -->
115 <div class="hr"></div>
116 <a id="Roo.dd.DragSource-configs"></a>
122 <table cellspacing="0" class="member-table">
123 <caption>Config Options (Usually are also Properties)</caption>
127 <th class="sig-header" colspan="2">Options</th>
129 <th class="msource-header">Defined By</th>
136 <tr class="config-row expandable config-row-alt0 notInherited">
137 <td class="micon"><a class="exi" href="#expand"> </a></td>
140 <a id="Roo.dd.DragSource-cfg-dropAllowed" name=".dropAllowed"></a>
141 <div class="fixedFont">
142 <b class="itemname">dropAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
148 <div class="short">The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</div>
152 <div class="long">The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</div>
166 <tr class="config-row expandable config-row-alt1 notInherited">
167 <td class="micon"><a class="exi" href="#expand"> </a></td>
170 <a id="Roo.dd.DragSource-cfg-dropNotAllowed" name=".dropNotAllowed"></a>
171 <div class="fixedFont">
172 <b class="itemname">dropNotAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
178 <div class="short">The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
182 <div class="long">The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
206 <!-- ============================== public properties ==================== -->
210 <a id="Roo.dd.DragSource-props"></a>
218 <table cellspacing="0" class="member-table">
219 <caption>Public Properties </caption>
221 <th class="sig-header" colspan="2">Property</th>
222 <th class="sig-header">Description</th>
223 <th class="msource-header">Defined By</th>
233 <tr class="property-row config-row-alt0">
235 <a class="exi" href="#expand"> </a>
238 <a id="Roo.dd.DDProxy-prop-dragElId" name=".dragElId"></a>
239 <div class="fixedFont">
240 <span class="attributes">Roo.dd.DragSource.</span><b class="itemname">dragElId</b> :
241 <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
249 The default drag frame div id
257 The default drag frame div id
264 <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
273 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
274 <tr class="property-row alt">
281 <!-- ============================== methods summary / details ======================== -->
284 <a id="Roo.dd.DragSource-methods"></a>
285 <!-- constructor?? -->
292 <!-- then dynamics first -->
299 <table cellspacing="0" class="member-table">
300 <caption>Public Methods</caption>
302 <th class="sig-header" colspan="2">Method</th>
303 <th class="msource-header">Defined By</th>
313 <tr class="method-row config-row-alt0 expandable notInherited">
314 <td class="micon"><a class="exi" href="#expand"> </a></td>
318 <a id="Roo.dd-method-DragSource" name=".DragSource"></a>
319 <div class="fixedFont">
320 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragSource</b>
322 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
330 <div class="short">Create a new Roo.dd.DragSource</div>
337 Create a new Roo.dd.DragSource
340 <dl class="detailList">
341 <dt class="heading">Parameters:</dt>
344 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
347 <dd>The container element</dd>
350 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
377 <tr class="method-row config-row-alt1 expandable">
378 <td class="micon"><a class="exi" href="#expand"> </a></td>
382 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
383 <div class="fixedFont">
384 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
386 (string <B><i>cssClass</i></B>)
393 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
399 Lets you specify a css class of elements that will not initiate a drag
406 <dl class="detailList">
407 <dt class="heading">Parameters:</dt>
410 <span class="fixedFont">string</span> <b>cssClass</b>
413 <dd>the class of the elements you wish to ignore</dd>
433 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
439 <tr class="method-row config-row-alt0 expandable">
440 <td class="micon"><a class="exi" href="#expand"> </a></td>
444 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
445 <div class="fixedFont">
446 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
448 (string <B><i>id</i></B>)
455 <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>
461 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
468 <dl class="detailList">
469 <dt class="heading">Parameters:</dt>
472 <span class="fixedFont">string</span> <b>id</b>
475 <dd>the element id of the element you wish to ignore</dd>
495 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
501 <tr class="method-row config-row-alt1 expandable">
502 <td class="micon"><a class="exi" href="#expand"> </a></td>
506 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
507 <div class="fixedFont">
508 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
510 (string <B><i>tagName</i></B>)
517 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
523 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.
530 <dl class="detailList">
531 <dt class="heading">Parameters:</dt>
534 <span class="fixedFont">string</span> <b>tagName</b>
537 <dd>the type of element to exclude</dd>
557 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
563 <tr class="method-row config-row-alt0 expandable">
564 <td class="micon"><a class="exi" href="#expand"> </a></td>
568 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
569 <div class="fixedFont">
570 <span class="attributes"></span><b class="itemname">addToGroup</b>
572 (<B><i>sGroup</i></B>)
579 <div class="short">Add this instance to a group of related drag/drop objects.</div>
585 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.
592 <dl class="detailList">
593 <dt class="heading">Parameters:</dt>
599 <dd>{string} the name of the group</dd>
619 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
625 <tr class="method-row config-row-alt1 expandable">
626 <td class="micon"><a class="exi" href="#expand"> </a></td>
630 <a id="Roo.dd.DD-method-alignElWithMouse" name=".alignElWithMouse"></a>
631 <div class="fixedFont">
632 <span class="attributes"></span><b class="itemname">alignElWithMouse</b>
634 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>el</i></B>, int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
641 <div class="short">Sets the element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.</div>
647 Sets the element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked. Override this if you want to place the element in a<br/>location other than where the cursor is.
654 <dl class="detailList">
655 <dt class="heading">Parameters:</dt>
658 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>el</b>
661 <dd>the element to move</dd>
664 <span class="fixedFont">int</span> <b>iPageX</b>
667 <dd>the X coordinate of the mousedown or drag event</dd>
670 <span class="fixedFont">int</span> <b>iPageY</b>
673 <dd>the Y coordinate of the mousedown or drag event</dd>
693 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
699 <tr class="method-row config-row-alt0 expandable">
700 <td class="micon"><a class="exi" href="#expand"> </a></td>
704 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
705 <div class="fixedFont">
706 <span class="attributes"></span><b class="itemname">applyConfig</b>
715 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
721 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.
744 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
750 <tr class="method-row config-row-alt1 expandable">
751 <td class="micon"><a class="exi" href="#expand"> </a></td>
755 <a id="Roo.dd.DD-method-autoOffset" name=".autoOffset"></a>
756 <div class="fixedFont">
757 <span class="attributes"></span><b class="itemname">autoOffset</b>
759 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
766 <div class="short">Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked</div>
772 Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked
779 <dl class="detailList">
780 <dt class="heading">Parameters:</dt>
783 <span class="fixedFont">int</span> <b>iPageX</b>
786 <dd>the X coordinate of the click</dd>
789 <span class="fixedFont">int</span> <b>iPageY</b>
792 <dd>the Y coordinate of the click</dd>
812 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
818 <tr class="method-row config-row-alt0 expandable notInherited">
819 <td class="micon"><a class="exi" href="#expand"> </a></td>
823 <a id="Roo.dd.DragSource-method-beforeDragDrop" name=".beforeDragDrop"></a>
824 <div class="fixedFont">
825 <span class="attributes"></span><b class="itemname">beforeDragDrop</b>
827 (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
833 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
842 <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged<br/>item is dropped onto the target and optionally cancel the onDragDrop.</div>
848 An empty function by default, but provided so that you can perform a custom action before the dragged<br/>item is dropped onto the target and optionally cancel the onDragDrop.
855 <dl class="detailList">
856 <dt class="heading">Parameters:</dt>
859 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span> <b>target</b>
862 <dd>The drop target</dd>
865 <span class="fixedFont">Event</span> <b>e</b>
868 <dd>The event object</dd>
871 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
874 <dd>The id of the dragged element</dd>
882 <dl class="detailList">
883 <dt class="heading">Returns:</dt>
885 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> isValid True if the drag drop event is valid, else false to cancel</dd>
907 <tr class="method-row config-row-alt1 expandable notInherited">
908 <td class="micon"><a class="exi" href="#expand"> </a></td>
912 <a id="Roo.dd.DragSource-method-beforeDragEnter" name=".beforeDragEnter"></a>
913 <div class="fixedFont">
914 <span class="attributes"></span><b class="itemname">beforeDragEnter</b>
916 (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
922 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
931 <div class="short">An empty function by default, but provided so that you can perform a custom action<br/>before the dragged item enters the drop target and optionally cancel the onDragEnter.</div>
937 An empty function by default, but provided so that you can perform a custom action<br/>before the dragged item enters the drop target and optionally cancel the onDragEnter.
944 <dl class="detailList">
945 <dt class="heading">Parameters:</dt>
948 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span> <b>target</b>
951 <dd>The drop target</dd>
954 <span class="fixedFont">Event</span> <b>e</b>
957 <dd>The event object</dd>
960 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
963 <dd>The id of the dragged element</dd>
971 <dl class="detailList">
972 <dt class="heading">Returns:</dt>
974 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> isValid True if the drag event is valid, else false to cancel</dd>
996 <tr class="method-row config-row-alt0 expandable notInherited">
997 <td class="micon"><a class="exi" href="#expand"> </a></td>
1001 <a id="Roo.dd.DragSource-method-beforeDragOut" name=".beforeDragOut"></a>
1002 <div class="fixedFont">
1003 <span class="attributes"></span><b class="itemname">beforeDragOut</b>
1005 (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1011 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1020 <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged<br/>item is dragged out of the target without dropping, and optionally cancel the onDragOut.</div>
1026 An empty function by default, but provided so that you can perform a custom action before the dragged<br/>item is dragged out of the target without dropping, and optionally cancel the onDragOut.
1033 <dl class="detailList">
1034 <dt class="heading">Parameters:</dt>
1037 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span> <b>target</b>
1040 <dd>The drop target</dd>
1043 <span class="fixedFont">Event</span> <b>e</b>
1046 <dd>The event object</dd>
1049 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1052 <dd>The id of the dragged element</dd>
1060 <dl class="detailList">
1061 <dt class="heading">Returns:</dt>
1063 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> isValid True if the drag event is valid, else false to cancel</dd>
1077 <td class="msource">
1085 <tr class="method-row config-row-alt1 expandable notInherited">
1086 <td class="micon"><a class="exi" href="#expand"> </a></td>
1090 <a id="Roo.dd.DragSource-method-beforeDragOver" name=".beforeDragOver"></a>
1091 <div class="fixedFont">
1092 <span class="attributes"></span><b class="itemname">beforeDragOver</b>
1094 (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1100 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1109 <div class="short">An empty function by default, but provided so that you can perform a custom action<br/>while the dragged item is over the drop target and optionally cancel the onDragOver.</div>
1115 An empty function by default, but provided so that you can perform a custom action<br/>while the dragged item is over the drop target and optionally cancel the onDragOver.
1122 <dl class="detailList">
1123 <dt class="heading">Parameters:</dt>
1126 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span> <b>target</b>
1129 <dd>The drop target</dd>
1132 <span class="fixedFont">Event</span> <b>e</b>
1135 <dd>The event object</dd>
1138 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1141 <dd>The id of the dragged element</dd>
1149 <dl class="detailList">
1150 <dt class="heading">Returns:</dt>
1152 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> isValid True if the drag event is valid, else false to cancel</dd>
1166 <td class="msource">
1174 <tr class="method-row config-row-alt0 expandable notInherited">
1175 <td class="micon"><a class="exi" href="#expand"> </a></td>
1179 <a id="Roo.dd.DragSource-method-beforeInvalidDrop" name=".beforeInvalidDrop"></a>
1180 <div class="fixedFont">
1181 <span class="attributes"></span><b class="itemname">beforeInvalidDrop</b>
1183 (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1189 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1198 <div class="short">An empty function by default, but provided so that you can perform a custom action after an invalid<br/>drop has occurred.</div>
1204 An empty function by default, but provided so that you can perform a custom action after an invalid<br/>drop has occurred.
1211 <dl class="detailList">
1212 <dt class="heading">Parameters:</dt>
1215 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span> <b>target</b>
1218 <dd>The drop target</dd>
1221 <span class="fixedFont">Event</span> <b>e</b>
1224 <dd>The event object</dd>
1227 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1230 <dd>The id of the dragged element</dd>
1238 <dl class="detailList">
1239 <dt class="heading">Returns:</dt>
1241 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> isValid True if the invalid drop should proceed, else false to cancel</dd>
1255 <td class="msource">
1263 <tr class="method-row config-row-alt1 expandable">
1264 <td class="micon"><a class="exi" href="#expand"> </a></td>
1268 <a id="Roo.dd.DD-method-cachePosition" name=".cachePosition"></a>
1269 <div class="fixedFont">
1270 <span class="attributes"></span><b class="itemname">cachePosition</b>
1272 (<B><i>iPageX</i></B>, <B><i>iPageY</i></B>)
1279 <div class="short">Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.</div>
1285 Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand. We need to know this so that we can calculate the<br/>number of pixels the element is offset from its original position.
1292 <dl class="detailList">
1293 <dt class="heading">Parameters:</dt>
1299 <dd>the current x position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
1305 <dd>the current y position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
1323 <td class="msource">
1325 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
1331 <tr class="method-row config-row-alt0 expandable">
1332 <td class="micon"><a class="exi" href="#expand"> </a></td>
1336 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
1337 <div class="fixedFont">
1338 <span class="attributes"></span><b class="itemname">clearConstraints</b>
1347 <div class="short">Clears any constraints applied to this instance.</div>
1353 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
1374 <td class="msource">
1376 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1382 <tr class="method-row config-row-alt1 expandable">
1383 <td class="micon"><a class="exi" href="#expand"> </a></td>
1387 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
1388 <div class="fixedFont">
1389 <span class="attributes"></span><b class="itemname">clearTicks</b>
1398 <div class="short">Clears any tick interval defined for this instance</div>
1404 Clears any tick interval defined for this instance
1425 <td class="msource">
1427 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1433 <tr class="method-row config-row-alt0 expandable">
1434 <td class="micon"><a class="exi" href="#expand"> </a></td>
1438 <a id="Roo.dd.DDProxy-method-createFrame" name=".createFrame"></a>
1439 <div class="fixedFont">
1440 <span class="attributes"></span><b class="itemname">createFrame</b>
1449 <div class="short">Creates the proxy element if it does not yet exist</div>
1455 Creates the proxy element if it does not yet exist
1476 <td class="msource">
1478 <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
1484 <tr class="method-row config-row-alt1 expandable">
1485 <td class="micon"><a class="exi" href="#expand"> </a></td>
1489 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
1490 <div class="fixedFont">
1491 <span class="attributes"></span><b class="itemname">endDrag</b>
1493 (Event <B><i>e</i></B>)
1500 <div class="short">Fired when we are done dragging the object</div>
1506 Fired when we are done dragging the object
1513 <dl class="detailList">
1514 <dt class="heading">Parameters:</dt>
1517 <span class="fixedFont">Event</span> <b>e</b>
1520 <dd>the mouseup event</dd>
1538 <td class="msource">
1540 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1546 <tr class="method-row config-row-alt0 expandable">
1547 <td class="micon"><a class="exi" href="#expand"> </a></td>
1551 <a id="Roo.dd.DragDrop-method-function toString() {
1553 }" name=".function toString() {
1556 <div class="fixedFont">
1557 <span class="attributes"></span><b class="itemname">function toString() {
1576 <div class="short">toString method</div>
1593 <dl class="detailList">
1594 <dt class="heading">Returns:</dt>
1596 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
1610 <td class="msource">
1612 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1618 <tr class="method-row config-row-alt1 expandable notInherited">
1619 <td class="micon"><a class="exi" href="#expand"> </a></td>
1623 <a id="Roo.dd.DragSource-method-getDragData" name=".getDragData"></a>
1624 <div class="fixedFont">
1625 <span class="attributes"></span><b class="itemname">getDragData</b>
1633 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1642 <div class="short">Returns the data object associated with this drag source</div>
1648 Returns the data object associated with this drag source
1659 <dl class="detailList">
1660 <dt class="heading">Returns:</dt>
1662 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> data An object containing arbitrary data</dd>
1676 <td class="msource">
1684 <tr class="method-row config-row-alt0 expandable">
1685 <td class="micon"><a class="exi" href="#expand"> </a></td>
1689 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
1690 <div class="fixedFont">
1691 <span class="attributes"></span><b class="itemname">getDragEl</b>
1699 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1708 <div class="short">Returns a reference to the actual element to drag.</div>
1714 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
1725 <dl class="detailList">
1726 <dt class="heading">Returns:</dt>
1728 <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>
1742 <td class="msource">
1744 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1750 <tr class="method-row config-row-alt1 expandable">
1751 <td class="micon"><a class="exi" href="#expand"> </a></td>
1755 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
1756 <div class="fixedFont">
1757 <span class="attributes"></span><b class="itemname">getEl</b>
1765 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1774 <div class="short">Returns a reference to the linked element</div>
1780 Returns a reference to the linked element
1791 <dl class="detailList">
1792 <dt class="heading">Returns:</dt>
1794 <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>
1808 <td class="msource">
1810 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1816 <tr class="method-row config-row-alt0 expandable notInherited">
1817 <td class="micon"><a class="exi" href="#expand"> </a></td>
1821 <a id="Roo.dd.DragSource-method-getProxy" name=".getProxy"></a>
1822 <div class="fixedFont">
1823 <span class="attributes"></span><b class="itemname">getProxy</b>
1831 <a href="./Roo.dd.StatusProxy.html#constructor" roo:cls="Roo.dd.StatusProxy.html#constructor">Roo.dd.StatusProxy</a>
1840 <div class="short">Returns the drag source's underlying {<b>link</b> Roo.dd.StatusProxy}</div>
1846 Returns the drag source's underlying {<b>link</b> Roo.dd.StatusProxy}
1857 <dl class="detailList">
1858 <dt class="heading">Returns:</dt>
1860 <dd><span class="fixedFont"><a href="./Roo.dd.StatusProxy.html#constructor" roo:cls="Roo.dd.StatusProxy.html#constructor">Roo.dd.StatusProxy</a></span> proxy The StatusProxy</dd>
1874 <td class="msource">
1882 <tr class="method-row config-row-alt1 expandable notInherited">
1883 <td class="micon"><a class="exi" href="#expand"> </a></td>
1887 <a id="Roo.dd.DragSource-method-hideProxy" name=".hideProxy"></a>
1888 <div class="fixedFont">
1889 <span class="attributes"></span><b class="itemname">hideProxy</b>
1898 <div class="short">Hides the drag source's {<b>link</b> Roo.dd.StatusProxy}</div>
1904 Hides the drag source's {<b>link</b> Roo.dd.StatusProxy}
1925 <td class="msource">
1933 <tr class="method-row config-row-alt0 expandable">
1934 <td class="micon"><a class="exi" href="#expand"> </a></td>
1938 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
1939 <div class="fixedFont">
1940 <span class="attributes"></span><b class="itemname">init</b>
1942 (<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>)
1949 <div class="short">Sets up the DragDrop object.</div>
1955 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1962 <dl class="detailList">
1963 <dt class="heading">Parameters:</dt>
1969 <dd>the id of the linked element</dd>
1972 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1975 <dd>the group of related items</dd>
1978 <span class="fixedFont">object</span> <b>config</b>
1981 <dd>configuration attributes</dd>
1999 <td class="msource">
2001 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2007 <tr class="method-row config-row-alt1 expandable">
2008 <td class="micon"><a class="exi" href="#expand"> </a></td>
2012 <a id="Roo.dd.DDProxy-method-initFrame" name=".initFrame"></a>
2013 <div class="fixedFont">
2014 <span class="attributes"></span><b class="itemname">initFrame</b>
2023 <div class="short">Initialization for the drag frame element.</div>
2029 Initialization for the drag frame element. Must be called in the<br/>constructor of all subclasses
2050 <td class="msource">
2052 <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</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-initTarget" name=".initTarget"></a>
2064 <div class="fixedFont">
2065 <span class="attributes"></span><b class="itemname">initTarget</b>
2067 (<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>)
2074 <div class="short">Initializes Targeting functionality only.</div>
2080 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
2087 <dl class="detailList">
2088 <dt class="heading">Parameters:</dt>
2094 <dd>the id of the linked element</dd>
2097 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
2100 <dd>the group of related items</dd>
2103 <span class="fixedFont">object</span> <b>config</b>
2106 <dd>configuration attributes</dd>
2124 <td class="msource">
2126 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2132 <tr class="method-row config-row-alt1 expandable">
2133 <td class="micon"><a class="exi" href="#expand"> </a></td>
2137 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
2138 <div class="fixedFont">
2139 <span class="attributes"></span><b class="itemname">isLocked</b>
2156 <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>
2162 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.)
2173 <dl class="detailList">
2174 <dt class="heading">Returns:</dt>
2176 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
2190 <td class="msource">
2192 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2198 <tr class="method-row config-row-alt0 expandable">
2199 <td class="micon"><a class="exi" href="#expand"> </a></td>
2203 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
2204 <div class="fixedFont">
2205 <span class="attributes"></span><b class="itemname">isTarget</b>
2214 <div class="short">By default, all insances can be a drop target.</div>
2220 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
2241 <td class="msource">
2243 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2249 <tr class="method-row config-row-alt1 expandable">
2250 <td class="micon"><a class="exi" href="#expand"> </a></td>
2254 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
2255 <div class="fixedFont">
2256 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
2258 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
2273 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
2279 Checks the tag exclusion list to see if this click should be ignored
2286 <dl class="detailList">
2287 <dt class="heading">Parameters:</dt>
2290 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2293 <dd>the HTMLElement to evaluate</dd>
2301 <dl class="detailList">
2302 <dt class="heading">Returns:</dt>
2304 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
2318 <td class="msource">
2320 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2326 <tr class="method-row config-row-alt0 expandable">
2327 <td class="micon"><a class="exi" href="#expand"> </a></td>
2331 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
2332 <div class="fixedFont">
2333 <span class="attributes"></span><b class="itemname">lock</b>
2342 <div class="short">Lock this instance</div>
2369 <td class="msource">
2371 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2377 <tr class="method-row config-row-alt1 expandable">
2378 <td class="micon"><a class="exi" href="#expand"> </a></td>
2382 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
2383 <div class="fixedFont">
2384 <span class="attributes"></span><b class="itemname">onAvailable</b>
2393 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
2399 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
2420 <td class="msource">
2422 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2428 <tr class="method-row config-row-alt0 expandable notInherited">
2429 <td class="micon"><a class="exi" href="#expand"> </a></td>
2433 <a id="Roo.dd.DragSource-method-onBeforeDrag" name=".onBeforeDrag"></a>
2434 <div class="fixedFont">
2435 <span class="attributes"></span><b class="itemname">onBeforeDrag</b>
2437 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>, Event <B><i>e</i></B>)
2443 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2452 <div class="short">An empty function by default, but provided so that you can perform a custom action before the initial<br/>drag event begins and optionally cancel it.</div>
2458 An empty function by default, but provided so that you can perform a custom action before the initial<br/>drag event begins and optionally cancel it.
2465 <dl class="detailList">
2466 <dt class="heading">Parameters:</dt>
2469 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
2472 <dd>An object containing arbitrary data to be shared with drop targets</dd>
2475 <span class="fixedFont">Event</span> <b>e</b>
2478 <dd>The event object</dd>
2486 <dl class="detailList">
2487 <dt class="heading">Returns:</dt>
2489 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> isValid True if the drag event is valid, else false to cancel</dd>
2503 <td class="msource">
2511 <tr class="method-row config-row-alt1 expandable">
2512 <td class="micon"><a class="exi" href="#expand"> </a></td>
2516 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
2517 <div class="fixedFont">
2518 <span class="attributes"></span><b class="itemname">onDrag</b>
2520 (Event <B><i>e</i></B>)
2527 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
2533 Abstract method called during the onMouseMove event while dragging an<br/>object.
2540 <dl class="detailList">
2541 <dt class="heading">Parameters:</dt>
2544 <span class="fixedFont">Event</span> <b>e</b>
2547 <dd>the mousemove event</dd>
2565 <td class="msource">
2567 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2573 <tr class="method-row config-row-alt0 expandable">
2574 <td class="micon"><a class="exi" href="#expand"> </a></td>
2578 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
2579 <div class="fixedFont">
2580 <span class="attributes"></span><b class="itemname">onDragDrop</b>
2582 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2589 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
2595 Abstract method called when this item is dropped on another DragDrop<br/>obj
2602 <dl class="detailList">
2603 <dt class="heading">Parameters:</dt>
2606 <span class="fixedFont">Event</span> <b>e</b>
2609 <dd>the mouseup event</dd>
2612 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2615 <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>
2633 <td class="msource">
2635 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2641 <tr class="method-row config-row-alt1 expandable">
2642 <td class="micon"><a class="exi" href="#expand"> </a></td>
2646 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
2647 <div class="fixedFont">
2648 <span class="attributes"></span><b class="itemname">onDragEnter</b>
2650 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2657 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
2663 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
2670 <dl class="detailList">
2671 <dt class="heading">Parameters:</dt>
2674 <span class="fixedFont">Event</span> <b>e</b>
2677 <dd>the mousemove event</dd>
2680 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2683 <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>
2701 <td class="msource">
2703 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2709 <tr class="method-row config-row-alt0 expandable">
2710 <td class="micon"><a class="exi" href="#expand"> </a></td>
2714 <a id="Roo.dd.DragDrop-method-onDragOut" name=".onDragOut"></a>
2715 <div class="fixedFont">
2716 <span class="attributes"></span><b class="itemname">onDragOut</b>
2718 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2725 <div class="short">Abstract method called when we are no longer hovering over an element</div>
2731 Abstract method called when we are no longer hovering over an element
2738 <dl class="detailList">
2739 <dt class="heading">Parameters:</dt>
2742 <span class="fixedFont">Event</span> <b>e</b>
2745 <dd>the mousemove event</dd>
2748 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2751 <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>
2769 <td class="msource">
2771 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2777 <tr class="method-row config-row-alt1 expandable">
2778 <td class="micon"><a class="exi" href="#expand"> </a></td>
2782 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
2783 <div class="fixedFont">
2784 <span class="attributes"></span><b class="itemname">onDragOver</b>
2786 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2793 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2799 Abstract method called when this element is hovering over another<br/>DragDrop obj
2806 <dl class="detailList">
2807 <dt class="heading">Parameters:</dt>
2810 <span class="fixedFont">Event</span> <b>e</b>
2813 <dd>the mousemove event</dd>
2816 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2819 <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>
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-onInvalidDrop" name=".onInvalidDrop"></a>
2851 <div class="fixedFont">
2852 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2854 (Event <B><i>e</i></B>)
2861 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2867 Abstract method called when this item is dropped on an area with no<br/>drop target
2874 <dl class="detailList">
2875 <dt class="heading">Parameters:</dt>
2878 <span class="fixedFont">Event</span> <b>e</b>
2881 <dd>the mouseup event</dd>
2899 <td class="msource">
2901 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2907 <tr class="method-row config-row-alt1 expandable">
2908 <td class="micon"><a class="exi" href="#expand"> </a></td>
2912 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
2913 <div class="fixedFont">
2914 <span class="attributes"></span><b class="itemname">onMouseDown</b>
2916 (Event <B><i>e</i></B>)
2923 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2929 Event handler that fires when a drag/drop obj gets a mousedown
2936 <dl class="detailList">
2937 <dt class="heading">Parameters:</dt>
2940 <span class="fixedFont">Event</span> <b>e</b>
2943 <dd>the mousedown event</dd>
2961 <td class="msource">
2963 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2969 <tr class="method-row config-row-alt0 expandable">
2970 <td class="micon"><a class="exi" href="#expand"> </a></td>
2974 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
2975 <div class="fixedFont">
2976 <span class="attributes"></span><b class="itemname">onMouseUp</b>
2978 (Event <B><i>e</i></B>)
2985 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2991 Event handler that fires when a drag/drop obj gets a mouseup
2998 <dl class="detailList">
2999 <dt class="heading">Parameters:</dt>
3002 <span class="fixedFont">Event</span> <b>e</b>
3005 <dd>the mouseup event</dd>
3023 <td class="msource">
3025 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3031 <tr class="method-row config-row-alt1 expandable notInherited">
3032 <td class="micon"><a class="exi" href="#expand"> </a></td>
3036 <a id="Roo.dd.DragSource-method-onStartDrag" name=".onStartDrag"></a>
3037 <div class="fixedFont">
3038 <span class="attributes"></span><b class="itemname">onStartDrag</b>
3040 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
3047 <div class="short">An empty function by default, but provided so that you can perform a custom action once the initial<br/>drag event has begun.</div>
3053 An empty function by default, but provided so that you can perform a custom action once the initial<br/>drag event has begun. The drag cannot be canceled from this function.
3060 <dl class="detailList">
3061 <dt class="heading">Parameters:</dt>
3064 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
3067 <dd>The x position of the click on the dragged object</dd>
3070 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
3073 <dd>The y position of the click on the dragged object</dd>
3091 <td class="msource">
3099 <tr class="method-row config-row-alt0 expandable">
3100 <td class="micon"><a class="exi" href="#expand"> </a></td>
3104 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
3105 <div class="fixedFont">
3106 <span class="attributes"></span><b class="itemname">padding</b>
3115 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
3121 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
3142 <td class="msource">
3144 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3150 <tr class="method-row config-row-alt1 expandable">
3151 <td class="micon"><a class="exi" href="#expand"> </a></td>
3155 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
3156 <div class="fixedFont">
3157 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
3159 (string <B><i>sGroup</i></B>)
3166 <div class="short">Remove's this instance from the supplied interaction group</div>
3172 Remove's this instance from the supplied interaction group
3179 <dl class="detailList">
3180 <dt class="heading">Parameters:</dt>
3183 <span class="fixedFont">string</span> <b>sGroup</b>
3186 <dd>The group to drop</dd>
3204 <td class="msource">
3206 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3212 <tr class="method-row config-row-alt0 expandable">
3213 <td class="micon"><a class="exi" href="#expand"> </a></td>
3217 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
3218 <div class="fixedFont">
3219 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
3221 (string <B><i>cssClass</i></B>)
3228 <div class="short">Unsets an invalid css class</div>
3234 Unsets an invalid css class
3241 <dl class="detailList">
3242 <dt class="heading">Parameters:</dt>
3245 <span class="fixedFont">string</span> <b>cssClass</b>
3248 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
3266 <td class="msource">
3268 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3274 <tr class="method-row config-row-alt1 expandable">
3275 <td class="micon"><a class="exi" href="#expand"> </a></td>
3279 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
3280 <div class="fixedFont">
3281 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
3283 (string <B><i>id</i></B>)
3290 <div class="short">Unsets an invalid handle id</div>
3296 Unsets an invalid handle id
3303 <dl class="detailList">
3304 <dt class="heading">Parameters:</dt>
3307 <span class="fixedFont">string</span> <b>id</b>
3310 <dd>the id of the element to re-enable</dd>
3328 <td class="msource">
3330 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3336 <tr class="method-row config-row-alt0 expandable">
3337 <td class="micon"><a class="exi" href="#expand"> </a></td>
3341 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
3342 <div class="fixedFont">
3343 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
3345 (string <B><i>tagName</i></B>)
3352 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
3358 Unsets an excluded tag name set by addInvalidHandleType
3365 <dl class="detailList">
3366 <dt class="heading">Parameters:</dt>
3369 <span class="fixedFont">string</span> <b>tagName</b>
3372 <dd>the type of element to unexclude</dd>
3390 <td class="msource">
3392 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3398 <tr class="method-row config-row-alt1 expandable">
3399 <td class="micon"><a class="exi" href="#expand"> </a></td>
3403 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
3404 <div class="fixedFont">
3405 <span class="attributes"></span><b class="itemname">resetConstraints</b>
3407 (boolean <B><i>maintainOffset</i></B>)
3414 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
3420 resetConstraints must be called if you manually reposition a dd element.
3427 <dl class="detailList">
3428 <dt class="heading">Parameters:</dt>
3431 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
3452 <td class="msource">
3454 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3460 <tr class="method-row config-row-alt0 expandable">
3461 <td class="micon"><a class="exi" href="#expand"> </a></td>
3465 <a id="Roo.dd.DD-method-setDelta" name=".setDelta"></a>
3466 <div class="fixedFont">
3467 <span class="attributes"></span><b class="itemname">setDelta</b>
3469 (int <B><i>iDeltaX</i></B>, int <B><i>iDeltaY</i></B>)
3476 <div class="short">Sets the pointer offset.</div>
3482 Sets the pointer offset. You can call this directly to force the<br/>offset to be in a particular location (e.g., pass in 0,0 to set it<br/>to the center of the object)
3489 <dl class="detailList">
3490 <dt class="heading">Parameters:</dt>
3493 <span class="fixedFont">int</span> <b>iDeltaX</b>
3496 <dd>the distance from the left</dd>
3499 <span class="fixedFont">int</span> <b>iDeltaY</b>
3502 <dd>the distance from the top</dd>
3520 <td class="msource">
3522 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
3528 <tr class="method-row config-row-alt1 expandable">
3529 <td class="micon"><a class="exi" href="#expand"> </a></td>
3533 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
3534 <div class="fixedFont">
3535 <span class="attributes"></span><b class="itemname">setDragElId</b>
3544 <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>
3550 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
3557 <dl class="detailList">
3558 <dt class="heading">Parameters:</dt>
3564 <dd>{string} the id of the element that will be used to initiate the drag</dd>
3582 <td class="msource">
3584 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3590 <tr class="method-row config-row-alt0 expandable">
3591 <td class="micon"><a class="exi" href="#expand"> </a></td>
3595 <a id="Roo.dd.DD-method-setDragElPos" name=".setDragElPos"></a>
3596 <div class="fixedFont">
3597 <span class="attributes"></span><b class="itemname">setDragElPos</b>
3599 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
3606 <div class="short">Sets the drag element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.</div>
3612 Sets the drag element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked. Override this if you want to place the element in a<br/>location other than where the cursor is.
3619 <dl class="detailList">
3620 <dt class="heading">Parameters:</dt>
3623 <span class="fixedFont">int</span> <b>iPageX</b>
3626 <dd>the X coordinate of the mousedown or drag event</dd>
3629 <span class="fixedFont">int</span> <b>iPageY</b>
3632 <dd>the Y coordinate of the mousedown or drag event</dd>
3650 <td class="msource">
3652 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
3658 <tr class="method-row config-row-alt1 expandable">
3659 <td class="micon"><a class="exi" href="#expand"> </a></td>
3663 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
3664 <div class="fixedFont">
3665 <span class="attributes"></span><b class="itemname">setHandleElId</b>
3674 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
3680 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.
3687 <dl class="detailList">
3688 <dt class="heading">Parameters:</dt>
3694 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
3712 <td class="msource">
3714 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3720 <tr class="method-row config-row-alt0 expandable">
3721 <td class="micon"><a class="exi" href="#expand"> </a></td>
3725 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
3726 <div class="fixedFont">
3727 <span class="attributes"></span><b class="itemname">setInitPosition</b>
3729 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
3736 <div class="short">Stores the initial placement of the linked element.</div>
3742 Stores the initial placement of the linked element.
3749 <dl class="detailList">
3750 <dt class="heading">Parameters:</dt>
3753 <span class="fixedFont">int</span> <b>diffX</b>
3756 <dd>the X offset, default 0</dd>
3759 <span class="fixedFont">int</span> <b>diffY</b>
3762 <dd>the Y offset, default 0</dd>
3780 <td class="msource">
3782 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3788 <tr class="method-row config-row-alt1 expandable">
3789 <td class="micon"><a class="exi" href="#expand"> </a></td>
3793 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
3794 <div class="fixedFont">
3795 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
3804 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3810 Allows you to set an element outside of the linked element as a drag<br/>handle
3817 <dl class="detailList">
3818 <dt class="heading">Parameters:</dt>
3824 <dd>the id of the element that will be used to initiate the drag</dd>
3842 <td class="msource">
3844 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3850 <tr class="method-row config-row-alt0 expandable">
3851 <td class="micon"><a class="exi" href="#expand"> </a></td>
3855 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
3856 <div class="fixedFont">
3857 <span class="attributes"></span><b class="itemname">setPadding</b>
3859 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3866 <div class="short">Configures the padding for the target zone in px.</div>
3872 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.
3879 <dl class="detailList">
3880 <dt class="heading">Parameters:</dt>
3883 <span class="fixedFont">int</span> <b>iTop</b>
3889 <span class="fixedFont">int</span> <b>iRight</b>
3895 <span class="fixedFont">int</span> <b>iBot</b>
3901 <span class="fixedFont">int</span> <b>iLeft</b>
3922 <td class="msource">
3924 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3930 <tr class="method-row config-row-alt1 expandable">
3931 <td class="micon"><a class="exi" href="#expand"> </a></td>
3935 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
3936 <div class="fixedFont">
3937 <span class="attributes"></span><b class="itemname">setXConstraint</b>
3939 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3946 <div class="short">By default, the element can be dragged any place on the screen.</div>
3952 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.
3959 <dl class="detailList">
3960 <dt class="heading">Parameters:</dt>
3963 <span class="fixedFont">int</span> <b>iLeft</b>
3966 <dd>the number of pixels the element can move to the left</dd>
3969 <span class="fixedFont">int</span> <b>iRight</b>
3972 <dd>the number of pixels the element can move to the<br/>right</dd>
3975 <span class="fixedFont">int</span> <b>iTickSize</b>
3978 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3996 <td class="msource">
3998 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4004 <tr class="method-row config-row-alt0 expandable">
4005 <td class="micon"><a class="exi" href="#expand"> </a></td>
4009 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
4010 <div class="fixedFont">
4011 <span class="attributes"></span><b class="itemname">setYConstraint</b>
4013 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
4020 <div class="short">By default, the element can be dragged any place on the screen.</div>
4026 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.
4033 <dl class="detailList">
4034 <dt class="heading">Parameters:</dt>
4037 <span class="fixedFont">int</span> <b>iUp</b>
4040 <dd>the number of pixels the element can move up</dd>
4043 <span class="fixedFont">int</span> <b>iDown</b>
4046 <dd>the number of pixels the element can move down</dd>
4049 <span class="fixedFont">int</span> <b>iTickSize</b>
4052 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
4070 <td class="msource">
4072 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4078 <tr class="method-row config-row-alt1 expandable">
4079 <td class="micon"><a class="exi" href="#expand"> </a></td>
4083 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
4084 <div class="fixedFont">
4085 <span class="attributes"></span><b class="itemname">startDrag</b>
4087 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
4094 <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>
4100 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
4107 <dl class="detailList">
4108 <dt class="heading">Parameters:</dt>
4111 <span class="fixedFont">int</span> <b>X</b>
4114 <dd>click location</dd>
4117 <span class="fixedFont">int</span> <b>Y</b>
4120 <dd>click location</dd>
4138 <td class="msource">
4140 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4146 <tr class="method-row config-row-alt0 expandable">
4147 <td class="micon"><a class="exi" href="#expand"> </a></td>
4151 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
4152 <div class="fixedFont">
4153 <span class="attributes"></span><b class="itemname">unlock</b>
4162 <div class="short">Unlock this instace</div>
4189 <td class="msource">
4191 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4197 <tr class="method-row config-row-alt1 expandable">
4198 <td class="micon"><a class="exi" href="#expand"> </a></td>
4202 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
4203 <div class="fixedFont">
4204 <span class="attributes"></span><b class="itemname">unreg</b>
4213 <div class="short">Remove all drag and drop hooks for this element</div>
4219 Remove all drag and drop hooks for this element
4240 <td class="msource">
4242 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4251 <!-- ============================== events summary / details ======================== -->
4254 <a id="Roo.dd.DragSource-events"></a>
4260 <table cellspacing="0" class="member-table">
4261 <caption class="Empty">Events - Has None</caption>
4272 <!-- ============================== footer ================================= -->
4273 <div class="fineprint" style="clear:both">
4275 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Nov 05 2010 11:53:04 GMT+0800 (HKT)
4277 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>