commit extjs-2.2.1
[extjs.git] / docs / output / Ext.dd.DragDrop.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.dd.DragDrop-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.dd.DragDrop-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.dd.DragDrop-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                         <a class="bookmark" href="../docs/?class=Ext.dd.DragDrop"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7         </div>
8                 <h1>Class Ext.dd.DragDrop</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">DragDrop</td></tr>
13                         <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.dd.DD" href="output/Ext.dd.DD.html">DD</a>, <a ext:cls="Ext.dd.DDTarget" href="output/Ext.dd.DDTarget.html">DDTarget</a></td></tr>
14                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
15                     </table>
16         <div class="description">
17             Defines the interface and base operation of items that that can be
18 dragged or can be drop targets.  It was designed to be extended, overriding
19 the event handlers for startDrag, onDrag, onDragOver and onDragOut.
20 Up to three html elements can be associated with a DragDrop instance:
21 <ul>
22 <li>linked element: the element that is passed into the constructor.
23 This is the element which defines the boundaries for interaction with
24 other DragDrop objects.</li>
25 <li>handle element(s): The drag operation only occurs if the element that
26 was clicked matches a handle element.  By default this is the linked
27 element, but there are times that you will want only a portion of the
28 linked element to initiate the drag operation, and the setHandleElId()
29 method provides a way to define this.</li>
30 <li>drag element: this represents the element that would be moved along
31 with the cursor during a drag operation.  By default, this is the linked
32 element itself as in <a ext:cls="Ext.dd.DD" href="output/Ext.dd.DD.html">Ext.dd.DD</a>.  setDragElId() lets you define
33 a separate element that would be moved, as in <a ext:cls="Ext.dd.DDProxy" href="output/Ext.dd.DDProxy.html">Ext.dd.DDProxy</a>.
34 </li>
35 </ul>
36 This class should not be instantiated until the onload event to ensure that
37 the associated elements are available.
38 The following would define a DragDrop obj that would interact with any
39 other DragDrop obj in the "group1" group:
40 <pre>dd = new Ext.dd.DragDrop("div1", "group1");</pre>
41 Since none of the event handlers have been implemented, nothing would
42 actually happen if you were to run the code above.  Normally you would
43 override this class or one of the default implementations, but you can
44 also override the methods you want on an instance of the class...
45 <pre>dd.onDragDrop = function(e, id) {
46 &nbsp;&nbsp;alert("dd was dropped on " + id);
47 }</pre>        </div>
48         
49         <div class="hr"></div>
50                 <a id="Ext.dd.DragDrop-props"></a>
51         <h2>Public Properties</h2>
52                 <table cellspacing="0" class="member-table">
53             <tr>
54                 <th class="sig-header" colspan="2">Property</th>
55                 <th class="msource-header">Defined By</th>
56             </tr>
57                 <tr class="property-row">\r
58         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
59         <td class="sig">\r
60         <a id="Ext.dd.DragDrop-available"></a>\r
61             <b>available</b> : boolean            <div class="mdesc">\r
62                             The availabe property is false until the linked dom element is accessible.                        </div>\r
63         </td>\r
64         <td class="msource">DragDrop</td>\r
65     </tr>\r
66         <tr class="property-row alt">\r
67         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
68         <td class="sig">\r
69         <a id="Ext.dd.DragDrop-config"></a>\r
70             <b>config</b> : object            <div class="mdesc">\r
71                             Configuration attributes passed into the constructor                        </div>\r
72         </td>\r
73         <td class="msource">DragDrop</td>\r
74     </tr>\r
75         <tr class="property-row">\r
76         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
77         <td class="sig">\r
78         <a id="Ext.dd.DragDrop-defaultPadding"></a>\r
79             <b>defaultPadding</b> : Object            <div class="mdesc">\r
80                             Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).                        </div>\r
81         </td>\r
82         <td class="msource">DragDrop</td>\r
83     </tr>\r
84         <tr class="property-row alt expandable">\r
85         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
86         <td class="sig">\r
87         <a id="Ext.dd.DragDrop-groups"></a>\r
88             <b>groups</b> : object            <div class="mdesc">\r
89                         <div class="short">The group defines a logical collection of DragDrop objects that are
90 related.  Instances only get events when interact...</div>\r
91             <div class="long">\r
92                 The group defines a logical collection of DragDrop objects that are
93 related.  Instances only get events when interacting with other
94 DragDrop object in the same group.  This lets us define multiple
95 groups using a single DragDrop subclass if we want.            </div>\r
96                         </div>\r
97         </td>\r
98         <td class="msource">DragDrop</td>\r
99     </tr>\r
100         <tr class="property-row expandable">\r
101         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
102         <td class="sig">\r
103         <a id="Ext.dd.DragDrop-hasOuterHandles"></a>\r
104             <b>hasOuterHandles</b> : boolean            <div class="mdesc">\r
105                         <div class="short">By default, drags can only be initiated if the mousedown occurs in the
106 region the linked element is.  This is done in...</div>\r
107             <div class="long">\r
108                 By default, drags can only be initiated if the mousedown occurs in the
109 region the linked element is.  This is done in part to work around a
110 bug in some browsers that mis-report the mousedown if the previous
111 mouseup happened outside of the window.  This property is set to true
112 if outer handles are defined.            </div>\r
113                         </div>\r
114         </td>\r
115         <td class="msource">DragDrop</td>\r
116     </tr>\r
117         <tr class="property-row alt 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.DragDrop-id"></a>\r
121             <b>id</b> : String            <div class="mdesc">\r
122                         <div class="short">The id of the element associated with this object.  This is what we
123 refer to as the "linked element" because the size...</div>\r
124             <div class="long">\r
125                 The id of the element associated with this object.  This is what we
126 refer to as the "linked element" because the size and position of
127 this element is used to determine when the drag and drop objects have
128 interacted.            </div>\r
129                         </div>\r
130         </td>\r
131         <td class="msource">DragDrop</td>\r
132     </tr>\r
133         <tr class="property-row">\r
134         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
135         <td class="sig">\r
136         <a id="Ext.dd.DragDrop-invalidHandleClasses"></a>\r
137             <b>invalidHandleClasses</b> : Array            <div class="mdesc">\r
138                             An Array of CSS class names for elements to be considered in valid as drag handles.                        </div>\r
139         </td>\r
140         <td class="msource">DragDrop</td>\r
141     </tr>\r
142         <tr class="property-row alt expandable">\r
143         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
144         <td class="sig">\r
145         <a id="Ext.dd.DragDrop-invalidHandleIds"></a>\r
146             <b>invalidHandleIds</b> : Object            <div class="mdesc">\r
147                         <div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles.
148 A non-null prop...</div>\r
149             <div class="long">\r
150                 An object who's property names identify the IDs of elements to be considered invalid as drag handles.
151 A non-null property value identifies the ID as invalid. For example, to prevent
152 dragging from being initiated on element ID "foo", use:<pre><code>{
153     foo: true
154 }</code></pre>            </div>\r
155                         </div>\r
156         </td>\r
157         <td class="msource">DragDrop</td>\r
158     </tr>\r
159         <tr class="property-row expandable">\r
160         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
161         <td class="sig">\r
162         <a id="Ext.dd.DragDrop-invalidHandleTypes"></a>\r
163             <b>invalidHandleTypes</b> : Object            <div class="mdesc">\r
164                         <div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles.
165 A non-null property value...</div>\r
166             <div class="long">\r
167                 An object who's property names identify HTML tags to be considered invalid as drag handles.
168 A non-null property value identifies the tag as invalid. Defaults to the 
169 following value which prevents drag operations from being initiated by &lt;a> elements:<pre><code>{
170     A: <em>"A"</em>
171 }</code></pre>            </div>\r
172                         </div>\r
173         </td>\r
174         <td class="msource">DragDrop</td>\r
175     </tr>\r
176         <tr class="property-row alt">\r
177         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
178         <td class="sig">\r
179         <a id="Ext.dd.DragDrop-isTarget"></a>\r
180             <b>isTarget</b> : boolean            <div class="mdesc">\r
181                             By default, all instances can be a drop target.  This can be disabled by
182 setting isTarget to false.                        </div>\r
183         </td>\r
184         <td class="msource">DragDrop</td>\r
185     </tr>\r
186         <tr class="property-row expandable">\r
187         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
188         <td class="sig">\r
189         <a id="Ext.dd.DragDrop-maintainOffset"></a>\r
190             <b>maintainOffset</b> : boolean            <div class="mdesc">\r
191                         <div class="short">Maintain offsets when we resetconstraints.  Set to true when you want
192 the position of the element relative to its par...</div>\r
193             <div class="long">\r
194                 Maintain offsets when we resetconstraints.  Set to true when you want
195 the position of the element relative to its parent to stay the same
196 when the page changes            </div>\r
197                         </div>\r
198         </td>\r
199         <td class="msource">DragDrop</td>\r
200     </tr>\r
201         <tr class="property-row alt expandable">\r
202         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
203         <td class="sig">\r
204         <a id="Ext.dd.DragDrop-moveOnly"></a>\r
205             <b>moveOnly</b> : boolean            <div class="mdesc">\r
206                         <div class="short">When set to true, other DD objects in cooperating DDGroups do not receive
207 notification events when this DD object is ...</div>\r
208             <div class="long">\r
209                 When set to true, other DD objects in cooperating DDGroups do not receive
210 notification events when this DD object is dragged over them. Defaults to false.            </div>\r
211                         </div>\r
212         </td>\r
213         <td class="msource">DragDrop</td>\r
214     </tr>\r
215         <tr class="property-row">\r
216         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
217         <td class="sig">\r
218         <a id="Ext.dd.DragDrop-padding"></a>\r
219             <b>padding</b> : int[]            <div class="mdesc">\r
220                             The padding configured for this drag and drop object for calculating
221 the drop zone intersection with this object.                        </div>\r
222         </td>\r
223         <td class="msource">DragDrop</td>\r
224     </tr>\r
225         <tr class="property-row alt expandable">\r
226         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
227         <td class="sig">\r
228         <a id="Ext.dd.DragDrop-primaryButtonOnly"></a>\r
229             <b>primaryButtonOnly</b> : boolean            <div class="mdesc">\r
230                         <div class="short">By default the drag and drop instance will only respond to the primary
231 button click (left button for a right-handed m...</div>\r
232             <div class="long">\r
233                 By default the drag and drop instance will only respond to the primary
234 button click (left button for a right-handed mouse).  Set to true to
235 allow drag and drop to start with any mouse click that is propogated
236 by the browser            </div>\r
237                         </div>\r
238         </td>\r
239         <td class="msource">DragDrop</td>\r
240     </tr>\r
241         <tr class="property-row expandable">\r
242         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
243         <td class="sig">\r
244         <a id="Ext.dd.DragDrop-xTicks"></a>\r
245             <b>xTicks</b> : int[]            <div class="mdesc">\r
246                         <div class="short">Array of pixel locations the element will snap to if we specified a
247 horizontal graduation/interval.  This array is ge...</div>\r
248             <div class="long">\r
249                 Array of pixel locations the element will snap to if we specified a
250 horizontal graduation/interval.  This array is generated automatically
251 when you define a tick interval.            </div>\r
252                         </div>\r
253         </td>\r
254         <td class="msource">DragDrop</td>\r
255     </tr>\r
256         <tr class="property-row alt expandable">\r
257         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
258         <td class="sig">\r
259         <a id="Ext.dd.DragDrop-yTicks"></a>\r
260             <b>yTicks</b> : int[]            <div class="mdesc">\r
261                         <div class="short">Array of pixel locations the element will snap to if we specified a
262 vertical graduation/interval.  This array is gene...</div>\r
263             <div class="long">\r
264                 Array of pixel locations the element will snap to if we specified a
265 vertical graduation/interval.  This array is generated automatically
266 when you define a tick interval.            </div>\r
267                         </div>\r
268         </td>\r
269         <td class="msource">DragDrop</td>\r
270     </tr>\r
271             </table>
272                 <a id="Ext.dd.DragDrop-methods"></a>
273         <h2>Public Methods</h2>
274                 <table cellspacing="0" class="member-table">
275             <tr>
276                 <th class="sig-header" colspan="2">Method</th>
277                 <th class="msource-header">Defined By</th>
278             </tr>
279                 <tr class="method-row expandable">\r
280         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
281         <td class="sig">\r
282         <a id="Ext.dd.DragDrop-DragDrop"></a>\r
283             <b>DragDrop</b>(&nbsp;<code>String id</code>, <code>String sGroup</code>, <code>object config</code>&nbsp;)            <div class="mdesc">\r
284                         <div class="short"></div>\r
285             <div class="long">\r
286                     <div class="mdetail-params">\r
287         <strong>Parameters:</strong>\r
288         <ul><li><code>id</code> : String<div class="sub-desc">of the element that is linked to this instance</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related DragDrop objects</div></li><li><code>config</code> : object<div class="sub-desc">an object containing configurable attributes
289 Valid properties for DragDrop:
290 padding, isTarget, maintainOffset, primaryButtonOnly</div></li>        </ul>\r
291         <strong>Returns:</strong>\r
292         <ul>\r
293             <li><code></code></li>\r
294         </ul>\r
295     </div>\r
296                 </div>\r
297                         </div>\r
298         </td>\r
299         <td class="msource">DragDrop</td>\r
300     </tr>\r
301         <tr class="method-row alt 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.DragDrop-addInvalidHandleClass"></a>\r
305             <b>addInvalidHandleClass</b>(&nbsp;<code>string cssClass</code>&nbsp;) : void            <div class="mdesc">\r
306                         <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>\r
307             <div class="long">\r
308                 Lets you specify a css class of elements that will not initiate a drag    <div class="mdetail-params">\r
309         <strong>Parameters:</strong>\r
310         <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li>        </ul>\r
311         <strong>Returns:</strong>\r
312         <ul>\r
313             <li><code>void</code></li>\r
314         </ul>\r
315     </div>\r
316                 </div>\r
317                         </div>\r
318         </td>\r
319         <td class="msource">DragDrop</td>\r
320     </tr>\r
321         <tr class="method-row 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.DragDrop-addInvalidHandleId"></a>\r
325             <b>addInvalidHandleId</b>(&nbsp;<code>string id</code>&nbsp;) : void            <div class="mdesc">\r
326                         <div class="short">Lets you to specify an element id for a child of a drag handle
327 that should not initiate a drag</div>\r
328             <div class="long">\r
329                 Lets you to specify an element id for a child of a drag handle
330 that should not initiate a drag    <div class="mdetail-params">\r
331         <strong>Parameters:</strong>\r
332         <ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li>        </ul>\r
333         <strong>Returns:</strong>\r
334         <ul>\r
335             <li><code>void</code></li>\r
336         </ul>\r
337     </div>\r
338                 </div>\r
339                         </div>\r
340         </td>\r
341         <td class="msource">DragDrop</td>\r
342     </tr>\r
343         <tr class="method-row alt 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.DragDrop-addInvalidHandleType"></a>\r
347             <b>addInvalidHandleType</b>(&nbsp;<code>string tagName</code>&nbsp;) : void            <div class="mdesc">\r
348                         <div class="short">Allows you to specify a tag name that should not start a drag operation
349 when clicked.  This is designed to facilitate...</div>\r
350             <div class="long">\r
351                 Allows you to specify a tag name that should not start a drag operation
352 when clicked.  This is designed to facilitate embedding links within a
353 drag handle that do something other than start the drag.    <div class="mdetail-params">\r
354         <strong>Parameters:</strong>\r
355         <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li>        </ul>\r
356         <strong>Returns:</strong>\r
357         <ul>\r
358             <li><code>void</code></li>\r
359         </ul>\r
360     </div>\r
361                 </div>\r
362                         </div>\r
363         </td>\r
364         <td class="msource">DragDrop</td>\r
365     </tr>\r
366         <tr class="method-row expandable">\r
367         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
368         <td class="sig">\r
369         <a id="Ext.dd.DragDrop-addToGroup"></a>\r
370             <b>addToGroup</b>(&nbsp;<code>sGroup {string}</code>&nbsp;) : void            <div class="mdesc">\r
371                         <div class="short">Add this instance to a group of related drag/drop objects.  All
372 instances belong to at least one group, and can belon...</div>\r
373             <div class="long">\r
374                 Add this instance to a group of related drag/drop objects.  All
375 instances belong to at least one group, and can belong to as many
376 groups as needed.    <div class="mdetail-params">\r
377         <strong>Parameters:</strong>\r
378         <ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li>        </ul>\r
379         <strong>Returns:</strong>\r
380         <ul>\r
381             <li><code>void</code></li>\r
382         </ul>\r
383     </div>\r
384                 </div>\r
385                         </div>\r
386         </td>\r
387         <td class="msource">DragDrop</td>\r
388     </tr>\r
389         <tr class="method-row alt expandable">\r
390         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
391         <td class="sig">\r
392         <a id="Ext.dd.DragDrop-applyConfig"></a>\r
393             <b>applyConfig</b>() : void            <div class="mdesc">\r
394                         <div class="short">Applies the configuration parameters that were passed into the constructor.
395 This is supposed to happen at each level ...</div>\r
396             <div class="long">\r
397                 Applies the configuration parameters that were passed into the constructor.
398 This is supposed to happen at each level through the inheritance chain.  So
399 a DDProxy implentation will execute apply config on DDProxy, DD, and
400 DragDrop in order to get all of the parameters that are available in
401 each object.    <div class="mdetail-params">\r
402         <strong>Parameters:</strong>\r
403         <ul><li>None.</li>        </ul>\r
404         <strong>Returns:</strong>\r
405         <ul>\r
406             <li><code>void</code></li>\r
407         </ul>\r
408     </div>\r
409                 </div>\r
410                         </div>\r
411         </td>\r
412         <td class="msource">DragDrop</td>\r
413     </tr>\r
414         <tr class="method-row expandable">\r
415         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
416         <td class="sig">\r
417         <a id="Ext.dd.DragDrop-clearConstraints"></a>\r
418             <b>clearConstraints</b>() : void            <div class="mdesc">\r
419                         <div class="short">Clears any constraints applied to this instance.  Also clears ticks
420 since they can't exist independent of a constrain...</div>\r
421             <div class="long">\r
422                 Clears any constraints applied to this instance.  Also clears ticks
423 since they can't exist independent of a constraint at this time.    <div class="mdetail-params">\r
424         <strong>Parameters:</strong>\r
425         <ul><li>None.</li>        </ul>\r
426         <strong>Returns:</strong>\r
427         <ul>\r
428             <li><code>void</code></li>\r
429         </ul>\r
430     </div>\r
431                 </div>\r
432                         </div>\r
433         </td>\r
434         <td class="msource">DragDrop</td>\r
435     </tr>\r
436         <tr class="method-row alt expandable">\r
437         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
438         <td class="sig">\r
439         <a id="Ext.dd.DragDrop-clearTicks"></a>\r
440             <b>clearTicks</b>() : void            <div class="mdesc">\r
441                         <div class="short">Clears any tick interval defined for this instance</div>\r
442             <div class="long">\r
443                 Clears any tick interval defined for this instance    <div class="mdetail-params">\r
444         <strong>Parameters:</strong>\r
445         <ul><li>None.</li>        </ul>\r
446         <strong>Returns:</strong>\r
447         <ul>\r
448             <li><code>void</code></li>\r
449         </ul>\r
450     </div>\r
451                 </div>\r
452                         </div>\r
453         </td>\r
454         <td class="msource">DragDrop</td>\r
455     </tr>\r
456         <tr class="method-row expandable">\r
457         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
458         <td class="sig">\r
459         <a id="Ext.dd.DragDrop-constrainTo"></a>\r
460             <b>constrainTo</b>(&nbsp;<code>Mixed constrainTo</code>, <span class="optional" title="Optional">[<code>Object/Number pad</code>]</span>, <span class="optional" title="Optional">[<code>Boolean inContent</code>]</span>&nbsp;) : void            <div class="mdesc">\r
461                         <div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element.
462 Usage:\r
463  var dd = new Ext.d...</div>\r
464             <div class="long">\r
465                 Initializes the drag drop object's constraints to restrict movement to a certain element.
466 Usage:\r
467  <pre><code>var dd = <b>new</b> Ext.dd.DDProxy(<em>"dragDiv1"</em>, <em>"proxytest"</em>,
468                 { dragElId: <em>"existingProxyDiv"</em> });
469  dd.startDrag = <b>function</b>(){
470      <b>this</b>.constrainTo(<em>"parent-id"</em>);
471  };</code></pre>
472 Or you can initalize it using the <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object:\r
473  <pre><code>Ext.get(<em>"dragDiv1"</em>).initDDProxy(<em>"proxytest"</em>, {dragElId: <em>"existingProxyDiv"</em>}, {
474      startDrag : <b>function</b>(){
475          <b>this</b>.constrainTo(<em>"parent-id"</em>);
476      }
477  });</code></pre>    <div class="mdetail-params">\r
478         <strong>Parameters:</strong>\r
479         <ul><li><code>constrainTo</code> : Mixed<div class="sub-desc">The element to constrain to.</div></li><li><code>pad</code> : Object/Number<div class="sub-desc">(optional) Pad provides a way to specify "padding" of the constraints,
480 and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
481 an object containing the sides to pad. For example: {right:10, bottom:10}</div></li><li><code>inContent</code> : Boolean<div class="sub-desc">(optional) Constrain the draggable in the content box of the element (inside padding and borders)</div></li>        </ul>\r
482         <strong>Returns:</strong>\r
483         <ul>\r
484             <li><code>void</code></li>\r
485         </ul>\r
486     </div>\r
487                 </div>\r
488                         </div>\r
489         </td>\r
490         <td class="msource">DragDrop</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.DragDrop-endDrag"></a>\r
496             <b>endDrag</b>(&nbsp;<code>Event e</code>&nbsp;) : void            <div class="mdesc">\r
497                         <div class="short">Fired when we are done dragging the object</div>\r
498             <div class="long">\r
499                 Fired when we are done dragging the object    <div class="mdetail-params">\r
500         <strong>Parameters:</strong>\r
501         <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li>        </ul>\r
502         <strong>Returns:</strong>\r
503         <ul>\r
504             <li><code>void</code></li>\r
505         </ul>\r
506     </div>\r
507                 </div>\r
508                         </div>\r
509         </td>\r
510         <td class="msource">DragDrop</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.DragDrop-getDragEl"></a>\r
516             <b>getDragEl</b>() : HTMLElement            <div class="mdesc">\r
517                         <div class="short">Returns a reference to the actual element to drag.  By default this is
518 the same as the html element, but it can be as...</div>\r
519             <div class="long">\r
520                 Returns a reference to the actual element to drag.  By default this is
521 the same as the html element, but it can be assigned to another
522 element. An example of this can be found in Ext.dd.DDProxy    <div class="mdetail-params">\r
523         <strong>Parameters:</strong>\r
524         <ul><li>None.</li>        </ul>\r
525         <strong>Returns:</strong>\r
526         <ul>\r
527             <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>\r
528         </ul>\r
529     </div>\r
530                 </div>\r
531                         </div>\r
532         </td>\r
533         <td class="msource">DragDrop</td>\r
534     </tr>\r
535         <tr class="method-row alt expandable">\r
536         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
537         <td class="sig">\r
538         <a id="Ext.dd.DragDrop-getEl"></a>\r
539             <b>getEl</b>() : HTMLElement            <div class="mdesc">\r
540                         <div class="short">Returns a reference to the linked element</div>\r
541             <div class="long">\r
542                 Returns a reference to the linked element    <div class="mdetail-params">\r
543         <strong>Parameters:</strong>\r
544         <ul><li>None.</li>        </ul>\r
545         <strong>Returns:</strong>\r
546         <ul>\r
547             <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>\r
548         </ul>\r
549     </div>\r
550                 </div>\r
551                         </div>\r
552         </td>\r
553         <td class="msource">DragDrop</td>\r
554     </tr>\r
555         <tr class="method-row expandable">\r
556         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
557         <td class="sig">\r
558         <a id="Ext.dd.DragDrop-init"></a>\r
559             <b>init</b>(&nbsp;<code>id the</code>, <code>String sGroup</code>, <code>object config</code>&nbsp;) : void            <div class="mdesc">\r
560                         <div class="short">Sets up the DragDrop object.  Must be called in the constructor of any
561 Ext.dd.DragDrop subclass</div>\r
562             <div class="long">\r
563                 Sets up the DragDrop object.  Must be called in the constructor of any
564 Ext.dd.DragDrop subclass    <div class="mdetail-params">\r
565         <strong>Parameters:</strong>\r
566         <ul><li><code>the</code> : id<div class="sub-desc">id of the linked element</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related items</div></li><li><code>config</code> : object<div class="sub-desc">configuration attributes</div></li>        </ul>\r
567         <strong>Returns:</strong>\r
568         <ul>\r
569             <li><code>void</code></li>\r
570         </ul>\r
571     </div>\r
572                 </div>\r
573                         </div>\r
574         </td>\r
575         <td class="msource">DragDrop</td>\r
576     </tr>\r
577         <tr class="method-row alt expandable">\r
578         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
579         <td class="sig">\r
580         <a id="Ext.dd.DragDrop-initTarget"></a>\r
581             <b>initTarget</b>(&nbsp;<code>id the</code>, <code>String sGroup</code>, <code>object config</code>&nbsp;) : void            <div class="mdesc">\r
582                         <div class="short">Initializes Targeting functionality only... the object does not
583 get a mousedown handler.</div>\r
584             <div class="long">\r
585                 Initializes Targeting functionality only... the object does not
586 get a mousedown handler.    <div class="mdetail-params">\r
587         <strong>Parameters:</strong>\r
588         <ul><li><code>the</code> : id<div class="sub-desc">id of the linked element</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related items</div></li><li><code>config</code> : object<div class="sub-desc">configuration attributes</div></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">DragDrop</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.DragDrop-isLocked"></a>\r
603             <b>isLocked</b>() : boolean            <div class="mdesc">\r
604                         <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
605 (meaning that all drag/drop is disabled on th...</div>\r
606             <div class="long">\r
607                 Returns true if this instance is locked, or the drag drop mgr is locked
608 (meaning that all drag/drop is disabled on the page.)    <div class="mdetail-params">\r
609         <strong>Parameters:</strong>\r
610         <ul><li>None.</li>        </ul>\r
611         <strong>Returns:</strong>\r
612         <ul>\r
613             <li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li>\r
614         </ul>\r
615     </div>\r
616                 </div>\r
617                         </div>\r
618         </td>\r
619         <td class="msource">DragDrop</td>\r
620     </tr>\r
621         <tr class="method-row alt expandable">\r
622         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
623         <td class="sig">\r
624         <a id="Ext.dd.DragDrop-isValidHandleChild"></a>\r
625             <b>isValidHandleChild</b>(&nbsp;<code>HTMLElement node</code>&nbsp;) : boolean            <div class="mdesc">\r
626                         <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>\r
627             <div class="long">\r
628                 Checks the tag exclusion list to see if this click should be ignored    <div class="mdetail-params">\r
629         <strong>Parameters:</strong>\r
630         <ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li>        </ul>\r
631         <strong>Returns:</strong>\r
632         <ul>\r
633             <li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li>\r
634         </ul>\r
635     </div>\r
636                 </div>\r
637                         </div>\r
638         </td>\r
639         <td class="msource">DragDrop</td>\r
640     </tr>\r
641         <tr class="method-row expandable">\r
642         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
643         <td class="sig">\r
644         <a id="Ext.dd.DragDrop-lock"></a>\r
645             <b>lock</b>() : void            <div class="mdesc">\r
646                         <div class="short">Lock this instance</div>\r
647             <div class="long">\r
648                 Lock this instance    <div class="mdetail-params">\r
649         <strong>Parameters:</strong>\r
650         <ul><li>None.</li>        </ul>\r
651         <strong>Returns:</strong>\r
652         <ul>\r
653             <li><code>void</code></li>\r
654         </ul>\r
655     </div>\r
656                 </div>\r
657                         </div>\r
658         </td>\r
659         <td class="msource">DragDrop</td>\r
660     </tr>\r
661         <tr class="method-row alt expandable">\r
662         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
663         <td class="sig">\r
664         <a id="Ext.dd.DragDrop-onAvailable"></a>\r
665             <b>onAvailable</b>() : void            <div class="mdesc">\r
666                         <div class="short">Override the onAvailable method to do what is needed after the initial
667 position was determined.</div>\r
668             <div class="long">\r
669                 Override the onAvailable method to do what is needed after the initial
670 position was determined.    <div class="mdetail-params">\r
671         <strong>Parameters:</strong>\r
672         <ul><li>None.</li>        </ul>\r
673         <strong>Returns:</strong>\r
674         <ul>\r
675             <li><code>void</code></li>\r
676         </ul>\r
677     </div>\r
678                 </div>\r
679                         </div>\r
680         </td>\r
681         <td class="msource">DragDrop</td>\r
682     </tr>\r
683         <tr class="method-row expandable">\r
684         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
685         <td class="sig">\r
686         <a id="Ext.dd.DragDrop-onDrag"></a>\r
687             <b>onDrag</b>(&nbsp;<code>Event e</code>&nbsp;) : void            <div class="mdesc">\r
688                         <div class="short">Abstract method called during the onMouseMove event while dragging an
689 object.</div>\r
690             <div class="long">\r
691                 Abstract method called during the onMouseMove event while dragging an
692 object.    <div class="mdetail-params">\r
693         <strong>Parameters:</strong>\r
694         <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li>        </ul>\r
695         <strong>Returns:</strong>\r
696         <ul>\r
697             <li><code>void</code></li>\r
698         </ul>\r
699     </div>\r
700                 </div>\r
701                         </div>\r
702         </td>\r
703         <td class="msource">DragDrop</td>\r
704     </tr>\r
705         <tr class="method-row alt expandable">\r
706         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
707         <td class="sig">\r
708         <a id="Ext.dd.DragDrop-onDragDrop"></a>\r
709             <b>onDragDrop</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void            <div class="mdesc">\r
710                         <div class="short">Abstract method called when this item is dropped on another DragDrop
711 obj</div>\r
712             <div class="long">\r
713                 Abstract method called when this item is dropped on another DragDrop
714 obj    <div class="mdetail-params">\r
715         <strong>Parameters:</strong>\r
716         <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
717 id this was dropped on. In INTERSECT mode, an array of dd items this
718 was dropped on.</div></li>        </ul>\r
719         <strong>Returns:</strong>\r
720         <ul>\r
721             <li><code>void</code></li>\r
722         </ul>\r
723     </div>\r
724                 </div>\r
725                         </div>\r
726         </td>\r
727         <td class="msource">DragDrop</td>\r
728     </tr>\r
729         <tr class="method-row expandable">\r
730         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
731         <td class="sig">\r
732         <a id="Ext.dd.DragDrop-onDragEnter"></a>\r
733             <b>onDragEnter</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void            <div class="mdesc">\r
734                         <div class="short">Abstract method called when this element fist begins hovering over
735 another DragDrop obj</div>\r
736             <div class="long">\r
737                 Abstract method called when this element fist begins hovering over
738 another DragDrop obj    <div class="mdetail-params">\r
739         <strong>Parameters:</strong>\r
740         <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
741 id this is hovering over. In INTERSECT mode, an array of one or more
742 dragdrop items being hovered over.</div></li>        </ul>\r
743         <strong>Returns:</strong>\r
744         <ul>\r
745             <li><code>void</code></li>\r
746         </ul>\r
747     </div>\r
748                 </div>\r
749                         </div>\r
750         </td>\r
751         <td class="msource">DragDrop</td>\r
752     </tr>\r
753         <tr class="method-row alt expandable">\r
754         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
755         <td class="sig">\r
756         <a id="Ext.dd.DragDrop-onDragOut"></a>\r
757             <b>onDragOut</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void            <div class="mdesc">\r
758                         <div class="short">Abstract method called when we are no longer hovering over an element</div>\r
759             <div class="long">\r
760                 Abstract method called when we are no longer hovering over an element    <div class="mdetail-params">\r
761         <strong>Parameters:</strong>\r
762         <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
763 id this was hovering over. In INTERSECT mode, an array of dd items
764 that the mouse is no longer over.</div></li>        </ul>\r
765         <strong>Returns:</strong>\r
766         <ul>\r
767             <li><code>void</code></li>\r
768         </ul>\r
769     </div>\r
770                 </div>\r
771                         </div>\r
772         </td>\r
773         <td class="msource">DragDrop</td>\r
774     </tr>\r
775         <tr class="method-row expandable">\r
776         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
777         <td class="sig">\r
778         <a id="Ext.dd.DragDrop-onDragOver"></a>\r
779             <b>onDragOver</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void            <div class="mdesc">\r
780                         <div class="short">Abstract method called when this element is hovering over another
781 DragDrop obj</div>\r
782             <div class="long">\r
783                 Abstract method called when this element is hovering over another
784 DragDrop obj    <div class="mdetail-params">\r
785         <strong>Parameters:</strong>\r
786         <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
787 id this is hovering over. In INTERSECT mode, an array of dd items
788 being hovered over.</div></li>        </ul>\r
789         <strong>Returns:</strong>\r
790         <ul>\r
791             <li><code>void</code></li>\r
792         </ul>\r
793     </div>\r
794                 </div>\r
795                         </div>\r
796         </td>\r
797         <td class="msource">DragDrop</td>\r
798     </tr>\r
799         <tr class="method-row alt expandable">\r
800         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
801         <td class="sig">\r
802         <a id="Ext.dd.DragDrop-onInvalidDrop"></a>\r
803             <b>onInvalidDrop</b>(&nbsp;<code>Event e</code>&nbsp;) : void            <div class="mdesc">\r
804                         <div class="short">Abstract method called when this item is dropped on an area with no
805 drop target</div>\r
806             <div class="long">\r
807                 Abstract method called when this item is dropped on an area with no
808 drop target    <div class="mdetail-params">\r
809         <strong>Parameters:</strong>\r
810         <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li>        </ul>\r
811         <strong>Returns:</strong>\r
812         <ul>\r
813             <li><code>void</code></li>\r
814         </ul>\r
815     </div>\r
816                 </div>\r
817                         </div>\r
818         </td>\r
819         <td class="msource">DragDrop</td>\r
820     </tr>\r
821         <tr class="method-row expandable">\r
822         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
823         <td class="sig">\r
824         <a id="Ext.dd.DragDrop-onMouseDown"></a>\r
825             <b>onMouseDown</b>(&nbsp;<code>Event e</code>&nbsp;) : void            <div class="mdesc">\r
826                         <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>\r
827             <div class="long">\r
828                 Event handler that fires when a drag/drop obj gets a mousedown    <div class="mdetail-params">\r
829         <strong>Parameters:</strong>\r
830         <ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li>        </ul>\r
831         <strong>Returns:</strong>\r
832         <ul>\r
833             <li><code>void</code></li>\r
834         </ul>\r
835     </div>\r
836                 </div>\r
837                         </div>\r
838         </td>\r
839         <td class="msource">DragDrop</td>\r
840     </tr>\r
841         <tr class="method-row alt expandable">\r
842         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
843         <td class="sig">\r
844         <a id="Ext.dd.DragDrop-onMouseUp"></a>\r
845             <b>onMouseUp</b>(&nbsp;<code>Event e</code>&nbsp;) : void            <div class="mdesc">\r
846                         <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>\r
847             <div class="long">\r
848                 Event handler that fires when a drag/drop obj gets a mouseup    <div class="mdetail-params">\r
849         <strong>Parameters:</strong>\r
850         <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li>        </ul>\r
851         <strong>Returns:</strong>\r
852         <ul>\r
853             <li><code>void</code></li>\r
854         </ul>\r
855     </div>\r
856                 </div>\r
857                         </div>\r
858         </td>\r
859         <td class="msource">DragDrop</td>\r
860     </tr>\r
861         <tr class="method-row expandable">\r
862         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
863         <td class="sig">\r
864         <a id="Ext.dd.DragDrop-removeFromGroup"></a>\r
865             <b>removeFromGroup</b>(&nbsp;<code>string sGroup</code>&nbsp;) : void            <div class="mdesc">\r
866                         <div class="short">Remove's this instance from the supplied interaction group</div>\r
867             <div class="long">\r
868                 Remove's this instance from the supplied interaction group    <div class="mdetail-params">\r
869         <strong>Parameters:</strong>\r
870         <ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li>        </ul>\r
871         <strong>Returns:</strong>\r
872         <ul>\r
873             <li><code>void</code></li>\r
874         </ul>\r
875     </div>\r
876                 </div>\r
877                         </div>\r
878         </td>\r
879         <td class="msource">DragDrop</td>\r
880     </tr>\r
881         <tr class="method-row alt expandable">\r
882         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
883         <td class="sig">\r
884         <a id="Ext.dd.DragDrop-removeInvalidHandleClass"></a>\r
885             <b>removeInvalidHandleClass</b>(&nbsp;<code>string cssClass</code>&nbsp;) : void            <div class="mdesc">\r
886                         <div class="short">Unsets an invalid css class</div>\r
887             <div class="long">\r
888                 Unsets an invalid css class    <div class="mdetail-params">\r
889         <strong>Parameters:</strong>\r
890         <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to
891 re-enable</div></li>        </ul>\r
892         <strong>Returns:</strong>\r
893         <ul>\r
894             <li><code>void</code></li>\r
895         </ul>\r
896     </div>\r
897                 </div>\r
898                         </div>\r
899         </td>\r
900         <td class="msource">DragDrop</td>\r
901     </tr>\r
902         <tr class="method-row expandable">\r
903         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
904         <td class="sig">\r
905         <a id="Ext.dd.DragDrop-removeInvalidHandleId"></a>\r
906             <b>removeInvalidHandleId</b>(&nbsp;<code>string id</code>&nbsp;) : void            <div class="mdesc">\r
907                         <div class="short">Unsets an invalid handle id</div>\r
908             <div class="long">\r
909                 Unsets an invalid handle id    <div class="mdetail-params">\r
910         <strong>Parameters:</strong>\r
911         <ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li>        </ul>\r
912         <strong>Returns:</strong>\r
913         <ul>\r
914             <li><code>void</code></li>\r
915         </ul>\r
916     </div>\r
917                 </div>\r
918                         </div>\r
919         </td>\r
920         <td class="msource">DragDrop</td>\r
921     </tr>\r
922         <tr class="method-row alt expandable">\r
923         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
924         <td class="sig">\r
925         <a id="Ext.dd.DragDrop-removeInvalidHandleType"></a>\r
926             <b>removeInvalidHandleType</b>(&nbsp;<code>string tagName</code>&nbsp;) : void            <div class="mdesc">\r
927                         <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>\r
928             <div class="long">\r
929                 Unsets an excluded tag name set by addInvalidHandleType    <div class="mdetail-params">\r
930         <strong>Parameters:</strong>\r
931         <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li>        </ul>\r
932         <strong>Returns:</strong>\r
933         <ul>\r
934             <li><code>void</code></li>\r
935         </ul>\r
936     </div>\r
937                 </div>\r
938                         </div>\r
939         </td>\r
940         <td class="msource">DragDrop</td>\r
941     </tr>\r
942         <tr class="method-row expandable">\r
943         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
944         <td class="sig">\r
945         <a id="Ext.dd.DragDrop-resetConstraints"></a>\r
946             <b>resetConstraints</b>(&nbsp;<code>boolean maintainOffset</code>&nbsp;) : void            <div class="mdesc">\r
947                         <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>\r
948             <div class="long">\r
949                 resetConstraints must be called if you manually reposition a dd element.    <div class="mdetail-params">\r
950         <strong>Parameters:</strong>\r
951         <ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li>        </ul>\r
952         <strong>Returns:</strong>\r
953         <ul>\r
954             <li><code>void</code></li>\r
955         </ul>\r
956     </div>\r
957                 </div>\r
958                         </div>\r
959         </td>\r
960         <td class="msource">DragDrop</td>\r
961     </tr>\r
962         <tr class="method-row alt expandable">\r
963         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
964         <td class="sig">\r
965         <a id="Ext.dd.DragDrop-setDragElId"></a>\r
966             <b>setDragElId</b>(&nbsp;<code>id {string}</code>&nbsp;) : void            <div class="mdesc">\r
967                         <div class="short">Allows you to specify that an element other than the linked element
968 will be moved with the cursor during a drag</div>\r
969             <div class="long">\r
970                 Allows you to specify that an element other than the linked element
971 will be moved with the cursor during a drag    <div class="mdetail-params">\r
972         <strong>Parameters:</strong>\r
973         <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to initiate the drag</div></li>        </ul>\r
974         <strong>Returns:</strong>\r
975         <ul>\r
976             <li><code>void</code></li>\r
977         </ul>\r
978     </div>\r
979                 </div>\r
980                         </div>\r
981         </td>\r
982         <td class="msource">DragDrop</td>\r
983     </tr>\r
984         <tr class="method-row expandable">\r
985         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
986         <td class="sig">\r
987         <a id="Ext.dd.DragDrop-setHandleElId"></a>\r
988             <b>setHandleElId</b>(&nbsp;<code>id {string}</code>&nbsp;) : void            <div class="mdesc">\r
989                         <div class="short">Allows you to specify a child of the linked element that should be
990 used to initiate the drag operation.  An example o...</div>\r
991             <div class="long">\r
992                 Allows you to specify a child of the linked element that should be
993 used to initiate the drag operation.  An example of this would be if
994 you have a content div with text and links.  Clicking anywhere in the
995 content area would normally start the drag operation.  Use this method
996 to specify that an element inside of the content div is the element
997 that starts the drag operation.    <div class="mdetail-params">\r
998         <strong>Parameters:</strong>\r
999         <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to
1000 initiate the drag.</div></li>        </ul>\r
1001         <strong>Returns:</strong>\r
1002         <ul>\r
1003             <li><code>void</code></li>\r
1004         </ul>\r
1005     </div>\r
1006                 </div>\r
1007                         </div>\r
1008         </td>\r
1009         <td class="msource">DragDrop</td>\r
1010     </tr>\r
1011         <tr class="method-row alt expandable">\r
1012         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1013         <td class="sig">\r
1014         <a id="Ext.dd.DragDrop-setInitialPosition"></a>\r
1015             <b>setInitialPosition</b>(&nbsp;<code>int diffX</code>, <code>int diffY</code>&nbsp;) : void            <div class="mdesc">\r
1016                         <div class="short">Stores the initial placement of the linked element.</div>\r
1017             <div class="long">\r
1018                 Stores the initial placement of the linked element.    <div class="mdetail-params">\r
1019         <strong>Parameters:</strong>\r
1020         <ul><li><code>diffX</code> : int<div class="sub-desc">the X offset, default 0</div></li><li><code>diffY</code> : int<div class="sub-desc">the Y offset, default 0</div></li>        </ul>\r
1021         <strong>Returns:</strong>\r
1022         <ul>\r
1023             <li><code>void</code></li>\r
1024         </ul>\r
1025     </div>\r
1026                 </div>\r
1027                         </div>\r
1028         </td>\r
1029         <td class="msource">DragDrop</td>\r
1030     </tr>\r
1031         <tr class="method-row expandable">\r
1032         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1033         <td class="sig">\r
1034         <a id="Ext.dd.DragDrop-setOuterHandleElId"></a>\r
1035             <b>setOuterHandleElId</b>(&nbsp;<code>id the</code>&nbsp;) : void            <div class="mdesc">\r
1036                         <div class="short">Allows you to set an element outside of the linked element as a drag
1037 handle</div>\r
1038             <div class="long">\r
1039                 Allows you to set an element outside of the linked element as a drag
1040 handle    <div class="mdetail-params">\r
1041         <strong>Parameters:</strong>\r
1042         <ul><li><code>the</code> : id<div class="sub-desc">id of the element that will be used to initiate the drag</div></li>        </ul>\r
1043         <strong>Returns:</strong>\r
1044         <ul>\r
1045             <li><code>void</code></li>\r
1046         </ul>\r
1047     </div>\r
1048                 </div>\r
1049                         </div>\r
1050         </td>\r
1051         <td class="msource">DragDrop</td>\r
1052     </tr>\r
1053         <tr class="method-row alt expandable">\r
1054         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1055         <td class="sig">\r
1056         <a id="Ext.dd.DragDrop-setPadding"></a>\r
1057             <b>setPadding</b>(&nbsp;<code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code>&nbsp;) : void            <div class="mdesc">\r
1058                         <div class="short">Configures the padding for the target zone in px.  Effectively expands
1059 (or reduces) the virtual object size for targe...</div>\r
1060             <div class="long">\r
1061                 Configures the padding for the target zone in px.  Effectively expands
1062 (or reduces) the virtual object size for targeting calculations.
1063 Supports css-style shorthand; if only one parameter is passed, all sides
1064 will have that padding, and if only two are passed, the top and bottom
1065 will have the first param, the left and right the second.    <div class="mdetail-params">\r
1066         <strong>Parameters:</strong>\r
1067         <ul><li><code>iTop</code> : int<div class="sub-desc">Top pad</div></li><li><code>iRight</code> : int<div class="sub-desc">Right pad</div></li><li><code>iBot</code> : int<div class="sub-desc">Bot pad</div></li><li><code>iLeft</code> : int<div class="sub-desc">Left pad</div></li>        </ul>\r
1068         <strong>Returns:</strong>\r
1069         <ul>\r
1070             <li><code>void</code></li>\r
1071         </ul>\r
1072     </div>\r
1073                 </div>\r
1074                         </div>\r
1075         </td>\r
1076         <td class="msource">DragDrop</td>\r
1077     </tr>\r
1078         <tr class="method-row expandable">\r
1079         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1080         <td class="sig">\r
1081         <a id="Ext.dd.DragDrop-setXConstraint"></a>\r
1082             <b>setXConstraint</b>(&nbsp;<code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code>&nbsp;) : void            <div class="mdesc">\r
1083                         <div class="short">By default, the element can be dragged any place on the screen.  Use
1084 this method to limit the horizontal travel of th...</div>\r
1085             <div class="long">\r
1086                 By default, the element can be dragged any place on the screen.  Use
1087 this method to limit the horizontal travel of the element.  Pass in
1088 0,0 for the parameters if you want to lock the drag to the y axis.    <div class="mdetail-params">\r
1089         <strong>Parameters:</strong>\r
1090         <ul><li><code>iLeft</code> : int<div class="sub-desc">the number of pixels the element can move to the left</div></li><li><code>iRight</code> : int<div class="sub-desc">the number of pixels the element can move to the
1091 right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
1092 element
1093 should move iTickSize pixels at a time.</div></li>        </ul>\r
1094         <strong>Returns:</strong>\r
1095         <ul>\r
1096             <li><code>void</code></li>\r
1097         </ul>\r
1098     </div>\r
1099                 </div>\r
1100                         </div>\r
1101         </td>\r
1102         <td class="msource">DragDrop</td>\r
1103     </tr>\r
1104         <tr class="method-row alt expandable">\r
1105         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1106         <td class="sig">\r
1107         <a id="Ext.dd.DragDrop-setYConstraint"></a>\r
1108             <b>setYConstraint</b>(&nbsp;<code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code>&nbsp;) : void            <div class="mdesc">\r
1109                         <div class="short">By default, the element can be dragged any place on the screen.  Set
1110 this to limit the vertical travel of the element...</div>\r
1111             <div class="long">\r
1112                 By default, the element can be dragged any place on the screen.  Set
1113 this to limit the vertical travel of the element.  Pass in 0,0 for the
1114 parameters if you want to lock the drag to the x axis.    <div class="mdetail-params">\r
1115         <strong>Parameters:</strong>\r
1116         <ul><li><code>iUp</code> : int<div class="sub-desc">the number of pixels the element can move up</div></li><li><code>iDown</code> : int<div class="sub-desc">the number of pixels the element can move down</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
1117 element should move iTickSize pixels at a time.</div></li>        </ul>\r
1118         <strong>Returns:</strong>\r
1119         <ul>\r
1120             <li><code>void</code></li>\r
1121         </ul>\r
1122     </div>\r
1123                 </div>\r
1124                         </div>\r
1125         </td>\r
1126         <td class="msource">DragDrop</td>\r
1127     </tr>\r
1128         <tr class="method-row expandable">\r
1129         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1130         <td class="sig">\r
1131         <a id="Ext.dd.DragDrop-startDrag"></a>\r
1132             <b>startDrag</b>(&nbsp;<code>int X</code>, <code>int Y</code>&nbsp;) : void            <div class="mdesc">\r
1133                         <div class="short">Abstract method called after a drag/drop object is clicked
1134 and the drag or mousedown time thresholds have beeen met.</div>\r
1135             <div class="long">\r
1136                 Abstract method called after a drag/drop object is clicked
1137 and the drag or mousedown time thresholds have beeen met.    <div class="mdetail-params">\r
1138         <strong>Parameters:</strong>\r
1139         <ul><li><code>X</code> : int<div class="sub-desc">click location</div></li><li><code>Y</code> : int<div class="sub-desc">click location</div></li>        </ul>\r
1140         <strong>Returns:</strong>\r
1141         <ul>\r
1142             <li><code>void</code></li>\r
1143         </ul>\r
1144     </div>\r
1145                 </div>\r
1146                         </div>\r
1147         </td>\r
1148         <td class="msource">DragDrop</td>\r
1149     </tr>\r
1150         <tr class="method-row alt expandable">\r
1151         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1152         <td class="sig">\r
1153         <a id="Ext.dd.DragDrop-toString"></a>\r
1154             <b>toString</b>() : string            <div class="mdesc">\r
1155                         <div class="short">toString method</div>\r
1156             <div class="long">\r
1157                 toString method    <div class="mdetail-params">\r
1158         <strong>Parameters:</strong>\r
1159         <ul><li>None.</li>        </ul>\r
1160         <strong>Returns:</strong>\r
1161         <ul>\r
1162             <li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li>\r
1163         </ul>\r
1164     </div>\r
1165                 </div>\r
1166                         </div>\r
1167         </td>\r
1168         <td class="msource">DragDrop</td>\r
1169     </tr>\r
1170         <tr class="method-row expandable">\r
1171         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1172         <td class="sig">\r
1173         <a id="Ext.dd.DragDrop-unlock"></a>\r
1174             <b>unlock</b>() : void            <div class="mdesc">\r
1175                         <div class="short">Unlock this instace</div>\r
1176             <div class="long">\r
1177                 Unlock this instace    <div class="mdetail-params">\r
1178         <strong>Parameters:</strong>\r
1179         <ul><li>None.</li>        </ul>\r
1180         <strong>Returns:</strong>\r
1181         <ul>\r
1182             <li><code>void</code></li>\r
1183         </ul>\r
1184     </div>\r
1185                 </div>\r
1186                         </div>\r
1187         </td>\r
1188         <td class="msource">DragDrop</td>\r
1189     </tr>\r
1190         <tr class="method-row alt expandable">\r
1191         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1192         <td class="sig">\r
1193         <a id="Ext.dd.DragDrop-unreg"></a>\r
1194             <b>unreg</b>() : void            <div class="mdesc">\r
1195                         <div class="short">Remove all drag and drop hooks for this element</div>\r
1196             <div class="long">\r
1197                 Remove all drag and drop hooks for this element    <div class="mdetail-params">\r
1198         <strong>Parameters:</strong>\r
1199         <ul><li>None.</li>        </ul>\r
1200         <strong>Returns:</strong>\r
1201         <ul>\r
1202             <li><code>void</code></li>\r
1203         </ul>\r
1204     </div>\r
1205                 </div>\r
1206                         </div>\r
1207         </td>\r
1208         <td class="msource">DragDrop</td>\r
1209     </tr>\r
1210             </table>
1211                 <a id="Ext.dd.DragDrop-events"></a>
1212         <h2>Public Events</h2>
1213         <div class="no-members">This class has no public events.</div>
1214         </div>