1 <div class="body-wrap">
2 <div class="top-tools">
3 <a class="inner-link" href="#Ext.tree.TreeDragZone-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 <a class="inner-link" href="#Ext.tree.TreeDragZone-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 <a class="inner-link" href="#Ext.tree.TreeDragZone-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 <a class="inner-link" href="#Ext.tree.TreeDragZone-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7 <a class="bookmark" href="../docs/?class=Ext.tree.TreeDragZone"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
9 <div class="inheritance res-block">
10 <pre class="res-block-inner"><a ext:cls="Ext.dd.DragDrop" ext:member="" href="output/Ext.dd.DragDrop.html">DragDrop</a>
11 <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DD" ext:member="" href="output/Ext.dd.DD.html">DD</a>
12 <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DDProxy" ext:member="" href="output/Ext.dd.DDProxy.html">DDProxy</a>
13 <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DragSource" ext:member="" href="output/Ext.dd.DragSource.html">DragSource</a>
14 <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DragZone" ext:member="" href="output/Ext.dd.DragZone.html">DragZone</a>
15 <img src="resources/elbow-end.gif"/>TreeDragZone</pre></div>
16 <h1>Class Ext.tree.TreeDragZone</h1>
17 <table cellspacing="0">
18 <tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr>
19 <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/TreeDragZone.js" target="_blank">TreeDragZone.js</a></td></tr>
20 <tr><td class="label">Class:</td><td class="hd-info">TreeDragZone</td></tr>
21 <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.dd.DragZone" ext:member="" href="output/Ext.dd.DragZone.html">DragZone</a></td></tr>
23 <div class="description">
26 <div class="hr"></div>
27 <a id="Ext.tree.TreeDragZone-configs"></a>
28 <h2>Config Options</h2>
29 <table cellspacing="0" class="member-table">
31 <th class="sig-header" colspan="2">Config Options</th>
32 <th class="msource-header">Defined By</th>
34 <tr class="config-row inherited">
\r
35 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
37 <a id="Ext.tree.TreeDragZone-containerScroll"></a>
\r
38 <b>containerScroll</b> : Boolean <div class="mdesc">
\r
39 True to register this container with the Scrollmanager for auto scrolling during drag operations. </div>
\r
41 <td class="msource"><a ext:cls="Ext.dd.DragZone" ext:member="#containerScroll" href="output/Ext.dd.DragZone.html#containerScroll">DragZone</a></td>
\r
43 <tr class="config-row alt expandable">
\r
44 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
46 <a id="Ext.tree.TreeDragZone-ddGroup"></a>
\r
47 <b>ddGroup</b> : String <div class="mdesc">
\r
48 <div class="short">A named drag drop group to which this object belongs. If a group is specified, then this object will only interact wi...</div>
\r
50 A named drag drop group to which this object belongs. If a group is specified, then this object will only interact with other drag drop objects in the same group (defaults to 'TreeDD'). </div>
\r
53 <td class="msource">TreeDragZone</td>
\r
55 <tr class="config-row inherited">
\r
56 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
58 <a id="Ext.tree.TreeDragZone-dropAllowed"></a>
\r
59 <b>dropAllowed</b> : String <div class="mdesc">
\r
60 The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). </div>
\r
62 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#dropAllowed" href="output/Ext.dd.DragSource.html#dropAllowed">DragSource</a></td>
\r
64 <tr class="config-row inherited alt">
\r
65 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
67 <a id="Ext.tree.TreeDragZone-dropNotAllowed"></a>
\r
68 <b>dropNotAllowed</b> : String <div class="mdesc">
\r
69 The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div>
\r
71 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#dropNotAllowed" href="output/Ext.dd.DragSource.html#dropNotAllowed">DragSource</a></td>
\r
73 <tr class="config-row inherited expandable">
\r
74 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
76 <a id="Ext.tree.TreeDragZone-hlColor"></a>
\r
77 <b>hlColor</b> : String <div class="mdesc">
\r
78 <div class="short">The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults t...</div>
\r
80 The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults to "c3daf9" - light blue) </div>
\r
83 <td class="msource"><a ext:cls="Ext.dd.DragZone" ext:member="#hlColor" href="output/Ext.dd.DragZone.html#hlColor">DragZone</a></td>
\r
86 <a id="Ext.tree.TreeDragZone-props"></a>
87 <h2>Public Properties</h2>
88 <table cellspacing="0" class="member-table">
90 <th class="sig-header" colspan="2">Property</th>
91 <th class="msource-header">Defined By</th>
93 <tr class="property-row inherited">
\r
94 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
96 <a id="Ext.tree.TreeDragZone-available"></a>
\r
97 <b>available</b> : boolean <div class="mdesc">
\r
98 The availabe property is false until the linked dom element is accessible. </div>
\r
100 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#available" href="output/Ext.dd.DragDrop.html#available">DragDrop</a></td>
\r
102 <tr class="property-row inherited alt expandable">
\r
103 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
105 <a id="Ext.tree.TreeDragZone-centerFrame"></a>
\r
106 <b>centerFrame</b> : boolean <div class="mdesc">
\r
107 <div class="short">By default the frame is positioned exactly where the drag element is, so
108 we use the cursor offset provided by Ext.dd....</div>
\r
110 By default the frame is positioned exactly where the drag element is, so
111 we use the cursor offset provided by Ext.dd.DD. Another option that works only if
112 you do not have constraints on the obj is to have the drag frame centered
113 around the cursor. Set centerFrame to true for this effect. </div>
\r
116 <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#centerFrame" href="output/Ext.dd.DDProxy.html#centerFrame">DDProxy</a></td>
\r
118 <tr class="property-row inherited">
\r
119 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
121 <a id="Ext.tree.TreeDragZone-config"></a>
\r
122 <b>config</b> : object <div class="mdesc">
\r
123 Configuration attributes passed into the constructor </div>
\r
125 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#config" href="output/Ext.dd.DragDrop.html#config">DragDrop</a></td>
\r
127 <tr class="property-row inherited alt">
\r
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
130 <a id="Ext.tree.TreeDragZone-defaultPadding"></a>
\r
131 <b>defaultPadding</b> : Object <div class="mdesc">
\r
132 Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). </div>
\r
134 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#defaultPadding" href="output/Ext.dd.DragDrop.html#defaultPadding">DragDrop</a></td>
\r
136 <tr class="property-row inherited expandable">
\r
137 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
139 <a id="Ext.tree.TreeDragZone-groups"></a>
\r
140 <b>groups</b> : object <div class="mdesc">
\r
141 <div class="short">The group defines a logical collection of DragDrop objects that are
142 related. Instances only get events when interact...</div>
\r
144 The group defines a logical collection of DragDrop objects that are
145 related. Instances only get events when interacting with other
146 DragDrop object in the same group. This lets us define multiple
147 groups using a single DragDrop subclass if we want. </div>
\r
150 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#groups" href="output/Ext.dd.DragDrop.html#groups">DragDrop</a></td>
\r
152 <tr class="property-row inherited alt expandable">
\r
153 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
155 <a id="Ext.tree.TreeDragZone-hasOuterHandles"></a>
\r
156 <b>hasOuterHandles</b> : boolean <div class="mdesc">
\r
157 <div class="short">By default, drags can only be initiated if the mousedown occurs in the
158 region the linked element is. This is done in...</div>
\r
160 By default, drags can only be initiated if the mousedown occurs in the
161 region the linked element is. This is done in part to work around a
162 bug in some browsers that mis-report the mousedown if the previous
163 mouseup happened outside of the window. This property is set to true
164 if outer handles are defined. </div>
\r
167 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#hasOuterHandles" href="output/Ext.dd.DragDrop.html#hasOuterHandles">DragDrop</a></td>
\r
169 <tr class="property-row inherited expandable">
\r
170 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
172 <a id="Ext.tree.TreeDragZone-id"></a>
\r
173 <b>id</b> : String <div class="mdesc">
\r
174 <div class="short">The id of the element associated with this object. This is what we
175 refer to as the "linked element" because the size...</div>
\r
177 The id of the element associated with this object. This is what we
178 refer to as the "linked element" because the size and position of
179 this element is used to determine when the drag and drop objects have
183 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#id" href="output/Ext.dd.DragDrop.html#id">DragDrop</a></td>
\r
185 <tr class="property-row inherited alt">
\r
186 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
188 <a id="Ext.tree.TreeDragZone-invalidHandleClasses"></a>
\r
189 <b>invalidHandleClasses</b> : Array <div class="mdesc">
\r
190 An Array of CSS class names for elements to be considered in valid as drag handles. </div>
\r
192 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleClasses" href="output/Ext.dd.DragDrop.html#invalidHandleClasses">DragDrop</a></td>
\r
194 <tr class="property-row inherited expandable">
\r
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
197 <a id="Ext.tree.TreeDragZone-invalidHandleIds"></a>
\r
198 <b>invalidHandleIds</b> : Object <div class="mdesc">
\r
199 <div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles.
200 A non-null prop...</div>
\r
202 An object who's property names identify the IDs of elements to be considered invalid as drag handles.
203 A non-null property value identifies the ID as invalid. For example, to prevent
204 dragging from being initiated on element ID "foo", use:<pre><code>{
206 }</code></pre> </div>
\r
209 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleIds" href="output/Ext.dd.DragDrop.html#invalidHandleIds">DragDrop</a></td>
\r
211 <tr class="property-row inherited alt expandable">
\r
212 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
214 <a id="Ext.tree.TreeDragZone-invalidHandleTypes"></a>
\r
215 <b>invalidHandleTypes</b> : Object <div class="mdesc">
\r
216 <div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles.
217 A non-null property value...</div>
\r
219 An object who's property names identify HTML tags to be considered invalid as drag handles.
220 A non-null property value identifies the tag as invalid. Defaults to the
221 following value which prevents drag operations from being initiated by <a> elements:<pre><code>{
223 }</code></pre> </div>
\r
226 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleTypes" href="output/Ext.dd.DragDrop.html#invalidHandleTypes">DragDrop</a></td>
\r
228 <tr class="property-row inherited">
\r
229 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
231 <a id="Ext.tree.TreeDragZone-isTarget"></a>
\r
232 <b>isTarget</b> : boolean <div class="mdesc">
\r
233 By default, all instances can be a drop target. This can be disabled by
234 setting isTarget to false. </div>
\r
236 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isTarget" href="output/Ext.dd.DragDrop.html#isTarget">DragDrop</a></td>
\r
238 <tr class="property-row inherited alt expandable">
\r
239 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
241 <a id="Ext.tree.TreeDragZone-maintainOffset"></a>
\r
242 <b>maintainOffset</b> : boolean <div class="mdesc">
\r
243 <div class="short">Maintain offsets when we resetconstraints. Set to true when you want
244 the position of the element relative to its par...</div>
\r
246 Maintain offsets when we resetconstraints. Set to true when you want
247 the position of the element relative to its parent to stay the same
248 when the page changes </div>
\r
251 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#maintainOffset" href="output/Ext.dd.DragDrop.html#maintainOffset">DragDrop</a></td>
\r
253 <tr class="property-row inherited expandable">
\r
254 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
256 <a id="Ext.tree.TreeDragZone-moveOnly"></a>
\r
257 <b>moveOnly</b> : boolean <div class="mdesc">
\r
258 <div class="short">When set to true, other DD objects in cooperating DDGroups do not receive
259 notification events when this DD object is ...</div>
\r
261 When set to true, other DD objects in cooperating DDGroups do not receive
262 notification events when this DD object is dragged over them. Defaults to false. </div>
\r
265 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#moveOnly" href="output/Ext.dd.DragDrop.html#moveOnly">DragDrop</a></td>
\r
267 <tr class="property-row inherited alt expandable">
\r
268 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
270 <a id="Ext.tree.TreeDragZone-onStartDrag"></a>
\r
271 <b>onStartDrag</b> : Object <div class="mdesc">
\r
272 <div class="short">An empty function by default, but provided so that you can perform a custom action once the initial
273 drag event has be...</div>
\r
275 An empty function by default, but provided so that you can perform a custom action once the initial
276 drag event has begun. The drag cannot be canceled from this function. </div>
\r
279 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#onStartDrag" href="output/Ext.dd.DragSource.html#onStartDrag">DragSource</a></td>
\r
281 <tr class="property-row inherited">
\r
282 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
284 <a id="Ext.tree.TreeDragZone-padding"></a>
\r
285 <b>padding</b> : int[] <div class="mdesc">
\r
286 The padding configured for this drag and drop object for calculating
287 the drop zone intersection with this object. </div>
\r
289 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#padding" href="output/Ext.dd.DragDrop.html#padding">DragDrop</a></td>
\r
291 <tr class="property-row inherited alt expandable">
\r
292 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
294 <a id="Ext.tree.TreeDragZone-primaryButtonOnly"></a>
\r
295 <b>primaryButtonOnly</b> : boolean <div class="mdesc">
\r
296 <div class="short">By default the drag and drop instance will only respond to the primary
297 button click (left button for a right-handed m...</div>
\r
299 By default the drag and drop instance will only respond to the primary
300 button click (left button for a right-handed mouse). Set to true to
301 allow drag and drop to start with any mouse click that is propogated
302 by the browser </div>
\r
305 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#primaryButtonOnly" href="output/Ext.dd.DragDrop.html#primaryButtonOnly">DragDrop</a></td>
\r
307 <tr class="property-row inherited expandable">
\r
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
310 <a id="Ext.tree.TreeDragZone-resizeFrame"></a>
\r
311 <b>resizeFrame</b> : boolean <div class="mdesc">
\r
312 <div class="short">By default we resize the drag frame to be the same size as the element
313 we want to drag (this is to get the frame effe...</div>
\r
315 By default we resize the drag frame to be the same size as the element
316 we want to drag (this is to get the frame effect). We can turn it off
317 if we want a different behavior. </div>
\r
320 <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#resizeFrame" href="output/Ext.dd.DDProxy.html#resizeFrame">DDProxy</a></td>
\r
322 <tr class="property-row inherited alt expandable">
\r
323 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
325 <a id="Ext.tree.TreeDragZone-scroll"></a>
\r
326 <b>scroll</b> : boolean <div class="mdesc">
\r
327 <div class="short">When set to true, the utility automatically tries to scroll the browser
328 window when a drag and drop element is dragge...</div>
\r
330 When set to true, the utility automatically tries to scroll the browser
331 window when a drag and drop element is dragged near the viewport boundary.
332 Defaults to true. </div>
\r
335 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#scroll" href="output/Ext.dd.DD.html#scroll">DD</a></td>
\r
337 <tr class="property-row">
\r
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
340 <a id="Ext.tree.TreeDragZone-tree"></a>
\r
341 <b>tree</b> : Ext.tree.TreePanel <div class="mdesc">
\r
342 The TreePanel for this drag zone </div>
\r
344 <td class="msource">TreeDragZone</td>
\r
346 <tr class="property-row inherited alt expandable">
\r
347 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
349 <a id="Ext.tree.TreeDragZone-xTicks"></a>
\r
350 <b>xTicks</b> : int[] <div class="mdesc">
\r
351 <div class="short">Array of pixel locations the element will snap to if we specified a
352 horizontal graduation/interval. This array is ge...</div>
\r
354 Array of pixel locations the element will snap to if we specified a
355 horizontal graduation/interval. This array is generated automatically
356 when you define a tick interval. </div>
\r
359 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#xTicks" href="output/Ext.dd.DragDrop.html#xTicks">DragDrop</a></td>
\r
361 <tr class="property-row inherited expandable">
\r
362 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
364 <a id="Ext.tree.TreeDragZone-yTicks"></a>
\r
365 <b>yTicks</b> : int[] <div class="mdesc">
\r
366 <div class="short">Array of pixel locations the element will snap to if we specified a
367 vertical graduation/interval. This array is gene...</div>
\r
369 Array of pixel locations the element will snap to if we specified a
370 vertical graduation/interval. This array is generated automatically
371 when you define a tick interval. </div>
\r
374 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#yTicks" href="output/Ext.dd.DragDrop.html#yTicks">DragDrop</a></td>
\r
377 <a id="Ext.tree.TreeDragZone-methods"></a>
378 <h2>Public Methods</h2>
379 <table cellspacing="0" class="member-table">
381 <th class="sig-header" colspan="2">Method</th>
382 <th class="msource-header">Defined By</th>
384 <tr class="method-row expandable">
\r
385 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
387 <a id="Ext.tree.TreeDragZone-TreeDragZone"></a>
\r
388 <b>TreeDragZone</b>( <code>String/HTMLElement/Element tree</code>, <code>Object config</code> ) <div class="mdesc">
\r
389 <div class="short"></div>
\r
391 <div class="mdetail-params">
\r
392 <strong>Parameters:</strong>
\r
393 <ul><li><code>tree</code> : String/HTMLElement/Element<div class="sub-desc">The <a ext:cls="Ext.tree.TreePanel" href="output/Ext.tree.TreePanel.html">Ext.tree.TreePanel</a> for which to enable dragging</div></li><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>
\r
394 <strong>Returns:</strong>
\r
396 <li><code></code></li>
\r
402 <td class="msource">TreeDragZone</td>
\r
404 <tr class="method-row inherited alt expandable">
\r
405 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
407 <a id="Ext.tree.TreeDragZone-addInvalidHandleClass"></a>
\r
408 <b>addInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">
\r
409 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
\r
411 Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params">
\r
412 <strong>Parameters:</strong>
\r
413 <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul>
\r
414 <strong>Returns:</strong>
\r
416 <li><code>void</code></li>
\r
422 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleClass" href="output/Ext.dd.DragDrop.html#addInvalidHandleClass">DragDrop</a></td>
\r
424 <tr class="method-row inherited expandable">
\r
425 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
427 <a id="Ext.tree.TreeDragZone-addInvalidHandleId"></a>
\r
428 <b>addInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">
\r
429 <div class="short">Lets you to specify an element id for a child of a drag handle
430 that should not initiate a drag</div>
\r
432 Lets you to specify an element id for a child of a drag handle
433 that should not initiate a drag <div class="mdetail-params">
\r
434 <strong>Parameters:</strong>
\r
435 <ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li> </ul>
\r
436 <strong>Returns:</strong>
\r
438 <li><code>void</code></li>
\r
444 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleId" href="output/Ext.dd.DragDrop.html#addInvalidHandleId">DragDrop</a></td>
\r
446 <tr class="method-row inherited alt expandable">
\r
447 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
449 <a id="Ext.tree.TreeDragZone-addInvalidHandleType"></a>
\r
450 <b>addInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">
\r
451 <div class="short">Allows you to specify a tag name that should not start a drag operation
452 when clicked. This is designed to facilitate...</div>
\r
454 Allows you to specify a tag name that should not start a drag operation
455 when clicked. This is designed to facilitate embedding links within a
456 drag handle that do something other than start the drag. <div class="mdetail-params">
\r
457 <strong>Parameters:</strong>
\r
458 <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul>
\r
459 <strong>Returns:</strong>
\r
461 <li><code>void</code></li>
\r
467 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleType" href="output/Ext.dd.DragDrop.html#addInvalidHandleType">DragDrop</a></td>
\r
469 <tr class="method-row inherited expandable">
\r
470 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
472 <a id="Ext.tree.TreeDragZone-addToGroup"></a>
\r
473 <b>addToGroup</b>( <code>sGroup {string}</code> ) : void <div class="mdesc">
\r
474 <div class="short">Add this instance to a group of related drag/drop objects. All
475 instances belong to at least one group, and can belon...</div>
\r
477 Add this instance to a group of related drag/drop objects. All
478 instances belong to at least one group, and can belong to as many
479 groups as needed. <div class="mdetail-params">
\r
480 <strong>Parameters:</strong>
\r
481 <ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul>
\r
482 <strong>Returns:</strong>
\r
484 <li><code>void</code></li>
\r
490 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addToGroup" href="output/Ext.dd.DragDrop.html#addToGroup">DragDrop</a></td>
\r
492 <tr class="method-row inherited alt expandable">
\r
493 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
495 <a id="Ext.tree.TreeDragZone-afterDragDrop"></a>
\r
496 <b>afterDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
497 <div class="short">An empty function by default, but provided so that you can perform a custom action
498 after a valid drag drop has occurr...</div>
\r
500 An empty function by default, but provided so that you can perform a custom action
501 after a valid drag drop has occurred by providing an implementation. <div class="mdetail-params">
\r
502 <strong>Parameters:</strong>
\r
503 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dropped element</div></li> </ul>
\r
504 <strong>Returns:</strong>
\r
506 <li><code>void</code></li>
\r
512 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragDrop" href="output/Ext.dd.DragSource.html#afterDragDrop">DragSource</a></td>
\r
514 <tr class="method-row inherited expandable">
\r
515 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
517 <a id="Ext.tree.TreeDragZone-afterDragEnter"></a>
\r
518 <b>afterDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
519 <div class="short">An empty function by default, but provided so that you can perform a custom action
520 when the dragged item enters the d...</div>
\r
522 An empty function by default, but provided so that you can perform a custom action
523 when the dragged item enters the drop target by providing an implementation. <div class="mdetail-params">
\r
524 <strong>Parameters:</strong>
\r
525 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>
\r
526 <strong>Returns:</strong>
\r
528 <li><code>void</code></li>
\r
534 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragEnter" href="output/Ext.dd.DragSource.html#afterDragEnter">DragSource</a></td>
\r
536 <tr class="method-row inherited alt expandable">
\r
537 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
539 <a id="Ext.tree.TreeDragZone-afterDragOut"></a>
\r
540 <b>afterDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
541 <div class="short">An empty function by default, but provided so that you can perform a custom action
542 after the dragged item is dragged ...</div>
\r
544 An empty function by default, but provided so that you can perform a custom action
545 after the dragged item is dragged out of the target without dropping. <div class="mdetail-params">
\r
546 <strong>Parameters:</strong>
\r
547 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>
\r
548 <strong>Returns:</strong>
\r
550 <li><code>void</code></li>
\r
556 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragOut" href="output/Ext.dd.DragSource.html#afterDragOut">DragSource</a></td>
\r
558 <tr class="method-row inherited expandable">
\r
559 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
561 <a id="Ext.tree.TreeDragZone-afterDragOver"></a>
\r
562 <b>afterDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
563 <div class="short">An empty function by default, but provided so that you can perform a custom action
564 while the dragged item is over the...</div>
\r
566 An empty function by default, but provided so that you can perform a custom action
567 while the dragged item is over the drop target by providing an implementation. <div class="mdetail-params">
\r
568 <strong>Parameters:</strong>
\r
569 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>
\r
570 <strong>Returns:</strong>
\r
572 <li><code>void</code></li>
\r
578 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragOver" href="output/Ext.dd.DragSource.html#afterDragOver">DragSource</a></td>
\r
580 <tr class="method-row inherited alt expandable">
\r
581 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
583 <a id="Ext.tree.TreeDragZone-afterInvalidDrop"></a>
\r
584 <b>afterInvalidDrop</b>( <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
585 <div class="short">An empty function by default, but provided so that you can perform a custom action
586 after an invalid drop has occurred...</div>
\r
588 An empty function by default, but provided so that you can perform a custom action
589 after an invalid drop has occurred by providing an implementation. <div class="mdetail-params">
\r
590 <strong>Parameters:</strong>
\r
591 <ul><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dropped element</div></li> </ul>
\r
592 <strong>Returns:</strong>
\r
594 <li><code>void</code></li>
\r
600 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterInvalidDrop" href="output/Ext.dd.DragSource.html#afterInvalidDrop">DragSource</a></td>
\r
602 <tr class="method-row inherited expandable">
\r
603 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
605 <a id="Ext.tree.TreeDragZone-afterRepair"></a>
\r
606 <b>afterRepair</b>() : void <div class="mdesc">
\r
607 <div class="short">Called after a repair of an invalid drop. By default, highlights this.dragData.ddel</div>
\r
609 Called after a repair of an invalid drop. By default, highlights this.dragData.ddel <div class="mdetail-params">
\r
610 <strong>Parameters:</strong>
\r
611 <ul><li>None.</li> </ul>
\r
612 <strong>Returns:</strong>
\r
614 <li><code>void</code></li>
\r
620 <td class="msource"><a ext:cls="Ext.dd.DragZone" ext:member="#afterRepair" href="output/Ext.dd.DragZone.html#afterRepair">DragZone</a></td>
\r
622 <tr class="method-row inherited alt expandable">
\r
623 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
625 <a id="Ext.tree.TreeDragZone-alignElWithMouse"></a>
\r
626 <b>alignElWithMouse</b>( <code>HTMLElement el</code>, <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
\r
627 <div class="short">Sets the element to the location of the mousedown or click event,
628 maintaining the cursor location relative to the loc...</div>
\r
630 Sets the element to the location of the mousedown or click event,
631 maintaining the cursor location relative to the location on the element
632 that was clicked. Override this if you want to place the element in a
633 location other than where the cursor is. <div class="mdetail-params">
\r
634 <strong>Parameters:</strong>
\r
635 <ul><li><code>el</code> : HTMLElement<div class="sub-desc">the element to move</div></li><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the mousedown or drag event</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the mousedown or drag event</div></li> </ul>
\r
636 <strong>Returns:</strong>
\r
638 <li><code>void</code></li>
\r
644 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#alignElWithMouse" href="output/Ext.dd.DD.html#alignElWithMouse">DD</a></td>
\r
646 <tr class="method-row inherited expandable">
\r
647 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
649 <a id="Ext.tree.TreeDragZone-applyConfig"></a>
\r
650 <b>applyConfig</b>() : void <div class="mdesc">
\r
651 <div class="short">Applies the configuration parameters that were passed into the constructor.
652 This is supposed to happen at each level ...</div>
\r
654 Applies the configuration parameters that were passed into the constructor.
655 This is supposed to happen at each level through the inheritance chain. So
656 a DDProxy implentation will execute apply config on DDProxy, DD, and
657 DragDrop in order to get all of the parameters that are available in
658 each object. <div class="mdetail-params">
\r
659 <strong>Parameters:</strong>
\r
660 <ul><li>None.</li> </ul>
\r
661 <strong>Returns:</strong>
\r
663 <li><code>void</code></li>
\r
669 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#applyConfig" href="output/Ext.dd.DragDrop.html#applyConfig">DragDrop</a></td>
\r
671 <tr class="method-row inherited alt expandable">
\r
672 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
674 <a id="Ext.tree.TreeDragZone-autoOffset"></a>
\r
675 <b>autoOffset</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
\r
676 <div class="short">Sets the pointer offset to the distance between the linked element's top
677 left corner and the location the element was...</div>
\r
679 Sets the pointer offset to the distance between the linked element's top
680 left corner and the location the element was clicked <div class="mdetail-params">
\r
681 <strong>Parameters:</strong>
\r
682 <ul><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the click</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the click</div></li> </ul>
\r
683 <strong>Returns:</strong>
\r
685 <li><code>void</code></li>
\r
691 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#autoOffset" href="output/Ext.dd.DD.html#autoOffset">DD</a></td>
\r
693 <tr class="method-row inherited expandable">
\r
694 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
696 <a id="Ext.tree.TreeDragZone-b4Drag"></a>
\r
697 <b>b4Drag</b>() : void <div class="mdesc">
\r
698 <div class="short">Event that fires prior to the onDrag event. Overrides
699 Ext.dd.DragDrop.</div>
\r
701 Event that fires prior to the onDrag event. Overrides
702 Ext.dd.DragDrop. <div class="mdetail-params">
\r
703 <strong>Parameters:</strong>
\r
704 <ul><li>None.</li> </ul>
\r
705 <strong>Returns:</strong>
\r
707 <li><code>void</code></li>
\r
713 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4Drag" href="output/Ext.dd.DD.html#b4Drag">DD</a></td>
\r
715 <tr class="method-row inherited alt expandable">
\r
716 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
718 <a id="Ext.tree.TreeDragZone-b4MouseDown"></a>
\r
719 <b>b4MouseDown</b>() : void <div class="mdesc">
\r
720 <div class="short">Event that fires prior to the onMouseDown event. Overrides
721 Ext.dd.DragDrop.</div>
\r
723 Event that fires prior to the onMouseDown event. Overrides
724 Ext.dd.DragDrop. <div class="mdetail-params">
\r
725 <strong>Parameters:</strong>
\r
726 <ul><li>None.</li> </ul>
\r
727 <strong>Returns:</strong>
\r
729 <li><code>void</code></li>
\r
735 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4MouseDown" href="output/Ext.dd.DD.html#b4MouseDown">DD</a></td>
\r
737 <tr class="method-row inherited expandable">
\r
738 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
740 <a id="Ext.tree.TreeDragZone-beforeDragDrop"></a>
\r
741 <b>beforeDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
742 <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
743 item is dropped...</div>
\r
745 An empty function by default, but provided so that you can perform a custom action before the dragged
746 item is dropped onto the target and optionally cancel the onDragDrop. <div class="mdetail-params">
\r
747 <strong>Parameters:</strong>
\r
748 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>
\r
749 <strong>Returns:</strong>
\r
751 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag drop event is valid, else false to cancel</div></li>
\r
757 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragDrop" href="output/Ext.dd.DragSource.html#beforeDragDrop">DragSource</a></td>
\r
759 <tr class="method-row inherited alt expandable">
\r
760 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
762 <a id="Ext.tree.TreeDragZone-beforeDragEnter"></a>
\r
763 <b>beforeDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
764 <div class="short">An empty function by default, but provided so that you can perform a custom action
765 before the dragged item enters the...</div>
\r
767 An empty function by default, but provided so that you can perform a custom action
768 before the dragged item enters the drop target and optionally cancel the onDragEnter. <div class="mdetail-params">
\r
769 <strong>Parameters:</strong>
\r
770 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>
\r
771 <strong>Returns:</strong>
\r
773 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
\r
779 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragEnter" href="output/Ext.dd.DragSource.html#beforeDragEnter">DragSource</a></td>
\r
781 <tr class="method-row inherited expandable">
\r
782 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
784 <a id="Ext.tree.TreeDragZone-beforeDragOut"></a>
\r
785 <b>beforeDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
786 <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
787 item is dragged...</div>
\r
789 An empty function by default, but provided so that you can perform a custom action before the dragged
790 item is dragged out of the target without dropping, and optionally cancel the onDragOut. <div class="mdetail-params">
\r
791 <strong>Parameters:</strong>
\r
792 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>
\r
793 <strong>Returns:</strong>
\r
795 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
\r
801 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragOut" href="output/Ext.dd.DragSource.html#beforeDragOut">DragSource</a></td>
\r
803 <tr class="method-row inherited alt expandable">
\r
804 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
806 <a id="Ext.tree.TreeDragZone-beforeDragOver"></a>
\r
807 <b>beforeDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
808 <div class="short">An empty function by default, but provided so that you can perform a custom action
809 while the dragged item is over the...</div>
\r
811 An empty function by default, but provided so that you can perform a custom action
812 while the dragged item is over the drop target and optionally cancel the onDragOver. <div class="mdetail-params">
\r
813 <strong>Parameters:</strong>
\r
814 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>
\r
815 <strong>Returns:</strong>
\r
817 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
\r
823 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragOver" href="output/Ext.dd.DragSource.html#beforeDragOver">DragSource</a></td>
\r
825 <tr class="method-row inherited expandable">
\r
826 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
828 <a id="Ext.tree.TreeDragZone-beforeInvalidDrop"></a>
\r
829 <b>beforeInvalidDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
830 <div class="short">An empty function by default, but provided so that you can perform a custom action after an invalid
831 drop has occurred.</div>
\r
833 An empty function by default, but provided so that you can perform a custom action after an invalid
834 drop has occurred. <div class="mdetail-params">
\r
835 <strong>Parameters:</strong>
\r
836 <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul>
\r
837 <strong>Returns:</strong>
\r
839 <li><code>Boolean</code><div class="sub-desc">isValid True if the invalid drop should proceed, else false to cancel</div></li>
\r
845 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeInvalidDrop" href="output/Ext.dd.DragSource.html#beforeInvalidDrop">DragSource</a></td>
\r
847 <tr class="method-row inherited alt expandable">
\r
848 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
850 <a id="Ext.tree.TreeDragZone-cachePosition"></a>
\r
851 <b>cachePosition</b>( <code>iPageX the</code>, <code>iPageY the</code> ) : void <div class="mdesc">
\r
852 <div class="short">Saves the most recent position so that we can reset the constraints and
853 tick marks on-demand. We need to know this s...</div>
\r
855 Saves the most recent position so that we can reset the constraints and
856 tick marks on-demand. We need to know this so that we can calculate the
857 number of pixels the element is offset from its original position. <div class="mdetail-params">
\r
858 <strong>Parameters:</strong>
\r
859 <ul><li><code>the</code> : iPageX<div class="sub-desc">current x position (optional, this just makes it so we
860 don't have to look it up again)</div></li><li><code>the</code> : iPageY<div class="sub-desc">current y position (optional, this just makes it so we
861 don't have to look it up again)</div></li> </ul>
\r
862 <strong>Returns:</strong>
\r
864 <li><code>void</code></li>
\r
870 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#cachePosition" href="output/Ext.dd.DD.html#cachePosition">DD</a></td>
\r
872 <tr class="method-row inherited expandable">
\r
873 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
875 <a id="Ext.tree.TreeDragZone-clearConstraints"></a>
\r
876 <b>clearConstraints</b>() : void <div class="mdesc">
\r
877 <div class="short">Clears any constraints applied to this instance. Also clears ticks
878 since they can't exist independent of a constrain...</div>
\r
880 Clears any constraints applied to this instance. Also clears ticks
881 since they can't exist independent of a constraint at this time. <div class="mdetail-params">
\r
882 <strong>Parameters:</strong>
\r
883 <ul><li>None.</li> </ul>
\r
884 <strong>Returns:</strong>
\r
886 <li><code>void</code></li>
\r
892 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearConstraints" href="output/Ext.dd.DragDrop.html#clearConstraints">DragDrop</a></td>
\r
894 <tr class="method-row inherited alt expandable">
\r
895 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
897 <a id="Ext.tree.TreeDragZone-clearTicks"></a>
\r
898 <b>clearTicks</b>() : void <div class="mdesc">
\r
899 <div class="short">Clears any tick interval defined for this instance</div>
\r
901 Clears any tick interval defined for this instance <div class="mdetail-params">
\r
902 <strong>Parameters:</strong>
\r
903 <ul><li>None.</li> </ul>
\r
904 <strong>Returns:</strong>
\r
906 <li><code>void</code></li>
\r
912 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearTicks" href="output/Ext.dd.DragDrop.html#clearTicks">DragDrop</a></td>
\r
914 <tr class="method-row inherited expandable">
\r
915 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
917 <a id="Ext.tree.TreeDragZone-constrainTo"></a>
\r
918 <b>constrainTo</b>( <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> ) : void <div class="mdesc">
\r
919 <div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element.
921 var dd = new Ext.d...</div>
\r
923 Initializes the drag drop object's constraints to restrict movement to a certain element.
925 <pre><code>var dd = <b>new</b> Ext.dd.DDProxy(<em>"dragDiv1"</em>, <em>"proxytest"</em>,
926 { dragElId: <em>"existingProxyDiv"</em> });
927 dd.startDrag = <b>function</b>(){
928 <b>this</b>.constrainTo(<em>"parent-id"</em>);
930 Or you can initalize it using the <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object:
\r
931 <pre><code>Ext.get(<em>"dragDiv1"</em>).initDDProxy(<em>"proxytest"</em>, {dragElId: <em>"existingProxyDiv"</em>}, {
932 startDrag : <b>function</b>(){
933 <b>this</b>.constrainTo(<em>"parent-id"</em>);
935 });</code></pre> <div class="mdetail-params">
\r
936 <strong>Parameters:</strong>
\r
937 <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,
938 and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
939 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
940 <strong>Returns:</strong>
\r
942 <li><code>void</code></li>
\r
948 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#constrainTo" href="output/Ext.dd.DragDrop.html#constrainTo">DragDrop</a></td>
\r
950 <tr class="method-row inherited alt expandable">
\r
951 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
953 <a id="Ext.tree.TreeDragZone-createFrame"></a>
\r
954 <b>createFrame</b>() : void <div class="mdesc">
\r
955 <div class="short">Creates the proxy element if it does not yet exist</div>
\r
957 Creates the proxy element if it does not yet exist <div class="mdetail-params">
\r
958 <strong>Parameters:</strong>
\r
959 <ul><li>None.</li> </ul>
\r
960 <strong>Returns:</strong>
\r
962 <li><code>void</code></li>
\r
968 <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#createFrame" href="output/Ext.dd.DDProxy.html#createFrame">DDProxy</a></td>
\r
970 <tr class="method-row inherited expandable">
\r
971 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
973 <a id="Ext.tree.TreeDragZone-endDrag"></a>
\r
974 <b>endDrag</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
975 <div class="short">Fired when we are done dragging the object</div>
\r
977 Fired when we are done dragging the object <div class="mdetail-params">
\r
978 <strong>Parameters:</strong>
\r
979 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
980 <strong>Returns:</strong>
\r
982 <li><code>void</code></li>
\r
988 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#endDrag" href="output/Ext.dd.DragDrop.html#endDrag">DragDrop</a></td>
\r
990 <tr class="method-row inherited alt expandable">
\r
991 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
993 <a id="Ext.tree.TreeDragZone-getDragData"></a>
\r
994 <b>getDragData</b>() : Object <div class="mdesc">
\r
995 <div class="short">Returns the data object associated with this drag source</div>
\r
997 Returns the data object associated with this drag source <div class="mdetail-params">
\r
998 <strong>Parameters:</strong>
\r
999 <ul><li>None.</li> </ul>
\r
1000 <strong>Returns:</strong>
\r
1002 <li><code>Object</code><div class="sub-desc">data An object containing arbitrary data</div></li>
\r
1008 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#getDragData" href="output/Ext.dd.DragSource.html#getDragData">DragSource</a></td>
\r
1010 <tr class="method-row inherited expandable">
\r
1011 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1013 <a id="Ext.tree.TreeDragZone-getDragEl"></a>
\r
1014 <b>getDragEl</b>() : HTMLElement <div class="mdesc">
\r
1015 <div class="short">Returns a reference to the actual element to drag. By default this is
1016 the same as the html element, but it can be as...</div>
\r
1017 <div class="long">
\r
1018 Returns a reference to the actual element to drag. By default this is
1019 the same as the html element, but it can be assigned to another
1020 element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params">
\r
1021 <strong>Parameters:</strong>
\r
1022 <ul><li>None.</li> </ul>
\r
1023 <strong>Returns:</strong>
\r
1025 <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
\r
1031 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getDragEl" href="output/Ext.dd.DragDrop.html#getDragEl">DragDrop</a></td>
\r
1033 <tr class="method-row inherited alt expandable">
\r
1034 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1036 <a id="Ext.tree.TreeDragZone-getEl"></a>
\r
1037 <b>getEl</b>() : HTMLElement <div class="mdesc">
\r
1038 <div class="short">Returns a reference to the linked element</div>
\r
1039 <div class="long">
\r
1040 Returns a reference to the linked element <div class="mdetail-params">
\r
1041 <strong>Parameters:</strong>
\r
1042 <ul><li>None.</li> </ul>
\r
1043 <strong>Returns:</strong>
\r
1045 <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
\r
1051 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getEl" href="output/Ext.dd.DragDrop.html#getEl">DragDrop</a></td>
\r
1053 <tr class="method-row inherited expandable">
\r
1054 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1056 <a id="Ext.tree.TreeDragZone-getProxy"></a>
\r
1057 <b>getProxy</b>() : Ext.dd.StatusProxy <div class="mdesc">
\r
1058 <div class="short">Returns the drag source's underlying <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a></div>
\r
1059 <div class="long">
\r
1060 Returns the drag source's underlying <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a> <div class="mdetail-params">
\r
1061 <strong>Parameters:</strong>
\r
1062 <ul><li>None.</li> </ul>
\r
1063 <strong>Returns:</strong>
\r
1065 <li><code>Ext.dd.StatusProxy</code><div class="sub-desc">proxy The StatusProxy</div></li>
\r
1071 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#getProxy" href="output/Ext.dd.DragSource.html#getProxy">DragSource</a></td>
\r
1073 <tr class="method-row inherited alt expandable">
\r
1074 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1076 <a id="Ext.tree.TreeDragZone-getRepairXY"></a>
\r
1077 <b>getRepairXY</b>( <code>EventObject e</code> ) : Array <div class="mdesc">
\r
1078 <div class="short">Called before a repair of an invalid drop to get the XY to animate to. By default returns
1079 the XY of this.dragData.ddel</div>
\r
1080 <div class="long">
\r
1081 Called before a repair of an invalid drop to get the XY to animate to. By default returns
1082 the XY of this.dragData.ddel <div class="mdetail-params">
\r
1083 <strong>Parameters:</strong>
\r
1084 <ul><li><code>e</code> : EventObject<div class="sub-desc">The mouse up event</div></li> </ul>
\r
1085 <strong>Returns:</strong>
\r
1087 <li><code>Array</code><div class="sub-desc">The xy location (e.g. [100, 200])</div></li>
\r
1093 <td class="msource"><a ext:cls="Ext.dd.DragZone" ext:member="#getRepairXY" href="output/Ext.dd.DragZone.html#getRepairXY">DragZone</a></td>
\r
1095 <tr class="method-row inherited expandable">
\r
1096 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1098 <a id="Ext.tree.TreeDragZone-hideProxy"></a>
\r
1099 <b>hideProxy</b>() : void <div class="mdesc">
\r
1100 <div class="short">Hides the drag source's <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a></div>
\r
1101 <div class="long">
\r
1102 Hides the drag source's <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a> <div class="mdetail-params">
\r
1103 <strong>Parameters:</strong>
\r
1104 <ul><li>None.</li> </ul>
\r
1105 <strong>Returns:</strong>
\r
1107 <li><code>void</code></li>
\r
1113 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#hideProxy" href="output/Ext.dd.DragSource.html#hideProxy">DragSource</a></td>
\r
1115 <tr class="method-row inherited alt expandable">
\r
1116 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1118 <a id="Ext.tree.TreeDragZone-init"></a>
\r
1119 <b>init</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">
\r
1120 <div class="short">Sets up the DragDrop object. Must be called in the constructor of any
1121 Ext.dd.DragDrop subclass</div>
\r
1122 <div class="long">
\r
1123 Sets up the DragDrop object. Must be called in the constructor of any
1124 Ext.dd.DragDrop subclass <div class="mdetail-params">
\r
1125 <strong>Parameters:</strong>
\r
1126 <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
1127 <strong>Returns:</strong>
\r
1129 <li><code>void</code></li>
\r
1135 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#init" href="output/Ext.dd.DragDrop.html#init">DragDrop</a></td>
\r
1137 <tr class="method-row inherited expandable">
\r
1138 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1140 <a id="Ext.tree.TreeDragZone-initFrame"></a>
\r
1141 <b>initFrame</b>() : void <div class="mdesc">
\r
1142 <div class="short">Initialization for the drag frame element. Must be called in the
1143 constructor of all subclasses</div>
\r
1144 <div class="long">
\r
1145 Initialization for the drag frame element. Must be called in the
1146 constructor of all subclasses <div class="mdetail-params">
\r
1147 <strong>Parameters:</strong>
\r
1148 <ul><li>None.</li> </ul>
\r
1149 <strong>Returns:</strong>
\r
1151 <li><code>void</code></li>
\r
1157 <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#initFrame" href="output/Ext.dd.DDProxy.html#initFrame">DDProxy</a></td>
\r
1159 <tr class="method-row inherited alt expandable">
\r
1160 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1162 <a id="Ext.tree.TreeDragZone-initTarget"></a>
\r
1163 <b>initTarget</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">
\r
1164 <div class="short">Initializes Targeting functionality only... the object does not
1165 get a mousedown handler.</div>
\r
1166 <div class="long">
\r
1167 Initializes Targeting functionality only... the object does not
1168 get a mousedown handler. <div class="mdetail-params">
\r
1169 <strong>Parameters:</strong>
\r
1170 <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
1171 <strong>Returns:</strong>
\r
1173 <li><code>void</code></li>
\r
1179 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#initTarget" href="output/Ext.dd.DragDrop.html#initTarget">DragDrop</a></td>
\r
1181 <tr class="method-row inherited expandable">
\r
1182 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1184 <a id="Ext.tree.TreeDragZone-isLocked"></a>
\r
1185 <b>isLocked</b>() : boolean <div class="mdesc">
\r
1186 <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
1187 (meaning that all drag/drop is disabled on th...</div>
\r
1188 <div class="long">
\r
1189 Returns true if this instance is locked, or the drag drop mgr is locked
1190 (meaning that all drag/drop is disabled on the page.) <div class="mdetail-params">
\r
1191 <strong>Parameters:</strong>
\r
1192 <ul><li>None.</li> </ul>
\r
1193 <strong>Returns:</strong>
\r
1195 <li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li>
\r
1201 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isLocked" href="output/Ext.dd.DragDrop.html#isLocked">DragDrop</a></td>
\r
1203 <tr class="method-row inherited alt expandable">
\r
1204 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1206 <a id="Ext.tree.TreeDragZone-isValidHandleChild"></a>
\r
1207 <b>isValidHandleChild</b>( <code>HTMLElement node</code> ) : boolean <div class="mdesc">
\r
1208 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
\r
1209 <div class="long">
\r
1210 Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params">
\r
1211 <strong>Parameters:</strong>
\r
1212 <ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul>
\r
1213 <strong>Returns:</strong>
\r
1215 <li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li>
\r
1221 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isValidHandleChild" href="output/Ext.dd.DragDrop.html#isValidHandleChild">DragDrop</a></td>
\r
1223 <tr class="method-row inherited expandable">
\r
1224 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1226 <a id="Ext.tree.TreeDragZone-lock"></a>
\r
1227 <b>lock</b>() : void <div class="mdesc">
\r
1228 <div class="short">Lock this instance</div>
\r
1229 <div class="long">
\r
1230 Lock this instance <div class="mdetail-params">
\r
1231 <strong>Parameters:</strong>
\r
1232 <ul><li>None.</li> </ul>
\r
1233 <strong>Returns:</strong>
\r
1235 <li><code>void</code></li>
\r
1241 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#lock" href="output/Ext.dd.DragDrop.html#lock">DragDrop</a></td>
\r
1243 <tr class="method-row inherited alt expandable">
\r
1244 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1246 <a id="Ext.tree.TreeDragZone-onAvailable"></a>
\r
1247 <b>onAvailable</b>() : void <div class="mdesc">
\r
1248 <div class="short">Override the onAvailable method to do what is needed after the initial
1249 position was determined.</div>
\r
1250 <div class="long">
\r
1251 Override the onAvailable method to do what is needed after the initial
1252 position was determined. <div class="mdetail-params">
\r
1253 <strong>Parameters:</strong>
\r
1254 <ul><li>None.</li> </ul>
\r
1255 <strong>Returns:</strong>
\r
1257 <li><code>void</code></li>
\r
1263 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onAvailable" href="output/Ext.dd.DragDrop.html#onAvailable">DragDrop</a></td>
\r
1265 <tr class="method-row inherited expandable">
\r
1266 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1268 <a id="Ext.tree.TreeDragZone-onBeforeDrag"></a>
\r
1269 <b>onBeforeDrag</b>( <code>Object data</code>, <code>Event e</code> ) : Boolean <div class="mdesc">
\r
1270 <div class="short">An empty function by default, but provided so that you can perform a custom action before the initial
1271 drag event begi...</div>
\r
1272 <div class="long">
\r
1273 An empty function by default, but provided so that you can perform a custom action before the initial
1274 drag event begins and optionally cancel it. <div class="mdetail-params">
\r
1275 <strong>Parameters:</strong>
\r
1276 <ul><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data to be shared with drop targets</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li> </ul>
\r
1277 <strong>Returns:</strong>
\r
1279 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
\r
1285 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#onBeforeDrag" href="output/Ext.dd.DragSource.html#onBeforeDrag">DragSource</a></td>
\r
1287 <tr class="method-row inherited alt expandable">
\r
1288 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1290 <a id="Ext.tree.TreeDragZone-onDrag"></a>
\r
1291 <b>onDrag</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
1292 <div class="short">Abstract method called during the onMouseMove event while dragging an
1294 <div class="long">
\r
1295 Abstract method called during the onMouseMove event while dragging an
1296 object. <div class="mdetail-params">
\r
1297 <strong>Parameters:</strong>
\r
1298 <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul>
\r
1299 <strong>Returns:</strong>
\r
1301 <li><code>void</code></li>
\r
1307 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDrag" href="output/Ext.dd.DragDrop.html#onDrag">DragDrop</a></td>
\r
1309 <tr class="method-row inherited expandable">
\r
1310 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1312 <a id="Ext.tree.TreeDragZone-onDragDrop"></a>
\r
1313 <b>onDragDrop</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
1314 <div class="short">Abstract method called when this item is dropped on another DragDrop
1316 <div class="long">
\r
1317 Abstract method called when this item is dropped on another DragDrop
1318 obj <div class="mdetail-params">
\r
1319 <strong>Parameters:</strong>
\r
1320 <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
1321 id this was dropped on. In INTERSECT mode, an array of dd items this
1322 was dropped on.</div></li> </ul>
\r
1323 <strong>Returns:</strong>
\r
1325 <li><code>void</code></li>
\r
1331 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragDrop" href="output/Ext.dd.DragDrop.html#onDragDrop">DragDrop</a></td>
\r
1333 <tr class="method-row inherited alt expandable">
\r
1334 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1336 <a id="Ext.tree.TreeDragZone-onDragEnter"></a>
\r
1337 <b>onDragEnter</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
1338 <div class="short">Abstract method called when this element fist begins hovering over
1339 another DragDrop obj</div>
\r
1340 <div class="long">
\r
1341 Abstract method called when this element fist begins hovering over
1342 another DragDrop obj <div class="mdetail-params">
\r
1343 <strong>Parameters:</strong>
\r
1344 <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
1345 id this is hovering over. In INTERSECT mode, an array of one or more
1346 dragdrop items being hovered over.</div></li> </ul>
\r
1347 <strong>Returns:</strong>
\r
1349 <li><code>void</code></li>
\r
1355 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragEnter" href="output/Ext.dd.DragDrop.html#onDragEnter">DragDrop</a></td>
\r
1357 <tr class="method-row inherited expandable">
\r
1358 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1360 <a id="Ext.tree.TreeDragZone-onDragOut"></a>
\r
1361 <b>onDragOut</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
1362 <div class="short">Abstract method called when we are no longer hovering over an element</div>
\r
1363 <div class="long">
\r
1364 Abstract method called when we are no longer hovering over an element <div class="mdetail-params">
\r
1365 <strong>Parameters:</strong>
\r
1366 <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
1367 id this was hovering over. In INTERSECT mode, an array of dd items
1368 that the mouse is no longer over.</div></li> </ul>
\r
1369 <strong>Returns:</strong>
\r
1371 <li><code>void</code></li>
\r
1377 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOut" href="output/Ext.dd.DragDrop.html#onDragOut">DragDrop</a></td>
\r
1379 <tr class="method-row inherited alt expandable">
\r
1380 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1382 <a id="Ext.tree.TreeDragZone-onDragOver"></a>
\r
1383 <b>onDragOver</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
1384 <div class="short">Abstract method called when this element is hovering over another
1385 DragDrop obj</div>
\r
1386 <div class="long">
\r
1387 Abstract method called when this element is hovering over another
1388 DragDrop obj <div class="mdetail-params">
\r
1389 <strong>Parameters:</strong>
\r
1390 <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
1391 id this is hovering over. In INTERSECT mode, an array of dd items
1392 being hovered over.</div></li> </ul>
\r
1393 <strong>Returns:</strong>
\r
1395 <li><code>void</code></li>
\r
1401 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOver" href="output/Ext.dd.DragDrop.html#onDragOver">DragDrop</a></td>
\r
1403 <tr class="method-row inherited expandable">
\r
1404 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1406 <a id="Ext.tree.TreeDragZone-onInitDrag"></a>
\r
1407 <b>onInitDrag</b>( <code>Number x</code>, <code>Number y</code> ) : Boolean <div class="mdesc">
\r
1408 <div class="short">Called once drag threshold has been reached to initialize the proxy element. By default, it clones the
1409 this.dragData....</div>
\r
1410 <div class="long">
\r
1411 Called once drag threshold has been reached to initialize the proxy element. By default, it clones the
1412 this.dragData.ddel <div class="mdetail-params">
\r
1413 <strong>Parameters:</strong>
\r
1414 <ul><li><code>x</code> : Number<div class="sub-desc">The x position of the click on the dragged object</div></li><li><code>y</code> : Number<div class="sub-desc">The y position of the click on the dragged object</div></li> </ul>
\r
1415 <strong>Returns:</strong>
\r
1417 <li><code>Boolean</code><div class="sub-desc">true to continue the drag, false to cancel</div></li>
\r
1423 <td class="msource"><a ext:cls="Ext.dd.DragZone" ext:member="#onInitDrag" href="output/Ext.dd.DragZone.html#onInitDrag">DragZone</a></td>
\r
1425 <tr class="method-row inherited alt expandable">
\r
1426 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1428 <a id="Ext.tree.TreeDragZone-onInvalidDrop"></a>
\r
1429 <b>onInvalidDrop</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
1430 <div class="short">Abstract method called when this item is dropped on an area with no
1432 <div class="long">
\r
1433 Abstract method called when this item is dropped on an area with no
1434 drop target <div class="mdetail-params">
\r
1435 <strong>Parameters:</strong>
\r
1436 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
1437 <strong>Returns:</strong>
\r
1439 <li><code>void</code></li>
\r
1445 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onInvalidDrop" href="output/Ext.dd.DragDrop.html#onInvalidDrop">DragDrop</a></td>
\r
1447 <tr class="method-row inherited expandable">
\r
1448 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1450 <a id="Ext.tree.TreeDragZone-onMouseDown"></a>
\r
1451 <b>onMouseDown</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
1452 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
\r
1453 <div class="long">
\r
1454 Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params">
\r
1455 <strong>Parameters:</strong>
\r
1456 <ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul>
\r
1457 <strong>Returns:</strong>
\r
1459 <li><code>void</code></li>
\r
1465 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseDown" href="output/Ext.dd.DragDrop.html#onMouseDown">DragDrop</a></td>
\r
1467 <tr class="method-row inherited alt expandable">
\r
1468 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1470 <a id="Ext.tree.TreeDragZone-onMouseUp"></a>
\r
1471 <b>onMouseUp</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
1472 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
\r
1473 <div class="long">
\r
1474 Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params">
\r
1475 <strong>Parameters:</strong>
\r
1476 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
1477 <strong>Returns:</strong>
\r
1479 <li><code>void</code></li>
\r
1485 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseUp" href="output/Ext.dd.DragDrop.html#onMouseUp">DragDrop</a></td>
\r
1487 <tr class="method-row inherited expandable">
\r
1488 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1490 <a id="Ext.tree.TreeDragZone-removeFromGroup"></a>
\r
1491 <b>removeFromGroup</b>( <code>string sGroup</code> ) : void <div class="mdesc">
\r
1492 <div class="short">Remove's this instance from the supplied interaction group</div>
\r
1493 <div class="long">
\r
1494 Remove's this instance from the supplied interaction group <div class="mdetail-params">
\r
1495 <strong>Parameters:</strong>
\r
1496 <ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul>
\r
1497 <strong>Returns:</strong>
\r
1499 <li><code>void</code></li>
\r
1505 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeFromGroup" href="output/Ext.dd.DragDrop.html#removeFromGroup">DragDrop</a></td>
\r
1507 <tr class="method-row inherited alt expandable">
\r
1508 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1510 <a id="Ext.tree.TreeDragZone-removeInvalidHandleClass"></a>
\r
1511 <b>removeInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">
\r
1512 <div class="short">Unsets an invalid css class</div>
\r
1513 <div class="long">
\r
1514 Unsets an invalid css class <div class="mdetail-params">
\r
1515 <strong>Parameters:</strong>
\r
1516 <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to
1517 re-enable</div></li> </ul>
\r
1518 <strong>Returns:</strong>
\r
1520 <li><code>void</code></li>
\r
1526 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleClass" href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass">DragDrop</a></td>
\r
1528 <tr class="method-row inherited expandable">
\r
1529 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1531 <a id="Ext.tree.TreeDragZone-removeInvalidHandleId"></a>
\r
1532 <b>removeInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">
\r
1533 <div class="short">Unsets an invalid handle id</div>
\r
1534 <div class="long">
\r
1535 Unsets an invalid handle id <div class="mdetail-params">
\r
1536 <strong>Parameters:</strong>
\r
1537 <ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul>
\r
1538 <strong>Returns:</strong>
\r
1540 <li><code>void</code></li>
\r
1546 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleId" href="output/Ext.dd.DragDrop.html#removeInvalidHandleId">DragDrop</a></td>
\r
1548 <tr class="method-row inherited alt expandable">
\r
1549 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1551 <a id="Ext.tree.TreeDragZone-removeInvalidHandleType"></a>
\r
1552 <b>removeInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">
\r
1553 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
\r
1554 <div class="long">
\r
1555 Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params">
\r
1556 <strong>Parameters:</strong>
\r
1557 <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li> </ul>
\r
1558 <strong>Returns:</strong>
\r
1560 <li><code>void</code></li>
\r
1566 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleType" href="output/Ext.dd.DragDrop.html#removeInvalidHandleType">DragDrop</a></td>
\r
1568 <tr class="method-row inherited expandable">
\r
1569 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1571 <a id="Ext.tree.TreeDragZone-resetConstraints"></a>
\r
1572 <b>resetConstraints</b>( <code>boolean maintainOffset</code> ) : void <div class="mdesc">
\r
1573 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
\r
1574 <div class="long">
\r
1575 resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params">
\r
1576 <strong>Parameters:</strong>
\r
1577 <ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul>
\r
1578 <strong>Returns:</strong>
\r
1580 <li><code>void</code></li>
\r
1586 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#resetConstraints" href="output/Ext.dd.DragDrop.html#resetConstraints">DragDrop</a></td>
\r
1588 <tr class="method-row inherited alt expandable">
\r
1589 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1591 <a id="Ext.tree.TreeDragZone-setDelta"></a>
\r
1592 <b>setDelta</b>( <code>int iDeltaX</code>, <code>int iDeltaY</code> ) : void <div class="mdesc">
\r
1593 <div class="short">Sets the pointer offset. You can call this directly to force the
1594 offset to be in a particular location (e.g., pass i...</div>
\r
1595 <div class="long">
\r
1596 Sets the pointer offset. You can call this directly to force the
1597 offset to be in a particular location (e.g., pass in 0,0 to set it
1598 to the center of the object) <div class="mdetail-params">
\r
1599 <strong>Parameters:</strong>
\r
1600 <ul><li><code>iDeltaX</code> : int<div class="sub-desc">the distance from the left</div></li><li><code>iDeltaY</code> : int<div class="sub-desc">the distance from the top</div></li> </ul>
\r
1601 <strong>Returns:</strong>
\r
1603 <li><code>void</code></li>
\r
1609 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDelta" href="output/Ext.dd.DD.html#setDelta">DD</a></td>
\r
1611 <tr class="method-row inherited expandable">
\r
1612 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1614 <a id="Ext.tree.TreeDragZone-setDragElId"></a>
\r
1615 <b>setDragElId</b>( <code>id {string}</code> ) : void <div class="mdesc">
\r
1616 <div class="short">Allows you to specify that an element other than the linked element
1617 will be moved with the cursor during a drag</div>
\r
1618 <div class="long">
\r
1619 Allows you to specify that an element other than the linked element
1620 will be moved with the cursor during a drag <div class="mdetail-params">
\r
1621 <strong>Parameters:</strong>
\r
1622 <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
1623 <strong>Returns:</strong>
\r
1625 <li><code>void</code></li>
\r
1631 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setDragElId" href="output/Ext.dd.DragDrop.html#setDragElId">DragDrop</a></td>
\r
1633 <tr class="method-row inherited alt expandable">
\r
1634 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1636 <a id="Ext.tree.TreeDragZone-setDragElPos"></a>
\r
1637 <b>setDragElPos</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
\r
1638 <div class="short">Sets the drag element to the location of the mousedown or click event,
1639 maintaining the cursor location relative to th...</div>
\r
1640 <div class="long">
\r
1641 Sets the drag element to the location of the mousedown or click event,
1642 maintaining the cursor location relative to the location on the element
1643 that was clicked. Override this if you want to place the element in a
1644 location other than where the cursor is. <div class="mdetail-params">
\r
1645 <strong>Parameters:</strong>
\r
1646 <ul><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the mousedown or drag event</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the mousedown or drag event</div></li> </ul>
\r
1647 <strong>Returns:</strong>
\r
1649 <li><code>void</code></li>
\r
1655 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDragElPos" href="output/Ext.dd.DD.html#setDragElPos">DD</a></td>
\r
1657 <tr class="method-row inherited expandable">
\r
1658 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1660 <a id="Ext.tree.TreeDragZone-setHandleElId"></a>
\r
1661 <b>setHandleElId</b>( <code>id {string}</code> ) : void <div class="mdesc">
\r
1662 <div class="short">Allows you to specify a child of the linked element that should be
1663 used to initiate the drag operation. An example o...</div>
\r
1664 <div class="long">
\r
1665 Allows you to specify a child of the linked element that should be
1666 used to initiate the drag operation. An example of this would be if
1667 you have a content div with text and links. Clicking anywhere in the
1668 content area would normally start the drag operation. Use this method
1669 to specify that an element inside of the content div is the element
1670 that starts the drag operation. <div class="mdetail-params">
\r
1671 <strong>Parameters:</strong>
\r
1672 <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to
1673 initiate the drag.</div></li> </ul>
\r
1674 <strong>Returns:</strong>
\r
1676 <li><code>void</code></li>
\r
1682 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setHandleElId" href="output/Ext.dd.DragDrop.html#setHandleElId">DragDrop</a></td>
\r
1684 <tr class="method-row inherited alt expandable">
\r
1685 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1687 <a id="Ext.tree.TreeDragZone-setInitialPosition"></a>
\r
1688 <b>setInitialPosition</b>( <code>int diffX</code>, <code>int diffY</code> ) : void <div class="mdesc">
\r
1689 <div class="short">Stores the initial placement of the linked element.</div>
\r
1690 <div class="long">
\r
1691 Stores the initial placement of the linked element. <div class="mdetail-params">
\r
1692 <strong>Parameters:</strong>
\r
1693 <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
1694 <strong>Returns:</strong>
\r
1696 <li><code>void</code></li>
\r
1702 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setInitialPosition" href="output/Ext.dd.DragDrop.html#setInitialPosition">DragDrop</a></td>
\r
1704 <tr class="method-row inherited expandable">
\r
1705 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1707 <a id="Ext.tree.TreeDragZone-setOuterHandleElId"></a>
\r
1708 <b>setOuterHandleElId</b>( <code>id the</code> ) : void <div class="mdesc">
\r
1709 <div class="short">Allows you to set an element outside of the linked element as a drag
1711 <div class="long">
\r
1712 Allows you to set an element outside of the linked element as a drag
1713 handle <div class="mdetail-params">
\r
1714 <strong>Parameters:</strong>
\r
1715 <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
1716 <strong>Returns:</strong>
\r
1718 <li><code>void</code></li>
\r
1724 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setOuterHandleElId" href="output/Ext.dd.DragDrop.html#setOuterHandleElId">DragDrop</a></td>
\r
1726 <tr class="method-row inherited alt expandable">
\r
1727 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1729 <a id="Ext.tree.TreeDragZone-setPadding"></a>
\r
1730 <b>setPadding</b>( <code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code> ) : void <div class="mdesc">
\r
1731 <div class="short">Configures the padding for the target zone in px. Effectively expands
1732 (or reduces) the virtual object size for targe...</div>
\r
1733 <div class="long">
\r
1734 Configures the padding for the target zone in px. Effectively expands
1735 (or reduces) the virtual object size for targeting calculations.
1736 Supports css-style shorthand; if only one parameter is passed, all sides
1737 will have that padding, and if only two are passed, the top and bottom
1738 will have the first param, the left and right the second. <div class="mdetail-params">
\r
1739 <strong>Parameters:</strong>
\r
1740 <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
1741 <strong>Returns:</strong>
\r
1743 <li><code>void</code></li>
\r
1749 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setPadding" href="output/Ext.dd.DragDrop.html#setPadding">DragDrop</a></td>
\r
1751 <tr class="method-row inherited expandable">
\r
1752 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1754 <a id="Ext.tree.TreeDragZone-setXConstraint"></a>
\r
1755 <b>setXConstraint</b>( <code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code> ) : void <div class="mdesc">
\r
1756 <div class="short">By default, the element can be dragged any place on the screen. Use
1757 this method to limit the horizontal travel of th...</div>
\r
1758 <div class="long">
\r
1759 By default, the element can be dragged any place on the screen. Use
1760 this method to limit the horizontal travel of the element. Pass in
1761 0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params">
\r
1762 <strong>Parameters:</strong>
\r
1763 <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
1764 right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
1766 should move iTickSize pixels at a time.</div></li> </ul>
\r
1767 <strong>Returns:</strong>
\r
1769 <li><code>void</code></li>
\r
1775 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setXConstraint" href="output/Ext.dd.DragDrop.html#setXConstraint">DragDrop</a></td>
\r
1777 <tr class="method-row inherited alt expandable">
\r
1778 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1780 <a id="Ext.tree.TreeDragZone-setYConstraint"></a>
\r
1781 <b>setYConstraint</b>( <code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code> ) : void <div class="mdesc">
\r
1782 <div class="short">By default, the element can be dragged any place on the screen. Set
1783 this to limit the vertical travel of the element...</div>
\r
1784 <div class="long">
\r
1785 By default, the element can be dragged any place on the screen. Set
1786 this to limit the vertical travel of the element. Pass in 0,0 for the
1787 parameters if you want to lock the drag to the x axis. <div class="mdetail-params">
\r
1788 <strong>Parameters:</strong>
\r
1789 <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
1790 element should move iTickSize pixels at a time.</div></li> </ul>
\r
1791 <strong>Returns:</strong>
\r
1793 <li><code>void</code></li>
\r
1799 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setYConstraint" href="output/Ext.dd.DragDrop.html#setYConstraint">DragDrop</a></td>
\r
1801 <tr class="method-row inherited expandable">
\r
1802 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1804 <a id="Ext.tree.TreeDragZone-startDrag"></a>
\r
1805 <b>startDrag</b>( <code>int X</code>, <code>int Y</code> ) : void <div class="mdesc">
\r
1806 <div class="short">Abstract method called after a drag/drop object is clicked
1807 and the drag or mousedown time thresholds have beeen met.</div>
\r
1808 <div class="long">
\r
1809 Abstract method called after a drag/drop object is clicked
1810 and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params">
\r
1811 <strong>Parameters:</strong>
\r
1812 <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
1813 <strong>Returns:</strong>
\r
1815 <li><code>void</code></li>
\r
1821 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#startDrag" href="output/Ext.dd.DragDrop.html#startDrag">DragDrop</a></td>
\r
1823 <tr class="method-row inherited alt expandable">
\r
1824 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1826 <a id="Ext.tree.TreeDragZone-toString"></a>
\r
1827 <b>toString</b>() : string <div class="mdesc">
\r
1828 <div class="short">toString method</div>
\r
1829 <div class="long">
\r
1830 toString method <div class="mdetail-params">
\r
1831 <strong>Parameters:</strong>
\r
1832 <ul><li>None.</li> </ul>
\r
1833 <strong>Returns:</strong>
\r
1835 <li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li>
\r
1841 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#toString" href="output/Ext.dd.DragDrop.html#toString">DragDrop</a></td>
\r
1843 <tr class="method-row inherited expandable">
\r
1844 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1846 <a id="Ext.tree.TreeDragZone-unlock"></a>
\r
1847 <b>unlock</b>() : void <div class="mdesc">
\r
1848 <div class="short">Unlock this instace</div>
\r
1849 <div class="long">
\r
1850 Unlock this instace <div class="mdetail-params">
\r
1851 <strong>Parameters:</strong>
\r
1852 <ul><li>None.</li> </ul>
\r
1853 <strong>Returns:</strong>
\r
1855 <li><code>void</code></li>
\r
1861 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unlock" href="output/Ext.dd.DragDrop.html#unlock">DragDrop</a></td>
\r
1863 <tr class="method-row inherited alt expandable">
\r
1864 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1866 <a id="Ext.tree.TreeDragZone-unreg"></a>
\r
1867 <b>unreg</b>() : void <div class="mdesc">
\r
1868 <div class="short">Remove all drag and drop hooks for this element</div>
\r
1869 <div class="long">
\r
1870 Remove all drag and drop hooks for this element <div class="mdetail-params">
\r
1871 <strong>Parameters:</strong>
\r
1872 <ul><li>None.</li> </ul>
\r
1873 <strong>Returns:</strong>
\r
1875 <li><code>void</code></li>
\r
1881 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unreg" href="output/Ext.dd.DragDrop.html#unreg">DragDrop</a></td>
\r
1884 <a id="Ext.tree.TreeDragZone-events"></a>
1885 <h2>Public Events</h2>
1886 <div class="no-members">This class has no public events.</div>