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.DDProxy</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.DDProxy-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.DDProxy-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.DDProxy-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.DDProxy-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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DDProxy
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_dd_DDProxy.js.html">Roo/dd/DDProxy.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">DDProxy</td></tr>
74 <tr><td class="label">Subclasses:</td><td class="hd-info">
75 <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>
83 <tr><td class="label">Extends:</td><td class="hd-info">
84 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
92 <!-- ============================== class summary ========================== -->
93 <div class="description">
94 A DragDrop implementation that inserts an empty, bordered div into<br/>the document that follows the cursor during drag operations. At the time of<br/>the click, the frame div is resized to the dimensions of the linked html<br/>element, and moved to the exact location of the linked element.<br/><br/>References to the "frame" element refer to the single proxy element that<br/>was created to be dragged in place of all DDProxy elements on the<br/>page.
98 <!-- ============================== Class comment block... ========================== -->
100 <div class="comments">
101 <b>Class Comments / Notes</B> =>
102 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DDProxy';">[Add Your comment/notes about this class]</u>
104 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
105 src="/blog.php/GtkDjsComments/Roo.dd.DDProxy.html"></iframe>
110 <!-- ============================== config options ========================== -->
115 <div class="hr"></div>
116 <a id="Roo.dd.DDProxy-configs"></a>
122 <table cellspacing="0" class="member-table">
123 <caption>Config Options (Usually are also Properties)</caption>
127 <th class="sig-header" colspan="2">Options</th>
129 <th class="msource-header">Defined By</th>
136 <tr class="config-row expandable config-row-alt0">
137 <td class="micon"><a class="exi" href="#expand"> </a></td>
140 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
141 <div class="fixedFont">
142 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
148 <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>
153 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>
163 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
179 <!-- ============================== public properties ==================== -->
183 <a id="Roo.dd.DDProxy-props"></a>
191 <table cellspacing="0" class="member-table">
192 <caption>Public Properties </caption>
194 <th class="sig-header" colspan="2">Property</th>
195 <th class="sig-header">Description</th>
196 <th class="msource-header">Defined By</th>
206 <tr class="property-row config-row-alt0 notInherited">
208 <a class="exi" href="#expand"> </a>
211 <a id="Roo.dd.DDProxy-prop-dragElId" name=".dragElId"></a>
212 <div class="fixedFont">
213 <span class="attributes">Roo.dd.DDProxy.</span><b class="itemname">dragElId</b> :
214 <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
222 The default drag frame div id
230 The default drag frame div id
246 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
247 <tr class="property-row alt">
254 <!-- ============================== methods summary / details ======================== -->
257 <a id="Roo.dd.DDProxy-methods"></a>
258 <!-- constructor?? -->
265 <!-- then dynamics first -->
272 <table cellspacing="0" class="member-table">
273 <caption>Public Methods</caption>
275 <th class="sig-header" colspan="2">Method</th>
276 <th class="msource-header">Defined By</th>
286 <tr class="method-row config-row-alt0 expandable notInherited">
287 <td class="micon"><a class="exi" href="#expand"> </a></td>
291 <a id="Roo.dd-method-DDProxy" name=".DDProxy"></a>
292 <div class="fixedFont">
293 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DDProxy</b>
295 (<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>)
303 <div class="short">Create a new Roo.dd.DDProxy</div>
310 Create a new Roo.dd.DDProxy
313 <dl class="detailList">
314 <dt class="heading">Parameters:</dt>
317 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
320 <dd>the id of the linked html element</dd>
323 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
326 <dd>the group of related DragDrop objects</dd>
329 <span class="fixedFont">object</span> <b>config</b>
332 <dd>an object containing configurable attributes<br/> Valid properties for DDProxy in addition to those in DragDrop:<br/> resizeFrame, centerFrame, dragElId</dd>
356 <tr class="method-row config-row-alt1 expandable">
357 <td class="micon"><a class="exi" href="#expand"> </a></td>
361 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
362 <div class="fixedFont">
363 <span class="attributes"></span><b class="itemname">addEvents</b>
365 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
372 <div class="short">Used to define events on this Observable</div>
378 Used to define events on this Observable
385 <dl class="detailList">
386 <dt class="heading">Parameters:</dt>
389 <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>
392 <dd>The object with the events defined</dd>
412 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
418 <tr class="method-row config-row-alt0 expandable">
419 <td class="micon"><a class="exi" href="#expand"> </a></td>
423 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
424 <div class="fixedFont">
425 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
427 (string <B><i>cssClass</i></B>)
434 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
440 Lets you specify a css class of elements that will not initiate a drag
447 <dl class="detailList">
448 <dt class="heading">Parameters:</dt>
451 <span class="fixedFont">string</span> <b>cssClass</b>
454 <dd>the class of the elements 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-alt1 expandable">
481 <td class="micon"><a class="exi" href="#expand"> </a></td>
485 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
486 <div class="fixedFont">
487 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
489 (string <B><i>id</i></B>)
496 <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>
502 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
509 <dl class="detailList">
510 <dt class="heading">Parameters:</dt>
513 <span class="fixedFont">string</span> <b>id</b>
516 <dd>the element id of the element you wish to ignore</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-alt0 expandable">
543 <td class="micon"><a class="exi" href="#expand"> </a></td>
547 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
548 <div class="fixedFont">
549 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
551 (string <B><i>tagName</i></B>)
558 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
564 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.
571 <dl class="detailList">
572 <dt class="heading">Parameters:</dt>
575 <span class="fixedFont">string</span> <b>tagName</b>
578 <dd>the type of element to exclude</dd>
598 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
604 <tr class="method-row config-row-alt1 expandable">
605 <td class="micon"><a class="exi" href="#expand"> </a></td>
609 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
610 <div class="fixedFont">
611 <span class="attributes"></span><b class="itemname">addListener</b>
613 (<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>)
620 <div class="short">Appends an event handler to this component</div>
626 Appends an event handler to this component
633 <dl class="detailList">
634 <dt class="heading">Parameters:</dt>
637 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
640 <dd>The type of event to listen for</dd>
643 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
646 <dd>The method the event invokes</dd>
649 <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>
652 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
655 <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>
658 <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>
678 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
684 <tr class="method-row config-row-alt0 expandable">
685 <td class="micon"><a class="exi" href="#expand"> </a></td>
689 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
690 <div class="fixedFont">
691 <span class="attributes"></span><b class="itemname">addToGroup</b>
693 (<B><i>sGroup</i></B>)
700 <div class="short">Add this instance to a group of related drag/drop objects.</div>
706 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.
713 <dl class="detailList">
714 <dt class="heading">Parameters:</dt>
720 <dd>{string} the name of the group</dd>
740 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
746 <tr class="method-row config-row-alt1 expandable">
747 <td class="micon"><a class="exi" href="#expand"> </a></td>
751 <a id="Roo.dd.DD-method-alignElWithMouse" name=".alignElWithMouse"></a>
752 <div class="fixedFont">
753 <span class="attributes"></span><b class="itemname">alignElWithMouse</b>
755 (<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>)
762 <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>
768 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.
775 <dl class="detailList">
776 <dt class="heading">Parameters:</dt>
779 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>el</b>
782 <dd>the element to move</dd>
785 <span class="fixedFont">int</span> <b>iPageX</b>
788 <dd>the X coordinate of the mousedown or drag event</dd>
791 <span class="fixedFont">int</span> <b>iPageY</b>
794 <dd>the Y coordinate of the mousedown or drag event</dd>
814 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
820 <tr class="method-row config-row-alt0 expandable">
821 <td class="micon"><a class="exi" href="#expand"> </a></td>
825 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
826 <div class="fixedFont">
827 <span class="attributes"></span><b class="itemname">applyConfig</b>
836 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
842 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.
865 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
871 <tr class="method-row config-row-alt1 expandable">
872 <td class="micon"><a class="exi" href="#expand"> </a></td>
876 <a id="Roo.dd.DD-method-autoOffset" name=".autoOffset"></a>
877 <div class="fixedFont">
878 <span class="attributes"></span><b class="itemname">autoOffset</b>
880 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
887 <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>
893 Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked
900 <dl class="detailList">
901 <dt class="heading">Parameters:</dt>
904 <span class="fixedFont">int</span> <b>iPageX</b>
907 <dd>the X coordinate of the click</dd>
910 <span class="fixedFont">int</span> <b>iPageY</b>
913 <dd>the Y coordinate of the click</dd>
933 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
939 <tr class="method-row config-row-alt0 expandable">
940 <td class="micon"><a class="exi" href="#expand"> </a></td>
944 <a id="Roo.dd.DD-method-cachePosition" name=".cachePosition"></a>
945 <div class="fixedFont">
946 <span class="attributes"></span><b class="itemname">cachePosition</b>
948 (<B><i>iPageX</i></B>, <B><i>iPageY</i></B>)
955 <div class="short">Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.</div>
961 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.
968 <dl class="detailList">
969 <dt class="heading">Parameters:</dt>
975 <dd>the current x position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
981 <dd>the current y position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
1001 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
1007 <tr class="method-row config-row-alt1 expandable">
1008 <td class="micon"><a class="exi" href="#expand"> </a></td>
1012 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
1013 <div class="fixedFont">
1014 <span class="attributes"></span><b class="itemname">clearConstraints</b>
1023 <div class="short">Clears any constraints applied to this instance.</div>
1029 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
1050 <td class="msource">
1052 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1058 <tr class="method-row config-row-alt0 expandable">
1059 <td class="micon"><a class="exi" href="#expand"> </a></td>
1063 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
1064 <div class="fixedFont">
1065 <span class="attributes"></span><b class="itemname">clearTicks</b>
1074 <div class="short">Clears any tick interval defined for this instance</div>
1080 Clears any tick interval defined for this instance
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-alt1 expandable notInherited">
1110 <td class="micon"><a class="exi" href="#expand"> </a></td>
1114 <a id="Roo.dd.DDProxy-method-createFrame" name=".createFrame"></a>
1115 <div class="fixedFont">
1116 <span class="attributes"></span><b class="itemname">createFrame</b>
1125 <div class="short">Creates the proxy element if it does not yet exist</div>
1131 Creates the proxy element if it does not yet exist
1152 <td class="msource">
1160 <tr class="method-row config-row-alt0 expandable">
1161 <td class="micon"><a class="exi" href="#expand"> </a></td>
1165 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
1166 <div class="fixedFont">
1167 <span class="attributes"></span><b class="itemname">endDrag</b>
1169 (Event <B><i>e</i></B>)
1176 <div class="short">Fired when we are done dragging the object</div>
1182 Fired when we are done dragging the object
1189 <dl class="detailList">
1190 <dt class="heading">Parameters:</dt>
1193 <span class="fixedFont">Event</span> <b>e</b>
1196 <dd>the mouseup event</dd>
1214 <td class="msource">
1216 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1222 <tr class="method-row config-row-alt1 expandable">
1223 <td class="micon"><a class="exi" href="#expand"> </a></td>
1227 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1228 <div class="fixedFont">
1229 <span class="attributes"></span><b class="itemname">fireEvent</b>
1231 (<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>)
1237 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1246 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1252 Fires the specified event with the passed parameters (minus the event name).
1259 <dl class="detailList">
1260 <dt class="heading">Parameters:</dt>
1263 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1269 <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>
1272 <dd>Variable number of parameters are passed to handlers</dd>
1280 <dl class="detailList">
1281 <dt class="heading">Returns:</dt>
1283 <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>
1297 <td class="msource">
1299 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1305 <tr class="method-row config-row-alt0 expandable">
1306 <td class="micon"><a class="exi" href="#expand"> </a></td>
1310 <a id="Roo.dd.DragDrop-method-function toString() {
1312 }" name=".function toString() {
1315 <div class="fixedFont">
1316 <span class="attributes"></span><b class="itemname">function toString() {
1335 <div class="short">toString method</div>
1352 <dl class="detailList">
1353 <dt class="heading">Returns:</dt>
1355 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
1369 <td class="msource">
1371 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1377 <tr class="method-row config-row-alt1 expandable">
1378 <td class="micon"><a class="exi" href="#expand"> </a></td>
1382 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
1383 <div class="fixedFont">
1384 <span class="attributes"></span><b class="itemname">getDragEl</b>
1392 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1401 <div class="short">Returns a reference to the actual element to drag.</div>
1407 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
1418 <dl class="detailList">
1419 <dt class="heading">Returns:</dt>
1421 <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>
1435 <td class="msource">
1437 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1443 <tr class="method-row config-row-alt0 expandable">
1444 <td class="micon"><a class="exi" href="#expand"> </a></td>
1448 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
1449 <div class="fixedFont">
1450 <span class="attributes"></span><b class="itemname">getEl</b>
1458 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1467 <div class="short">Returns a reference to the linked element</div>
1473 Returns a reference to the linked element
1484 <dl class="detailList">
1485 <dt class="heading">Returns:</dt>
1487 <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>
1501 <td class="msource">
1503 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1509 <tr class="method-row config-row-alt1 expandable">
1510 <td class="micon"><a class="exi" href="#expand"> </a></td>
1514 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1515 <div class="fixedFont">
1516 <span class="attributes"></span><b class="itemname">hasListener</b>
1518 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1524 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1533 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1539 Checks to see if this object has any listeners for a specified event
1546 <dl class="detailList">
1547 <dt class="heading">Parameters:</dt>
1550 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1553 <dd>The name of the event to check for</dd>
1561 <dl class="detailList">
1562 <dt class="heading">Returns:</dt>
1564 <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>
1578 <td class="msource">
1580 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1586 <tr class="method-row config-row-alt0 expandable">
1587 <td class="micon"><a class="exi" href="#expand"> </a></td>
1591 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
1592 <div class="fixedFont">
1593 <span class="attributes"></span><b class="itemname">init</b>
1595 (<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>)
1602 <div class="short">Sets up the DragDrop object.</div>
1608 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1615 <dl class="detailList">
1616 <dt class="heading">Parameters:</dt>
1622 <dd>the id of the linked element</dd>
1625 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1628 <dd>the group of related items</dd>
1631 <span class="fixedFont">object</span> <b>config</b>
1634 <dd>configuration attributes</dd>
1652 <td class="msource">
1654 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1660 <tr class="method-row config-row-alt1 expandable notInherited">
1661 <td class="micon"><a class="exi" href="#expand"> </a></td>
1665 <a id="Roo.dd.DDProxy-method-initFrame" name=".initFrame"></a>
1666 <div class="fixedFont">
1667 <span class="attributes"></span><b class="itemname">initFrame</b>
1676 <div class="short">Initialization for the drag frame element.</div>
1682 Initialization for the drag frame element. Must be called in the<br/>constructor of all subclasses
1703 <td class="msource">
1711 <tr class="method-row config-row-alt0 expandable">
1712 <td class="micon"><a class="exi" href="#expand"> </a></td>
1716 <a id="Roo.dd.DragDrop-method-initTarget" name=".initTarget"></a>
1717 <div class="fixedFont">
1718 <span class="attributes"></span><b class="itemname">initTarget</b>
1720 (<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>)
1727 <div class="short">Initializes Targeting functionality only.</div>
1733 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1740 <dl class="detailList">
1741 <dt class="heading">Parameters:</dt>
1747 <dd>the id of the linked element</dd>
1750 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1753 <dd>the group of related items</dd>
1756 <span class="fixedFont">object</span> <b>config</b>
1759 <dd>configuration attributes</dd>
1777 <td class="msource">
1779 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1785 <tr class="method-row config-row-alt1 expandable">
1786 <td class="micon"><a class="exi" href="#expand"> </a></td>
1790 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
1791 <div class="fixedFont">
1792 <span class="attributes"></span><b class="itemname">isLocked</b>
1809 <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>
1815 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.)
1826 <dl class="detailList">
1827 <dt class="heading">Returns:</dt>
1829 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
1843 <td class="msource">
1845 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1851 <tr class="method-row config-row-alt0 expandable">
1852 <td class="micon"><a class="exi" href="#expand"> </a></td>
1856 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
1857 <div class="fixedFont">
1858 <span class="attributes"></span><b class="itemname">isTarget</b>
1867 <div class="short">By default, all insances can be a drop target.</div>
1873 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
1894 <td class="msource">
1896 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1902 <tr class="method-row config-row-alt1 expandable">
1903 <td class="micon"><a class="exi" href="#expand"> </a></td>
1907 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
1908 <div class="fixedFont">
1909 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1911 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1926 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1932 Checks the tag exclusion list to see if this click should be ignored
1939 <dl class="detailList">
1940 <dt class="heading">Parameters:</dt>
1943 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1946 <dd>the HTMLElement to evaluate</dd>
1954 <dl class="detailList">
1955 <dt class="heading">Returns:</dt>
1957 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
1971 <td class="msource">
1973 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1979 <tr class="method-row config-row-alt0 expandable">
1980 <td class="micon"><a class="exi" href="#expand"> </a></td>
1984 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
1985 <div class="fixedFont">
1986 <span class="attributes"></span><b class="itemname">lock</b>
1995 <div class="short">Lock this instance</div>
2022 <td class="msource">
2024 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2030 <tr class="method-row config-row-alt1 expandable">
2031 <td class="micon"><a class="exi" href="#expand"> </a></td>
2035 <a id="Roo.util.Observable-method-on" name=".on"></a>
2036 <div class="fixedFont">
2037 <span class="attributes"></span><b class="itemname">on</b>
2039 (<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>)
2046 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2052 Appends an event handler to this element (shorthand for addListener)
2059 <dl class="detailList">
2060 <dt class="heading">Parameters:</dt>
2063 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2066 <dd>The type of event to listen for</dd>
2069 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2072 <dd>The method the event invokes</dd>
2075 <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>
2078 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2081 <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>
2102 <td class="msource">
2104 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2110 <tr class="method-row config-row-alt0 expandable">
2111 <td class="micon"><a class="exi" href="#expand"> </a></td>
2115 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
2116 <div class="fixedFont">
2117 <span class="attributes"></span><b class="itemname">onAvailable</b>
2126 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
2132 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
2153 <td class="msource">
2155 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2161 <tr class="method-row config-row-alt1 expandable">
2162 <td class="micon"><a class="exi" href="#expand"> </a></td>
2166 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
2167 <div class="fixedFont">
2168 <span class="attributes"></span><b class="itemname">onDrag</b>
2170 (Event <B><i>e</i></B>)
2177 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
2183 Abstract method called during the onMouseMove event while dragging an<br/>object.
2190 <dl class="detailList">
2191 <dt class="heading">Parameters:</dt>
2194 <span class="fixedFont">Event</span> <b>e</b>
2197 <dd>the mousemove event</dd>
2215 <td class="msource">
2217 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2223 <tr class="method-row config-row-alt0 expandable">
2224 <td class="micon"><a class="exi" href="#expand"> </a></td>
2228 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
2229 <div class="fixedFont">
2230 <span class="attributes"></span><b class="itemname">onDragDrop</b>
2232 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2239 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
2245 Abstract method called when this item is dropped on another DragDrop<br/>obj
2252 <dl class="detailList">
2253 <dt class="heading">Parameters:</dt>
2256 <span class="fixedFont">Event</span> <b>e</b>
2259 <dd>the mouseup event</dd>
2262 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2265 <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>
2283 <td class="msource">
2285 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2291 <tr class="method-row config-row-alt1 expandable">
2292 <td class="micon"><a class="exi" href="#expand"> </a></td>
2296 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
2297 <div class="fixedFont">
2298 <span class="attributes"></span><b class="itemname">onDragEnter</b>
2300 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2307 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
2313 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
2320 <dl class="detailList">
2321 <dt class="heading">Parameters:</dt>
2324 <span class="fixedFont">Event</span> <b>e</b>
2327 <dd>the mousemove event</dd>
2330 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2333 <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>
2351 <td class="msource">
2353 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2359 <tr class="method-row config-row-alt0 expandable">
2360 <td class="micon"><a class="exi" href="#expand"> </a></td>
2364 <a id="Roo.dd.DragDrop-method-onDragOut" name=".onDragOut"></a>
2365 <div class="fixedFont">
2366 <span class="attributes"></span><b class="itemname">onDragOut</b>
2368 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2375 <div class="short">Abstract method called when we are no longer hovering over an element</div>
2381 Abstract method called when we are no longer hovering over an element
2388 <dl class="detailList">
2389 <dt class="heading">Parameters:</dt>
2392 <span class="fixedFont">Event</span> <b>e</b>
2395 <dd>the mousemove event</dd>
2398 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2401 <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>
2419 <td class="msource">
2421 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2427 <tr class="method-row config-row-alt1 expandable">
2428 <td class="micon"><a class="exi" href="#expand"> </a></td>
2432 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
2433 <div class="fixedFont">
2434 <span class="attributes"></span><b class="itemname">onDragOver</b>
2436 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2443 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2449 Abstract method called when this element is hovering over another<br/>DragDrop obj
2456 <dl class="detailList">
2457 <dt class="heading">Parameters:</dt>
2460 <span class="fixedFont">Event</span> <b>e</b>
2463 <dd>the mousemove event</dd>
2466 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2469 <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>
2487 <td class="msource">
2489 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2495 <tr class="method-row config-row-alt0 expandable">
2496 <td class="micon"><a class="exi" href="#expand"> </a></td>
2500 <a id="Roo.dd.DragDrop-method-onInvalidDrop" name=".onInvalidDrop"></a>
2501 <div class="fixedFont">
2502 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2504 (Event <B><i>e</i></B>)
2511 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2517 Abstract method called when this item is dropped on an area with no<br/>drop target
2524 <dl class="detailList">
2525 <dt class="heading">Parameters:</dt>
2528 <span class="fixedFont">Event</span> <b>e</b>
2531 <dd>the mouseup event</dd>
2549 <td class="msource">
2551 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2557 <tr class="method-row config-row-alt1 expandable">
2558 <td class="micon"><a class="exi" href="#expand"> </a></td>
2562 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
2563 <div class="fixedFont">
2564 <span class="attributes"></span><b class="itemname">onMouseDown</b>
2566 (Event <B><i>e</i></B>)
2573 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2579 Event handler that fires when a drag/drop obj gets a mousedown
2586 <dl class="detailList">
2587 <dt class="heading">Parameters:</dt>
2590 <span class="fixedFont">Event</span> <b>e</b>
2593 <dd>the mousedown event</dd>
2611 <td class="msource">
2613 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2619 <tr class="method-row config-row-alt0 expandable">
2620 <td class="micon"><a class="exi" href="#expand"> </a></td>
2624 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
2625 <div class="fixedFont">
2626 <span class="attributes"></span><b class="itemname">onMouseUp</b>
2628 (Event <B><i>e</i></B>)
2635 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2641 Event handler that fires when a drag/drop obj gets a mouseup
2648 <dl class="detailList">
2649 <dt class="heading">Parameters:</dt>
2652 <span class="fixedFont">Event</span> <b>e</b>
2655 <dd>the mouseup event</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-alt1 expandable">
2682 <td class="micon"><a class="exi" href="#expand"> </a></td>
2686 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
2687 <div class="fixedFont">
2688 <span class="attributes"></span><b class="itemname">padding</b>
2697 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
2703 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
2724 <td class="msource">
2726 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2732 <tr class="method-row config-row-alt0 expandable">
2733 <td class="micon"><a class="exi" href="#expand"> </a></td>
2737 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2738 <div class="fixedFont">
2739 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2748 <div class="short">Removes all listeners for this object</div>
2754 Removes all listeners for this object
2775 <td class="msource">
2777 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2783 <tr class="method-row config-row-alt1 expandable">
2784 <td class="micon"><a class="exi" href="#expand"> </a></td>
2788 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
2789 <div class="fixedFont">
2790 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
2792 (string <B><i>sGroup</i></B>)
2799 <div class="short">Remove's this instance from the supplied interaction group</div>
2805 Remove's this instance from the supplied interaction group
2812 <dl class="detailList">
2813 <dt class="heading">Parameters:</dt>
2816 <span class="fixedFont">string</span> <b>sGroup</b>
2819 <dd>The group to drop</dd>
2837 <td class="msource">
2839 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2845 <tr class="method-row config-row-alt0 expandable">
2846 <td class="micon"><a class="exi" href="#expand"> </a></td>
2850 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
2851 <div class="fixedFont">
2852 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
2854 (string <B><i>cssClass</i></B>)
2861 <div class="short">Unsets an invalid css class</div>
2867 Unsets an invalid css class
2874 <dl class="detailList">
2875 <dt class="heading">Parameters:</dt>
2878 <span class="fixedFont">string</span> <b>cssClass</b>
2881 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2899 <td class="msource">
2901 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2907 <tr class="method-row config-row-alt1 expandable">
2908 <td class="micon"><a class="exi" href="#expand"> </a></td>
2912 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
2913 <div class="fixedFont">
2914 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2916 (string <B><i>id</i></B>)
2923 <div class="short">Unsets an invalid handle id</div>
2929 Unsets an invalid handle id
2936 <dl class="detailList">
2937 <dt class="heading">Parameters:</dt>
2940 <span class="fixedFont">string</span> <b>id</b>
2943 <dd>the id of the element to re-enable</dd>
2961 <td class="msource">
2963 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2969 <tr class="method-row config-row-alt0 expandable">
2970 <td class="micon"><a class="exi" href="#expand"> </a></td>
2974 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
2975 <div class="fixedFont">
2976 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2978 (string <B><i>tagName</i></B>)
2985 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2991 Unsets an excluded tag name set by addInvalidHandleType
2998 <dl class="detailList">
2999 <dt class="heading">Parameters:</dt>
3002 <span class="fixedFont">string</span> <b>tagName</b>
3005 <dd>the type of element to unexclude</dd>
3023 <td class="msource">
3025 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3031 <tr class="method-row config-row-alt1 expandable">
3032 <td class="micon"><a class="exi" href="#expand"> </a></td>
3036 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
3037 <div class="fixedFont">
3038 <span class="attributes"></span><b class="itemname">removeListener</b>
3040 (<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>)
3047 <div class="short">Removes a listener</div>
3060 <dl class="detailList">
3061 <dt class="heading">Parameters:</dt>
3064 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3067 <dd>The type of event to listen for</dd>
3070 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3073 <dd>The handler to remove</dd>
3076 <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>
3079 <dd>(optional) The scope (this object) for the handler</dd>
3097 <td class="msource">
3099 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3105 <tr class="method-row config-row-alt0 expandable">
3106 <td class="micon"><a class="exi" href="#expand"> </a></td>
3110 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
3111 <div class="fixedFont">
3112 <span class="attributes"></span><b class="itemname">resetConstraints</b>
3114 (boolean <B><i>maintainOffset</i></B>)
3121 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
3127 resetConstraints must be called if you manually reposition a dd element.
3134 <dl class="detailList">
3135 <dt class="heading">Parameters:</dt>
3138 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
3159 <td class="msource">
3161 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3167 <tr class="method-row config-row-alt1 expandable">
3168 <td class="micon"><a class="exi" href="#expand"> </a></td>
3172 <a id="Roo.dd.DD-method-setDelta" name=".setDelta"></a>
3173 <div class="fixedFont">
3174 <span class="attributes"></span><b class="itemname">setDelta</b>
3176 (int <B><i>iDeltaX</i></B>, int <B><i>iDeltaY</i></B>)
3183 <div class="short">Sets the pointer offset.</div>
3189 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)
3196 <dl class="detailList">
3197 <dt class="heading">Parameters:</dt>
3200 <span class="fixedFont">int</span> <b>iDeltaX</b>
3203 <dd>the distance from the left</dd>
3206 <span class="fixedFont">int</span> <b>iDeltaY</b>
3209 <dd>the distance from the top</dd>
3227 <td class="msource">
3229 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
3235 <tr class="method-row config-row-alt0 expandable">
3236 <td class="micon"><a class="exi" href="#expand"> </a></td>
3240 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
3241 <div class="fixedFont">
3242 <span class="attributes"></span><b class="itemname">setDragElId</b>
3251 <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>
3257 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
3264 <dl class="detailList">
3265 <dt class="heading">Parameters:</dt>
3271 <dd>{string} the id of the element that will be used to initiate the drag</dd>
3289 <td class="msource">
3291 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3297 <tr class="method-row config-row-alt1 expandable">
3298 <td class="micon"><a class="exi" href="#expand"> </a></td>
3302 <a id="Roo.dd.DD-method-setDragElPos" name=".setDragElPos"></a>
3303 <div class="fixedFont">
3304 <span class="attributes"></span><b class="itemname">setDragElPos</b>
3306 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
3313 <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>
3319 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.
3326 <dl class="detailList">
3327 <dt class="heading">Parameters:</dt>
3330 <span class="fixedFont">int</span> <b>iPageX</b>
3333 <dd>the X coordinate of the mousedown or drag event</dd>
3336 <span class="fixedFont">int</span> <b>iPageY</b>
3339 <dd>the Y coordinate of the mousedown or drag event</dd>
3357 <td class="msource">
3359 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
3365 <tr class="method-row config-row-alt0 expandable">
3366 <td class="micon"><a class="exi" href="#expand"> </a></td>
3370 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
3371 <div class="fixedFont">
3372 <span class="attributes"></span><b class="itemname">setHandleElId</b>
3381 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
3387 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.
3394 <dl class="detailList">
3395 <dt class="heading">Parameters:</dt>
3401 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
3419 <td class="msource">
3421 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3427 <tr class="method-row config-row-alt1 expandable">
3428 <td class="micon"><a class="exi" href="#expand"> </a></td>
3432 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
3433 <div class="fixedFont">
3434 <span class="attributes"></span><b class="itemname">setInitPosition</b>
3436 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
3443 <div class="short">Stores the initial placement of the linked element.</div>
3449 Stores the initial placement of the linked element.
3456 <dl class="detailList">
3457 <dt class="heading">Parameters:</dt>
3460 <span class="fixedFont">int</span> <b>diffX</b>
3463 <dd>the X offset, default 0</dd>
3466 <span class="fixedFont">int</span> <b>diffY</b>
3469 <dd>the Y offset, default 0</dd>
3487 <td class="msource">
3489 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3495 <tr class="method-row config-row-alt0 expandable">
3496 <td class="micon"><a class="exi" href="#expand"> </a></td>
3500 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
3501 <div class="fixedFont">
3502 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
3511 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3517 Allows you to set an element outside of the linked element as a drag<br/>handle
3524 <dl class="detailList">
3525 <dt class="heading">Parameters:</dt>
3531 <dd>the id of the element that will be used to initiate the drag</dd>
3549 <td class="msource">
3551 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3557 <tr class="method-row config-row-alt1 expandable">
3558 <td class="micon"><a class="exi" href="#expand"> </a></td>
3562 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
3563 <div class="fixedFont">
3564 <span class="attributes"></span><b class="itemname">setPadding</b>
3566 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3573 <div class="short">Configures the padding for the target zone in px.</div>
3579 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.
3586 <dl class="detailList">
3587 <dt class="heading">Parameters:</dt>
3590 <span class="fixedFont">int</span> <b>iTop</b>
3596 <span class="fixedFont">int</span> <b>iRight</b>
3602 <span class="fixedFont">int</span> <b>iBot</b>
3608 <span class="fixedFont">int</span> <b>iLeft</b>
3629 <td class="msource">
3631 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3637 <tr class="method-row config-row-alt0 expandable">
3638 <td class="micon"><a class="exi" href="#expand"> </a></td>
3642 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
3643 <div class="fixedFont">
3644 <span class="attributes"></span><b class="itemname">setXConstraint</b>
3646 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3653 <div class="short">By default, the element can be dragged any place on the screen.</div>
3659 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.
3666 <dl class="detailList">
3667 <dt class="heading">Parameters:</dt>
3670 <span class="fixedFont">int</span> <b>iLeft</b>
3673 <dd>the number of pixels the element can move to the left</dd>
3676 <span class="fixedFont">int</span> <b>iRight</b>
3679 <dd>the number of pixels the element can move to the<br/>right</dd>
3682 <span class="fixedFont">int</span> <b>iTickSize</b>
3685 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3703 <td class="msource">
3705 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3711 <tr class="method-row config-row-alt1 expandable">
3712 <td class="micon"><a class="exi" href="#expand"> </a></td>
3716 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
3717 <div class="fixedFont">
3718 <span class="attributes"></span><b class="itemname">setYConstraint</b>
3720 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
3727 <div class="short">By default, the element can be dragged any place on the screen.</div>
3733 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.
3740 <dl class="detailList">
3741 <dt class="heading">Parameters:</dt>
3744 <span class="fixedFont">int</span> <b>iUp</b>
3747 <dd>the number of pixels the element can move up</dd>
3750 <span class="fixedFont">int</span> <b>iDown</b>
3753 <dd>the number of pixels the element can move down</dd>
3756 <span class="fixedFont">int</span> <b>iTickSize</b>
3759 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
3777 <td class="msource">
3779 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3785 <tr class="method-row config-row-alt0 expandable">
3786 <td class="micon"><a class="exi" href="#expand"> </a></td>
3790 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
3791 <div class="fixedFont">
3792 <span class="attributes"></span><b class="itemname">startDrag</b>
3794 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
3801 <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>
3807 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
3814 <dl class="detailList">
3815 <dt class="heading">Parameters:</dt>
3818 <span class="fixedFont">int</span> <b>X</b>
3821 <dd>click location</dd>
3824 <span class="fixedFont">int</span> <b>Y</b>
3827 <dd>click location</dd>
3845 <td class="msource">
3847 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3853 <tr class="method-row config-row-alt1 expandable">
3854 <td class="micon"><a class="exi" href="#expand"> </a></td>
3858 <a id="Roo.util.Observable-method-un" name=".un"></a>
3859 <div class="fixedFont">
3860 <span class="attributes"></span><b class="itemname">un</b>
3862 (<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>)
3869 <div class="short">Removes a listener (shorthand for removeListener)</div>
3875 Removes a listener (shorthand for removeListener)
3882 <dl class="detailList">
3883 <dt class="heading">Parameters:</dt>
3886 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3889 <dd>The type of event to listen for</dd>
3892 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3895 <dd>The handler to remove</dd>
3898 <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>
3901 <dd>(optional) The scope (this object) for the handler</dd>
3919 <td class="msource">
3921 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3927 <tr class="method-row config-row-alt0 expandable">
3928 <td class="micon"><a class="exi" href="#expand"> </a></td>
3932 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
3933 <div class="fixedFont">
3934 <span class="attributes"></span><b class="itemname">unlock</b>
3943 <div class="short">Unlock this instace</div>
3970 <td class="msource">
3972 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3978 <tr class="method-row config-row-alt1 expandable">
3979 <td class="micon"><a class="exi" href="#expand"> </a></td>
3983 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
3984 <div class="fixedFont">
3985 <span class="attributes"></span><b class="itemname">unreg</b>
3994 <div class="short">Remove all drag and drop hooks for this element</div>
4000 Remove all drag and drop hooks for this element
4021 <td class="msource">
4023 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4032 <!-- ============================== events summary / details ======================== -->
4035 <a id="Roo.dd.DDProxy-events"></a>
4041 <table cellspacing="0" class="member-table">
4042 <caption class="Empty">Events - Has None</caption>
4053 <!-- ============================== footer ================================= -->
4054 <div class="fineprint" style="clear:both">
4056 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
4058 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob