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.DD</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.DD-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.DD-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.DD-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.DD-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.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</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.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DD
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_dd_DD.js.html">Roo/dd/DD.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">DD</td></tr>
73 <tr><td class="label">Subclasses:</td><td class="hd-info">
74 <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>, <a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a>, <a href="./Roo.dd.DragZone.html#constructor" roo:cls="Roo.dd.DragZone.html#constructor">Roo.dd.DragZone</a>
82 <tr><td class="label">Extends:</td><td class="hd-info">
83 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
91 <!-- ============================== class summary ========================== -->
92 <div class="description">
93 A DragDrop implementation where the linked element follows the<br/>mouse cursor during a drag.
97 <!-- ============================== Class comment block... ========================== -->
99 <div class="comments">
100 <b>Class Comments / Notes</B> =>
101 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DD';">[Add Your comment/notes about this class]</u>
103 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
104 src="/blog.php/GtkDjsComments/Roo.dd.DD.html"></iframe>
109 <!-- ============================== config options ========================== -->
114 <div class="hr"></div>
115 <a id="Roo.dd.DD-configs"></a>
121 <table cellspacing="0" class="member-table">
122 <caption>Config Options (Usually are also Properties)</caption>
126 <th class="sig-header" colspan="2">Options</th>
128 <th class="msource-header">Defined By</th>
135 <tr class="config-row expandable config-row-alt0">
136 <td class="micon"><a class="exi" href="#expand"> </a></td>
139 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
140 <div class="fixedFont">
141 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
147 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
152 list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre>
162 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
178 <!-- ============================== public properties ==================== -->
182 <a id="Roo.dd.DD-props"></a>
188 <table cellspacing="0" class="member-table">
189 <caption class="Empty">Public Properties - Has None</caption>
195 <!-- ============================== methods summary / details ======================== -->
198 <a id="Roo.dd.DD-methods"></a>
199 <!-- constructor?? -->
206 <!-- then dynamics first -->
213 <table cellspacing="0" class="member-table">
214 <caption>Public Methods</caption>
216 <th class="sig-header" colspan="2">Method</th>
217 <th class="msource-header">Defined By</th>
227 <tr class="method-row config-row-alt0 expandable notInherited">
228 <td class="micon"><a class="exi" href="#expand"> </a></td>
232 <a id="Roo.dd-method-DD" name=".DD"></a>
233 <div class="fixedFont">
234 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DD</b>
236 (<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>)
244 <div class="short">Create a new Roo.dd.DD</div>
251 Create a new Roo.dd.DD
254 <dl class="detailList">
255 <dt class="heading">Parameters:</dt>
258 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
261 <dd>the id of the linked element</dd>
264 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
267 <dd>the group of related DragDrop items</dd>
270 <span class="fixedFont">object</span> <b>config</b>
273 <dd>an object containing configurable attributes<br/> Valid properties for DD:<br/> scroll</dd>
297 <tr class="method-row config-row-alt1 expandable">
298 <td class="micon"><a class="exi" href="#expand"> </a></td>
302 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
303 <div class="fixedFont">
304 <span class="attributes"></span><b class="itemname">addEvents</b>
306 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
313 <div class="short">Used to define events on this Observable</div>
319 Used to define events on this Observable
326 <dl class="detailList">
327 <dt class="heading">Parameters:</dt>
330 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
333 <dd>The object with the events defined</dd>
353 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
359 <tr class="method-row config-row-alt0 expandable">
360 <td class="micon"><a class="exi" href="#expand"> </a></td>
364 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
365 <div class="fixedFont">
366 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
368 (string <B><i>cssClass</i></B>)
375 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
381 Lets you specify a css class of elements that will not initiate a drag
388 <dl class="detailList">
389 <dt class="heading">Parameters:</dt>
392 <span class="fixedFont">string</span> <b>cssClass</b>
395 <dd>the class of the elements you wish to ignore</dd>
415 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
421 <tr class="method-row config-row-alt1 expandable">
422 <td class="micon"><a class="exi" href="#expand"> </a></td>
426 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
427 <div class="fixedFont">
428 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
430 (string <B><i>id</i></B>)
437 <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>
443 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
450 <dl class="detailList">
451 <dt class="heading">Parameters:</dt>
454 <span class="fixedFont">string</span> <b>id</b>
457 <dd>the element id of the element you wish to ignore</dd>
477 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
483 <tr class="method-row config-row-alt0 expandable">
484 <td class="micon"><a class="exi" href="#expand"> </a></td>
488 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
489 <div class="fixedFont">
490 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
492 (string <B><i>tagName</i></B>)
499 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
505 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.
512 <dl class="detailList">
513 <dt class="heading">Parameters:</dt>
516 <span class="fixedFont">string</span> <b>tagName</b>
519 <dd>the type of element to exclude</dd>
539 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
545 <tr class="method-row config-row-alt1 expandable">
546 <td class="micon"><a class="exi" href="#expand"> </a></td>
550 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
551 <div class="fixedFont">
552 <span class="attributes"></span><b class="itemname">addListener</b>
554 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
561 <div class="short">Appends an event handler to this component</div>
567 Appends an event handler to this component
574 <dl class="detailList">
575 <dt class="heading">Parameters:</dt>
578 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
581 <dd>The type of event to listen for</dd>
584 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
587 <dd>The method the event invokes</dd>
590 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
593 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
596 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
599 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
619 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
625 <tr class="method-row config-row-alt0 expandable">
626 <td class="micon"><a class="exi" href="#expand"> </a></td>
630 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
631 <div class="fixedFont">
632 <span class="attributes"></span><b class="itemname">addToGroup</b>
634 (<B><i>sGroup</i></B>)
641 <div class="short">Add this instance to a group of related drag/drop objects.</div>
647 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.
654 <dl class="detailList">
655 <dt class="heading">Parameters:</dt>
661 <dd>{string} the name of the group</dd>
681 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
687 <tr class="method-row config-row-alt1 expandable notInherited">
688 <td class="micon"><a class="exi" href="#expand"> </a></td>
692 <a id="Roo.dd.DD-method-alignElWithMouse" name=".alignElWithMouse"></a>
693 <div class="fixedFont">
694 <span class="attributes"></span><b class="itemname">alignElWithMouse</b>
696 (<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>)
703 <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>
709 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.
716 <dl class="detailList">
717 <dt class="heading">Parameters:</dt>
720 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>el</b>
723 <dd>the element to move</dd>
726 <span class="fixedFont">int</span> <b>iPageX</b>
729 <dd>the X coordinate of the mousedown or drag event</dd>
732 <span class="fixedFont">int</span> <b>iPageY</b>
735 <dd>the Y coordinate of the mousedown or drag event</dd>
761 <tr class="method-row config-row-alt0 expandable">
762 <td class="micon"><a class="exi" href="#expand"> </a></td>
766 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
767 <div class="fixedFont">
768 <span class="attributes"></span><b class="itemname">applyConfig</b>
777 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
783 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.
806 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
812 <tr class="method-row config-row-alt1 expandable notInherited">
813 <td class="micon"><a class="exi" href="#expand"> </a></td>
817 <a id="Roo.dd.DD-method-autoOffset" name=".autoOffset"></a>
818 <div class="fixedFont">
819 <span class="attributes"></span><b class="itemname">autoOffset</b>
821 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
828 <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>
834 Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked
841 <dl class="detailList">
842 <dt class="heading">Parameters:</dt>
845 <span class="fixedFont">int</span> <b>iPageX</b>
848 <dd>the X coordinate of the click</dd>
851 <span class="fixedFont">int</span> <b>iPageY</b>
854 <dd>the Y coordinate of the click</dd>
880 <tr class="method-row config-row-alt0 expandable notInherited">
881 <td class="micon"><a class="exi" href="#expand"> </a></td>
885 <a id="Roo.dd.DD-method-cachePosition" name=".cachePosition"></a>
886 <div class="fixedFont">
887 <span class="attributes"></span><b class="itemname">cachePosition</b>
889 (<B><i>iPageX</i></B>, <B><i>iPageY</i></B>)
896 <div class="short">Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.</div>
902 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.
909 <dl class="detailList">
910 <dt class="heading">Parameters:</dt>
916 <dd>the current x position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
922 <dd>the current y position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
948 <tr class="method-row config-row-alt1 expandable">
949 <td class="micon"><a class="exi" href="#expand"> </a></td>
953 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
954 <div class="fixedFont">
955 <span class="attributes"></span><b class="itemname">clearConstraints</b>
964 <div class="short">Clears any constraints applied to this instance.</div>
970 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
993 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
999 <tr class="method-row config-row-alt0 expandable">
1000 <td class="micon"><a class="exi" href="#expand"> </a></td>
1004 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
1005 <div class="fixedFont">
1006 <span class="attributes"></span><b class="itemname">clearTicks</b>
1015 <div class="short">Clears any tick interval defined for this instance</div>
1021 Clears any tick interval defined for this instance
1042 <td class="msource">
1044 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1050 <tr class="method-row config-row-alt1 expandable">
1051 <td class="micon"><a class="exi" href="#expand"> </a></td>
1055 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
1056 <div class="fixedFont">
1057 <span class="attributes"></span><b class="itemname">endDrag</b>
1059 (Event <B><i>e</i></B>)
1066 <div class="short">Fired when we are done dragging the object</div>
1072 Fired when we are done dragging the object
1079 <dl class="detailList">
1080 <dt class="heading">Parameters:</dt>
1083 <span class="fixedFont">Event</span> <b>e</b>
1086 <dd>the mouseup event</dd>
1104 <td class="msource">
1106 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1112 <tr class="method-row config-row-alt0 expandable">
1113 <td class="micon"><a class="exi" href="#expand"> </a></td>
1117 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1118 <div class="fixedFont">
1119 <span class="attributes"></span><b class="itemname">fireEvent</b>
1121 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
1127 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1136 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1142 Fires the specified event with the passed parameters (minus the event name).
1149 <dl class="detailList">
1150 <dt class="heading">Parameters:</dt>
1153 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1159 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
1162 <dd>Variable number of parameters are passed to handlers</dd>
1170 <dl class="detailList">
1171 <dt class="heading">Returns:</dt>
1173 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
1187 <td class="msource">
1189 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1195 <tr class="method-row config-row-alt1 expandable">
1196 <td class="micon"><a class="exi" href="#expand"> </a></td>
1200 <a id="Roo.dd.DragDrop-method-function toString() {
1202 }" name=".function toString() {
1205 <div class="fixedFont">
1206 <span class="attributes"></span><b class="itemname">function toString() {
1225 <div class="short">toString method</div>
1242 <dl class="detailList">
1243 <dt class="heading">Returns:</dt>
1245 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
1259 <td class="msource">
1261 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1267 <tr class="method-row config-row-alt0 expandable">
1268 <td class="micon"><a class="exi" href="#expand"> </a></td>
1272 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
1273 <div class="fixedFont">
1274 <span class="attributes"></span><b class="itemname">getDragEl</b>
1282 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1291 <div class="short">Returns a reference to the actual element to drag.</div>
1297 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
1308 <dl class="detailList">
1309 <dt class="heading">Returns:</dt>
1311 <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>
1325 <td class="msource">
1327 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1333 <tr class="method-row config-row-alt1 expandable">
1334 <td class="micon"><a class="exi" href="#expand"> </a></td>
1338 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
1339 <div class="fixedFont">
1340 <span class="attributes"></span><b class="itemname">getEl</b>
1348 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1357 <div class="short">Returns a reference to the linked element</div>
1363 Returns a reference to the linked element
1374 <dl class="detailList">
1375 <dt class="heading">Returns:</dt>
1377 <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>
1391 <td class="msource">
1393 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1399 <tr class="method-row config-row-alt0 expandable">
1400 <td class="micon"><a class="exi" href="#expand"> </a></td>
1404 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1405 <div class="fixedFont">
1406 <span class="attributes"></span><b class="itemname">hasListener</b>
1408 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1414 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1423 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1429 Checks to see if this object has any listeners for a specified event
1436 <dl class="detailList">
1437 <dt class="heading">Parameters:</dt>
1440 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1443 <dd>The name of the event to check for</dd>
1451 <dl class="detailList">
1452 <dt class="heading">Returns:</dt>
1454 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1468 <td class="msource">
1470 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1476 <tr class="method-row config-row-alt1 expandable">
1477 <td class="micon"><a class="exi" href="#expand"> </a></td>
1481 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
1482 <div class="fixedFont">
1483 <span class="attributes"></span><b class="itemname">init</b>
1485 (<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>)
1492 <div class="short">Sets up the DragDrop object.</div>
1498 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1505 <dl class="detailList">
1506 <dt class="heading">Parameters:</dt>
1512 <dd>the id of the linked element</dd>
1515 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1518 <dd>the group of related items</dd>
1521 <span class="fixedFont">object</span> <b>config</b>
1524 <dd>configuration attributes</dd>
1542 <td class="msource">
1544 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1550 <tr class="method-row config-row-alt0 expandable">
1551 <td class="micon"><a class="exi" href="#expand"> </a></td>
1555 <a id="Roo.dd.DragDrop-method-initTarget" name=".initTarget"></a>
1556 <div class="fixedFont">
1557 <span class="attributes"></span><b class="itemname">initTarget</b>
1559 (<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>)
1566 <div class="short">Initializes Targeting functionality only.</div>
1572 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1579 <dl class="detailList">
1580 <dt class="heading">Parameters:</dt>
1586 <dd>the id of the linked element</dd>
1589 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1592 <dd>the group of related items</dd>
1595 <span class="fixedFont">object</span> <b>config</b>
1598 <dd>configuration attributes</dd>
1616 <td class="msource">
1618 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1624 <tr class="method-row config-row-alt1 expandable">
1625 <td class="micon"><a class="exi" href="#expand"> </a></td>
1629 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
1630 <div class="fixedFont">
1631 <span class="attributes"></span><b class="itemname">isLocked</b>
1648 <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>
1654 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.)
1665 <dl class="detailList">
1666 <dt class="heading">Returns:</dt>
1668 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
1682 <td class="msource">
1684 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1690 <tr class="method-row config-row-alt0 expandable">
1691 <td class="micon"><a class="exi" href="#expand"> </a></td>
1695 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
1696 <div class="fixedFont">
1697 <span class="attributes"></span><b class="itemname">isTarget</b>
1706 <div class="short">By default, all insances can be a drop target.</div>
1712 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
1733 <td class="msource">
1735 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1741 <tr class="method-row config-row-alt1 expandable">
1742 <td class="micon"><a class="exi" href="#expand"> </a></td>
1746 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
1747 <div class="fixedFont">
1748 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1750 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1765 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1771 Checks the tag exclusion list to see if this click should be ignored
1778 <dl class="detailList">
1779 <dt class="heading">Parameters:</dt>
1782 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1785 <dd>the HTMLElement to evaluate</dd>
1793 <dl class="detailList">
1794 <dt class="heading">Returns:</dt>
1796 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
1810 <td class="msource">
1812 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1818 <tr class="method-row config-row-alt0 expandable">
1819 <td class="micon"><a class="exi" href="#expand"> </a></td>
1823 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
1824 <div class="fixedFont">
1825 <span class="attributes"></span><b class="itemname">lock</b>
1834 <div class="short">Lock this instance</div>
1861 <td class="msource">
1863 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1869 <tr class="method-row config-row-alt1 expandable">
1870 <td class="micon"><a class="exi" href="#expand"> </a></td>
1874 <a id="Roo.util.Observable-method-on" name=".on"></a>
1875 <div class="fixedFont">
1876 <span class="attributes"></span><b class="itemname">on</b>
1878 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1885 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1891 Appends an event handler to this element (shorthand for addListener)
1898 <dl class="detailList">
1899 <dt class="heading">Parameters:</dt>
1902 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1905 <dd>The type of event to listen for</dd>
1908 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1911 <dd>The method the event invokes</dd>
1914 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1917 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1920 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1941 <td class="msource">
1943 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1949 <tr class="method-row config-row-alt0 expandable">
1950 <td class="micon"><a class="exi" href="#expand"> </a></td>
1954 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
1955 <div class="fixedFont">
1956 <span class="attributes"></span><b class="itemname">onAvailable</b>
1965 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
1971 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
1992 <td class="msource">
1994 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2000 <tr class="method-row config-row-alt1 expandable">
2001 <td class="micon"><a class="exi" href="#expand"> </a></td>
2005 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
2006 <div class="fixedFont">
2007 <span class="attributes"></span><b class="itemname">onDrag</b>
2009 (Event <B><i>e</i></B>)
2016 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
2022 Abstract method called during the onMouseMove event while dragging an<br/>object.
2029 <dl class="detailList">
2030 <dt class="heading">Parameters:</dt>
2033 <span class="fixedFont">Event</span> <b>e</b>
2036 <dd>the mousemove event</dd>
2054 <td class="msource">
2056 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2062 <tr class="method-row config-row-alt0 expandable">
2063 <td class="micon"><a class="exi" href="#expand"> </a></td>
2067 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
2068 <div class="fixedFont">
2069 <span class="attributes"></span><b class="itemname">onDragDrop</b>
2071 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2078 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
2084 Abstract method called when this item is dropped on another DragDrop<br/>obj
2091 <dl class="detailList">
2092 <dt class="heading">Parameters:</dt>
2095 <span class="fixedFont">Event</span> <b>e</b>
2098 <dd>the mouseup event</dd>
2101 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2104 <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>
2122 <td class="msource">
2124 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2130 <tr class="method-row config-row-alt1 expandable">
2131 <td class="micon"><a class="exi" href="#expand"> </a></td>
2135 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
2136 <div class="fixedFont">
2137 <span class="attributes"></span><b class="itemname">onDragEnter</b>
2139 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2146 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
2152 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
2159 <dl class="detailList">
2160 <dt class="heading">Parameters:</dt>
2163 <span class="fixedFont">Event</span> <b>e</b>
2166 <dd>the mousemove event</dd>
2169 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2172 <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>
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-onDragOut" name=".onDragOut"></a>
2204 <div class="fixedFont">
2205 <span class="attributes"></span><b class="itemname">onDragOut</b>
2207 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2214 <div class="short">Abstract method called when we are no longer hovering over an element</div>
2220 Abstract method called when we are no longer hovering over an element
2227 <dl class="detailList">
2228 <dt class="heading">Parameters:</dt>
2231 <span class="fixedFont">Event</span> <b>e</b>
2234 <dd>the mousemove event</dd>
2237 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2240 <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>
2258 <td class="msource">
2260 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2266 <tr class="method-row config-row-alt1 expandable">
2267 <td class="micon"><a class="exi" href="#expand"> </a></td>
2271 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
2272 <div class="fixedFont">
2273 <span class="attributes"></span><b class="itemname">onDragOver</b>
2275 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2282 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2288 Abstract method called when this element is hovering over another<br/>DragDrop obj
2295 <dl class="detailList">
2296 <dt class="heading">Parameters:</dt>
2299 <span class="fixedFont">Event</span> <b>e</b>
2302 <dd>the mousemove event</dd>
2305 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2308 <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>
2326 <td class="msource">
2328 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2334 <tr class="method-row config-row-alt0 expandable">
2335 <td class="micon"><a class="exi" href="#expand"> </a></td>
2339 <a id="Roo.dd.DragDrop-method-onInvalidDrop" name=".onInvalidDrop"></a>
2340 <div class="fixedFont">
2341 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2343 (Event <B><i>e</i></B>)
2350 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2356 Abstract method called when this item is dropped on an area with no<br/>drop target
2363 <dl class="detailList">
2364 <dt class="heading">Parameters:</dt>
2367 <span class="fixedFont">Event</span> <b>e</b>
2370 <dd>the mouseup event</dd>
2388 <td class="msource">
2390 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2396 <tr class="method-row config-row-alt1 expandable">
2397 <td class="micon"><a class="exi" href="#expand"> </a></td>
2401 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
2402 <div class="fixedFont">
2403 <span class="attributes"></span><b class="itemname">onMouseDown</b>
2405 (Event <B><i>e</i></B>)
2412 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2418 Event handler that fires when a drag/drop obj gets a mousedown
2425 <dl class="detailList">
2426 <dt class="heading">Parameters:</dt>
2429 <span class="fixedFont">Event</span> <b>e</b>
2432 <dd>the mousedown event</dd>
2450 <td class="msource">
2452 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2458 <tr class="method-row config-row-alt0 expandable">
2459 <td class="micon"><a class="exi" href="#expand"> </a></td>
2463 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
2464 <div class="fixedFont">
2465 <span class="attributes"></span><b class="itemname">onMouseUp</b>
2467 (Event <B><i>e</i></B>)
2474 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2480 Event handler that fires when a drag/drop obj gets a mouseup
2487 <dl class="detailList">
2488 <dt class="heading">Parameters:</dt>
2491 <span class="fixedFont">Event</span> <b>e</b>
2494 <dd>the mouseup event</dd>
2512 <td class="msource">
2514 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2520 <tr class="method-row config-row-alt1 expandable">
2521 <td class="micon"><a class="exi" href="#expand"> </a></td>
2525 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
2526 <div class="fixedFont">
2527 <span class="attributes"></span><b class="itemname">padding</b>
2536 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
2542 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
2563 <td class="msource">
2565 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2571 <tr class="method-row config-row-alt0 expandable">
2572 <td class="micon"><a class="exi" href="#expand"> </a></td>
2576 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2577 <div class="fixedFont">
2578 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2587 <div class="short">Removes all listeners for this object</div>
2593 Removes all listeners for this object
2614 <td class="msource">
2616 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2622 <tr class="method-row config-row-alt1 expandable">
2623 <td class="micon"><a class="exi" href="#expand"> </a></td>
2627 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
2628 <div class="fixedFont">
2629 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
2631 (string <B><i>sGroup</i></B>)
2638 <div class="short">Remove's this instance from the supplied interaction group</div>
2644 Remove's this instance from the supplied interaction group
2651 <dl class="detailList">
2652 <dt class="heading">Parameters:</dt>
2655 <span class="fixedFont">string</span> <b>sGroup</b>
2658 <dd>The group to drop</dd>
2676 <td class="msource">
2678 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2684 <tr class="method-row config-row-alt0 expandable">
2685 <td class="micon"><a class="exi" href="#expand"> </a></td>
2689 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
2690 <div class="fixedFont">
2691 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
2693 (string <B><i>cssClass</i></B>)
2700 <div class="short">Unsets an invalid css class</div>
2706 Unsets an invalid css class
2713 <dl class="detailList">
2714 <dt class="heading">Parameters:</dt>
2717 <span class="fixedFont">string</span> <b>cssClass</b>
2720 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2738 <td class="msource">
2740 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2746 <tr class="method-row config-row-alt1 expandable">
2747 <td class="micon"><a class="exi" href="#expand"> </a></td>
2751 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
2752 <div class="fixedFont">
2753 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2755 (string <B><i>id</i></B>)
2762 <div class="short">Unsets an invalid handle id</div>
2768 Unsets an invalid handle id
2775 <dl class="detailList">
2776 <dt class="heading">Parameters:</dt>
2779 <span class="fixedFont">string</span> <b>id</b>
2782 <dd>the id of the element to re-enable</dd>
2800 <td class="msource">
2802 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2808 <tr class="method-row config-row-alt0 expandable">
2809 <td class="micon"><a class="exi" href="#expand"> </a></td>
2813 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
2814 <div class="fixedFont">
2815 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2817 (string <B><i>tagName</i></B>)
2824 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2830 Unsets an excluded tag name set by addInvalidHandleType
2837 <dl class="detailList">
2838 <dt class="heading">Parameters:</dt>
2841 <span class="fixedFont">string</span> <b>tagName</b>
2844 <dd>the type of element to unexclude</dd>
2862 <td class="msource">
2864 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2870 <tr class="method-row config-row-alt1 expandable">
2871 <td class="micon"><a class="exi" href="#expand"> </a></td>
2875 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2876 <div class="fixedFont">
2877 <span class="attributes"></span><b class="itemname">removeListener</b>
2879 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2886 <div class="short">Removes a listener</div>
2899 <dl class="detailList">
2900 <dt class="heading">Parameters:</dt>
2903 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2906 <dd>The type of event to listen for</dd>
2909 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2912 <dd>The handler to remove</dd>
2915 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2918 <dd>(optional) The scope (this object) for the handler</dd>
2936 <td class="msource">
2938 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2944 <tr class="method-row config-row-alt0 expandable">
2945 <td class="micon"><a class="exi" href="#expand"> </a></td>
2949 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
2950 <div class="fixedFont">
2951 <span class="attributes"></span><b class="itemname">resetConstraints</b>
2953 (boolean <B><i>maintainOffset</i></B>)
2960 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
2966 resetConstraints must be called if you manually reposition a dd element.
2973 <dl class="detailList">
2974 <dt class="heading">Parameters:</dt>
2977 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
2998 <td class="msource">
3000 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3006 <tr class="method-row config-row-alt1 expandable notInherited">
3007 <td class="micon"><a class="exi" href="#expand"> </a></td>
3011 <a id="Roo.dd.DD-method-setDelta" name=".setDelta"></a>
3012 <div class="fixedFont">
3013 <span class="attributes"></span><b class="itemname">setDelta</b>
3015 (int <B><i>iDeltaX</i></B>, int <B><i>iDeltaY</i></B>)
3022 <div class="short">Sets the pointer offset.</div>
3028 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)
3035 <dl class="detailList">
3036 <dt class="heading">Parameters:</dt>
3039 <span class="fixedFont">int</span> <b>iDeltaX</b>
3042 <dd>the distance from the left</dd>
3045 <span class="fixedFont">int</span> <b>iDeltaY</b>
3048 <dd>the distance from the top</dd>
3066 <td class="msource">
3074 <tr class="method-row config-row-alt0 expandable">
3075 <td class="micon"><a class="exi" href="#expand"> </a></td>
3079 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
3080 <div class="fixedFont">
3081 <span class="attributes"></span><b class="itemname">setDragElId</b>
3090 <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>
3096 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
3103 <dl class="detailList">
3104 <dt class="heading">Parameters:</dt>
3110 <dd>{string} the id of the element that will be used to initiate the drag</dd>
3128 <td class="msource">
3130 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3136 <tr class="method-row config-row-alt1 expandable notInherited">
3137 <td class="micon"><a class="exi" href="#expand"> </a></td>
3141 <a id="Roo.dd.DD-method-setDragElPos" name=".setDragElPos"></a>
3142 <div class="fixedFont">
3143 <span class="attributes"></span><b class="itemname">setDragElPos</b>
3145 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
3152 <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>
3158 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.
3165 <dl class="detailList">
3166 <dt class="heading">Parameters:</dt>
3169 <span class="fixedFont">int</span> <b>iPageX</b>
3172 <dd>the X coordinate of the mousedown or drag event</dd>
3175 <span class="fixedFont">int</span> <b>iPageY</b>
3178 <dd>the Y coordinate of the mousedown or drag event</dd>
3196 <td class="msource">
3204 <tr class="method-row config-row-alt0 expandable">
3205 <td class="micon"><a class="exi" href="#expand"> </a></td>
3209 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
3210 <div class="fixedFont">
3211 <span class="attributes"></span><b class="itemname">setHandleElId</b>
3220 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
3226 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.
3233 <dl class="detailList">
3234 <dt class="heading">Parameters:</dt>
3240 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
3258 <td class="msource">
3260 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3266 <tr class="method-row config-row-alt1 expandable">
3267 <td class="micon"><a class="exi" href="#expand"> </a></td>
3271 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
3272 <div class="fixedFont">
3273 <span class="attributes"></span><b class="itemname">setInitPosition</b>
3275 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
3282 <div class="short">Stores the initial placement of the linked element.</div>
3288 Stores the initial placement of the linked element.
3295 <dl class="detailList">
3296 <dt class="heading">Parameters:</dt>
3299 <span class="fixedFont">int</span> <b>diffX</b>
3302 <dd>the X offset, default 0</dd>
3305 <span class="fixedFont">int</span> <b>diffY</b>
3308 <dd>the Y offset, default 0</dd>
3326 <td class="msource">
3328 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3334 <tr class="method-row config-row-alt0 expandable">
3335 <td class="micon"><a class="exi" href="#expand"> </a></td>
3339 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
3340 <div class="fixedFont">
3341 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
3350 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3356 Allows you to set an element outside of the linked element as a drag<br/>handle
3363 <dl class="detailList">
3364 <dt class="heading">Parameters:</dt>
3370 <dd>the id of the element that will be used to initiate the drag</dd>
3388 <td class="msource">
3390 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3396 <tr class="method-row config-row-alt1 expandable">
3397 <td class="micon"><a class="exi" href="#expand"> </a></td>
3401 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
3402 <div class="fixedFont">
3403 <span class="attributes"></span><b class="itemname">setPadding</b>
3405 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3412 <div class="short">Configures the padding for the target zone in px.</div>
3418 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.
3425 <dl class="detailList">
3426 <dt class="heading">Parameters:</dt>
3429 <span class="fixedFont">int</span> <b>iTop</b>
3435 <span class="fixedFont">int</span> <b>iRight</b>
3441 <span class="fixedFont">int</span> <b>iBot</b>
3447 <span class="fixedFont">int</span> <b>iLeft</b>
3468 <td class="msource">
3470 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3476 <tr class="method-row config-row-alt0 expandable">
3477 <td class="micon"><a class="exi" href="#expand"> </a></td>
3481 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
3482 <div class="fixedFont">
3483 <span class="attributes"></span><b class="itemname">setXConstraint</b>
3485 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3492 <div class="short">By default, the element can be dragged any place on the screen.</div>
3498 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.
3505 <dl class="detailList">
3506 <dt class="heading">Parameters:</dt>
3509 <span class="fixedFont">int</span> <b>iLeft</b>
3512 <dd>the number of pixels the element can move to the left</dd>
3515 <span class="fixedFont">int</span> <b>iRight</b>
3518 <dd>the number of pixels the element can move to the<br/>right</dd>
3521 <span class="fixedFont">int</span> <b>iTickSize</b>
3524 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3542 <td class="msource">
3544 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3550 <tr class="method-row config-row-alt1 expandable">
3551 <td class="micon"><a class="exi" href="#expand"> </a></td>
3555 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
3556 <div class="fixedFont">
3557 <span class="attributes"></span><b class="itemname">setYConstraint</b>
3559 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
3566 <div class="short">By default, the element can be dragged any place on the screen.</div>
3572 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.
3579 <dl class="detailList">
3580 <dt class="heading">Parameters:</dt>
3583 <span class="fixedFont">int</span> <b>iUp</b>
3586 <dd>the number of pixels the element can move up</dd>
3589 <span class="fixedFont">int</span> <b>iDown</b>
3592 <dd>the number of pixels the element can move down</dd>
3595 <span class="fixedFont">int</span> <b>iTickSize</b>
3598 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
3616 <td class="msource">
3618 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3624 <tr class="method-row config-row-alt0 expandable">
3625 <td class="micon"><a class="exi" href="#expand"> </a></td>
3629 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
3630 <div class="fixedFont">
3631 <span class="attributes"></span><b class="itemname">startDrag</b>
3633 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
3640 <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>
3646 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
3653 <dl class="detailList">
3654 <dt class="heading">Parameters:</dt>
3657 <span class="fixedFont">int</span> <b>X</b>
3660 <dd>click location</dd>
3663 <span class="fixedFont">int</span> <b>Y</b>
3666 <dd>click location</dd>
3684 <td class="msource">
3686 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3692 <tr class="method-row config-row-alt1 expandable">
3693 <td class="micon"><a class="exi" href="#expand"> </a></td>
3697 <a id="Roo.util.Observable-method-un" name=".un"></a>
3698 <div class="fixedFont">
3699 <span class="attributes"></span><b class="itemname">un</b>
3701 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
3708 <div class="short">Removes a listener (shorthand for removeListener)</div>
3714 Removes a listener (shorthand for removeListener)
3721 <dl class="detailList">
3722 <dt class="heading">Parameters:</dt>
3725 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3728 <dd>The type of event to listen for</dd>
3731 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3734 <dd>The handler to remove</dd>
3737 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
3740 <dd>(optional) The scope (this object) for the handler</dd>
3758 <td class="msource">
3760 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3766 <tr class="method-row config-row-alt0 expandable">
3767 <td class="micon"><a class="exi" href="#expand"> </a></td>
3771 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
3772 <div class="fixedFont">
3773 <span class="attributes"></span><b class="itemname">unlock</b>
3782 <div class="short">Unlock this instace</div>
3809 <td class="msource">
3811 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3817 <tr class="method-row config-row-alt1 expandable">
3818 <td class="micon"><a class="exi" href="#expand"> </a></td>
3822 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
3823 <div class="fixedFont">
3824 <span class="attributes"></span><b class="itemname">unreg</b>
3833 <div class="short">Remove all drag and drop hooks for this element</div>
3839 Remove all drag and drop hooks for this element
3860 <td class="msource">
3862 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3871 <!-- ============================== events summary / details ======================== -->
3874 <a id="Roo.dd.DD-events"></a>
3880 <table cellspacing="0" class="member-table">
3881 <caption class="Empty">Events - Has None</caption>
3892 <!-- ============================== footer ================================= -->
3893 <div class="fineprint" style="clear:both">
3895 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed Apr 06 2016 14:39:01 GMT+0800 (HKT)
3897 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>