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>
150 <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>
158 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
174 <!-- ============================== public properties ==================== -->
178 <a id="Roo.dd.DragDrop-props"></a>
184 <table cellspacing="0" class="member-table">
185 <caption class="Empty">Public Properties - Has None</caption>
191 <!-- ============================== methods summary / details ======================== -->
194 <a id="Roo.dd.DragDrop-methods"></a>
195 <!-- constructor?? -->
202 <!-- then dynamics first -->
209 <table cellspacing="0" class="member-table">
210 <caption>Public Methods</caption>
212 <th class="sig-header" colspan="2">Method</th>
213 <th class="msource-header">Defined By</th>
223 <tr class="method-row config-row-alt0 expandable notInherited">
224 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.dd-method-DragDrop" name=".DragDrop"></a>
229 <div class="fixedFont">
230 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragDrop</b>
232 (<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>)
240 <div class="short">Create a new Roo.dd.DragDrop</div>
247 Create a new Roo.dd.DragDrop
250 <dl class="detailList">
251 <dt class="heading">Parameters:</dt>
254 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
257 <dd>of the element that is linked to this instance</dd>
260 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
263 <dd>the group of related DragDrop objects</dd>
266 <span class="fixedFont">object</span> <b>config</b>
269 <dd>an object containing configurable attributes<br/> Valid properties for DragDrop:<br/> padding, isTarget, maintainOffset, primaryButtonOnly</dd>
293 <tr class="method-row config-row-alt1 expandable">
294 <td class="micon"><a class="exi" href="#expand"> </a></td>
298 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
299 <div class="fixedFont">
300 <span class="attributes"></span><b class="itemname">addEvents</b>
302 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
309 <div class="short">Used to define events on this Observable</div>
315 Used to define events on this Observable
322 <dl class="detailList">
323 <dt class="heading">Parameters:</dt>
326 <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>
329 <dd>The object with the events defined</dd>
349 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
355 <tr class="method-row config-row-alt0 expandable notInherited">
356 <td class="micon"><a class="exi" href="#expand"> </a></td>
360 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
361 <div class="fixedFont">
362 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
364 (string <B><i>cssClass</i></B>)
371 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
377 Lets you specify a css class of elements that will not initiate a drag
384 <dl class="detailList">
385 <dt class="heading">Parameters:</dt>
388 <span class="fixedFont">string</span> <b>cssClass</b>
391 <dd>the class of the elements you wish to ignore</dd>
417 <tr class="method-row config-row-alt1 expandable notInherited">
418 <td class="micon"><a class="exi" href="#expand"> </a></td>
422 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
423 <div class="fixedFont">
424 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
426 (string <B><i>id</i></B>)
433 <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>
439 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
446 <dl class="detailList">
447 <dt class="heading">Parameters:</dt>
450 <span class="fixedFont">string</span> <b>id</b>
453 <dd>the element id of the element you wish to ignore</dd>
479 <tr class="method-row config-row-alt0 expandable notInherited">
480 <td class="micon"><a class="exi" href="#expand"> </a></td>
484 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
485 <div class="fixedFont">
486 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
488 (string <B><i>tagName</i></B>)
495 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
501 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.
508 <dl class="detailList">
509 <dt class="heading">Parameters:</dt>
512 <span class="fixedFont">string</span> <b>tagName</b>
515 <dd>the type of element to exclude</dd>
541 <tr class="method-row config-row-alt1 expandable">
542 <td class="micon"><a class="exi" href="#expand"> </a></td>
546 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
547 <div class="fixedFont">
548 <span class="attributes"></span><b class="itemname">addListener</b>
550 (<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>)
557 <div class="short">Appends an event handler to this component</div>
563 Appends an event handler to this component
570 <dl class="detailList">
571 <dt class="heading">Parameters:</dt>
574 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
577 <dd>The type of event to listen for</dd>
580 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
583 <dd>The method the event invokes</dd>
586 <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>
589 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
592 <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>
595 <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>
615 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
621 <tr class="method-row config-row-alt0 expandable notInherited">
622 <td class="micon"><a class="exi" href="#expand"> </a></td>
626 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
627 <div class="fixedFont">
628 <span class="attributes"></span><b class="itemname">addToGroup</b>
630 (<B><i>sGroup</i></B>)
637 <div class="short">Add this instance to a group of related drag/drop objects.</div>
643 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.
650 <dl class="detailList">
651 <dt class="heading">Parameters:</dt>
657 <dd>{string} the name of the group</dd>
683 <tr class="method-row config-row-alt1 expandable notInherited">
684 <td class="micon"><a class="exi" href="#expand"> </a></td>
688 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
689 <div class="fixedFont">
690 <span class="attributes"></span><b class="itemname">applyConfig</b>
699 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
705 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.
734 <tr class="method-row config-row-alt0 expandable notInherited">
735 <td class="micon"><a class="exi" href="#expand"> </a></td>
739 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
740 <div class="fixedFont">
741 <span class="attributes"></span><b class="itemname">clearConstraints</b>
750 <div class="short">Clears any constraints applied to this instance.</div>
756 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
785 <tr class="method-row config-row-alt1 expandable notInherited">
786 <td class="micon"><a class="exi" href="#expand"> </a></td>
790 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
791 <div class="fixedFont">
792 <span class="attributes"></span><b class="itemname">clearTicks</b>
801 <div class="short">Clears any tick interval defined for this instance</div>
807 Clears any tick interval defined for this instance
836 <tr class="method-row config-row-alt0 expandable notInherited">
837 <td class="micon"><a class="exi" href="#expand"> </a></td>
841 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
842 <div class="fixedFont">
843 <span class="attributes"></span><b class="itemname">endDrag</b>
845 (Event <B><i>e</i></B>)
852 <div class="short">Fired when we are done dragging the object</div>
858 Fired when we are done dragging the object
865 <dl class="detailList">
866 <dt class="heading">Parameters:</dt>
869 <span class="fixedFont">Event</span> <b>e</b>
872 <dd>the mouseup event</dd>
898 <tr class="method-row config-row-alt1 expandable">
899 <td class="micon"><a class="exi" href="#expand"> </a></td>
903 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
904 <div class="fixedFont">
905 <span class="attributes"></span><b class="itemname">fireEvent</b>
907 (<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>)
913 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
922 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
928 Fires the specified event with the passed parameters (minus the event name).
935 <dl class="detailList">
936 <dt class="heading">Parameters:</dt>
939 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
945 <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>
948 <dd>Variable number of parameters are passed to handlers</dd>
956 <dl class="detailList">
957 <dt class="heading">Returns:</dt>
959 <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>
975 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
981 <tr class="method-row config-row-alt0 expandable notInherited">
982 <td class="micon"><a class="exi" href="#expand"> </a></td>
986 <a id="Roo.dd.DragDrop-method-function toString() {
988 }" name=".function toString() {
991 <div class="fixedFont">
992 <span class="attributes"></span><b class="itemname">function toString() {
1011 <div class="short">toString method</div>
1028 <dl class="detailList">
1029 <dt class="heading">Returns:</dt>
1031 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
1045 <td class="msource">
1053 <tr class="method-row config-row-alt1 expandable notInherited">
1054 <td class="micon"><a class="exi" href="#expand"> </a></td>
1058 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
1059 <div class="fixedFont">
1060 <span class="attributes"></span><b class="itemname">getDragEl</b>
1068 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1077 <div class="short">Returns a reference to the actual element to drag.</div>
1083 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
1094 <dl class="detailList">
1095 <dt class="heading">Returns:</dt>
1097 <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>
1111 <td class="msource">
1119 <tr class="method-row config-row-alt0 expandable notInherited">
1120 <td class="micon"><a class="exi" href="#expand"> </a></td>
1124 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
1125 <div class="fixedFont">
1126 <span class="attributes"></span><b class="itemname">getEl</b>
1134 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1143 <div class="short">Returns a reference to the linked element</div>
1149 Returns a reference to the linked element
1160 <dl class="detailList">
1161 <dt class="heading">Returns:</dt>
1163 <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>
1177 <td class="msource">
1185 <tr class="method-row config-row-alt1 expandable">
1186 <td class="micon"><a class="exi" href="#expand"> </a></td>
1190 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1191 <div class="fixedFont">
1192 <span class="attributes"></span><b class="itemname">hasListener</b>
1194 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1200 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1209 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1215 Checks to see if this object has any listeners for a specified event
1222 <dl class="detailList">
1223 <dt class="heading">Parameters:</dt>
1226 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1229 <dd>The name of the event to check for</dd>
1237 <dl class="detailList">
1238 <dt class="heading">Returns:</dt>
1240 <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>
1254 <td class="msource">
1256 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1262 <tr class="method-row config-row-alt0 expandable notInherited">
1263 <td class="micon"><a class="exi" href="#expand"> </a></td>
1267 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
1268 <div class="fixedFont">
1269 <span class="attributes"></span><b class="itemname">init</b>
1271 (<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>)
1278 <div class="short">Sets up the DragDrop object.</div>
1284 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1291 <dl class="detailList">
1292 <dt class="heading">Parameters:</dt>
1298 <dd>the id of the linked element</dd>
1301 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1304 <dd>the group of related items</dd>
1307 <span class="fixedFont">object</span> <b>config</b>
1310 <dd>configuration attributes</dd>
1328 <td class="msource">
1336 <tr class="method-row config-row-alt1 expandable notInherited">
1337 <td class="micon"><a class="exi" href="#expand"> </a></td>
1341 <a id="Roo.dd.DragDrop-method-initTarget" name=".initTarget"></a>
1342 <div class="fixedFont">
1343 <span class="attributes"></span><b class="itemname">initTarget</b>
1345 (<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>)
1352 <div class="short">Initializes Targeting functionality only.</div>
1358 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1365 <dl class="detailList">
1366 <dt class="heading">Parameters:</dt>
1372 <dd>the id of the linked element</dd>
1375 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1378 <dd>the group of related items</dd>
1381 <span class="fixedFont">object</span> <b>config</b>
1384 <dd>configuration attributes</dd>
1402 <td class="msource">
1410 <tr class="method-row config-row-alt0 expandable notInherited">
1411 <td class="micon"><a class="exi" href="#expand"> </a></td>
1415 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
1416 <div class="fixedFont">
1417 <span class="attributes"></span><b class="itemname">isLocked</b>
1434 <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>
1440 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.)
1451 <dl class="detailList">
1452 <dt class="heading">Returns:</dt>
1454 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
1468 <td class="msource">
1476 <tr class="method-row config-row-alt1 expandable notInherited">
1477 <td class="micon"><a class="exi" href="#expand"> </a></td>
1481 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
1482 <div class="fixedFont">
1483 <span class="attributes"></span><b class="itemname">isTarget</b>
1492 <div class="short">By default, all insances can be a drop target.</div>
1498 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
1519 <td class="msource">
1527 <tr class="method-row config-row-alt0 expandable notInherited">
1528 <td class="micon"><a class="exi" href="#expand"> </a></td>
1532 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
1533 <div class="fixedFont">
1534 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1536 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1551 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1557 Checks the tag exclusion list to see if this click should be ignored
1564 <dl class="detailList">
1565 <dt class="heading">Parameters:</dt>
1568 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1571 <dd>the HTMLElement to evaluate</dd>
1579 <dl class="detailList">
1580 <dt class="heading">Returns:</dt>
1582 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
1596 <td class="msource">
1604 <tr class="method-row config-row-alt1 expandable notInherited">
1605 <td class="micon"><a class="exi" href="#expand"> </a></td>
1609 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
1610 <div class="fixedFont">
1611 <span class="attributes"></span><b class="itemname">lock</b>
1620 <div class="short">Lock this instance</div>
1647 <td class="msource">
1655 <tr class="method-row config-row-alt0 expandable">
1656 <td class="micon"><a class="exi" href="#expand"> </a></td>
1660 <a id="Roo.util.Observable-method-on" name=".on"></a>
1661 <div class="fixedFont">
1662 <span class="attributes"></span><b class="itemname">on</b>
1664 (<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>)
1671 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1677 Appends an event handler to this element (shorthand for addListener)
1684 <dl class="detailList">
1685 <dt class="heading">Parameters:</dt>
1688 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1691 <dd>The type of event to listen for</dd>
1694 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1697 <dd>The method the event invokes</dd>
1700 <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>
1703 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1706 <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>
1727 <td class="msource">
1729 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1735 <tr class="method-row config-row-alt1 expandable notInherited">
1736 <td class="micon"><a class="exi" href="#expand"> </a></td>
1740 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
1741 <div class="fixedFont">
1742 <span class="attributes"></span><b class="itemname">onAvailable</b>
1751 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
1757 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
1778 <td class="msource">
1786 <tr class="method-row config-row-alt0 expandable notInherited">
1787 <td class="micon"><a class="exi" href="#expand"> </a></td>
1791 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
1792 <div class="fixedFont">
1793 <span class="attributes"></span><b class="itemname">onDrag</b>
1795 (Event <B><i>e</i></B>)
1802 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
1808 Abstract method called during the onMouseMove event while dragging an<br/>object.
1815 <dl class="detailList">
1816 <dt class="heading">Parameters:</dt>
1819 <span class="fixedFont">Event</span> <b>e</b>
1822 <dd>the mousemove event</dd>
1840 <td class="msource">
1848 <tr class="method-row config-row-alt1 expandable notInherited">
1849 <td class="micon"><a class="exi" href="#expand"> </a></td>
1853 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
1854 <div class="fixedFont">
1855 <span class="attributes"></span><b class="itemname">onDragDrop</b>
1857 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1864 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
1870 Abstract method called when this item is dropped on another DragDrop<br/>obj
1877 <dl class="detailList">
1878 <dt class="heading">Parameters:</dt>
1881 <span class="fixedFont">Event</span> <b>e</b>
1884 <dd>the mouseup event</dd>
1887 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1890 <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>
1908 <td class="msource">
1916 <tr class="method-row config-row-alt0 expandable notInherited">
1917 <td class="micon"><a class="exi" href="#expand"> </a></td>
1921 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
1922 <div class="fixedFont">
1923 <span class="attributes"></span><b class="itemname">onDragEnter</b>
1925 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1932 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
1938 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
1945 <dl class="detailList">
1946 <dt class="heading">Parameters:</dt>
1949 <span class="fixedFont">Event</span> <b>e</b>
1952 <dd>the mousemove event</dd>
1955 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
1958 <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>
1976 <td class="msource">
1984 <tr class="method-row config-row-alt1 expandable notInherited">
1985 <td class="micon"><a class="exi" href="#expand"> </a></td>
1989 <a id="Roo.dd.DragDrop-method-onDragOut" name=".onDragOut"></a>
1990 <div class="fixedFont">
1991 <span class="attributes"></span><b class="itemname">onDragOut</b>
1993 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2000 <div class="short">Abstract method called when we are no longer hovering over an element</div>
2006 Abstract method called when we are no longer hovering over an element
2013 <dl class="detailList">
2014 <dt class="heading">Parameters:</dt>
2017 <span class="fixedFont">Event</span> <b>e</b>
2020 <dd>the mousemove event</dd>
2023 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2026 <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>
2044 <td class="msource">
2052 <tr class="method-row config-row-alt0 expandable notInherited">
2053 <td class="micon"><a class="exi" href="#expand"> </a></td>
2057 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
2058 <div class="fixedFont">
2059 <span class="attributes"></span><b class="itemname">onDragOver</b>
2061 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2068 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2074 Abstract method called when this element is hovering over another<br/>DragDrop obj
2081 <dl class="detailList">
2082 <dt class="heading">Parameters:</dt>
2085 <span class="fixedFont">Event</span> <b>e</b>
2088 <dd>the mousemove event</dd>
2091 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2094 <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>
2112 <td class="msource">
2120 <tr class="method-row config-row-alt1 expandable notInherited">
2121 <td class="micon"><a class="exi" href="#expand"> </a></td>
2125 <a id="Roo.dd.DragDrop-method-onInvalidDrop" name=".onInvalidDrop"></a>
2126 <div class="fixedFont">
2127 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2129 (Event <B><i>e</i></B>)
2136 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2142 Abstract method called when this item is dropped on an area with no<br/>drop target
2149 <dl class="detailList">
2150 <dt class="heading">Parameters:</dt>
2153 <span class="fixedFont">Event</span> <b>e</b>
2156 <dd>the mouseup event</dd>
2174 <td class="msource">
2182 <tr class="method-row config-row-alt0 expandable notInherited">
2183 <td class="micon"><a class="exi" href="#expand"> </a></td>
2187 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
2188 <div class="fixedFont">
2189 <span class="attributes"></span><b class="itemname">onMouseDown</b>
2191 (Event <B><i>e</i></B>)
2198 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2204 Event handler that fires when a drag/drop obj gets a mousedown
2211 <dl class="detailList">
2212 <dt class="heading">Parameters:</dt>
2215 <span class="fixedFont">Event</span> <b>e</b>
2218 <dd>the mousedown event</dd>
2236 <td class="msource">
2244 <tr class="method-row config-row-alt1 expandable notInherited">
2245 <td class="micon"><a class="exi" href="#expand"> </a></td>
2249 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
2250 <div class="fixedFont">
2251 <span class="attributes"></span><b class="itemname">onMouseUp</b>
2253 (Event <B><i>e</i></B>)
2260 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2266 Event handler that fires when a drag/drop obj gets a mouseup
2273 <dl class="detailList">
2274 <dt class="heading">Parameters:</dt>
2277 <span class="fixedFont">Event</span> <b>e</b>
2280 <dd>the mouseup event</dd>
2298 <td class="msource">
2306 <tr class="method-row config-row-alt0 expandable notInherited">
2307 <td class="micon"><a class="exi" href="#expand"> </a></td>
2311 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
2312 <div class="fixedFont">
2313 <span class="attributes"></span><b class="itemname">padding</b>
2322 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
2328 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
2349 <td class="msource">
2357 <tr class="method-row config-row-alt1 expandable">
2358 <td class="micon"><a class="exi" href="#expand"> </a></td>
2362 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2363 <div class="fixedFont">
2364 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2373 <div class="short">Removes all listeners for this object</div>
2379 Removes all listeners for this object
2400 <td class="msource">
2402 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2408 <tr class="method-row config-row-alt0 expandable notInherited">
2409 <td class="micon"><a class="exi" href="#expand"> </a></td>
2413 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
2414 <div class="fixedFont">
2415 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
2417 (string <B><i>sGroup</i></B>)
2424 <div class="short">Remove's this instance from the supplied interaction group</div>
2430 Remove's this instance from the supplied interaction group
2437 <dl class="detailList">
2438 <dt class="heading">Parameters:</dt>
2441 <span class="fixedFont">string</span> <b>sGroup</b>
2444 <dd>The group to drop</dd>
2462 <td class="msource">
2470 <tr class="method-row config-row-alt1 expandable notInherited">
2471 <td class="micon"><a class="exi" href="#expand"> </a></td>
2475 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
2476 <div class="fixedFont">
2477 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
2479 (string <B><i>cssClass</i></B>)
2486 <div class="short">Unsets an invalid css class</div>
2492 Unsets an invalid css class
2499 <dl class="detailList">
2500 <dt class="heading">Parameters:</dt>
2503 <span class="fixedFont">string</span> <b>cssClass</b>
2506 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2524 <td class="msource">
2532 <tr class="method-row config-row-alt0 expandable notInherited">
2533 <td class="micon"><a class="exi" href="#expand"> </a></td>
2537 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
2538 <div class="fixedFont">
2539 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2541 (string <B><i>id</i></B>)
2548 <div class="short">Unsets an invalid handle id</div>
2554 Unsets an invalid handle id
2561 <dl class="detailList">
2562 <dt class="heading">Parameters:</dt>
2565 <span class="fixedFont">string</span> <b>id</b>
2568 <dd>the id of the element to re-enable</dd>
2586 <td class="msource">
2594 <tr class="method-row config-row-alt1 expandable notInherited">
2595 <td class="micon"><a class="exi" href="#expand"> </a></td>
2599 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
2600 <div class="fixedFont">
2601 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2603 (string <B><i>tagName</i></B>)
2610 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2616 Unsets an excluded tag name set by addInvalidHandleType
2623 <dl class="detailList">
2624 <dt class="heading">Parameters:</dt>
2627 <span class="fixedFont">string</span> <b>tagName</b>
2630 <dd>the type of element to unexclude</dd>
2648 <td class="msource">
2656 <tr class="method-row config-row-alt0 expandable">
2657 <td class="micon"><a class="exi" href="#expand"> </a></td>
2661 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2662 <div class="fixedFont">
2663 <span class="attributes"></span><b class="itemname">removeListener</b>
2665 (<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>)
2672 <div class="short">Removes a listener</div>
2685 <dl class="detailList">
2686 <dt class="heading">Parameters:</dt>
2689 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2692 <dd>The type of event to listen for</dd>
2695 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2698 <dd>The handler to remove</dd>
2701 <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>
2704 <dd>(optional) The scope (this object) for the handler</dd>
2722 <td class="msource">
2724 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2730 <tr class="method-row config-row-alt1 expandable notInherited">
2731 <td class="micon"><a class="exi" href="#expand"> </a></td>
2735 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
2736 <div class="fixedFont">
2737 <span class="attributes"></span><b class="itemname">resetConstraints</b>
2739 (boolean <B><i>maintainOffset</i></B>)
2746 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
2752 resetConstraints must be called if you manually reposition a dd element.
2759 <dl class="detailList">
2760 <dt class="heading">Parameters:</dt>
2763 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
2784 <td class="msource">
2792 <tr class="method-row config-row-alt0 expandable notInherited">
2793 <td class="micon"><a class="exi" href="#expand"> </a></td>
2797 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
2798 <div class="fixedFont">
2799 <span class="attributes"></span><b class="itemname">setDragElId</b>
2808 <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>
2814 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
2821 <dl class="detailList">
2822 <dt class="heading">Parameters:</dt>
2828 <dd>{string} the id of the element that will be used to initiate the drag</dd>
2846 <td class="msource">
2854 <tr class="method-row config-row-alt1 expandable notInherited">
2855 <td class="micon"><a class="exi" href="#expand"> </a></td>
2859 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
2860 <div class="fixedFont">
2861 <span class="attributes"></span><b class="itemname">setHandleElId</b>
2870 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
2876 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.
2883 <dl class="detailList">
2884 <dt class="heading">Parameters:</dt>
2890 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
2908 <td class="msource">
2916 <tr class="method-row config-row-alt0 expandable notInherited">
2917 <td class="micon"><a class="exi" href="#expand"> </a></td>
2921 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
2922 <div class="fixedFont">
2923 <span class="attributes"></span><b class="itemname">setInitPosition</b>
2925 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
2932 <div class="short">Stores the initial placement of the linked element.</div>
2938 Stores the initial placement of the linked element.
2945 <dl class="detailList">
2946 <dt class="heading">Parameters:</dt>
2949 <span class="fixedFont">int</span> <b>diffX</b>
2952 <dd>the X offset, default 0</dd>
2955 <span class="fixedFont">int</span> <b>diffY</b>
2958 <dd>the Y offset, default 0</dd>
2976 <td class="msource">
2984 <tr class="method-row config-row-alt1 expandable notInherited">
2985 <td class="micon"><a class="exi" href="#expand"> </a></td>
2989 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
2990 <div class="fixedFont">
2991 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
3000 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3006 Allows you to set an element outside of the linked element as a drag<br/>handle
3013 <dl class="detailList">
3014 <dt class="heading">Parameters:</dt>
3020 <dd>the id of the element that will be used to initiate the drag</dd>
3038 <td class="msource">
3046 <tr class="method-row config-row-alt0 expandable notInherited">
3047 <td class="micon"><a class="exi" href="#expand"> </a></td>
3051 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
3052 <div class="fixedFont">
3053 <span class="attributes"></span><b class="itemname">setPadding</b>
3055 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3062 <div class="short">Configures the padding for the target zone in px.</div>
3068 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.
3075 <dl class="detailList">
3076 <dt class="heading">Parameters:</dt>
3079 <span class="fixedFont">int</span> <b>iTop</b>
3085 <span class="fixedFont">int</span> <b>iRight</b>
3091 <span class="fixedFont">int</span> <b>iBot</b>
3097 <span class="fixedFont">int</span> <b>iLeft</b>
3118 <td class="msource">
3126 <tr class="method-row config-row-alt1 expandable notInherited">
3127 <td class="micon"><a class="exi" href="#expand"> </a></td>
3131 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
3132 <div class="fixedFont">
3133 <span class="attributes"></span><b class="itemname">setXConstraint</b>
3135 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3142 <div class="short">By default, the element can be dragged any place on the screen.</div>
3148 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.
3155 <dl class="detailList">
3156 <dt class="heading">Parameters:</dt>
3159 <span class="fixedFont">int</span> <b>iLeft</b>
3162 <dd>the number of pixels the element can move to the left</dd>
3165 <span class="fixedFont">int</span> <b>iRight</b>
3168 <dd>the number of pixels the element can move to the<br/>right</dd>
3171 <span class="fixedFont">int</span> <b>iTickSize</b>
3174 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3192 <td class="msource">
3200 <tr class="method-row config-row-alt0 expandable notInherited">
3201 <td class="micon"><a class="exi" href="#expand"> </a></td>
3205 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
3206 <div class="fixedFont">
3207 <span class="attributes"></span><b class="itemname">setYConstraint</b>
3209 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
3216 <div class="short">By default, the element can be dragged any place on the screen.</div>
3222 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.
3229 <dl class="detailList">
3230 <dt class="heading">Parameters:</dt>
3233 <span class="fixedFont">int</span> <b>iUp</b>
3236 <dd>the number of pixels the element can move up</dd>
3239 <span class="fixedFont">int</span> <b>iDown</b>
3242 <dd>the number of pixels the element can move down</dd>
3245 <span class="fixedFont">int</span> <b>iTickSize</b>
3248 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
3266 <td class="msource">
3274 <tr class="method-row config-row-alt1 expandable notInherited">
3275 <td class="micon"><a class="exi" href="#expand"> </a></td>
3279 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
3280 <div class="fixedFont">
3281 <span class="attributes"></span><b class="itemname">startDrag</b>
3283 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
3290 <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>
3296 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
3303 <dl class="detailList">
3304 <dt class="heading">Parameters:</dt>
3307 <span class="fixedFont">int</span> <b>X</b>
3310 <dd>click location</dd>
3313 <span class="fixedFont">int</span> <b>Y</b>
3316 <dd>click location</dd>
3334 <td class="msource">
3342 <tr class="method-row config-row-alt0 expandable">
3343 <td class="micon"><a class="exi" href="#expand"> </a></td>
3347 <a id="Roo.util.Observable-method-un" name=".un"></a>
3348 <div class="fixedFont">
3349 <span class="attributes"></span><b class="itemname">un</b>
3351 (<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>)
3358 <div class="short">Removes a listener (shorthand for removeListener)</div>
3364 Removes a listener (shorthand for removeListener)
3371 <dl class="detailList">
3372 <dt class="heading">Parameters:</dt>
3375 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3378 <dd>The type of event to listen for</dd>
3381 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3384 <dd>The handler to remove</dd>
3387 <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>
3390 <dd>(optional) The scope (this object) for the handler</dd>
3408 <td class="msource">
3410 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3416 <tr class="method-row config-row-alt1 expandable notInherited">
3417 <td class="micon"><a class="exi" href="#expand"> </a></td>
3421 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
3422 <div class="fixedFont">
3423 <span class="attributes"></span><b class="itemname">unlock</b>
3432 <div class="short">Unlock this instace</div>
3459 <td class="msource">
3467 <tr class="method-row config-row-alt0 expandable notInherited">
3468 <td class="micon"><a class="exi" href="#expand"> </a></td>
3472 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
3473 <div class="fixedFont">
3474 <span class="attributes"></span><b class="itemname">unreg</b>
3483 <div class="short">Remove all drag and drop hooks for this element</div>
3489 Remove all drag and drop hooks for this element
3510 <td class="msource">
3521 <!-- ============================== events summary / details ======================== -->
3524 <a id="Roo.dd.DragDrop-events"></a>
3530 <table cellspacing="0" class="member-table">
3531 <caption class="Empty">Events - Has None</caption>
3542 <!-- ============================== footer ================================= -->
3543 <div class="fineprint" style="clear:both">
3545 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed May 02 2012 14:21:08 GMT+0800 (HKT)
3547 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob