1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.dd.DragDrop</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.dd.DragDrop-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.DragDrop-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.DragDrop-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.DragDrop-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DragDrop
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_dd_DragDrop.js.html">Roo/dd/DragDrop.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">DragDrop</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>, <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>, <a href="./Roo.dd.DDTarget.html#constructor" roo:cls="Roo.dd.DDTarget.html#constructor">Roo.dd.DDTarget</a>, <a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a>, <a href="./Roo.dd.DragZone.html#constructor" roo:cls="Roo.dd.DragZone.html#constructor">Roo.dd.DragZone</a>, <a href="./Roo.dd.DropTarget.html#constructor" roo:cls="Roo.dd.DropTarget.html#constructor">Roo.dd.DropTarget</a>, <a href="./Roo.dd.DropZone.html#constructor" roo:cls="Roo.dd.DropZone.html#constructor">Roo.dd.DropZone</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 Defines the interface and base operation of items that that can be<br/>dragged or can be drop targets. It was designed to be extended, overriding<br/>the event handlers for startDrag, onDrag, onDragOver and onDragOut.<br/>Up to three html elements can be associated with a DragDrop instance:<br/><ul><br/><li>linked element: the element that is passed into the constructor.<br/>This is the element which defines the boundaries for interaction with<br/>other DragDrop objects.</li><br/><li>handle element(s): The drag operation only occurs if the element that<br/>was clicked matches a handle element. By default this is the linked<br/>element, but there are times that you will want only a portion of the<br/>linked element to initiate the drag operation, and the setHandleElId()<br/>method provides a way to define this.</li><br/><li>drag element: this represents the element that would be moved along<br/>with the cursor during a drag operation. By default, this is the linked<br/>element itself as in {<b>link</b> Roo.dd.DD}. setDragElId() lets you define<br/>a separate element that would be moved, as in {<b>link</b> Roo.dd.DDProxy}.<br/></li><br/></ul><br/>This class should not be instantiated until the onload event to ensure that<br/>the associated elements are available.<br/>The following would define a DragDrop obj that would interact with any<br/>other DragDrop obj in the "group1" group:<br/><pre><br/> dd = new Roo.dd.DragDrop("div1", "group1");<br/></pre><br/>Since none of the event handlers have been implemented, nothing would<br/>actually happen if you were to run the code above. Normally you would<br/>override this class or one of the default implementations, but you can<br/>also override the methods you want on an instance of the class...<br/><pre><br/> dd.onDragDrop = function(e, id) {<br/> alert("dd was dropped on " + id);<br/> }<br/></pre>
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DragDrop';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.dd.DragDrop.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.dd.DragDrop-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
139 <div class="fixedFont">
140 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
146 <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>
151 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>
161 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
177 <!-- ============================== public properties ==================== -->
181 <a id="Roo.dd.DragDrop-props"></a>
187 <table cellspacing="0" class="member-table">
188 <caption class="Empty">Public Properties - Has None</caption>
194 <!-- ============================== methods summary / details ======================== -->
197 <a id="Roo.dd.DragDrop-methods"></a>
198 <!-- constructor?? -->
205 <!-- then dynamics first -->
212 <table cellspacing="0" class="member-table">
213 <caption>Public Methods</caption>
215 <th class="sig-header" colspan="2">Method</th>
216 <th class="msource-header">Defined By</th>
226 <tr class="method-row config-row-alt0 expandable notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
231 <a id="Roo.dd-method-DragDrop" name=".DragDrop"></a>
232 <div class="fixedFont">
233 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragDrop</b>
235 (<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>)
243 <div class="short">Create a new Roo.dd.DragDrop</div>
250 Create a new Roo.dd.DragDrop
253 <dl class="detailList">
254 <dt class="heading">Parameters:</dt>
257 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
260 <dd>of the element that is linked to this instance</dd>
263 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
266 <dd>the group of related DragDrop objects</dd>
269 <span class="fixedFont">object</span> <b>config</b>
272 <dd>an object containing configurable attributes<br/> Valid properties for DragDrop:<br/> padding, isTarget, maintainOffset, primaryButtonOnly</dd>
296 <tr class="method-row config-row-alt1 expandable">
297 <td class="micon"><a class="exi" href="#expand"> </a></td>
301 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
302 <div class="fixedFont">
303 <span class="attributes"></span><b class="itemname">addEvents</b>
305 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
312 <div class="short">Used to define events on this Observable</div>
318 Used to define events on this Observable
325 <dl class="detailList">
326 <dt class="heading">Parameters:</dt>
329 <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>
332 <dd>The object with the events defined</dd>
352 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
358 <tr class="method-row config-row-alt0 expandable notInherited">
359 <td class="micon"><a class="exi" href="#expand"> </a></td>
363 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
364 <div class="fixedFont">
365 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
367 (string <B><i>cssClass</i></B>)
374 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
380 Lets you specify a css class of elements that will not initiate a drag
387 <dl class="detailList">
388 <dt class="heading">Parameters:</dt>
391 <span class="fixedFont">string</span> <b>cssClass</b>
394 <dd>the class of the elements you wish to ignore</dd>
420 <tr class="method-row config-row-alt1 expandable notInherited">
421 <td class="micon"><a class="exi" href="#expand"> </a></td>
425 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
426 <div class="fixedFont">
427 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
429 (string <B><i>id</i></B>)
436 <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>
442 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
449 <dl class="detailList">
450 <dt class="heading">Parameters:</dt>
453 <span class="fixedFont">string</span> <b>id</b>
456 <dd>the element id of the element you wish to ignore</dd>
482 <tr class="method-row config-row-alt0 expandable notInherited">
483 <td class="micon"><a class="exi" href="#expand"> </a></td>
487 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
488 <div class="fixedFont">
489 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
491 (string <B><i>tagName</i></B>)
498 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
504 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.
511 <dl class="detailList">
512 <dt class="heading">Parameters:</dt>
515 <span class="fixedFont">string</span> <b>tagName</b>
518 <dd>the type of element to exclude</dd>
544 <tr class="method-row config-row-alt1 expandable">
545 <td class="micon"><a class="exi" href="#expand"> </a></td>
549 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
550 <div class="fixedFont">
551 <span class="attributes"></span><b class="itemname">addListener</b>
553 (<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>)
560 <div class="short">Appends an event handler to this component</div>
566 Appends an event handler to this component
573 <dl class="detailList">
574 <dt class="heading">Parameters:</dt>
577 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
580 <dd>The type of event to listen for</dd>
583 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
586 <dd>The method the event invokes</dd>
589 <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>
592 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
595 <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>
598 <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>
618 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
624 <tr class="method-row config-row-alt0 expandable notInherited">
625 <td class="micon"><a class="exi" href="#expand"> </a></td>
629 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
630 <div class="fixedFont">
631 <span class="attributes"></span><b class="itemname">addToGroup</b>
633 (<B><i>sGroup</i></B>)
640 <div class="short">Add this instance to a group of related drag/drop objects.</div>
646 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.
653 <dl class="detailList">
654 <dt class="heading">Parameters:</dt>
660 <dd>{string} the name of the group</dd>
686 <tr class="method-row config-row-alt1 expandable notInherited">
687 <td class="micon"><a class="exi" href="#expand"> </a></td>
691 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
692 <div class="fixedFont">
693 <span class="attributes"></span><b class="itemname">applyConfig</b>
702 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
708 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.
737 <tr class="method-row config-row-alt0 expandable notInherited">
738 <td class="micon"><a class="exi" href="#expand"> </a></td>
742 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
743 <div class="fixedFont">
744 <span class="attributes"></span><b class="itemname">clearConstraints</b>
753 <div class="short">Clears any constraints applied to this instance.</div>
759 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
788 <tr class="method-row config-row-alt1 expandable notInherited">
789 <td class="micon"><a class="exi" href="#expand"> </a></td>
793 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
794 <div class="fixedFont">
795 <span class="attributes"></span><b class="itemname">clearTicks</b>
804 <div class="short">Clears any tick interval defined for this instance</div>
810 Clears any tick interval defined for this instance
839 <tr class="method-row config-row-alt0 expandable notInherited">
840 <td class="micon"><a class="exi" href="#expand"> </a></td>
844 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
845 <div class="fixedFont">
846 <span class="attributes"></span><b class="itemname">endDrag</b>
848 (Event <B><i>e</i></B>)
855 <div class="short">Fired when we are done dragging the object</div>
861 Fired when we are done dragging the object
868 <dl class="detailList">
869 <dt class="heading">Parameters:</dt>
872 <span class="fixedFont">Event</span> <b>e</b>
875 <dd>the mouseup event</dd>
901 <tr class="method-row config-row-alt1 expandable">
902 <td class="micon"><a class="exi" href="#expand"> </a></td>
906 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
907 <div class="fixedFont">
908 <span class="attributes"></span><b class="itemname">fireEvent</b>
910 (<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>)
916 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
925 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
931 Fires the specified event with the passed parameters (minus the event name).
938 <dl class="detailList">
939 <dt class="heading">Parameters:</dt>
942 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
948 <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>
951 <dd>Variable number of parameters are passed to handlers</dd>
959 <dl class="detailList">
960 <dt class="heading">Returns:</dt>
962 <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>
978 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
984 <tr class="method-row config-row-alt0 expandable notInherited">
985 <td class="micon"><a class="exi" href="#expand"> </a></td>
989 <a id="Roo.dd.DragDrop-method-function toString() {
991 }" name=".function toString() {
994 <div class="fixedFont">
995 <span class="attributes"></span><b class="itemname">function toString() {
1014 <div class="short">toString method</div>
1031 <dl class="detailList">
1032 <dt class="heading">Returns:</dt>
1034 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
1048 <td class="msource">
1056 <tr class="method-row config-row-alt1 expandable notInherited">
1057 <td class="micon"><a class="exi" href="#expand"> </a></td>
1061 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
1062 <div class="fixedFont">
1063 <span class="attributes"></span><b class="itemname">getDragEl</b>
1071 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1080 <div class="short">Returns a reference to the actual element to drag.</div>
1086 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
1097 <dl class="detailList">
1098 <dt class="heading">Returns:</dt>
1100 <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>
1114 <td class="msource">
1122 <tr class="method-row config-row-alt0 expandable notInherited">
1123 <td class="micon"><a class="exi" href="#expand"> </a></td>
1127 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
1128 <div class="fixedFont">
1129 <span class="attributes"></span><b class="itemname">getEl</b>
1137 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1146 <div class="short">Returns a reference to the linked element</div>
1152 Returns a reference to the linked element
1163 <dl class="detailList">
1164 <dt class="heading">Returns:</dt>
1166 <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>
1180 <td class="msource">
1188 <tr class="method-row config-row-alt1 expandable">
1189 <td class="micon"><a class="exi" href="#expand"> </a></td>
1193 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1194 <div class="fixedFont">
1195 <span class="attributes"></span><b class="itemname">hasListener</b>
1197 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1203 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1212 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1218 Checks to see if this object has any listeners for a specified event
1225 <dl class="detailList">
1226 <dt class="heading">Parameters:</dt>
1229 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1232 <dd>The name of the event to check for</dd>
1240 <dl class="detailList">
1241 <dt class="heading">Returns:</dt>
1243 <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>
1257 <td class="msource">
1259 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1265 <tr class="method-row config-row-alt0 expandable notInherited">
1266 <td class="micon"><a class="exi" href="#expand"> </a></td>
1270 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
1271 <div class="fixedFont">
1272 <span class="attributes"></span><b class="itemname">init</b>
1274 (<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>)
1281 <div class="short">Sets up the DragDrop object.</div>
1287 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1294 <dl class="detailList">
1295 <dt class="heading">Parameters:</dt>
1301 <dd>the id of the linked element</dd>
1304 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1307 <dd>the group of related items</dd>
1310 <span class="fixedFont">object</span> <b>config</b>
1313 <dd>configuration attributes</dd>
1331 <td class="msource">
1339 <tr class="method-row config-row-alt1 expandable notInherited">
1340 <td class="micon"><a class="exi" href="#expand"> </a></td>
1344 <a id="Roo.dd.DragDrop-method-initTarget" name=".initTarget"></a>
1345 <div class="fixedFont">
1346 <span class="attributes"></span><b class="itemname">initTarget</b>
1348 (<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>)
1355 <div class="short">Initializes Targeting functionality only.</div>
1361 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1368 <dl class="detailList">
1369 <dt class="heading">Parameters:</dt>
1375 <dd>the id of the linked element</dd>
1378 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1381 <dd>the group of related items</dd>
1384 <span class="fixedFont">object</span> <b>config</b>
1387 <dd>configuration attributes</dd>
1405 <td class="msource">
1413 <tr class="method-row config-row-alt0 expandable notInherited">
1414 <td class="micon"><a class="exi" href="#expand"> </a></td>
1418 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
1419 <div class="fixedFont">
1420 <span class="attributes"></span><b class="itemname">isLocked</b>
1437 <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>
1443 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.)
1454 <dl class="detailList">
1455 <dt class="heading">Returns:</dt>
1457 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
1471 <td class="msource">
1479 <tr class="method-row config-row-alt1 expandable notInherited">
1480 <td class="micon"><a class="exi" href="#expand"> </a></td>
1484 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
1485 <div class="fixedFont">
1486 <span class="attributes"></span><b class="itemname">isTarget</b>
1495 <div class="short">By default, all insances can be a drop target.</div>
1501 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
1522 <td class="msource">
1530 <tr class="method-row config-row-alt0 expandable notInherited">
1531 <td class="micon"><a class="exi" href="#expand"> </a></td>
1535 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
1536 <div class="fixedFont">
1537 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1539 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1554 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1560 Checks the tag exclusion list to see if this click should be ignored
1567 <dl class="detailList">
1568 <dt class="heading">Parameters:</dt>
1571 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1574 <dd>the HTMLElement to evaluate</dd>
1582 <dl class="detailList">
1583 <dt class="heading">Returns:</dt>
1585 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
1599 <td class="msource">
1607 <tr class="method-row config-row-alt1 expandable notInherited">
1608 <td class="micon"><a class="exi" href="#expand"> </a></td>
1612 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
1613 <div class="fixedFont">
1614 <span class="attributes"></span><b class="itemname">lock</b>
1623 <div class="short">Lock this instance</div>
1650 <td class="msource">
1658 <tr class="method-row config-row-alt0 expandable">
1659 <td class="micon"><a class="exi" href="#expand"> </a></td>
1663 <a id="Roo.util.Observable-method-on" name=".on"></a>
1664 <div class="fixedFont">
1665 <span class="attributes"></span><b class="itemname">on</b>
1667 (<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>)
1674 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1680 Appends an event handler to this element (shorthand for addListener)
1687 <dl class="detailList">
1688 <dt class="heading">Parameters:</dt>
1691 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1694 <dd>The type of event to listen for</dd>
1697 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1700 <dd>The method the event invokes</dd>
1703 <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>
1706 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1709 <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>
1730 <td class="msource">
1732 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1738 <tr class="method-row config-row-alt1 expandable notInherited">
1739 <td class="micon"><a class="exi" href="#expand"> </a></td>
1743 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
1744 <div class="fixedFont">
1745 <span class="attributes"></span><b class="itemname">onAvailable</b>
1754 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
1760 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
1781 <td class="msource">
1789 <tr class="method-row config-row-alt0 expandable notInherited">
1790 <td class="micon"><a class="exi" href="#expand"> </a></td>
1794 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
1795 <div class="fixedFont">
1796 <span class="attributes"></span><b class="itemname">onDrag</b>
1798 (Event <B><i>e</i></B>)
1805 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
1811 Abstract method called during the onMouseMove event while dragging an<br/>object.
1818 <dl class="detailList">
1819 <dt class="heading">Parameters:</dt>
1822 <span class="fixedFont">Event</span> <b>e</b>
1825 <dd>the mousemove event</dd>
1843 <td class="msource">
1851 <tr class="method-row config-row-alt1 expandable notInherited">
1852 <td class="micon"><a class="exi" href="#expand"> </a></td>
1856 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
1857 <div class="fixedFont">
1858 <span class="attributes"></span><b class="itemname">onDragDrop</b>
1860 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1867 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
1873 Abstract method called when this item is dropped on another DragDrop<br/>obj
1880 <dl class="detailList">
1881 <dt class="heading">Parameters:</dt>
1884 <span class="fixedFont">Event</span> <b>e</b>
1887 <dd>the mouseup event</dd>
1890 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1893 <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>
1911 <td class="msource">
1919 <tr class="method-row config-row-alt0 expandable notInherited">
1920 <td class="micon"><a class="exi" href="#expand"> </a></td>
1924 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
1925 <div class="fixedFont">
1926 <span class="attributes"></span><b class="itemname">onDragEnter</b>
1928 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1935 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
1941 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
1948 <dl class="detailList">
1949 <dt class="heading">Parameters:</dt>
1952 <span class="fixedFont">Event</span> <b>e</b>
1955 <dd>the mousemove event</dd>
1958 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1961 <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>
1979 <td class="msource">
1987 <tr class="method-row config-row-alt1 expandable notInherited">
1988 <td class="micon"><a class="exi" href="#expand"> </a></td>
1992 <a id="Roo.dd.DragDrop-method-onDragOut" name=".onDragOut"></a>
1993 <div class="fixedFont">
1994 <span class="attributes"></span><b class="itemname">onDragOut</b>
1996 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2003 <div class="short">Abstract method called when we are no longer hovering over an element</div>
2009 Abstract method called when we are no longer hovering over an element
2016 <dl class="detailList">
2017 <dt class="heading">Parameters:</dt>
2020 <span class="fixedFont">Event</span> <b>e</b>
2023 <dd>the mousemove event</dd>
2026 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2029 <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>
2047 <td class="msource">
2055 <tr class="method-row config-row-alt0 expandable notInherited">
2056 <td class="micon"><a class="exi" href="#expand"> </a></td>
2060 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
2061 <div class="fixedFont">
2062 <span class="attributes"></span><b class="itemname">onDragOver</b>
2064 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2071 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2077 Abstract method called when this element is hovering over another<br/>DragDrop obj
2084 <dl class="detailList">
2085 <dt class="heading">Parameters:</dt>
2088 <span class="fixedFont">Event</span> <b>e</b>
2091 <dd>the mousemove event</dd>
2094 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2097 <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>
2115 <td class="msource">
2123 <tr class="method-row config-row-alt1 expandable notInherited">
2124 <td class="micon"><a class="exi" href="#expand"> </a></td>
2128 <a id="Roo.dd.DragDrop-method-onInvalidDrop" name=".onInvalidDrop"></a>
2129 <div class="fixedFont">
2130 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2132 (Event <B><i>e</i></B>)
2139 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2145 Abstract method called when this item is dropped on an area with no<br/>drop target
2152 <dl class="detailList">
2153 <dt class="heading">Parameters:</dt>
2156 <span class="fixedFont">Event</span> <b>e</b>
2159 <dd>the mouseup event</dd>
2177 <td class="msource">
2185 <tr class="method-row config-row-alt0 expandable notInherited">
2186 <td class="micon"><a class="exi" href="#expand"> </a></td>
2190 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
2191 <div class="fixedFont">
2192 <span class="attributes"></span><b class="itemname">onMouseDown</b>
2194 (Event <B><i>e</i></B>)
2201 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2207 Event handler that fires when a drag/drop obj gets a mousedown
2214 <dl class="detailList">
2215 <dt class="heading">Parameters:</dt>
2218 <span class="fixedFont">Event</span> <b>e</b>
2221 <dd>the mousedown event</dd>
2239 <td class="msource">
2247 <tr class="method-row config-row-alt1 expandable notInherited">
2248 <td class="micon"><a class="exi" href="#expand"> </a></td>
2252 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
2253 <div class="fixedFont">
2254 <span class="attributes"></span><b class="itemname">onMouseUp</b>
2256 (Event <B><i>e</i></B>)
2263 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2269 Event handler that fires when a drag/drop obj gets a mouseup
2276 <dl class="detailList">
2277 <dt class="heading">Parameters:</dt>
2280 <span class="fixedFont">Event</span> <b>e</b>
2283 <dd>the mouseup event</dd>
2301 <td class="msource">
2309 <tr class="method-row config-row-alt0 expandable notInherited">
2310 <td class="micon"><a class="exi" href="#expand"> </a></td>
2314 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
2315 <div class="fixedFont">
2316 <span class="attributes"></span><b class="itemname">padding</b>
2325 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
2331 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
2352 <td class="msource">
2360 <tr class="method-row config-row-alt1 expandable">
2361 <td class="micon"><a class="exi" href="#expand"> </a></td>
2365 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2366 <div class="fixedFont">
2367 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2376 <div class="short">Removes all listeners for this object</div>
2382 Removes all listeners for this object
2403 <td class="msource">
2405 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2411 <tr class="method-row config-row-alt0 expandable notInherited">
2412 <td class="micon"><a class="exi" href="#expand"> </a></td>
2416 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
2417 <div class="fixedFont">
2418 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
2420 (string <B><i>sGroup</i></B>)
2427 <div class="short">Remove's this instance from the supplied interaction group</div>
2433 Remove's this instance from the supplied interaction group
2440 <dl class="detailList">
2441 <dt class="heading">Parameters:</dt>
2444 <span class="fixedFont">string</span> <b>sGroup</b>
2447 <dd>The group to drop</dd>
2465 <td class="msource">
2473 <tr class="method-row config-row-alt1 expandable notInherited">
2474 <td class="micon"><a class="exi" href="#expand"> </a></td>
2478 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
2479 <div class="fixedFont">
2480 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
2482 (string <B><i>cssClass</i></B>)
2489 <div class="short">Unsets an invalid css class</div>
2495 Unsets an invalid css class
2502 <dl class="detailList">
2503 <dt class="heading">Parameters:</dt>
2506 <span class="fixedFont">string</span> <b>cssClass</b>
2509 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2527 <td class="msource">
2535 <tr class="method-row config-row-alt0 expandable notInherited">
2536 <td class="micon"><a class="exi" href="#expand"> </a></td>
2540 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
2541 <div class="fixedFont">
2542 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2544 (string <B><i>id</i></B>)
2551 <div class="short">Unsets an invalid handle id</div>
2557 Unsets an invalid handle id
2564 <dl class="detailList">
2565 <dt class="heading">Parameters:</dt>
2568 <span class="fixedFont">string</span> <b>id</b>
2571 <dd>the id of the element to re-enable</dd>
2589 <td class="msource">
2597 <tr class="method-row config-row-alt1 expandable notInherited">
2598 <td class="micon"><a class="exi" href="#expand"> </a></td>
2602 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
2603 <div class="fixedFont">
2604 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2606 (string <B><i>tagName</i></B>)
2613 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2619 Unsets an excluded tag name set by addInvalidHandleType
2626 <dl class="detailList">
2627 <dt class="heading">Parameters:</dt>
2630 <span class="fixedFont">string</span> <b>tagName</b>
2633 <dd>the type of element to unexclude</dd>
2651 <td class="msource">
2659 <tr class="method-row config-row-alt0 expandable">
2660 <td class="micon"><a class="exi" href="#expand"> </a></td>
2664 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2665 <div class="fixedFont">
2666 <span class="attributes"></span><b class="itemname">removeListener</b>
2668 (<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>)
2675 <div class="short">Removes a listener</div>
2688 <dl class="detailList">
2689 <dt class="heading">Parameters:</dt>
2692 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2695 <dd>The type of event to listen for</dd>
2698 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2701 <dd>The handler to remove</dd>
2704 <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>
2707 <dd>(optional) The scope (this object) for the handler</dd>
2725 <td class="msource">
2727 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2733 <tr class="method-row config-row-alt1 expandable notInherited">
2734 <td class="micon"><a class="exi" href="#expand"> </a></td>
2738 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
2739 <div class="fixedFont">
2740 <span class="attributes"></span><b class="itemname">resetConstraints</b>
2742 (boolean <B><i>maintainOffset</i></B>)
2749 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
2755 resetConstraints must be called if you manually reposition a dd element.
2762 <dl class="detailList">
2763 <dt class="heading">Parameters:</dt>
2766 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
2787 <td class="msource">
2795 <tr class="method-row config-row-alt0 expandable notInherited">
2796 <td class="micon"><a class="exi" href="#expand"> </a></td>
2800 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
2801 <div class="fixedFont">
2802 <span class="attributes"></span><b class="itemname">setDragElId</b>
2811 <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>
2817 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
2824 <dl class="detailList">
2825 <dt class="heading">Parameters:</dt>
2831 <dd>{string} the id of the element that will be used to initiate the drag</dd>
2849 <td class="msource">
2857 <tr class="method-row config-row-alt1 expandable notInherited">
2858 <td class="micon"><a class="exi" href="#expand"> </a></td>
2862 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
2863 <div class="fixedFont">
2864 <span class="attributes"></span><b class="itemname">setHandleElId</b>
2873 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
2879 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.
2886 <dl class="detailList">
2887 <dt class="heading">Parameters:</dt>
2893 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
2911 <td class="msource">
2919 <tr class="method-row config-row-alt0 expandable notInherited">
2920 <td class="micon"><a class="exi" href="#expand"> </a></td>
2924 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
2925 <div class="fixedFont">
2926 <span class="attributes"></span><b class="itemname">setInitPosition</b>
2928 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
2935 <div class="short">Stores the initial placement of the linked element.</div>
2941 Stores the initial placement of the linked element.
2948 <dl class="detailList">
2949 <dt class="heading">Parameters:</dt>
2952 <span class="fixedFont">int</span> <b>diffX</b>
2955 <dd>the X offset, default 0</dd>
2958 <span class="fixedFont">int</span> <b>diffY</b>
2961 <dd>the Y offset, default 0</dd>
2979 <td class="msource">
2987 <tr class="method-row config-row-alt1 expandable notInherited">
2988 <td class="micon"><a class="exi" href="#expand"> </a></td>
2992 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
2993 <div class="fixedFont">
2994 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
3003 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3009 Allows you to set an element outside of the linked element as a drag<br/>handle
3016 <dl class="detailList">
3017 <dt class="heading">Parameters:</dt>
3023 <dd>the id of the element that will be used to initiate the drag</dd>
3041 <td class="msource">
3049 <tr class="method-row config-row-alt0 expandable notInherited">
3050 <td class="micon"><a class="exi" href="#expand"> </a></td>
3054 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
3055 <div class="fixedFont">
3056 <span class="attributes"></span><b class="itemname">setPadding</b>
3058 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3065 <div class="short">Configures the padding for the target zone in px.</div>
3071 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.
3078 <dl class="detailList">
3079 <dt class="heading">Parameters:</dt>
3082 <span class="fixedFont">int</span> <b>iTop</b>
3088 <span class="fixedFont">int</span> <b>iRight</b>
3094 <span class="fixedFont">int</span> <b>iBot</b>
3100 <span class="fixedFont">int</span> <b>iLeft</b>
3121 <td class="msource">
3129 <tr class="method-row config-row-alt1 expandable notInherited">
3130 <td class="micon"><a class="exi" href="#expand"> </a></td>
3134 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
3135 <div class="fixedFont">
3136 <span class="attributes"></span><b class="itemname">setXConstraint</b>
3138 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3145 <div class="short">By default, the element can be dragged any place on the screen.</div>
3151 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.
3158 <dl class="detailList">
3159 <dt class="heading">Parameters:</dt>
3162 <span class="fixedFont">int</span> <b>iLeft</b>
3165 <dd>the number of pixels the element can move to the left</dd>
3168 <span class="fixedFont">int</span> <b>iRight</b>
3171 <dd>the number of pixels the element can move to the<br/>right</dd>
3174 <span class="fixedFont">int</span> <b>iTickSize</b>
3177 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3195 <td class="msource">
3203 <tr class="method-row config-row-alt0 expandable notInherited">
3204 <td class="micon"><a class="exi" href="#expand"> </a></td>
3208 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
3209 <div class="fixedFont">
3210 <span class="attributes"></span><b class="itemname">setYConstraint</b>
3212 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
3219 <div class="short">By default, the element can be dragged any place on the screen.</div>
3225 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.
3232 <dl class="detailList">
3233 <dt class="heading">Parameters:</dt>
3236 <span class="fixedFont">int</span> <b>iUp</b>
3239 <dd>the number of pixels the element can move up</dd>
3242 <span class="fixedFont">int</span> <b>iDown</b>
3245 <dd>the number of pixels the element can move down</dd>
3248 <span class="fixedFont">int</span> <b>iTickSize</b>
3251 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
3269 <td class="msource">
3277 <tr class="method-row config-row-alt1 expandable notInherited">
3278 <td class="micon"><a class="exi" href="#expand"> </a></td>
3282 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
3283 <div class="fixedFont">
3284 <span class="attributes"></span><b class="itemname">startDrag</b>
3286 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
3293 <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>
3299 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
3306 <dl class="detailList">
3307 <dt class="heading">Parameters:</dt>
3310 <span class="fixedFont">int</span> <b>X</b>
3313 <dd>click location</dd>
3316 <span class="fixedFont">int</span> <b>Y</b>
3319 <dd>click location</dd>
3337 <td class="msource">
3345 <tr class="method-row config-row-alt0 expandable">
3346 <td class="micon"><a class="exi" href="#expand"> </a></td>
3350 <a id="Roo.util.Observable-method-un" name=".un"></a>
3351 <div class="fixedFont">
3352 <span class="attributes"></span><b class="itemname">un</b>
3354 (<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>)
3361 <div class="short">Removes a listener (shorthand for removeListener)</div>
3367 Removes a listener (shorthand for removeListener)
3374 <dl class="detailList">
3375 <dt class="heading">Parameters:</dt>
3378 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3381 <dd>The type of event to listen for</dd>
3384 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3387 <dd>The handler to remove</dd>
3390 <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>
3393 <dd>(optional) The scope (this object) for the handler</dd>
3411 <td class="msource">
3413 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3419 <tr class="method-row config-row-alt1 expandable notInherited">
3420 <td class="micon"><a class="exi" href="#expand"> </a></td>
3424 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
3425 <div class="fixedFont">
3426 <span class="attributes"></span><b class="itemname">unlock</b>
3435 <div class="short">Unlock this instace</div>
3462 <td class="msource">
3470 <tr class="method-row config-row-alt0 expandable notInherited">
3471 <td class="micon"><a class="exi" href="#expand"> </a></td>
3475 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
3476 <div class="fixedFont">
3477 <span class="attributes"></span><b class="itemname">unreg</b>
3486 <div class="short">Remove all drag and drop hooks for this element</div>
3492 Remove all drag and drop hooks for this element
3513 <td class="msource">
3524 <!-- ============================== events summary / details ======================== -->
3527 <a id="Roo.dd.DragDrop-events"></a>
3533 <table cellspacing="0" class="member-table">
3534 <caption class="Empty">Events - Has None</caption>
3545 <!-- ============================== footer ================================= -->
3546 <div class="fineprint" style="clear:both">
3548 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed Apr 06 2016 11:58:57 GMT+0800 (HKT)
3550 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>