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>
152 <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>
160 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
176 <!-- ============================== public properties ==================== -->
180 <a id="Roo.dd.DDProxy-props"></a>
188 <table cellspacing="0" class="member-table">
189 <caption>Public Properties </caption>
191 <th class="sig-header" colspan="2">Property</th>
192 <th class="sig-header">Description</th>
193 <th class="msource-header">Defined By</th>
203 <tr class="property-row config-row-alt0 notInherited">
205 <a class="exi" href="#expand"> </a>
208 <a id="Roo.dd.DDProxy-prop-dragElId" name=".dragElId"></a>
209 <div class="fixedFont">
210 <span class="attributes">Roo.dd.DDProxy.</span><b class="itemname">dragElId</b> :
211 <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
219 The default drag frame div id
227 The default drag frame div id
243 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
244 <tr class="property-row alt">
251 <!-- ============================== methods summary / details ======================== -->
254 <a id="Roo.dd.DDProxy-methods"></a>
255 <!-- constructor?? -->
262 <!-- then dynamics first -->
269 <table cellspacing="0" class="member-table">
270 <caption>Public Methods</caption>
272 <th class="sig-header" colspan="2">Method</th>
273 <th class="msource-header">Defined By</th>
283 <tr class="method-row config-row-alt0 expandable notInherited">
284 <td class="micon"><a class="exi" href="#expand"> </a></td>
288 <a id="Roo.dd-method-DDProxy" name=".DDProxy"></a>
289 <div class="fixedFont">
290 <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DDProxy</b>
292 (<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>)
300 <div class="short">Create a new Roo.dd.DDProxy</div>
307 Create a new Roo.dd.DDProxy
310 <dl class="detailList">
311 <dt class="heading">Parameters:</dt>
314 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
317 <dd>the id of the linked html element</dd>
320 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
323 <dd>the group of related DragDrop objects</dd>
326 <span class="fixedFont">object</span> <b>config</b>
329 <dd>an object containing configurable attributes<br/> Valid properties for DDProxy in addition to those in DragDrop:<br/> resizeFrame, centerFrame, dragElId</dd>
353 <tr class="method-row config-row-alt1 expandable">
354 <td class="micon"><a class="exi" href="#expand"> </a></td>
358 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
359 <div class="fixedFont">
360 <span class="attributes"></span><b class="itemname">addEvents</b>
362 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
369 <div class="short">Used to define events on this Observable</div>
375 Used to define events on this Observable
382 <dl class="detailList">
383 <dt class="heading">Parameters:</dt>
386 <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>
389 <dd>The object with the events defined</dd>
409 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
415 <tr class="method-row config-row-alt0 expandable">
416 <td class="micon"><a class="exi" href="#expand"> </a></td>
420 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass" name=".addInvalidHandleClass"></a>
421 <div class="fixedFont">
422 <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
424 (string <B><i>cssClass</i></B>)
431 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
437 Lets you specify a css class of elements that will not initiate a drag
444 <dl class="detailList">
445 <dt class="heading">Parameters:</dt>
448 <span class="fixedFont">string</span> <b>cssClass</b>
451 <dd>the class of the elements you wish to ignore</dd>
471 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
477 <tr class="method-row config-row-alt1 expandable">
478 <td class="micon"><a class="exi" href="#expand"> </a></td>
482 <a id="Roo.dd.DragDrop-method-addInvalidHandleId" name=".addInvalidHandleId"></a>
483 <div class="fixedFont">
484 <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
486 (string <B><i>id</i></B>)
493 <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>
499 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
506 <dl class="detailList">
507 <dt class="heading">Parameters:</dt>
510 <span class="fixedFont">string</span> <b>id</b>
513 <dd>the element id of the element you wish to ignore</dd>
533 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
539 <tr class="method-row config-row-alt0 expandable">
540 <td class="micon"><a class="exi" href="#expand"> </a></td>
544 <a id="Roo.dd.DragDrop-method-addInvalidHandleType" name=".addInvalidHandleType"></a>
545 <div class="fixedFont">
546 <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
548 (string <B><i>tagName</i></B>)
555 <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
561 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.
568 <dl class="detailList">
569 <dt class="heading">Parameters:</dt>
572 <span class="fixedFont">string</span> <b>tagName</b>
575 <dd>the type of element to exclude</dd>
595 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
601 <tr class="method-row config-row-alt1 expandable">
602 <td class="micon"><a class="exi" href="#expand"> </a></td>
606 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
607 <div class="fixedFont">
608 <span class="attributes"></span><b class="itemname">addListener</b>
610 (<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>)
617 <div class="short">Appends an event handler to this component</div>
623 Appends an event handler to this component
630 <dl class="detailList">
631 <dt class="heading">Parameters:</dt>
634 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
637 <dd>The type of event to listen for</dd>
640 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
643 <dd>The method the event invokes</dd>
646 <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>
649 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
652 <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>
655 <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>
675 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
681 <tr class="method-row config-row-alt0 expandable">
682 <td class="micon"><a class="exi" href="#expand"> </a></td>
686 <a id="Roo.dd.DragDrop-method-addToGroup" name=".addToGroup"></a>
687 <div class="fixedFont">
688 <span class="attributes"></span><b class="itemname">addToGroup</b>
690 (<B><i>sGroup</i></B>)
697 <div class="short">Add this instance to a group of related drag/drop objects.</div>
703 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.
710 <dl class="detailList">
711 <dt class="heading">Parameters:</dt>
717 <dd>{string} the name of the group</dd>
737 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
743 <tr class="method-row config-row-alt1 expandable">
744 <td class="micon"><a class="exi" href="#expand"> </a></td>
748 <a id="Roo.dd.DD-method-alignElWithMouse" name=".alignElWithMouse"></a>
749 <div class="fixedFont">
750 <span class="attributes"></span><b class="itemname">alignElWithMouse</b>
752 (<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>)
759 <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>
765 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.
772 <dl class="detailList">
773 <dt class="heading">Parameters:</dt>
776 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>el</b>
779 <dd>the element to move</dd>
782 <span class="fixedFont">int</span> <b>iPageX</b>
785 <dd>the X coordinate of the mousedown or drag event</dd>
788 <span class="fixedFont">int</span> <b>iPageY</b>
791 <dd>the Y coordinate of the mousedown or drag event</dd>
811 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
817 <tr class="method-row config-row-alt0 expandable">
818 <td class="micon"><a class="exi" href="#expand"> </a></td>
822 <a id="Roo.dd.DragDrop-method-applyConfig" name=".applyConfig"></a>
823 <div class="fixedFont">
824 <span class="attributes"></span><b class="itemname">applyConfig</b>
833 <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
839 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.
862 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
868 <tr class="method-row config-row-alt1 expandable">
869 <td class="micon"><a class="exi" href="#expand"> </a></td>
873 <a id="Roo.dd.DD-method-autoOffset" name=".autoOffset"></a>
874 <div class="fixedFont">
875 <span class="attributes"></span><b class="itemname">autoOffset</b>
877 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
884 <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>
890 Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked
897 <dl class="detailList">
898 <dt class="heading">Parameters:</dt>
901 <span class="fixedFont">int</span> <b>iPageX</b>
904 <dd>the X coordinate of the click</dd>
907 <span class="fixedFont">int</span> <b>iPageY</b>
910 <dd>the Y coordinate of the click</dd>
930 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
936 <tr class="method-row config-row-alt0 expandable">
937 <td class="micon"><a class="exi" href="#expand"> </a></td>
941 <a id="Roo.dd.DD-method-cachePosition" name=".cachePosition"></a>
942 <div class="fixedFont">
943 <span class="attributes"></span><b class="itemname">cachePosition</b>
945 (<B><i>iPageX</i></B>, <B><i>iPageY</i></B>)
952 <div class="short">Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.</div>
958 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.
965 <dl class="detailList">
966 <dt class="heading">Parameters:</dt>
972 <dd>the current x position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
978 <dd>the current y position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
998 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
1004 <tr class="method-row config-row-alt1 expandable">
1005 <td class="micon"><a class="exi" href="#expand"> </a></td>
1009 <a id="Roo.dd.DragDrop-method-clearConstraints" name=".clearConstraints"></a>
1010 <div class="fixedFont">
1011 <span class="attributes"></span><b class="itemname">clearConstraints</b>
1020 <div class="short">Clears any constraints applied to this instance.</div>
1026 Clears any constraints applied to this instance. Also clears ticks<br/>since they can't exist independent of a constraint at this time.
1047 <td class="msource">
1049 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1055 <tr class="method-row config-row-alt0 expandable">
1056 <td class="micon"><a class="exi" href="#expand"> </a></td>
1060 <a id="Roo.dd.DragDrop-method-clearTicks" name=".clearTicks"></a>
1061 <div class="fixedFont">
1062 <span class="attributes"></span><b class="itemname">clearTicks</b>
1071 <div class="short">Clears any tick interval defined for this instance</div>
1077 Clears any tick interval defined for this instance
1098 <td class="msource">
1100 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1106 <tr class="method-row config-row-alt1 expandable notInherited">
1107 <td class="micon"><a class="exi" href="#expand"> </a></td>
1111 <a id="Roo.dd.DDProxy-method-createFrame" name=".createFrame"></a>
1112 <div class="fixedFont">
1113 <span class="attributes"></span><b class="itemname">createFrame</b>
1122 <div class="short">Creates the proxy element if it does not yet exist</div>
1128 Creates the proxy element if it does not yet exist
1149 <td class="msource">
1157 <tr class="method-row config-row-alt0 expandable">
1158 <td class="micon"><a class="exi" href="#expand"> </a></td>
1162 <a id="Roo.dd.DragDrop-method-endDrag" name=".endDrag"></a>
1163 <div class="fixedFont">
1164 <span class="attributes"></span><b class="itemname">endDrag</b>
1166 (Event <B><i>e</i></B>)
1173 <div class="short">Fired when we are done dragging the object</div>
1179 Fired when we are done dragging the object
1186 <dl class="detailList">
1187 <dt class="heading">Parameters:</dt>
1190 <span class="fixedFont">Event</span> <b>e</b>
1193 <dd>the mouseup event</dd>
1211 <td class="msource">
1213 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1219 <tr class="method-row config-row-alt1 expandable">
1220 <td class="micon"><a class="exi" href="#expand"> </a></td>
1224 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1225 <div class="fixedFont">
1226 <span class="attributes"></span><b class="itemname">fireEvent</b>
1228 (<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>)
1234 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1243 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1249 Fires the specified event with the passed parameters (minus the event name).
1256 <dl class="detailList">
1257 <dt class="heading">Parameters:</dt>
1260 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1266 <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>
1269 <dd>Variable number of parameters are passed to handlers</dd>
1277 <dl class="detailList">
1278 <dt class="heading">Returns:</dt>
1280 <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>
1294 <td class="msource">
1296 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1302 <tr class="method-row config-row-alt0 expandable">
1303 <td class="micon"><a class="exi" href="#expand"> </a></td>
1307 <a id="Roo.dd.DragDrop-method-function toString() {
1309 }" name=".function toString() {
1312 <div class="fixedFont">
1313 <span class="attributes"></span><b class="itemname">function toString() {
1332 <div class="short">toString method</div>
1349 <dl class="detailList">
1350 <dt class="heading">Returns:</dt>
1352 <dd><span class="fixedFont">string</span> string representation of the dd obj</dd>
1366 <td class="msource">
1368 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1374 <tr class="method-row config-row-alt1 expandable">
1375 <td class="micon"><a class="exi" href="#expand"> </a></td>
1379 <a id="Roo.dd.DragDrop-method-getDragEl" name=".getDragEl"></a>
1380 <div class="fixedFont">
1381 <span class="attributes"></span><b class="itemname">getDragEl</b>
1389 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1398 <div class="short">Returns a reference to the actual element to drag.</div>
1404 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
1415 <dl class="detailList">
1416 <dt class="heading">Returns:</dt>
1418 <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>
1432 <td class="msource">
1434 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1440 <tr class="method-row config-row-alt0 expandable">
1441 <td class="micon"><a class="exi" href="#expand"> </a></td>
1445 <a id="Roo.dd.DragDrop-method-getEl" name=".getEl"></a>
1446 <div class="fixedFont">
1447 <span class="attributes"></span><b class="itemname">getEl</b>
1455 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1464 <div class="short">Returns a reference to the linked element</div>
1470 Returns a reference to the linked element
1481 <dl class="detailList">
1482 <dt class="heading">Returns:</dt>
1484 <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>
1498 <td class="msource">
1500 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1506 <tr class="method-row config-row-alt1 expandable">
1507 <td class="micon"><a class="exi" href="#expand"> </a></td>
1511 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1512 <div class="fixedFont">
1513 <span class="attributes"></span><b class="itemname">hasListener</b>
1515 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1521 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1530 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1536 Checks to see if this object has any listeners for a specified event
1543 <dl class="detailList">
1544 <dt class="heading">Parameters:</dt>
1547 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1550 <dd>The name of the event to check for</dd>
1558 <dl class="detailList">
1559 <dt class="heading">Returns:</dt>
1561 <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>
1575 <td class="msource">
1577 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1583 <tr class="method-row config-row-alt0 expandable">
1584 <td class="micon"><a class="exi" href="#expand"> </a></td>
1588 <a id="Roo.dd.DragDrop-method-init" name=".init"></a>
1589 <div class="fixedFont">
1590 <span class="attributes"></span><b class="itemname">init</b>
1592 (<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>)
1599 <div class="short">Sets up the DragDrop object.</div>
1605 Sets up the DragDrop object. Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1612 <dl class="detailList">
1613 <dt class="heading">Parameters:</dt>
1619 <dd>the id of the linked element</dd>
1622 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1625 <dd>the group of related items</dd>
1628 <span class="fixedFont">object</span> <b>config</b>
1631 <dd>configuration attributes</dd>
1649 <td class="msource">
1651 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1657 <tr class="method-row config-row-alt1 expandable notInherited">
1658 <td class="micon"><a class="exi" href="#expand"> </a></td>
1662 <a id="Roo.dd.DDProxy-method-initFrame" name=".initFrame"></a>
1663 <div class="fixedFont">
1664 <span class="attributes"></span><b class="itemname">initFrame</b>
1673 <div class="short">Initialization for the drag frame element.</div>
1679 Initialization for the drag frame element. Must be called in the<br/>constructor of all subclasses
1700 <td class="msource">
1708 <tr class="method-row config-row-alt0 expandable">
1709 <td class="micon"><a class="exi" href="#expand"> </a></td>
1713 <a id="Roo.dd.DragDrop-method-initTarget" name=".initTarget"></a>
1714 <div class="fixedFont">
1715 <span class="attributes"></span><b class="itemname">initTarget</b>
1717 (<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>)
1724 <div class="short">Initializes Targeting functionality only.</div>
1730 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1737 <dl class="detailList">
1738 <dt class="heading">Parameters:</dt>
1744 <dd>the id of the linked element</dd>
1747 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>sGroup</b>
1750 <dd>the group of related items</dd>
1753 <span class="fixedFont">object</span> <b>config</b>
1756 <dd>configuration attributes</dd>
1774 <td class="msource">
1776 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1782 <tr class="method-row config-row-alt1 expandable">
1783 <td class="micon"><a class="exi" href="#expand"> </a></td>
1787 <a id="Roo.dd.DragDrop-method-isLocked" name=".isLocked"></a>
1788 <div class="fixedFont">
1789 <span class="attributes"></span><b class="itemname">isLocked</b>
1806 <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>
1812 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.)
1823 <dl class="detailList">
1824 <dt class="heading">Returns:</dt>
1826 <dd><span class="fixedFont">boolean</span> true if this obj or all drag/drop is locked, else<br/>false</dd>
1840 <td class="msource">
1842 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1848 <tr class="method-row config-row-alt0 expandable">
1849 <td class="micon"><a class="exi" href="#expand"> </a></td>
1853 <a id="Roo.dd.DragDrop-method-isTarget" name=".isTarget"></a>
1854 <div class="fixedFont">
1855 <span class="attributes"></span><b class="itemname">isTarget</b>
1864 <div class="short">By default, all insances can be a drop target.</div>
1870 By default, all insances can be a drop target. This can be disabled by<br/>setting isTarget to false.
1891 <td class="msource">
1893 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1899 <tr class="method-row config-row-alt1 expandable">
1900 <td class="micon"><a class="exi" href="#expand"> </a></td>
1904 <a id="Roo.dd.DragDrop-method-isValidHandleChild" name=".isValidHandleChild"></a>
1905 <div class="fixedFont">
1906 <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1908 (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1923 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1929 Checks the tag exclusion list to see if this click should be ignored
1936 <dl class="detailList">
1937 <dt class="heading">Parameters:</dt>
1940 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1943 <dd>the HTMLElement to evaluate</dd>
1951 <dl class="detailList">
1952 <dt class="heading">Returns:</dt>
1954 <dd><span class="fixedFont">boolean</span> true if this is a valid tag type, false if not</dd>
1968 <td class="msource">
1970 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1976 <tr class="method-row config-row-alt0 expandable">
1977 <td class="micon"><a class="exi" href="#expand"> </a></td>
1981 <a id="Roo.dd.DragDrop-method-lock" name=".lock"></a>
1982 <div class="fixedFont">
1983 <span class="attributes"></span><b class="itemname">lock</b>
1992 <div class="short">Lock this instance</div>
2019 <td class="msource">
2021 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2027 <tr class="method-row config-row-alt1 expandable">
2028 <td class="micon"><a class="exi" href="#expand"> </a></td>
2032 <a id="Roo.util.Observable-method-on" name=".on"></a>
2033 <div class="fixedFont">
2034 <span class="attributes"></span><b class="itemname">on</b>
2036 (<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>)
2043 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2049 Appends an event handler to this element (shorthand for addListener)
2056 <dl class="detailList">
2057 <dt class="heading">Parameters:</dt>
2060 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2063 <dd>The type of event to listen for</dd>
2066 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2069 <dd>The method the event invokes</dd>
2072 <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>
2075 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2078 <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>
2099 <td class="msource">
2101 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2107 <tr class="method-row config-row-alt0 expandable">
2108 <td class="micon"><a class="exi" href="#expand"> </a></td>
2112 <a id="Roo.dd.DragDrop-method-onAvailable" name=".onAvailable"></a>
2113 <div class="fixedFont">
2114 <span class="attributes"></span><b class="itemname">onAvailable</b>
2123 <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
2129 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
2150 <td class="msource">
2152 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2158 <tr class="method-row config-row-alt1 expandable">
2159 <td class="micon"><a class="exi" href="#expand"> </a></td>
2163 <a id="Roo.dd.DragDrop-method-onDrag" name=".onDrag"></a>
2164 <div class="fixedFont">
2165 <span class="attributes"></span><b class="itemname">onDrag</b>
2167 (Event <B><i>e</i></B>)
2174 <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
2180 Abstract method called during the onMouseMove event while dragging an<br/>object.
2187 <dl class="detailList">
2188 <dt class="heading">Parameters:</dt>
2191 <span class="fixedFont">Event</span> <b>e</b>
2194 <dd>the mousemove event</dd>
2212 <td class="msource">
2214 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2220 <tr class="method-row config-row-alt0 expandable">
2221 <td class="micon"><a class="exi" href="#expand"> </a></td>
2225 <a id="Roo.dd.DragDrop-method-onDragDrop" name=".onDragDrop"></a>
2226 <div class="fixedFont">
2227 <span class="attributes"></span><b class="itemname">onDragDrop</b>
2229 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2236 <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
2242 Abstract method called when this item is dropped on another DragDrop<br/>obj
2249 <dl class="detailList">
2250 <dt class="heading">Parameters:</dt>
2253 <span class="fixedFont">Event</span> <b>e</b>
2256 <dd>the mouseup event</dd>
2259 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2262 <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>
2280 <td class="msource">
2282 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2288 <tr class="method-row config-row-alt1 expandable">
2289 <td class="micon"><a class="exi" href="#expand"> </a></td>
2293 <a id="Roo.dd.DragDrop-method-onDragEnter" name=".onDragEnter"></a>
2294 <div class="fixedFont">
2295 <span class="attributes"></span><b class="itemname">onDragEnter</b>
2297 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2304 <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
2310 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
2317 <dl class="detailList">
2318 <dt class="heading">Parameters:</dt>
2321 <span class="fixedFont">Event</span> <b>e</b>
2324 <dd>the mousemove event</dd>
2327 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2330 <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>
2348 <td class="msource">
2350 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2356 <tr class="method-row config-row-alt0 expandable">
2357 <td class="micon"><a class="exi" href="#expand"> </a></td>
2361 <a id="Roo.dd.DragDrop-method-onDragOut" name=".onDragOut"></a>
2362 <div class="fixedFont">
2363 <span class="attributes"></span><b class="itemname">onDragOut</b>
2365 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2372 <div class="short">Abstract method called when we are no longer hovering over an element</div>
2378 Abstract method called when we are no longer hovering over an element
2385 <dl class="detailList">
2386 <dt class="heading">Parameters:</dt>
2389 <span class="fixedFont">Event</span> <b>e</b>
2392 <dd>the mousemove event</dd>
2395 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2398 <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>
2416 <td class="msource">
2418 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2424 <tr class="method-row config-row-alt1 expandable">
2425 <td class="micon"><a class="exi" href="#expand"> </a></td>
2429 <a id="Roo.dd.DragDrop-method-onDragOver" name=".onDragOver"></a>
2430 <div class="fixedFont">
2431 <span class="attributes"></span><b class="itemname">onDragOver</b>
2433 (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2440 <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2446 Abstract method called when this element is hovering over another<br/>DragDrop obj
2453 <dl class="detailList">
2454 <dt class="heading">Parameters:</dt>
2457 <span class="fixedFont">Event</span> <b>e</b>
2460 <dd>the mousemove event</dd>
2463 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span> <b>id</b>
2466 <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>
2484 <td class="msource">
2486 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2492 <tr class="method-row config-row-alt0 expandable">
2493 <td class="micon"><a class="exi" href="#expand"> </a></td>
2497 <a id="Roo.dd.DragDrop-method-onInvalidDrop" name=".onInvalidDrop"></a>
2498 <div class="fixedFont">
2499 <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2501 (Event <B><i>e</i></B>)
2508 <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2514 Abstract method called when this item is dropped on an area with no<br/>drop target
2521 <dl class="detailList">
2522 <dt class="heading">Parameters:</dt>
2525 <span class="fixedFont">Event</span> <b>e</b>
2528 <dd>the mouseup event</dd>
2546 <td class="msource">
2548 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2554 <tr class="method-row config-row-alt1 expandable">
2555 <td class="micon"><a class="exi" href="#expand"> </a></td>
2559 <a id="Roo.dd.DragDrop-method-onMouseDown" name=".onMouseDown"></a>
2560 <div class="fixedFont">
2561 <span class="attributes"></span><b class="itemname">onMouseDown</b>
2563 (Event <B><i>e</i></B>)
2570 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2576 Event handler that fires when a drag/drop obj gets a mousedown
2583 <dl class="detailList">
2584 <dt class="heading">Parameters:</dt>
2587 <span class="fixedFont">Event</span> <b>e</b>
2590 <dd>the mousedown event</dd>
2608 <td class="msource">
2610 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2616 <tr class="method-row config-row-alt0 expandable">
2617 <td class="micon"><a class="exi" href="#expand"> </a></td>
2621 <a id="Roo.dd.DragDrop-method-onMouseUp" name=".onMouseUp"></a>
2622 <div class="fixedFont">
2623 <span class="attributes"></span><b class="itemname">onMouseUp</b>
2625 (Event <B><i>e</i></B>)
2632 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2638 Event handler that fires when a drag/drop obj gets a mouseup
2645 <dl class="detailList">
2646 <dt class="heading">Parameters:</dt>
2649 <span class="fixedFont">Event</span> <b>e</b>
2652 <dd>the mouseup event</dd>
2670 <td class="msource">
2672 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2678 <tr class="method-row config-row-alt1 expandable">
2679 <td class="micon"><a class="exi" href="#expand"> </a></td>
2683 <a id="Roo.dd.DragDrop-method-padding" name=".padding"></a>
2684 <div class="fixedFont">
2685 <span class="attributes"></span><b class="itemname">padding</b>
2694 <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
2700 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
2721 <td class="msource">
2723 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2729 <tr class="method-row config-row-alt0 expandable">
2730 <td class="micon"><a class="exi" href="#expand"> </a></td>
2734 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2735 <div class="fixedFont">
2736 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2745 <div class="short">Removes all listeners for this object</div>
2751 Removes all listeners for this object
2772 <td class="msource">
2774 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2780 <tr class="method-row config-row-alt1 expandable">
2781 <td class="micon"><a class="exi" href="#expand"> </a></td>
2785 <a id="Roo.dd.DragDrop-method-removeFromGroup" name=".removeFromGroup"></a>
2786 <div class="fixedFont">
2787 <span class="attributes"></span><b class="itemname">removeFromGroup</b>
2789 (string <B><i>sGroup</i></B>)
2796 <div class="short">Remove's this instance from the supplied interaction group</div>
2802 Remove's this instance from the supplied interaction group
2809 <dl class="detailList">
2810 <dt class="heading">Parameters:</dt>
2813 <span class="fixedFont">string</span> <b>sGroup</b>
2816 <dd>The group to drop</dd>
2834 <td class="msource">
2836 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2842 <tr class="method-row config-row-alt0 expandable">
2843 <td class="micon"><a class="exi" href="#expand"> </a></td>
2847 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass" name=".removeInvalidHandleClass"></a>
2848 <div class="fixedFont">
2849 <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
2851 (string <B><i>cssClass</i></B>)
2858 <div class="short">Unsets an invalid css class</div>
2864 Unsets an invalid css class
2871 <dl class="detailList">
2872 <dt class="heading">Parameters:</dt>
2875 <span class="fixedFont">string</span> <b>cssClass</b>
2878 <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2896 <td class="msource">
2898 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2904 <tr class="method-row config-row-alt1 expandable">
2905 <td class="micon"><a class="exi" href="#expand"> </a></td>
2909 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId" name=".removeInvalidHandleId"></a>
2910 <div class="fixedFont">
2911 <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2913 (string <B><i>id</i></B>)
2920 <div class="short">Unsets an invalid handle id</div>
2926 Unsets an invalid handle id
2933 <dl class="detailList">
2934 <dt class="heading">Parameters:</dt>
2937 <span class="fixedFont">string</span> <b>id</b>
2940 <dd>the id of the element to re-enable</dd>
2958 <td class="msource">
2960 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2966 <tr class="method-row config-row-alt0 expandable">
2967 <td class="micon"><a class="exi" href="#expand"> </a></td>
2971 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType" name=".removeInvalidHandleType"></a>
2972 <div class="fixedFont">
2973 <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2975 (string <B><i>tagName</i></B>)
2982 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2988 Unsets an excluded tag name set by addInvalidHandleType
2995 <dl class="detailList">
2996 <dt class="heading">Parameters:</dt>
2999 <span class="fixedFont">string</span> <b>tagName</b>
3002 <dd>the type of element to unexclude</dd>
3020 <td class="msource">
3022 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3028 <tr class="method-row config-row-alt1 expandable">
3029 <td class="micon"><a class="exi" href="#expand"> </a></td>
3033 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
3034 <div class="fixedFont">
3035 <span class="attributes"></span><b class="itemname">removeListener</b>
3037 (<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>)
3044 <div class="short">Removes a listener</div>
3057 <dl class="detailList">
3058 <dt class="heading">Parameters:</dt>
3061 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3064 <dd>The type of event to listen for</dd>
3067 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3070 <dd>The handler to remove</dd>
3073 <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>
3076 <dd>(optional) The scope (this object) for the handler</dd>
3094 <td class="msource">
3096 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3102 <tr class="method-row config-row-alt0 expandable">
3103 <td class="micon"><a class="exi" href="#expand"> </a></td>
3107 <a id="Roo.dd.DragDrop-method-resetConstraints" name=".resetConstraints"></a>
3108 <div class="fixedFont">
3109 <span class="attributes"></span><b class="itemname">resetConstraints</b>
3111 (boolean <B><i>maintainOffset</i></B>)
3118 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
3124 resetConstraints must be called if you manually reposition a dd element.
3131 <dl class="detailList">
3132 <dt class="heading">Parameters:</dt>
3135 <span class="fixedFont">boolean</span> <b>maintainOffset</b>
3156 <td class="msource">
3158 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3164 <tr class="method-row config-row-alt1 expandable">
3165 <td class="micon"><a class="exi" href="#expand"> </a></td>
3169 <a id="Roo.dd.DD-method-setDelta" name=".setDelta"></a>
3170 <div class="fixedFont">
3171 <span class="attributes"></span><b class="itemname">setDelta</b>
3173 (int <B><i>iDeltaX</i></B>, int <B><i>iDeltaY</i></B>)
3180 <div class="short">Sets the pointer offset.</div>
3186 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)
3193 <dl class="detailList">
3194 <dt class="heading">Parameters:</dt>
3197 <span class="fixedFont">int</span> <b>iDeltaX</b>
3200 <dd>the distance from the left</dd>
3203 <span class="fixedFont">int</span> <b>iDeltaY</b>
3206 <dd>the distance from the top</dd>
3224 <td class="msource">
3226 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
3232 <tr class="method-row config-row-alt0 expandable">
3233 <td class="micon"><a class="exi" href="#expand"> </a></td>
3237 <a id="Roo.dd.DragDrop-method-setDragElId" name=".setDragElId"></a>
3238 <div class="fixedFont">
3239 <span class="attributes"></span><b class="itemname">setDragElId</b>
3248 <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>
3254 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
3261 <dl class="detailList">
3262 <dt class="heading">Parameters:</dt>
3268 <dd>{string} the id of the element that will be used to initiate the drag</dd>
3286 <td class="msource">
3288 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3294 <tr class="method-row config-row-alt1 expandable">
3295 <td class="micon"><a class="exi" href="#expand"> </a></td>
3299 <a id="Roo.dd.DD-method-setDragElPos" name=".setDragElPos"></a>
3300 <div class="fixedFont">
3301 <span class="attributes"></span><b class="itemname">setDragElPos</b>
3303 (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
3310 <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>
3316 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.
3323 <dl class="detailList">
3324 <dt class="heading">Parameters:</dt>
3327 <span class="fixedFont">int</span> <b>iPageX</b>
3330 <dd>the X coordinate of the mousedown or drag event</dd>
3333 <span class="fixedFont">int</span> <b>iPageY</b>
3336 <dd>the Y coordinate of the mousedown or drag event</dd>
3354 <td class="msource">
3356 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
3362 <tr class="method-row config-row-alt0 expandable">
3363 <td class="micon"><a class="exi" href="#expand"> </a></td>
3367 <a id="Roo.dd.DragDrop-method-setHandleElId" name=".setHandleElId"></a>
3368 <div class="fixedFont">
3369 <span class="attributes"></span><b class="itemname">setHandleElId</b>
3378 <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
3384 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.
3391 <dl class="detailList">
3392 <dt class="heading">Parameters:</dt>
3398 <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
3416 <td class="msource">
3418 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3424 <tr class="method-row config-row-alt1 expandable">
3425 <td class="micon"><a class="exi" href="#expand"> </a></td>
3429 <a id="Roo.dd.DragDrop-method-setInitPosition" name=".setInitPosition"></a>
3430 <div class="fixedFont">
3431 <span class="attributes"></span><b class="itemname">setInitPosition</b>
3433 (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
3440 <div class="short">Stores the initial placement of the linked element.</div>
3446 Stores the initial placement of the linked element.
3453 <dl class="detailList">
3454 <dt class="heading">Parameters:</dt>
3457 <span class="fixedFont">int</span> <b>diffX</b>
3460 <dd>the X offset, default 0</dd>
3463 <span class="fixedFont">int</span> <b>diffY</b>
3466 <dd>the Y offset, default 0</dd>
3484 <td class="msource">
3486 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3492 <tr class="method-row config-row-alt0 expandable">
3493 <td class="micon"><a class="exi" href="#expand"> </a></td>
3497 <a id="Roo.dd.DragDrop-method-setOuterHandleElId" name=".setOuterHandleElId"></a>
3498 <div class="fixedFont">
3499 <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
3508 <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3514 Allows you to set an element outside of the linked element as a drag<br/>handle
3521 <dl class="detailList">
3522 <dt class="heading">Parameters:</dt>
3528 <dd>the id of the element that will be used to initiate the drag</dd>
3546 <td class="msource">
3548 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3554 <tr class="method-row config-row-alt1 expandable">
3555 <td class="micon"><a class="exi" href="#expand"> </a></td>
3559 <a id="Roo.dd.DragDrop-method-setPadding" name=".setPadding"></a>
3560 <div class="fixedFont">
3561 <span class="attributes"></span><b class="itemname">setPadding</b>
3563 (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3570 <div class="short">Configures the padding for the target zone in px.</div>
3576 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.
3583 <dl class="detailList">
3584 <dt class="heading">Parameters:</dt>
3587 <span class="fixedFont">int</span> <b>iTop</b>
3593 <span class="fixedFont">int</span> <b>iRight</b>
3599 <span class="fixedFont">int</span> <b>iBot</b>
3605 <span class="fixedFont">int</span> <b>iLeft</b>
3626 <td class="msource">
3628 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3634 <tr class="method-row config-row-alt0 expandable">
3635 <td class="micon"><a class="exi" href="#expand"> </a></td>
3639 <a id="Roo.dd.DragDrop-method-setXConstraint" name=".setXConstraint"></a>
3640 <div class="fixedFont">
3641 <span class="attributes"></span><b class="itemname">setXConstraint</b>
3643 (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3650 <div class="short">By default, the element can be dragged any place on the screen.</div>
3656 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.
3663 <dl class="detailList">
3664 <dt class="heading">Parameters:</dt>
3667 <span class="fixedFont">int</span> <b>iLeft</b>
3670 <dd>the number of pixels the element can move to the left</dd>
3673 <span class="fixedFont">int</span> <b>iRight</b>
3676 <dd>the number of pixels the element can move to the<br/>right</dd>
3679 <span class="fixedFont">int</span> <b>iTickSize</b>
3682 <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3700 <td class="msource">
3702 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3708 <tr class="method-row config-row-alt1 expandable">
3709 <td class="micon"><a class="exi" href="#expand"> </a></td>
3713 <a id="Roo.dd.DragDrop-method-setYConstraint" name=".setYConstraint"></a>
3714 <div class="fixedFont">
3715 <span class="attributes"></span><b class="itemname">setYConstraint</b>
3717 (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
3724 <div class="short">By default, the element can be dragged any place on the screen.</div>
3730 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.
3737 <dl class="detailList">
3738 <dt class="heading">Parameters:</dt>
3741 <span class="fixedFont">int</span> <b>iUp</b>
3744 <dd>the number of pixels the element can move up</dd>
3747 <span class="fixedFont">int</span> <b>iDown</b>
3750 <dd>the number of pixels the element can move down</dd>
3753 <span class="fixedFont">int</span> <b>iTickSize</b>
3756 <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
3774 <td class="msource">
3776 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3782 <tr class="method-row config-row-alt0 expandable">
3783 <td class="micon"><a class="exi" href="#expand"> </a></td>
3787 <a id="Roo.dd.DragDrop-method-startDrag" name=".startDrag"></a>
3788 <div class="fixedFont">
3789 <span class="attributes"></span><b class="itemname">startDrag</b>
3791 (int <B><i>X</i></B>, int <B><i>Y</i></B>)
3798 <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>
3804 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
3811 <dl class="detailList">
3812 <dt class="heading">Parameters:</dt>
3815 <span class="fixedFont">int</span> <b>X</b>
3818 <dd>click location</dd>
3821 <span class="fixedFont">int</span> <b>Y</b>
3824 <dd>click location</dd>
3842 <td class="msource">
3844 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3850 <tr class="method-row config-row-alt1 expandable">
3851 <td class="micon"><a class="exi" href="#expand"> </a></td>
3855 <a id="Roo.util.Observable-method-un" name=".un"></a>
3856 <div class="fixedFont">
3857 <span class="attributes"></span><b class="itemname">un</b>
3859 (<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>)
3866 <div class="short">Removes a listener (shorthand for removeListener)</div>
3872 Removes a listener (shorthand for removeListener)
3879 <dl class="detailList">
3880 <dt class="heading">Parameters:</dt>
3883 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3886 <dd>The type of event to listen for</dd>
3889 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3892 <dd>The handler to remove</dd>
3895 <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>
3898 <dd>(optional) The scope (this object) for the handler</dd>
3916 <td class="msource">
3918 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3924 <tr class="method-row config-row-alt0 expandable">
3925 <td class="micon"><a class="exi" href="#expand"> </a></td>
3929 <a id="Roo.dd.DragDrop-method-unlock" name=".unlock"></a>
3930 <div class="fixedFont">
3931 <span class="attributes"></span><b class="itemname">unlock</b>
3940 <div class="short">Unlock this instace</div>
3967 <td class="msource">
3969 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3975 <tr class="method-row config-row-alt1 expandable">
3976 <td class="micon"><a class="exi" href="#expand"> </a></td>
3980 <a id="Roo.dd.DragDrop-method-unreg" name=".unreg"></a>
3981 <div class="fixedFont">
3982 <span class="attributes"></span><b class="itemname">unreg</b>
3991 <div class="short">Remove all drag and drop hooks for this element</div>
3997 Remove all drag and drop hooks for this element
4018 <td class="msource">
4020 <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4029 <!-- ============================== events summary / details ======================== -->
4032 <a id="Roo.dd.DDProxy-events"></a>
4038 <table cellspacing="0" class="member-table">
4039 <caption class="Empty">Events - Has None</caption>
4050 <!-- ============================== footer ================================= -->
4051 <div class="fineprint" style="clear:both">
4053 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed May 02 2012 11:27:36 GMT+0800 (HKT)
4055 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob