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>
151 <div class="long">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></div>
159 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
175 <!-- ============================== public properties ==================== -->
179 <a id="Roo.dd.DD-props"></a>
185 <table cellspacing="0" class="member-table">
186 <caption class="Empty">Public Properties - Has None</caption>
192 <!-- ============================== methods summary / details ======================== -->
195 <a id="Roo.dd.DD-methods"></a>
196 <!-- constructor?? -->
203 <!-- then dynamics first -->
210 <table cellspacing="0" class="member-table">
211 <caption>Public Methods</caption>
213 <th class="sig-header" colspan="2">Method</th>
214 <th class="msource-header">Defined By</th>
224 <tr class="method-row config-row-alt0 expandable notInherited">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
229 <a id="Roo.dd-method-DD" name=".DD"></a>
230 <div class="fixedFont">
231 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DD</b>
233 (<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>)
241 <div class="short">Create a new Roo.dd.DD</div>
248 Create a new Roo.dd.DD
251 <dl class="detailList">
252 <dt class="heading">Parameters:</dt>
255 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
258 <dd>the id of the linked element</dd>
261 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
264 <dd>the group of related DragDrop items</dd>
267 <span class="fixedFont">object</span> <b>config</b>
270 <dd>an object containing configurable attributes<br/> Valid properties for DD:<br/> scroll</dd>
294 <tr class="method-row config-row-alt1 expandable">
295 <td class="micon"><a class="exi" href="#expand"> </a></td>
299 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
300 <div class="fixedFont">
301 <span class="attributes"></span><b class="itemname">addEvents</b>
303 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
310 <div class="short">Used to define events on this Observable</div>
316 Used to define events on this Observable
323 <dl class="detailList">
324 <dt class="heading">Parameters:</dt>
327 <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>
330 <dd>The object with the events defined</dd>
350 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
356 <tr class="method-row config-row-alt0 expandable">
357 <td class="micon"><a class="exi" href="#expand"> </a></td>
361 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
362 <div class="fixedFont">
363 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
365 (string <B><i>cssClass</i></B>)
372 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
378 Lets you specify a css class of elements that will not initiate a drag
385 <dl class="detailList">
386 <dt class="heading">Parameters:</dt>
389 <span class="fixedFont">string</span> <b>cssClass</b>
392 <dd>the class of the elements you wish to ignore</dd>
412 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
418 <tr class="method-row config-row-alt1 expandable">
419 <td class="micon"><a class="exi" href="#expand"> </a></td>
423 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
424 <div class="fixedFont">
425 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
427 (string <B><i>id</i></B>)
434 <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>
440 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
447 <dl class="detailList">
448 <dt class="heading">Parameters:</dt>
451 <span class="fixedFont">string</span> <b>id</b>
454 <dd>the element id of the element you wish to ignore</dd>
474 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
480 <tr class="method-row config-row-alt0 expandable">
481 <td class="micon"><a class="exi" href="#expand"> </a></td>
485 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
486 <div class="fixedFont">
487 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
489 (string <B><i>tagName</i></B>)
496 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
502 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.
509 <dl class="detailList">
510 <dt class="heading">Parameters:</dt>
513 <span class="fixedFont">string</span> <b>tagName</b>
516 <dd>the type of element to exclude</dd>
536 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
542 <tr class="method-row config-row-alt1 expandable">
543 <td class="micon"><a class="exi" href="#expand"> </a></td>
547 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
548 <div class="fixedFont">
549 <span class="attributes"></span><b class="itemname">addListener</b>
551 (<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>)
558 <div class="short">Appends an event handler to this component</div>
564 Appends an event handler to this component
571 <dl class="detailList">
572 <dt class="heading">Parameters:</dt>
575 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
578 <dd>The type of event to listen for</dd>
581 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
584 <dd>The method the event invokes</dd>
587 <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>
590 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
593 <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>
596 <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>
616 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
622 <tr class="method-row config-row-alt0 expandable">
623 <td class="micon"><a class="exi" href="#expand"> </a></td>
627 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
628 <div class="fixedFont">
629 <span class="attributes"></span><b class="itemname">addToGroup</b>
631 (<B><i>sGroup</i></B>)
638 <div class="short">Add this instance to a group of related drag/drop objects.</div>
644 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.
651 <dl class="detailList">
652 <dt class="heading">Parameters:</dt>
658 <dd>{string} the name of the group</dd>
678 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
684 <tr class="method-row config-row-alt1 expandable notInherited">
685 <td class="micon"><a class="exi" href="#expand"> </a></td>
689 <a id="Roo.dd.DD-method-alignElWithMouse" name=".alignElWithMouse"></a>
690 <div class="fixedFont">
691 <span class="attributes"></span><b class="itemname">alignElWithMouse</b>
693 (<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>)
700 <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>
706 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.
713 <dl class="detailList">
714 <dt class="heading">Parameters:</dt>
717 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>el</b>
720 <dd>the element to move</dd>
723 <span class="fixedFont">int</span> <b>iPageX</b>
726 <dd>the X coordinate of the mousedown or drag event</dd>
729 <span class="fixedFont">int</span> <b>iPageY</b>
732 <dd>the Y coordinate of the mousedown or drag event</dd>
758 <tr class="method-row config-row-alt0 expandable">
759 <td class="micon"><a class="exi" href="#expand"> </a></td>
763 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
764 <div class="fixedFont">
765 <span class="attributes"></span><b class="itemname">applyConfig</b>
774 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
780 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.
803 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
809 <tr class="method-row config-row-alt1 expandable notInherited">
810 <td class="micon"><a class="exi" href="#expand"> </a></td>
814 <a id="Roo.dd.DD-method-autoOffset" name=".autoOffset"></a>
815 <div class="fixedFont">
816 <span class="attributes"></span><b class="itemname">autoOffset</b>
818 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
825 <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>
831 Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked
838 <dl class="detailList">
839 <dt class="heading">Parameters:</dt>
842 <span class="fixedFont">int</span> <b>iPageX</b>
845 <dd>the X coordinate of the click</dd>
848 <span class="fixedFont">int</span> <b>iPageY</b>
851 <dd>the Y coordinate of the click</dd>
877 <tr class="method-row config-row-alt0 expandable notInherited">
878 <td class="micon"><a class="exi" href="#expand"> </a></td>
882 <a id="Roo.dd.DD-method-cachePosition" name=".cachePosition"></a>
883 <div class="fixedFont">
884 <span class="attributes"></span><b class="itemname">cachePosition</b>
886 (<B><i>iPageX</i></B>, <B><i>iPageY</i></B>)
893 <div class="short">Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.</div>
899 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.
906 <dl class="detailList">
907 <dt class="heading">Parameters:</dt>
913 <dd>the current x position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
919 <dd>the current y position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
945 <tr class="method-row config-row-alt1 expandable">
946 <td class="micon"><a class="exi" href="#expand"> </a></td>
950 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
951 <div class="fixedFont">
952 <span class="attributes"></span><b class="itemname">clearConstraints</b>
961 <div class="short">Clears any constraints applied to this instance.</div>
967 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
990 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
996 <tr class="method-row config-row-alt0 expandable">
997 <td class="micon"><a class="exi" href="#expand"> </a></td>
1001 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
1002 <div class="fixedFont">
1003 <span class="attributes"></span><b class="itemname">clearTicks</b>
1012 <div class="short">Clears any tick interval defined for this instance</div>
1018 Clears any tick interval defined for this instance
1039 <td class="msource">
1041 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1047 <tr class="method-row config-row-alt1 expandable">
1048 <td class="micon"><a class="exi" href="#expand"> </a></td>
1052 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
1053 <div class="fixedFont">
1054 <span class="attributes"></span><b class="itemname">endDrag</b>
1056 (Event <B><i>e</i></B>)
1063 <div class="short">Fired when we are done dragging the object</div>
1069 Fired when we are done dragging the object
1076 <dl class="detailList">
1077 <dt class="heading">Parameters:</dt>
1080 <span class="fixedFont">Event</span> <b>e</b>
1083 <dd>the mouseup event</dd>
1101 <td class="msource">
1103 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1109 <tr class="method-row config-row-alt0 expandable">
1110 <td class="micon"><a class="exi" href="#expand"> </a></td>
1114 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1115 <div class="fixedFont">
1116 <span class="attributes"></span><b class="itemname">fireEvent</b>
1118 (<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>)
1124 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1133 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1139 Fires the specified event with the passed parameters (minus the event name).
1146 <dl class="detailList">
1147 <dt class="heading">Parameters:</dt>
1150 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1156 <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>
1159 <dd>Variable number of parameters are passed to handlers</dd>
1167 <dl class="detailList">
1168 <dt class="heading">Returns:</dt>
1170 <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>
1184 <td class="msource">
1186 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1192 <tr class="method-row config-row-alt1 expandable">
1193 <td class="micon"><a class="exi" href="#expand"> </a></td>
1197 <a id="Roo.dd.DragDrop-method-function toString() {
1199 }" name=".function toString() {
1202 <div class="fixedFont">
1203 <span class="attributes"></span><b class="itemname">function toString() {
1222 <div class="short">toString method</div>
1239 <dl class="detailList">
1240 <dt class="heading">Returns:</dt>
1242 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
1256 <td class="msource">
1258 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1264 <tr class="method-row config-row-alt0 expandable">
1265 <td class="micon"><a class="exi" href="#expand"> </a></td>
1269 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
1270 <div class="fixedFont">
1271 <span class="attributes"></span><b class="itemname">getDragEl</b>
1279 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1288 <div class="short">Returns a reference to the actual element to drag.</div>
1294 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
1305 <dl class="detailList">
1306 <dt class="heading">Returns:</dt>
1308 <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>
1322 <td class="msource">
1324 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1330 <tr class="method-row config-row-alt1 expandable">
1331 <td class="micon"><a class="exi" href="#expand"> </a></td>
1335 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
1336 <div class="fixedFont">
1337 <span class="attributes"></span><b class="itemname">getEl</b>
1345 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1354 <div class="short">Returns a reference to the linked element</div>
1360 Returns a reference to the linked element
1371 <dl class="detailList">
1372 <dt class="heading">Returns:</dt>
1374 <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>
1388 <td class="msource">
1390 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1396 <tr class="method-row config-row-alt0 expandable">
1397 <td class="micon"><a class="exi" href="#expand"> </a></td>
1401 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1402 <div class="fixedFont">
1403 <span class="attributes"></span><b class="itemname">hasListener</b>
1405 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1411 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1420 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1426 Checks to see if this object has any listeners for a specified event
1433 <dl class="detailList">
1434 <dt class="heading">Parameters:</dt>
1437 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1440 <dd>The name of the event to check for</dd>
1448 <dl class="detailList">
1449 <dt class="heading">Returns:</dt>
1451 <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>
1465 <td class="msource">
1467 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1473 <tr class="method-row config-row-alt1 expandable">
1474 <td class="micon"><a class="exi" href="#expand"> </a></td>
1478 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
1479 <div class="fixedFont">
1480 <span class="attributes"></span><b class="itemname">init</b>
1482 (<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>)
1489 <div class="short">Sets up the DragDrop object.</div>
1495 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1502 <dl class="detailList">
1503 <dt class="heading">Parameters:</dt>
1509 <dd>the id of the linked element</dd>
1512 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1515 <dd>the group of related items</dd>
1518 <span class="fixedFont">object</span> <b>config</b>
1521 <dd>configuration attributes</dd>
1539 <td class="msource">
1541 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1547 <tr class="method-row config-row-alt0 expandable">
1548 <td class="micon"><a class="exi" href="#expand"> </a></td>
1552 <a id="Roo.dd.DragDrop-method-initTarget" name=".initTarget"></a>
1553 <div class="fixedFont">
1554 <span class="attributes"></span><b class="itemname">initTarget</b>
1556 (<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>)
1563 <div class="short">Initializes Targeting functionality only.</div>
1569 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1576 <dl class="detailList">
1577 <dt class="heading">Parameters:</dt>
1583 <dd>the id of the linked element</dd>
1586 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1589 <dd>the group of related items</dd>
1592 <span class="fixedFont">object</span> <b>config</b>
1595 <dd>configuration attributes</dd>
1613 <td class="msource">
1615 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1621 <tr class="method-row config-row-alt1 expandable">
1622 <td class="micon"><a class="exi" href="#expand"> </a></td>
1626 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
1627 <div class="fixedFont">
1628 <span class="attributes"></span><b class="itemname">isLocked</b>
1645 <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>
1651 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.)
1662 <dl class="detailList">
1663 <dt class="heading">Returns:</dt>
1665 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
1679 <td class="msource">
1681 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1687 <tr class="method-row config-row-alt0 expandable">
1688 <td class="micon"><a class="exi" href="#expand"> </a></td>
1692 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
1693 <div class="fixedFont">
1694 <span class="attributes"></span><b class="itemname">isTarget</b>
1703 <div class="short">By default, all insances can be a drop target.</div>
1709 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
1730 <td class="msource">
1732 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1738 <tr class="method-row config-row-alt1 expandable">
1739 <td class="micon"><a class="exi" href="#expand"> </a></td>
1743 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
1744 <div class="fixedFont">
1745 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1747 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1762 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1768 Checks the tag exclusion list to see if this click should be ignored
1775 <dl class="detailList">
1776 <dt class="heading">Parameters:</dt>
1779 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1782 <dd>the HTMLElement to evaluate</dd>
1790 <dl class="detailList">
1791 <dt class="heading">Returns:</dt>
1793 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
1807 <td class="msource">
1809 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1815 <tr class="method-row config-row-alt0 expandable">
1816 <td class="micon"><a class="exi" href="#expand"> </a></td>
1820 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
1821 <div class="fixedFont">
1822 <span class="attributes"></span><b class="itemname">lock</b>
1831 <div class="short">Lock this instance</div>
1858 <td class="msource">
1860 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1866 <tr class="method-row config-row-alt1 expandable">
1867 <td class="micon"><a class="exi" href="#expand"> </a></td>
1871 <a id="Roo.util.Observable-method-on" name=".on"></a>
1872 <div class="fixedFont">
1873 <span class="attributes"></span><b class="itemname">on</b>
1875 (<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>)
1882 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1888 Appends an event handler to this element (shorthand for addListener)
1895 <dl class="detailList">
1896 <dt class="heading">Parameters:</dt>
1899 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1902 <dd>The type of event to listen for</dd>
1905 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1908 <dd>The method the event invokes</dd>
1911 <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>
1914 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1917 <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>
1938 <td class="msource">
1940 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1946 <tr class="method-row config-row-alt0 expandable">
1947 <td class="micon"><a class="exi" href="#expand"> </a></td>
1951 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
1952 <div class="fixedFont">
1953 <span class="attributes"></span><b class="itemname">onAvailable</b>
1962 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
1968 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
1989 <td class="msource">
1991 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1997 <tr class="method-row config-row-alt1 expandable">
1998 <td class="micon"><a class="exi" href="#expand"> </a></td>
2002 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
2003 <div class="fixedFont">
2004 <span class="attributes"></span><b class="itemname">onDrag</b>
2006 (Event <B><i>e</i></B>)
2013 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
2019 Abstract method called during the onMouseMove event while dragging an<br/>object.
2026 <dl class="detailList">
2027 <dt class="heading">Parameters:</dt>
2030 <span class="fixedFont">Event</span> <b>e</b>
2033 <dd>the mousemove event</dd>
2051 <td class="msource">
2053 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2059 <tr class="method-row config-row-alt0 expandable">
2060 <td class="micon"><a class="exi" href="#expand"> </a></td>
2064 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
2065 <div class="fixedFont">
2066 <span class="attributes"></span><b class="itemname">onDragDrop</b>
2068 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2075 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
2081 Abstract method called when this item is dropped on another DragDrop<br/>obj
2088 <dl class="detailList">
2089 <dt class="heading">Parameters:</dt>
2092 <span class="fixedFont">Event</span> <b>e</b>
2095 <dd>the mouseup event</dd>
2098 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2101 <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>
2119 <td class="msource">
2121 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2127 <tr class="method-row config-row-alt1 expandable">
2128 <td class="micon"><a class="exi" href="#expand"> </a></td>
2132 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
2133 <div class="fixedFont">
2134 <span class="attributes"></span><b class="itemname">onDragEnter</b>
2136 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2143 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
2149 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
2156 <dl class="detailList">
2157 <dt class="heading">Parameters:</dt>
2160 <span class="fixedFont">Event</span> <b>e</b>
2163 <dd>the mousemove event</dd>
2166 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2169 <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>
2187 <td class="msource">
2189 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2195 <tr class="method-row config-row-alt0 expandable">
2196 <td class="micon"><a class="exi" href="#expand"> </a></td>
2200 <a id="Roo.dd.DragDrop-method-onDragOut" name=".onDragOut"></a>
2201 <div class="fixedFont">
2202 <span class="attributes"></span><b class="itemname">onDragOut</b>
2204 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2211 <div class="short">Abstract method called when we are no longer hovering over an element</div>
2217 Abstract method called when we are no longer hovering over an element
2224 <dl class="detailList">
2225 <dt class="heading">Parameters:</dt>
2228 <span class="fixedFont">Event</span> <b>e</b>
2231 <dd>the mousemove event</dd>
2234 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2237 <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>
2255 <td class="msource">
2257 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2263 <tr class="method-row config-row-alt1 expandable">
2264 <td class="micon"><a class="exi" href="#expand"> </a></td>
2268 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
2269 <div class="fixedFont">
2270 <span class="attributes"></span><b class="itemname">onDragOver</b>
2272 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2279 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2285 Abstract method called when this element is hovering over another<br/>DragDrop obj
2292 <dl class="detailList">
2293 <dt class="heading">Parameters:</dt>
2296 <span class="fixedFont">Event</span> <b>e</b>
2299 <dd>the mousemove event</dd>
2302 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2305 <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>
2323 <td class="msource">
2325 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2331 <tr class="method-row config-row-alt0 expandable">
2332 <td class="micon"><a class="exi" href="#expand"> </a></td>
2336 <a id="Roo.dd.DragDrop-method-onInvalidDrop" name=".onInvalidDrop"></a>
2337 <div class="fixedFont">
2338 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2340 (Event <B><i>e</i></B>)
2347 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2353 Abstract method called when this item is dropped on an area with no<br/>drop target
2360 <dl class="detailList">
2361 <dt class="heading">Parameters:</dt>
2364 <span class="fixedFont">Event</span> <b>e</b>
2367 <dd>the mouseup event</dd>
2385 <td class="msource">
2387 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2393 <tr class="method-row config-row-alt1 expandable">
2394 <td class="micon"><a class="exi" href="#expand"> </a></td>
2398 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
2399 <div class="fixedFont">
2400 <span class="attributes"></span><b class="itemname">onMouseDown</b>
2402 (Event <B><i>e</i></B>)
2409 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2415 Event handler that fires when a drag/drop obj gets a mousedown
2422 <dl class="detailList">
2423 <dt class="heading">Parameters:</dt>
2426 <span class="fixedFont">Event</span> <b>e</b>
2429 <dd>the mousedown event</dd>
2447 <td class="msource">
2449 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2455 <tr class="method-row config-row-alt0 expandable">
2456 <td class="micon"><a class="exi" href="#expand"> </a></td>
2460 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
2461 <div class="fixedFont">
2462 <span class="attributes"></span><b class="itemname">onMouseUp</b>
2464 (Event <B><i>e</i></B>)
2471 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2477 Event handler that fires when a drag/drop obj gets a mouseup
2484 <dl class="detailList">
2485 <dt class="heading">Parameters:</dt>
2488 <span class="fixedFont">Event</span> <b>e</b>
2491 <dd>the mouseup event</dd>
2509 <td class="msource">
2511 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2517 <tr class="method-row config-row-alt1 expandable">
2518 <td class="micon"><a class="exi" href="#expand"> </a></td>
2522 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
2523 <div class="fixedFont">
2524 <span class="attributes"></span><b class="itemname">padding</b>
2533 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
2539 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
2560 <td class="msource">
2562 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2568 <tr class="method-row config-row-alt0 expandable">
2569 <td class="micon"><a class="exi" href="#expand"> </a></td>
2573 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2574 <div class="fixedFont">
2575 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2584 <div class="short">Removes all listeners for this object</div>
2590 Removes all listeners for this object
2611 <td class="msource">
2613 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2619 <tr class="method-row config-row-alt1 expandable">
2620 <td class="micon"><a class="exi" href="#expand"> </a></td>
2624 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
2625 <div class="fixedFont">
2626 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
2628 (string <B><i>sGroup</i></B>)
2635 <div class="short">Remove's this instance from the supplied interaction group</div>
2641 Remove's this instance from the supplied interaction group
2648 <dl class="detailList">
2649 <dt class="heading">Parameters:</dt>
2652 <span class="fixedFont">string</span> <b>sGroup</b>
2655 <dd>The group to drop</dd>
2673 <td class="msource">
2675 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2681 <tr class="method-row config-row-alt0 expandable">
2682 <td class="micon"><a class="exi" href="#expand"> </a></td>
2686 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
2687 <div class="fixedFont">
2688 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
2690 (string <B><i>cssClass</i></B>)
2697 <div class="short">Unsets an invalid css class</div>
2703 Unsets an invalid css class
2710 <dl class="detailList">
2711 <dt class="heading">Parameters:</dt>
2714 <span class="fixedFont">string</span> <b>cssClass</b>
2717 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2735 <td class="msource">
2737 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2743 <tr class="method-row config-row-alt1 expandable">
2744 <td class="micon"><a class="exi" href="#expand"> </a></td>
2748 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
2749 <div class="fixedFont">
2750 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2752 (string <B><i>id</i></B>)
2759 <div class="short">Unsets an invalid handle id</div>
2765 Unsets an invalid handle id
2772 <dl class="detailList">
2773 <dt class="heading">Parameters:</dt>
2776 <span class="fixedFont">string</span> <b>id</b>
2779 <dd>the id of the element to re-enable</dd>
2797 <td class="msource">
2799 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2805 <tr class="method-row config-row-alt0 expandable">
2806 <td class="micon"><a class="exi" href="#expand"> </a></td>
2810 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
2811 <div class="fixedFont">
2812 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2814 (string <B><i>tagName</i></B>)
2821 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2827 Unsets an excluded tag name set by addInvalidHandleType
2834 <dl class="detailList">
2835 <dt class="heading">Parameters:</dt>
2838 <span class="fixedFont">string</span> <b>tagName</b>
2841 <dd>the type of element to unexclude</dd>
2859 <td class="msource">
2861 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2867 <tr class="method-row config-row-alt1 expandable">
2868 <td class="micon"><a class="exi" href="#expand"> </a></td>
2872 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2873 <div class="fixedFont">
2874 <span class="attributes"></span><b class="itemname">removeListener</b>
2876 (<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>)
2883 <div class="short">Removes a listener</div>
2896 <dl class="detailList">
2897 <dt class="heading">Parameters:</dt>
2900 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2903 <dd>The type of event to listen for</dd>
2906 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2909 <dd>The handler to remove</dd>
2912 <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>
2915 <dd>(optional) The scope (this object) for the handler</dd>
2933 <td class="msource">
2935 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2941 <tr class="method-row config-row-alt0 expandable">
2942 <td class="micon"><a class="exi" href="#expand"> </a></td>
2946 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
2947 <div class="fixedFont">
2948 <span class="attributes"></span><b class="itemname">resetConstraints</b>
2950 (boolean <B><i>maintainOffset</i></B>)
2957 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
2963 resetConstraints must be called if you manually reposition a dd element.
2970 <dl class="detailList">
2971 <dt class="heading">Parameters:</dt>
2974 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
2995 <td class="msource">
2997 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3003 <tr class="method-row config-row-alt1 expandable notInherited">
3004 <td class="micon"><a class="exi" href="#expand"> </a></td>
3008 <a id="Roo.dd.DD-method-setDelta" name=".setDelta"></a>
3009 <div class="fixedFont">
3010 <span class="attributes"></span><b class="itemname">setDelta</b>
3012 (int <B><i>iDeltaX</i></B>, int <B><i>iDeltaY</i></B>)
3019 <div class="short">Sets the pointer offset.</div>
3025 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)
3032 <dl class="detailList">
3033 <dt class="heading">Parameters:</dt>
3036 <span class="fixedFont">int</span> <b>iDeltaX</b>
3039 <dd>the distance from the left</dd>
3042 <span class="fixedFont">int</span> <b>iDeltaY</b>
3045 <dd>the distance from the top</dd>
3063 <td class="msource">
3071 <tr class="method-row config-row-alt0 expandable">
3072 <td class="micon"><a class="exi" href="#expand"> </a></td>
3076 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
3077 <div class="fixedFont">
3078 <span class="attributes"></span><b class="itemname">setDragElId</b>
3087 <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>
3093 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
3100 <dl class="detailList">
3101 <dt class="heading">Parameters:</dt>
3107 <dd>{string} the id of the element that will be used to initiate the drag</dd>
3125 <td class="msource">
3127 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3133 <tr class="method-row config-row-alt1 expandable notInherited">
3134 <td class="micon"><a class="exi" href="#expand"> </a></td>
3138 <a id="Roo.dd.DD-method-setDragElPos" name=".setDragElPos"></a>
3139 <div class="fixedFont">
3140 <span class="attributes"></span><b class="itemname">setDragElPos</b>
3142 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
3149 <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>
3155 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.
3162 <dl class="detailList">
3163 <dt class="heading">Parameters:</dt>
3166 <span class="fixedFont">int</span> <b>iPageX</b>
3169 <dd>the X coordinate of the mousedown or drag event</dd>
3172 <span class="fixedFont">int</span> <b>iPageY</b>
3175 <dd>the Y coordinate of the mousedown or drag event</dd>
3193 <td class="msource">
3201 <tr class="method-row config-row-alt0 expandable">
3202 <td class="micon"><a class="exi" href="#expand"> </a></td>
3206 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
3207 <div class="fixedFont">
3208 <span class="attributes"></span><b class="itemname">setHandleElId</b>
3217 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
3223 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.
3230 <dl class="detailList">
3231 <dt class="heading">Parameters:</dt>
3237 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
3255 <td class="msource">
3257 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3263 <tr class="method-row config-row-alt1 expandable">
3264 <td class="micon"><a class="exi" href="#expand"> </a></td>
3268 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
3269 <div class="fixedFont">
3270 <span class="attributes"></span><b class="itemname">setInitPosition</b>
3272 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
3279 <div class="short">Stores the initial placement of the linked element.</div>
3285 Stores the initial placement of the linked element.
3292 <dl class="detailList">
3293 <dt class="heading">Parameters:</dt>
3296 <span class="fixedFont">int</span> <b>diffX</b>
3299 <dd>the X offset, default 0</dd>
3302 <span class="fixedFont">int</span> <b>diffY</b>
3305 <dd>the Y offset, default 0</dd>
3323 <td class="msource">
3325 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3331 <tr class="method-row config-row-alt0 expandable">
3332 <td class="micon"><a class="exi" href="#expand"> </a></td>
3336 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
3337 <div class="fixedFont">
3338 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
3347 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3353 Allows you to set an element outside of the linked element as a drag<br/>handle
3360 <dl class="detailList">
3361 <dt class="heading">Parameters:</dt>
3367 <dd>the id of the element that will be used to initiate the drag</dd>
3385 <td class="msource">
3387 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3393 <tr class="method-row config-row-alt1 expandable">
3394 <td class="micon"><a class="exi" href="#expand"> </a></td>
3398 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
3399 <div class="fixedFont">
3400 <span class="attributes"></span><b class="itemname">setPadding</b>
3402 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3409 <div class="short">Configures the padding for the target zone in px.</div>
3415 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.
3422 <dl class="detailList">
3423 <dt class="heading">Parameters:</dt>
3426 <span class="fixedFont">int</span> <b>iTop</b>
3432 <span class="fixedFont">int</span> <b>iRight</b>
3438 <span class="fixedFont">int</span> <b>iBot</b>
3444 <span class="fixedFont">int</span> <b>iLeft</b>
3465 <td class="msource">
3467 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3473 <tr class="method-row config-row-alt0 expandable">
3474 <td class="micon"><a class="exi" href="#expand"> </a></td>
3478 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
3479 <div class="fixedFont">
3480 <span class="attributes"></span><b class="itemname">setXConstraint</b>
3482 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3489 <div class="short">By default, the element can be dragged any place on the screen.</div>
3495 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.
3502 <dl class="detailList">
3503 <dt class="heading">Parameters:</dt>
3506 <span class="fixedFont">int</span> <b>iLeft</b>
3509 <dd>the number of pixels the element can move to the left</dd>
3512 <span class="fixedFont">int</span> <b>iRight</b>
3515 <dd>the number of pixels the element can move to the<br/>right</dd>
3518 <span class="fixedFont">int</span> <b>iTickSize</b>
3521 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3539 <td class="msource">
3541 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3547 <tr class="method-row config-row-alt1 expandable">
3548 <td class="micon"><a class="exi" href="#expand"> </a></td>
3552 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
3553 <div class="fixedFont">
3554 <span class="attributes"></span><b class="itemname">setYConstraint</b>
3556 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
3563 <div class="short">By default, the element can be dragged any place on the screen.</div>
3569 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.
3576 <dl class="detailList">
3577 <dt class="heading">Parameters:</dt>
3580 <span class="fixedFont">int</span> <b>iUp</b>
3583 <dd>the number of pixels the element can move up</dd>
3586 <span class="fixedFont">int</span> <b>iDown</b>
3589 <dd>the number of pixels the element can move down</dd>
3592 <span class="fixedFont">int</span> <b>iTickSize</b>
3595 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
3613 <td class="msource">
3615 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3621 <tr class="method-row config-row-alt0 expandable">
3622 <td class="micon"><a class="exi" href="#expand"> </a></td>
3626 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
3627 <div class="fixedFont">
3628 <span class="attributes"></span><b class="itemname">startDrag</b>
3630 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
3637 <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>
3643 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
3650 <dl class="detailList">
3651 <dt class="heading">Parameters:</dt>
3654 <span class="fixedFont">int</span> <b>X</b>
3657 <dd>click location</dd>
3660 <span class="fixedFont">int</span> <b>Y</b>
3663 <dd>click location</dd>
3681 <td class="msource">
3683 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3689 <tr class="method-row config-row-alt1 expandable">
3690 <td class="micon"><a class="exi" href="#expand"> </a></td>
3694 <a id="Roo.util.Observable-method-un" name=".un"></a>
3695 <div class="fixedFont">
3696 <span class="attributes"></span><b class="itemname">un</b>
3698 (<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>)
3705 <div class="short">Removes a listener (shorthand for removeListener)</div>
3711 Removes a listener (shorthand for removeListener)
3718 <dl class="detailList">
3719 <dt class="heading">Parameters:</dt>
3722 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3725 <dd>The type of event to listen for</dd>
3728 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3731 <dd>The handler to remove</dd>
3734 <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>
3737 <dd>(optional) The scope (this object) for the handler</dd>
3755 <td class="msource">
3757 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3763 <tr class="method-row config-row-alt0 expandable">
3764 <td class="micon"><a class="exi" href="#expand"> </a></td>
3768 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
3769 <div class="fixedFont">
3770 <span class="attributes"></span><b class="itemname">unlock</b>
3779 <div class="short">Unlock this instace</div>
3806 <td class="msource">
3808 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3814 <tr class="method-row config-row-alt1 expandable">
3815 <td class="micon"><a class="exi" href="#expand"> </a></td>
3819 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
3820 <div class="fixedFont">
3821 <span class="attributes"></span><b class="itemname">unreg</b>
3830 <div class="short">Remove all drag and drop hooks for this element</div>
3836 Remove all drag and drop hooks for this element
3857 <td class="msource">
3859 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3868 <!-- ============================== events summary / details ======================== -->
3871 <a id="Roo.dd.DD-events"></a>
3877 <table cellspacing="0" class="member-table">
3878 <caption class="Empty">Events - Has None</caption>
3889 <!-- ============================== footer ================================= -->
3890 <div class="fineprint" style="clear:both">
3892 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed May 02 2012 11:27:36 GMT+0800 (HKT)
3894 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob