commit extjs-2.2.1
[extjs.git] / docs / output / Ext.dd.DragDropMgr.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.dd.DragDropMgr-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.dd.DragDropMgr-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.dd.DragDropMgr-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                         <a class="bookmark" href="../docs/?class=Ext.dd.DragDropMgr"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7         </div>
8                 <h1>Class Ext.dd.DragDropMgr</h1>
9         <table cellspacing="0">
10             <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DDCore.js" target="_blank">DDCore.js</a></td></tr>
12             <tr><td class="label">Class:</td><td class="hd-info">DragDropMgr</td></tr>
13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
14                     </table>
15         <div class="description">
16             DragDropMgr is a singleton that tracks the element interaction for
17 all DragDrop items in the window.  Generally, you will not call
18 this class directly, but it does have helper methods that could
19 be useful in your DragDrop implementations.<br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
20         
21         <div class="hr"></div>
22                 <a id="Ext.dd.DragDropMgr-props"></a>
23         <h2>Public Properties</h2>
24                 <table cellspacing="0" class="member-table">
25             <tr>
26                 <th class="sig-header" colspan="2">Property</th>
27                 <th class="msource-header">Defined By</th>
28             </tr>
29                 <tr class="property-row expandable">\r
30         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
31         <td class="sig">\r
32         <a id="Ext.dd.DragDropMgr-INTERSECT"></a>\r
33             <b>INTERSECT</b> : int            <div class="mdesc">\r
34                         <div class="short">&lt;static&gt; In intersect mode, drag and drop interaction is defined by the
35 overlap of two or more drag and drop ob...</div>\r
36             <div class="long">\r
37                 &lt;static&gt; In intersect mode, drag and drop interaction is defined by the
38 overlap of two or more drag and drop objects.            </div>\r
39                         </div>\r
40         </td>\r
41         <td class="msource">DragDropMgr</td>\r
42     </tr>\r
43         <tr class="property-row alt">\r
44         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
45         <td class="sig">\r
46         <a id="Ext.dd.DragDropMgr-POINT"></a>\r
47             <b>POINT</b> : int            <div class="mdesc">\r
48                             &lt;static&gt; In point mode, drag and drop interaction is defined by the
49 location of the cursor during the drag/drop                        </div>\r
50         </td>\r
51         <td class="msource">DragDropMgr</td>\r
52     </tr>\r
53         <tr class="property-row expandable">\r
54         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
55         <td class="sig">\r
56         <a id="Ext.dd.DragDropMgr-clickPixelThresh"></a>\r
57             <b>clickPixelThresh</b> : int            <div class="mdesc">\r
58                         <div class="short">&lt;static&gt; The number of pixels that the mouse needs to move after the
59 mousedown before the drag is initiated.  D...</div>\r
60             <div class="long">\r
61                 &lt;static&gt; The number of pixels that the mouse needs to move after the
62 mousedown before the drag is initiated.  Default=3;            </div>\r
63                         </div>\r
64         </td>\r
65         <td class="msource">DragDropMgr</td>\r
66     </tr>\r
67         <tr class="property-row alt expandable">\r
68         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
69         <td class="sig">\r
70         <a id="Ext.dd.DragDropMgr-clickTimeThresh"></a>\r
71             <b>clickTimeThresh</b> : int            <div class="mdesc">\r
72                         <div class="short">&lt;static&gt; The number of milliseconds after the mousedown event to initiate the
73 drag if we don't get a mouseup ev...</div>\r
74             <div class="long">\r
75                 &lt;static&gt; The number of milliseconds after the mousedown event to initiate the
76 drag if we don't get a mouseup event. Default=1000            </div>\r
77                         </div>\r
78         </td>\r
79         <td class="msource">DragDropMgr</td>\r
80     </tr>\r
81         <tr class="property-row">\r
82         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
83         <td class="sig">\r
84         <a id="Ext.dd.DragDropMgr-css"></a>\r
85             <b>css</b> : Object            <div class="mdesc">\r
86                             A reference to the style property                        </div>\r
87         </td>\r
88         <td class="msource">DragDropMgr</td>\r
89     </tr>\r
90         <tr class="property-row alt">\r
91         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
92         <td class="sig">\r
93         <a id="Ext.dd.DragDropMgr-el"></a>\r
94             <b>el</b> : Object            <div class="mdesc">\r
95                             The element                        </div>\r
96         </td>\r
97         <td class="msource">DragDropMgr</td>\r
98     </tr>\r
99         <tr class="property-row">\r
100         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
101         <td class="sig">\r
102         <a id="Ext.dd.DragDropMgr-id"></a>\r
103             <b>id</b> : Object            <div class="mdesc">\r
104                             The element id                        </div>\r
105         </td>\r
106         <td class="msource">DragDropMgr</td>\r
107     </tr>\r
108         <tr class="property-row alt">\r
109         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
110         <td class="sig">\r
111         <a id="Ext.dd.DragDropMgr-mode"></a>\r
112             <b>mode</b> : int            <div class="mdesc">\r
113                             &lt;static&gt; The current drag and drop mode.  Default: POINT                        </div>\r
114         </td>\r
115         <td class="msource">DragDropMgr</td>\r
116     </tr>\r
117         <tr class="property-row expandable">\r
118         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
119         <td class="sig">\r
120         <a id="Ext.dd.DragDropMgr-preventDefault"></a>\r
121             <b>preventDefault</b> : boolean            <div class="mdesc">\r
122                         <div class="short">&lt;static&gt; Flag to determine if we should prevent the default behavior of the
123 events we define. By default this i...</div>\r
124             <div class="long">\r
125                 &lt;static&gt; Flag to determine if we should prevent the default behavior of the
126 events we define. By default this is true, but this can be set to
127 false if you need the default behavior (not recommended)            </div>\r
128                         </div>\r
129         </td>\r
130         <td class="msource">DragDropMgr</td>\r
131     </tr>\r
132         <tr class="property-row alt expandable">\r
133         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
134         <td class="sig">\r
135         <a id="Ext.dd.DragDropMgr-stopPropagation"></a>\r
136             <b>stopPropagation</b> : boolean            <div class="mdesc">\r
137                         <div class="short">&lt;static&gt; Flag to determine if we should stop the propagation of the events
138 we generate. This is true by default...</div>\r
139             <div class="long">\r
140                 &lt;static&gt; Flag to determine if we should stop the propagation of the events
141 we generate. This is true by default but you may want to set it to
142 false if the html element contains other features that require the
143 mouse click.            </div>\r
144                         </div>\r
145         </td>\r
146         <td class="msource">DragDropMgr</td>\r
147     </tr>\r
148         <tr class="property-row expandable">\r
149         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
150         <td class="sig">\r
151         <a id="Ext.dd.DragDropMgr-useCache"></a>\r
152             <b>useCache</b> : boolean            <div class="mdesc">\r
153                         <div class="short">&lt;static&gt; Set useCache to false if you want to force object the lookup of each
154 drag and drop linked element cons...</div>\r
155             <div class="long">\r
156                 &lt;static&gt; Set useCache to false if you want to force object the lookup of each
157 drag and drop linked element constantly during a drag.            </div>\r
158                         </div>\r
159         </td>\r
160         <td class="msource">DragDropMgr</td>\r
161     </tr>\r
162             </table>
163                 <a id="Ext.dd.DragDropMgr-methods"></a>
164         <h2>Public Methods</h2>
165                 <table cellspacing="0" class="member-table">
166             <tr>
167                 <th class="sig-header" colspan="2">Method</th>
168                 <th class="msource-header">Defined By</th>
169             </tr>
170                 <tr class="method-row expandable">\r
171         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
172         <td class="sig">\r
173         <a id="Ext.dd.DragDropMgr-getBestMatch"></a>\r
174             <b>getBestMatch</b>(&nbsp;<code>DragDrop[] dds</code>&nbsp;) : DragDrop            <div class="mdesc">\r
175                         <div class="short">&lt;static&gt; Helper function for getting the best match from the list of drag
176 and drop objects returned by the drag...</div>\r
177             <div class="long">\r
178                 &lt;static&gt; Helper function for getting the best match from the list of drag
179 and drop objects returned by the drag and drop events when we are
180 in INTERSECT mode.  It returns either the first object that the
181 cursor is over, or the object that has the greatest overlap with
182 the dragged element.    <div class="mdetail-params">\r
183         <strong>Parameters:</strong>\r
184         <ul><li><code>dds</code> : DragDrop[]<div class="sub-desc">The array of drag and drop objects
185 targeted</div></li>        </ul>\r
186         <strong>Returns:</strong>\r
187         <ul>\r
188             <li><code>DragDrop</code><div class="sub-desc">The best single match</div></li>\r
189         </ul>\r
190     </div>\r
191                 </div>\r
192                         </div>\r
193         </td>\r
194         <td class="msource">DragDropMgr</td>\r
195     </tr>\r
196         <tr class="method-row alt expandable">\r
197         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
198         <td class="sig">\r
199         <a id="Ext.dd.DragDropMgr-getCss"></a>\r
200             <b>getCss</b>(&nbsp;<code>String id</code>&nbsp;) : Object            <div class="mdesc">\r
201                         <div class="short"><b>Deprecated.</b> &lt;static&gt; Returns the style property for the DOM element (i.e.,
202 document.getElById(id).style)</div>\r
203             <div class="long">\r
204                 <b>Deprecated.</b> &lt;static&gt; Returns the style property for the DOM element (i.e.,
205 document.getElById(id).style)    <div class="mdetail-params">\r
206         <strong>Parameters:</strong>\r
207         <ul><li><code>id</code> : String<div class="sub-desc">the id of the elment to get</div></li>        </ul>\r
208         <strong>Returns:</strong>\r
209         <ul>\r
210             <li><code>Object</code><div class="sub-desc">The style property of the element</div></li>\r
211         </ul>\r
212     </div>\r
213                 </div>\r
214                         </div>\r
215         </td>\r
216         <td class="msource">DragDropMgr</td>\r
217     </tr>\r
218         <tr class="method-row expandable">\r
219         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
220         <td class="sig">\r
221         <a id="Ext.dd.DragDropMgr-getDDById"></a>\r
222             <b>getDDById</b>(&nbsp;<code>String id</code>&nbsp;) : DragDrop            <div class="mdesc">\r
223                         <div class="short">&lt;static&gt; Returns the DragDrop instance for a given id</div>\r
224             <div class="long">\r
225                 &lt;static&gt; Returns the DragDrop instance for a given id    <div class="mdetail-params">\r
226         <strong>Parameters:</strong>\r
227         <ul><li><code>id</code> : String<div class="sub-desc">the id of the DragDrop object</div></li>        </ul>\r
228         <strong>Returns:</strong>\r
229         <ul>\r
230             <li><code>DragDrop</code><div class="sub-desc">the drag drop object, null if it is not found</div></li>\r
231         </ul>\r
232     </div>\r
233                 </div>\r
234                         </div>\r
235         </td>\r
236         <td class="msource">DragDropMgr</td>\r
237     </tr>\r
238         <tr class="method-row alt expandable">\r
239         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
240         <td class="sig">\r
241         <a id="Ext.dd.DragDropMgr-getElement"></a>\r
242             <b>getElement</b>(&nbsp;<code>String id</code>&nbsp;) : Object            <div class="mdesc">\r
243                         <div class="short"><b>Deprecated.</b> &lt;static&gt; Returns the actual DOM element</div>\r
244             <div class="long">\r
245                 <b>Deprecated.</b> &lt;static&gt; Returns the actual DOM element    <div class="mdetail-params">\r
246         <strong>Parameters:</strong>\r
247         <ul><li><code>id</code> : String<div class="sub-desc">the id of the elment to get</div></li>        </ul>\r
248         <strong>Returns:</strong>\r
249         <ul>\r
250             <li><code>Object</code><div class="sub-desc">The element</div></li>\r
251         </ul>\r
252     </div>\r
253                 </div>\r
254                         </div>\r
255         </td>\r
256         <td class="msource">DragDropMgr</td>\r
257     </tr>\r
258         <tr class="method-row expandable">\r
259         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
260         <td class="sig">\r
261         <a id="Ext.dd.DragDropMgr-getLocation"></a>\r
262             <b>getLocation</b>(&nbsp;<code>DragDrop oDD</code>&nbsp;) : Ext.lib.Region            <div class="mdesc">\r
263                         <div class="short">&lt;static&gt; Returns a Region object containing the drag and drop element's position
264 and size, including the paddin...</div>\r
265             <div class="long">\r
266                 &lt;static&gt; Returns a Region object containing the drag and drop element's position
267 and size, including the padding configured for it    <div class="mdetail-params">\r
268         <strong>Parameters:</strong>\r
269         <ul><li><code>oDD</code> : DragDrop<div class="sub-desc">the drag and drop object to get the
270 location for</div></li>        </ul>\r
271         <strong>Returns:</strong>\r
272         <ul>\r
273             <li><code>Ext.lib.Region</code><div class="sub-desc">a Region object representing the total area the element occupies, including any padding the instance is configured for.</div></li>\r
274         </ul>\r
275     </div>\r
276                 </div>\r
277                         </div>\r
278         </td>\r
279         <td class="msource">DragDropMgr</td>\r
280     </tr>\r
281         <tr class="method-row alt expandable">\r
282         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
283         <td class="sig">\r
284         <a id="Ext.dd.DragDropMgr-getPosX"></a>\r
285             <b>getPosX</b>(&nbsp;<code>el the</code>&nbsp;) : int            <div class="mdesc">\r
286                         <div class="short"><b>Deprecated.</b> &lt;static&gt; Returns the X position of an html element</div>\r
287             <div class="long">\r
288                 <b>Deprecated.</b> &lt;static&gt; Returns the X position of an html element    <div class="mdetail-params">\r
289         <strong>Parameters:</strong>\r
290         <ul><li><code>the</code> : el<div class="sub-desc">element for which to get the position</div></li>        </ul>\r
291         <strong>Returns:</strong>\r
292         <ul>\r
293             <li><code>int</code><div class="sub-desc">the X coordinate @for DragDropMgr</div></li>\r
294         </ul>\r
295     </div>\r
296                 </div>\r
297                         </div>\r
298         </td>\r
299         <td class="msource">DragDropMgr</td>\r
300     </tr>\r
301         <tr class="method-row expandable">\r
302         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
303         <td class="sig">\r
304         <a id="Ext.dd.DragDropMgr-getPosY"></a>\r
305             <b>getPosY</b>(&nbsp;<code>el the</code>&nbsp;) : int            <div class="mdesc">\r
306                         <div class="short"><b>Deprecated.</b> &lt;static&gt; Returns the Y position of an html element</div>\r
307             <div class="long">\r
308                 <b>Deprecated.</b> &lt;static&gt; Returns the Y position of an html element    <div class="mdetail-params">\r
309         <strong>Parameters:</strong>\r
310         <ul><li><code>the</code> : el<div class="sub-desc">element for which to get the position</div></li>        </ul>\r
311         <strong>Returns:</strong>\r
312         <ul>\r
313             <li><code>int</code><div class="sub-desc">the Y coordinate</div></li>\r
314         </ul>\r
315     </div>\r
316                 </div>\r
317                         </div>\r
318         </td>\r
319         <td class="msource">DragDropMgr</td>\r
320     </tr>\r
321         <tr class="method-row alt expandable">\r
322         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
323         <td class="sig">\r
324         <a id="Ext.dd.DragDropMgr-getRelated"></a>\r
325             <b>getRelated</b>(&nbsp;<code>DragDrop p_oDD</code>, <code>boolean bTargetsOnly</code>&nbsp;) : DragDrop[]            <div class="mdesc">\r
326                         <div class="short">&lt;static&gt; Returns the drag and drop instances that are in all groups the
327 passed in instance belongs to.</div>\r
328             <div class="long">\r
329                 &lt;static&gt; Returns the drag and drop instances that are in all groups the
330 passed in instance belongs to.    <div class="mdetail-params">\r
331         <strong>Parameters:</strong>\r
332         <ul><li><code>p_oDD</code> : DragDrop<div class="sub-desc">the obj to get related data for</div></li><li><code>bTargetsOnly</code> : boolean<div class="sub-desc">if true, only return targetable objs</div></li>        </ul>\r
333         <strong>Returns:</strong>\r
334         <ul>\r
335             <li><code>DragDrop[]</code><div class="sub-desc">the related instances</div></li>\r
336         </ul>\r
337     </div>\r
338                 </div>\r
339                         </div>\r
340         </td>\r
341         <td class="msource">DragDropMgr</td>\r
342     </tr>\r
343         <tr class="method-row expandable">\r
344         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
345         <td class="sig">\r
346         <a id="Ext.dd.DragDropMgr-getScrollLeft"></a>\r
347             <b>getScrollLeft</b>() : int            <div class="mdesc">\r
348                         <div class="short">&lt;static&gt; Gets the scrollLeft</div>\r
349             <div class="long">\r
350                 &lt;static&gt; Gets the scrollLeft    <div class="mdetail-params">\r
351         <strong>Parameters:</strong>\r
352         <ul><li>None.</li>        </ul>\r
353         <strong>Returns:</strong>\r
354         <ul>\r
355             <li><code>int</code><div class="sub-desc">the document's scrollTop</div></li>\r
356         </ul>\r
357     </div>\r
358                 </div>\r
359                         </div>\r
360         </td>\r
361         <td class="msource">DragDropMgr</td>\r
362     </tr>\r
363         <tr class="method-row alt expandable">\r
364         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
365         <td class="sig">\r
366         <a id="Ext.dd.DragDropMgr-getScrollTop"></a>\r
367             <b>getScrollTop</b>() : int            <div class="mdesc">\r
368                         <div class="short">&lt;static&gt; Gets the scrollTop</div>\r
369             <div class="long">\r
370                 &lt;static&gt; Gets the scrollTop    <div class="mdetail-params">\r
371         <strong>Parameters:</strong>\r
372         <ul><li>None.</li>        </ul>\r
373         <strong>Returns:</strong>\r
374         <ul>\r
375             <li><code>int</code><div class="sub-desc">the document's scrollTop</div></li>\r
376         </ul>\r
377     </div>\r
378                 </div>\r
379                         </div>\r
380         </td>\r
381         <td class="msource">DragDropMgr</td>\r
382     </tr>\r
383         <tr class="method-row expandable">\r
384         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
385         <td class="sig">\r
386         <a id="Ext.dd.DragDropMgr-getStyle"></a>\r
387             <b>getStyle</b>(&nbsp;<code>HTMLElement el</code>, <code>string styleProp</code>&nbsp;) : string            <div class="mdesc">\r
388                         <div class="short"><b>Deprecated.</b> &lt;static&gt; Returns the specified element style property</div>\r
389             <div class="long">\r
390                 <b>Deprecated.</b> &lt;static&gt; Returns the specified element style property    <div class="mdetail-params">\r
391         <strong>Parameters:</strong>\r
392         <ul><li><code>el</code> : HTMLElement<div class="sub-desc">the element</div></li><li><code>styleProp</code> : string<div class="sub-desc">the style property</div></li>        </ul>\r
393         <strong>Returns:</strong>\r
394         <ul>\r
395             <li><code>string</code><div class="sub-desc">The value of the style property</div></li>\r
396         </ul>\r
397     </div>\r
398                 </div>\r
399                         </div>\r
400         </td>\r
401         <td class="msource">DragDropMgr</td>\r
402     </tr>\r
403         <tr class="method-row alt expandable">\r
404         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
405         <td class="sig">\r
406         <a id="Ext.dd.DragDropMgr-handleWasClicked"></a>\r
407             <b>handleWasClicked</b>(&nbsp;<code>node the</code>&nbsp;) : void            <div class="mdesc">\r
408                         <div class="short">&lt;static&gt; Recursively searches the immediate parent and all child nodes for
409 the handle element in order to deter...</div>\r
410             <div class="long">\r
411                 &lt;static&gt; Recursively searches the immediate parent and all child nodes for
412 the handle element in order to determine wheter or not it was
413 clicked.    <div class="mdetail-params">\r
414         <strong>Parameters:</strong>\r
415         <ul><li><code>the</code> : node<div class="sub-desc">html element to inspect</div></li>        </ul>\r
416         <strong>Returns:</strong>\r
417         <ul>\r
418             <li><code>void</code></li>\r
419         </ul>\r
420     </div>\r
421                 </div>\r
422                         </div>\r
423         </td>\r
424         <td class="msource">DragDropMgr</td>\r
425     </tr>\r
426         <tr class="method-row expandable">\r
427         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
428         <td class="sig">\r
429         <a id="Ext.dd.DragDropMgr-isDragDrop"></a>\r
430             <b>isDragDrop</b>(&nbsp;<code>String id</code>&nbsp;) : boolean            <div class="mdesc">\r
431                         <div class="short">&lt;static&gt; Utility function to determine if a given element has been
432 registered as a drag drop item.</div>\r
433             <div class="long">\r
434                 &lt;static&gt; Utility function to determine if a given element has been
435 registered as a drag drop item.    <div class="mdetail-params">\r
436         <strong>Parameters:</strong>\r
437         <ul><li><code>id</code> : String<div class="sub-desc">the element id to check</div></li>        </ul>\r
438         <strong>Returns:</strong>\r
439         <ul>\r
440             <li><code>boolean</code><div class="sub-desc">true if this element is a DragDrop item, false otherwise</div></li>\r
441         </ul>\r
442     </div>\r
443                 </div>\r
444                         </div>\r
445         </td>\r
446         <td class="msource">DragDropMgr</td>\r
447     </tr>\r
448         <tr class="method-row alt expandable">\r
449         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
450         <td class="sig">\r
451         <a id="Ext.dd.DragDropMgr-isHandle"></a>\r
452             <b>isHandle</b>(&nbsp;<code>String id</code>&nbsp;) : boolean            <div class="mdesc">\r
453                         <div class="short">&lt;static&gt; Utility function to determine if a given element has been
454 registered as a drag drop handle for the giv...</div>\r
455             <div class="long">\r
456                 &lt;static&gt; Utility function to determine if a given element has been
457 registered as a drag drop handle for the given Drag Drop object.    <div class="mdetail-params">\r
458         <strong>Parameters:</strong>\r
459         <ul><li><code>id</code> : String<div class="sub-desc">the element id to check</div></li>        </ul>\r
460         <strong>Returns:</strong>\r
461         <ul>\r
462             <li><code>boolean</code><div class="sub-desc">true if this element is a DragDrop handle, false otherwise</div></li>\r
463         </ul>\r
464     </div>\r
465                 </div>\r
466                         </div>\r
467         </td>\r
468         <td class="msource">DragDropMgr</td>\r
469     </tr>\r
470         <tr class="method-row expandable">\r
471         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
472         <td class="sig">\r
473         <a id="Ext.dd.DragDropMgr-isLegalTarget"></a>\r
474             <b>isLegalTarget</b>(&nbsp;<code>DragDrop the</code>, <code>DragDrop the</code>&nbsp;) : boolean            <div class="mdesc">\r
475                         <div class="short">&lt;static&gt; Returns true if the specified dd target is a legal target for
476 the specifice drag obj</div>\r
477             <div class="long">\r
478                 &lt;static&gt; Returns true if the specified dd target is a legal target for
479 the specifice drag obj    <div class="mdetail-params">\r
480         <strong>Parameters:</strong>\r
481         <ul><li><code>the</code> : DragDrop<div class="sub-desc">drag obj</div></li><li><code>the</code> : DragDrop<div class="sub-desc">target</div></li>        </ul>\r
482         <strong>Returns:</strong>\r
483         <ul>\r
484             <li><code>boolean</code><div class="sub-desc">true if the target is a legal target for the dd obj</div></li>\r
485         </ul>\r
486     </div>\r
487                 </div>\r
488                         </div>\r
489         </td>\r
490         <td class="msource">DragDropMgr</td>\r
491     </tr>\r
492         <tr class="method-row alt expandable">\r
493         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
494         <td class="sig">\r
495         <a id="Ext.dd.DragDropMgr-isLocked"></a>\r
496             <b>isLocked</b>() : boolean            <div class="mdesc">\r
497                         <div class="short">&lt;static&gt; Is drag and drop locked?</div>\r
498             <div class="long">\r
499                 &lt;static&gt; Is drag and drop locked?    <div class="mdetail-params">\r
500         <strong>Parameters:</strong>\r
501         <ul><li>None.</li>        </ul>\r
502         <strong>Returns:</strong>\r
503         <ul>\r
504             <li><code>boolean</code><div class="sub-desc">True if drag and drop is locked, false otherwise.</div></li>\r
505         </ul>\r
506     </div>\r
507                 </div>\r
508                         </div>\r
509         </td>\r
510         <td class="msource">DragDropMgr</td>\r
511     </tr>\r
512         <tr class="method-row expandable">\r
513         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
514         <td class="sig">\r
515         <a id="Ext.dd.DragDropMgr-isTypeOfDD"></a>\r
516             <b>isTypeOfDD</b>(&nbsp;<code>Object the</code>&nbsp;) : boolean            <div class="mdesc">\r
517                         <div class="short">&lt;static&gt; My goal is to be able to transparently determine if an object is
518 typeof DragDrop, and the exact subcla...</div>\r
519             <div class="long">\r
520                 &lt;static&gt; My goal is to be able to transparently determine if an object is
521 typeof DragDrop, and the exact subclass of DragDrop.  typeof
522 returns "object", oDD.constructor.toString() always returns
523 "DragDrop" and not the name of the subclass.  So for now it just
524 evaluates a well-known variable in DragDrop.    <div class="mdetail-params">\r
525         <strong>Parameters:</strong>\r
526         <ul><li><code>the</code> : Object<div class="sub-desc">object to evaluate</div></li>        </ul>\r
527         <strong>Returns:</strong>\r
528         <ul>\r
529             <li><code>boolean</code><div class="sub-desc">true if typeof oDD = DragDrop</div></li>\r
530         </ul>\r
531     </div>\r
532                 </div>\r
533                         </div>\r
534         </td>\r
535         <td class="msource">DragDropMgr</td>\r
536     </tr>\r
537         <tr class="method-row alt expandable">\r
538         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
539         <td class="sig">\r
540         <a id="Ext.dd.DragDropMgr-lock"></a>\r
541             <b>lock</b>() : void            <div class="mdesc">\r
542                         <div class="short">&lt;static&gt; Lock all drag and drop functionality</div>\r
543             <div class="long">\r
544                 &lt;static&gt; Lock all drag and drop functionality    <div class="mdetail-params">\r
545         <strong>Parameters:</strong>\r
546         <ul><li>None.</li>        </ul>\r
547         <strong>Returns:</strong>\r
548         <ul>\r
549             <li><code>void</code></li>\r
550         </ul>\r
551     </div>\r
552                 </div>\r
553                         </div>\r
554         </td>\r
555         <td class="msource">DragDropMgr</td>\r
556     </tr>\r
557         <tr class="method-row expandable">\r
558         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
559         <td class="sig">\r
560         <a id="Ext.dd.DragDropMgr-moveToEl"></a>\r
561             <b>moveToEl</b>(&nbsp;<code>HTMLElement moveEl</code>, <code>HTMLElement targetEl</code>&nbsp;) : void            <div class="mdesc">\r
562                         <div class="short">&lt;static&gt; Sets the x/y position of an element to the location of the
563 target element.</div>\r
564             <div class="long">\r
565                 &lt;static&gt; Sets the x/y position of an element to the location of the
566 target element.    <div class="mdetail-params">\r
567         <strong>Parameters:</strong>\r
568         <ul><li><code>moveEl</code> : HTMLElement<div class="sub-desc">The element to move</div></li><li><code>targetEl</code> : HTMLElement<div class="sub-desc">The position reference element</div></li>        </ul>\r
569         <strong>Returns:</strong>\r
570         <ul>\r
571             <li><code>void</code></li>\r
572         </ul>\r
573     </div>\r
574                 </div>\r
575                         </div>\r
576         </td>\r
577         <td class="msource">DragDropMgr</td>\r
578     </tr>\r
579         <tr class="method-row alt expandable">\r
580         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
581         <td class="sig">\r
582         <a id="Ext.dd.DragDropMgr-numericSort"></a>\r
583             <b>numericSort</b>() : void            <div class="mdesc">\r
584                         <div class="short">&lt;static&gt; Numeric array sort function</div>\r
585             <div class="long">\r
586                 &lt;static&gt; Numeric array sort function    <div class="mdetail-params">\r
587         <strong>Parameters:</strong>\r
588         <ul><li>None.</li>        </ul>\r
589         <strong>Returns:</strong>\r
590         <ul>\r
591             <li><code>void</code></li>\r
592         </ul>\r
593     </div>\r
594                 </div>\r
595                         </div>\r
596         </td>\r
597         <td class="msource">DragDropMgr</td>\r
598     </tr>\r
599         <tr class="method-row expandable">\r
600         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
601         <td class="sig">\r
602         <a id="Ext.dd.DragDropMgr-refreshCache"></a>\r
603             <b>refreshCache</b>(&nbsp;<code>Object groups</code>&nbsp;) : void            <div class="mdesc">\r
604                         <div class="short">&lt;static&gt; Refreshes the cache of the top-left and bottom-right points of the
605 drag and drop objects in the specif...</div>\r
606             <div class="long">\r
607                 &lt;static&gt; Refreshes the cache of the top-left and bottom-right points of the
608 drag and drop objects in the specified group(s).  This is in the
609 format that is stored in the drag and drop instance, so typical
610 usage is:
611 <code>
612 Ext.dd.DragDropMgr.refreshCache(ddinstance.groups);
613 </code>
614 Alternatively:
615 <code>
616 Ext.dd.DragDropMgr.refreshCache({group1:true, group2:true});
617 </code>
618 @TODO this really should be an indexed array.  Alternatively this
619 method could accept both.    <div class="mdetail-params">\r
620         <strong>Parameters:</strong>\r
621         <ul><li><code>groups</code> : Object<div class="sub-desc">an associative array of groups to refresh</div></li>        </ul>\r
622         <strong>Returns:</strong>\r
623         <ul>\r
624             <li><code>void</code></li>\r
625         </ul>\r
626     </div>\r
627                 </div>\r
628                         </div>\r
629         </td>\r
630         <td class="msource">DragDropMgr</td>\r
631     </tr>\r
632         <tr class="method-row alt expandable">\r
633         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
634         <td class="sig">\r
635         <a id="Ext.dd.DragDropMgr-regDragDrop"></a>\r
636             <b>regDragDrop</b>(&nbsp;<code>DragDrop oDD</code>, <code>String sGroup</code>&nbsp;) : void            <div class="mdesc">\r
637                         <div class="short">&lt;static&gt; Each DragDrop instance must be registered with the DragDropMgr.
638 This is executed in DragDrop.init()</div>\r
639             <div class="long">\r
640                 &lt;static&gt; Each DragDrop instance must be registered with the DragDropMgr.
641 This is executed in DragDrop.init()    <div class="mdetail-params">\r
642         <strong>Parameters:</strong>\r
643         <ul><li><code>oDD</code> : DragDrop<div class="sub-desc">the DragDrop object to register</div></li><li><code>sGroup</code> : String<div class="sub-desc">the name of the group this element belongs to</div></li>        </ul>\r
644         <strong>Returns:</strong>\r
645         <ul>\r
646             <li><code>void</code></li>\r
647         </ul>\r
648     </div>\r
649                 </div>\r
650                         </div>\r
651         </td>\r
652         <td class="msource">DragDropMgr</td>\r
653     </tr>\r
654         <tr class="method-row expandable">\r
655         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
656         <td class="sig">\r
657         <a id="Ext.dd.DragDropMgr-regHandle"></a>\r
658             <b>regHandle</b>(&nbsp;<code>String sDDId</code>, <code>String sHandleId</code>&nbsp;) : void            <div class="mdesc">\r
659                         <div class="short">&lt;static&gt; Each DragDrop handle element must be registered.  This is done
660 automatically when executing DragDrop.s...</div>\r
661             <div class="long">\r
662                 &lt;static&gt; Each DragDrop handle element must be registered.  This is done
663 automatically when executing DragDrop.setHandleElId()    <div class="mdetail-params">\r
664         <strong>Parameters:</strong>\r
665         <ul><li><code>sDDId</code> : String<div class="sub-desc">the DragDrop id this element is a handle for</div></li><li><code>sHandleId</code> : String<div class="sub-desc">the id of the element that is the drag
666 handle</div></li>        </ul>\r
667         <strong>Returns:</strong>\r
668         <ul>\r
669             <li><code>void</code></li>\r
670         </ul>\r
671     </div>\r
672                 </div>\r
673                         </div>\r
674         </td>\r
675         <td class="msource">DragDropMgr</td>\r
676     </tr>\r
677         <tr class="method-row alt expandable">\r
678         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
679         <td class="sig">\r
680         <a id="Ext.dd.DragDropMgr-startDrag"></a>\r
681             <b>startDrag</b>(&nbsp;<code>x {int}</code>, <code>y {int}</code>&nbsp;) : void            <div class="mdesc">\r
682                         <div class="short">&lt;static&gt; Fired when either the drag pixel threshol or the mousedown hold
683 time threshold has been met.</div>\r
684             <div class="long">\r
685                 &lt;static&gt; Fired when either the drag pixel threshol or the mousedown hold
686 time threshold has been met.    <div class="mdetail-params">\r
687         <strong>Parameters:</strong>\r
688         <ul><li><code>{int}</code> : x<div class="sub-desc">the X position of the original mousedown</div></li><li><code>{int}</code> : y<div class="sub-desc">the Y position of the original mousedown</div></li>        </ul>\r
689         <strong>Returns:</strong>\r
690         <ul>\r
691             <li><code>void</code></li>\r
692         </ul>\r
693     </div>\r
694                 </div>\r
695                         </div>\r
696         </td>\r
697         <td class="msource">DragDropMgr</td>\r
698     </tr>\r
699         <tr class="method-row expandable">\r
700         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
701         <td class="sig">\r
702         <a id="Ext.dd.DragDropMgr-stopEvent"></a>\r
703             <b>stopEvent</b>(&nbsp;<code>Event e</code>&nbsp;) : void            <div class="mdesc">\r
704                         <div class="short">&lt;static&gt; Utility to stop event propagation and event default, if these
705 features are turned on.</div>\r
706             <div class="long">\r
707                 &lt;static&gt; Utility to stop event propagation and event default, if these
708 features are turned on.    <div class="mdetail-params">\r
709         <strong>Parameters:</strong>\r
710         <ul><li><code>e</code> : Event<div class="sub-desc">the event as returned by this.getEvent()</div></li>        </ul>\r
711         <strong>Returns:</strong>\r
712         <ul>\r
713             <li><code>void</code></li>\r
714         </ul>\r
715     </div>\r
716                 </div>\r
717                         </div>\r
718         </td>\r
719         <td class="msource">DragDropMgr</td>\r
720     </tr>\r
721         <tr class="method-row alt expandable">\r
722         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
723         <td class="sig">\r
724         <a id="Ext.dd.DragDropMgr-swapNode"></a>\r
725             <b>swapNode</b>(&nbsp;<code>n1 the</code>, <code>n2 the</code>&nbsp;) : void            <div class="mdesc">\r
726                         <div class="short">&lt;static&gt; Swap two nodes.  In IE, we use the native method, for others we
727 emulate the IE behavior</div>\r
728             <div class="long">\r
729                 &lt;static&gt; Swap two nodes.  In IE, we use the native method, for others we
730 emulate the IE behavior    <div class="mdetail-params">\r
731         <strong>Parameters:</strong>\r
732         <ul><li><code>the</code> : n1<div class="sub-desc">first node to swap</div></li><li><code>the</code> : n2<div class="sub-desc">other node to swap</div></li>        </ul>\r
733         <strong>Returns:</strong>\r
734         <ul>\r
735             <li><code>void</code></li>\r
736         </ul>\r
737     </div>\r
738                 </div>\r
739                         </div>\r
740         </td>\r
741         <td class="msource">DragDropMgr</td>\r
742     </tr>\r
743         <tr class="method-row expandable">\r
744         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
745         <td class="sig">\r
746         <a id="Ext.dd.DragDropMgr-unlock"></a>\r
747             <b>unlock</b>() : void            <div class="mdesc">\r
748                         <div class="short">&lt;static&gt; Unlock all drag and drop functionality</div>\r
749             <div class="long">\r
750                 &lt;static&gt; Unlock all drag and drop functionality    <div class="mdetail-params">\r
751         <strong>Parameters:</strong>\r
752         <ul><li>None.</li>        </ul>\r
753         <strong>Returns:</strong>\r
754         <ul>\r
755             <li><code>void</code></li>\r
756         </ul>\r
757     </div>\r
758                 </div>\r
759                         </div>\r
760         </td>\r
761         <td class="msource">DragDropMgr</td>\r
762     </tr>\r
763         <tr class="method-row alt expandable">\r
764         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
765         <td class="sig">\r
766         <a id="Ext.dd.DragDropMgr-verifyEl"></a>\r
767             <b>verifyEl</b>(&nbsp;<code>HTMLElement el</code>&nbsp;) : boolean            <div class="mdesc">\r
768                         <div class="short">&lt;static&gt; This checks to make sure an element exists and is in the DOM.  The
769 main purpose is to handle cases whe...</div>\r
770             <div class="long">\r
771                 &lt;static&gt; This checks to make sure an element exists and is in the DOM.  The
772 main purpose is to handle cases where innerHTML is used to remove
773 drag and drop objects from the DOM.  IE provides an 'unspecified
774 error' when trying to access the offsetParent of such an element    <div class="mdetail-params">\r
775         <strong>Parameters:</strong>\r
776         <ul><li><code>el</code> : HTMLElement<div class="sub-desc">the element to check</div></li>        </ul>\r
777         <strong>Returns:</strong>\r
778         <ul>\r
779             <li><code>boolean</code><div class="sub-desc">true if the element looks usable</div></li>\r
780         </ul>\r
781     </div>\r
782                 </div>\r
783                         </div>\r
784         </td>\r
785         <td class="msource">DragDropMgr</td>\r
786     </tr>\r
787             </table>
788                 <a id="Ext.dd.DragDropMgr-events"></a>
789         <h2>Public Events</h2>
790         <div class="no-members">This class has no public events.</div>
791         </div>