1 <div class="body-wrap">
2 <div class="top-tools">
3 <a class="inner-link" href="#Ext.dd.DragZone-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 <a class="inner-link" href="#Ext.dd.DragZone-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 <a class="inner-link" href="#Ext.dd.DragZone-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 <a class="inner-link" href="#Ext.dd.DragZone-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7 <a class="bookmark" href="../docs/?class=Ext.dd.DragZone"><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"/>DragZone</pre></div>
15 <h1>Class Ext.dd.DragZone</h1>
16 <table cellspacing="0">
17 <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
18 <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DragZone.js" target="_blank">DragZone.js</a></td></tr>
19 <tr><td class="label">Class:</td><td class="hd-info">DragZone</td></tr>
20 <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.grid.GridDragZone" href="output/Ext.grid.GridDragZone.html">GridDragZone</a>, <a ext:cls="Ext.tree.TreeDragZone" href="output/Ext.tree.TreeDragZone.html">TreeDragZone</a></td></tr>
21 <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.dd.DragSource" ext:member="" href="output/Ext.dd.DragSource.html">DragSource</a></td></tr>
23 <div class="description">
25 This class provides a container DD instance that proxies for multiple child node sources.<br />
26 By default, this class requires that draggable child nodes are registered with <a ext:cls="Ext.dd.Registry" href="output/Ext.dd.Registry.html">Ext.dd.Registry</a>. </div>
28 <div class="hr"></div>
29 <a id="Ext.dd.DragZone-configs"></a>
30 <h2>Config Options</h2>
31 <table cellspacing="0" class="member-table">
33 <th class="sig-header" colspan="2">Config Options</th>
34 <th class="msource-header">Defined By</th>
36 <tr class="config-row">
\r
37 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
39 <a id="Ext.dd.DragZone-containerScroll"></a>
\r
40 <b>containerScroll</b> : Boolean <div class="mdesc">
\r
41 True to register this container with the Scrollmanager for auto scrolling during drag operations. </div>
\r
43 <td class="msource">DragZone</td>
\r
45 <tr class="config-row inherited alt expandable">
\r
46 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
48 <a id="Ext.dd.DragZone-ddGroup"></a>
\r
49 <b>ddGroup</b> : String <div class="mdesc">
\r
50 <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
52 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 undefined). </div>
\r
55 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#ddGroup" href="output/Ext.dd.DragSource.html#ddGroup">DragSource</a></td>
\r
57 <tr class="config-row inherited">
\r
58 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
60 <a id="Ext.dd.DragZone-dropAllowed"></a>
\r
61 <b>dropAllowed</b> : String <div class="mdesc">
\r
62 The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). </div>
\r
64 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#dropAllowed" href="output/Ext.dd.DragSource.html#dropAllowed">DragSource</a></td>
\r
66 <tr class="config-row inherited alt">
\r
67 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
69 <a id="Ext.dd.DragZone-dropNotAllowed"></a>
\r
70 <b>dropNotAllowed</b> : String <div class="mdesc">
\r
71 The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div>
\r
73 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#dropNotAllowed" href="output/Ext.dd.DragSource.html#dropNotAllowed">DragSource</a></td>
\r
75 <tr class="config-row expandable">
\r
76 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
78 <a id="Ext.dd.DragZone-hlColor"></a>
\r
79 <b>hlColor</b> : String <div class="mdesc">
\r
80 <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
82 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
85 <td class="msource">DragZone</td>
\r
88 <a id="Ext.dd.DragZone-props"></a>
89 <h2>Public Properties</h2>
90 <table cellspacing="0" class="member-table">
92 <th class="sig-header" colspan="2">Property</th>
93 <th class="msource-header">Defined By</th>
95 <tr class="property-row inherited">
\r
96 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
98 <a id="Ext.dd.DragZone-available"></a>
\r
99 <b>available</b> : boolean <div class="mdesc">
\r
100 The availabe property is false until the linked dom element is accessible. </div>
\r
102 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#available" href="output/Ext.dd.DragDrop.html#available">DragDrop</a></td>
\r
104 <tr class="property-row inherited alt expandable">
\r
105 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
107 <a id="Ext.dd.DragZone-centerFrame"></a>
\r
108 <b>centerFrame</b> : boolean <div class="mdesc">
\r
109 <div class="short">By default the frame is positioned exactly where the drag element is, so
110 we use the cursor offset provided by Ext.dd....</div>
\r
112 By default the frame is positioned exactly where the drag element is, so
113 we use the cursor offset provided by Ext.dd.DD. Another option that works only if
114 you do not have constraints on the obj is to have the drag frame centered
115 around the cursor. Set centerFrame to true for this effect. </div>
\r
118 <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#centerFrame" href="output/Ext.dd.DDProxy.html#centerFrame">DDProxy</a></td>
\r
120 <tr class="property-row inherited">
\r
121 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
123 <a id="Ext.dd.DragZone-config"></a>
\r
124 <b>config</b> : object <div class="mdesc">
\r
125 Configuration attributes passed into the constructor </div>
\r
127 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#config" href="output/Ext.dd.DragDrop.html#config">DragDrop</a></td>
\r
129 <tr class="property-row inherited alt">
\r
130 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
132 <a id="Ext.dd.DragZone-defaultPadding"></a>
\r
133 <b>defaultPadding</b> : Object <div class="mdesc">
\r
134 Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). </div>
\r
136 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#defaultPadding" href="output/Ext.dd.DragDrop.html#defaultPadding">DragDrop</a></td>
\r
138 <tr class="property-row inherited expandable">
\r
139 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
141 <a id="Ext.dd.DragZone-groups"></a>
\r
142 <b>groups</b> : object <div class="mdesc">
\r
143 <div class="short">The group defines a logical collection of DragDrop objects that are
144 related. Instances only get events when interact...</div>
\r
146 The group defines a logical collection of DragDrop objects that are
147 related. Instances only get events when interacting with other
148 DragDrop object in the same group. This lets us define multiple
149 groups using a single DragDrop subclass if we want. </div>
\r
152 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#groups" href="output/Ext.dd.DragDrop.html#groups">DragDrop</a></td>
\r
154 <tr class="property-row inherited alt expandable">
\r
155 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
157 <a id="Ext.dd.DragZone-hasOuterHandles"></a>
\r
158 <b>hasOuterHandles</b> : boolean <div class="mdesc">
\r
159 <div class="short">By default, drags can only be initiated if the mousedown occurs in the
160 region the linked element is. This is done in...</div>
\r
162 By default, drags can only be initiated if the mousedown occurs in the
163 region the linked element is. This is done in part to work around a
164 bug in some browsers that mis-report the mousedown if the previous
165 mouseup happened outside of the window. This property is set to true
166 if outer handles are defined. </div>
\r
169 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#hasOuterHandles" href="output/Ext.dd.DragDrop.html#hasOuterHandles">DragDrop</a></td>
\r
171 <tr class="property-row inherited expandable">
\r
172 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
174 <a id="Ext.dd.DragZone-id"></a>
\r
175 <b>id</b> : String <div class="mdesc">
\r
176 <div class="short">The id of the element associated with this object. This is what we
177 refer to as the "linked element" because the size...</div>
\r
179 The id of the element associated with this object. This is what we
180 refer to as the "linked element" because the size and position of
181 this element is used to determine when the drag and drop objects have
185 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#id" href="output/Ext.dd.DragDrop.html#id">DragDrop</a></td>
\r
187 <tr class="property-row inherited alt">
\r
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
190 <a id="Ext.dd.DragZone-invalidHandleClasses"></a>
\r
191 <b>invalidHandleClasses</b> : Array <div class="mdesc">
\r
192 An Array of CSS class names for elements to be considered in valid as drag handles. </div>
\r
194 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleClasses" href="output/Ext.dd.DragDrop.html#invalidHandleClasses">DragDrop</a></td>
\r
196 <tr class="property-row inherited expandable">
\r
197 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
199 <a id="Ext.dd.DragZone-invalidHandleIds"></a>
\r
200 <b>invalidHandleIds</b> : Object <div class="mdesc">
\r
201 <div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles.
202 A non-null prop...</div>
\r
204 An object who's property names identify the IDs of elements to be considered invalid as drag handles.
205 A non-null property value identifies the ID as invalid. For example, to prevent
206 dragging from being initiated on element ID "foo", use:<pre><code>{
208 }</code></pre> </div>
\r
211 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleIds" href="output/Ext.dd.DragDrop.html#invalidHandleIds">DragDrop</a></td>
\r
213 <tr class="property-row inherited alt expandable">
\r
214 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
216 <a id="Ext.dd.DragZone-invalidHandleTypes"></a>
\r
217 <b>invalidHandleTypes</b> : Object <div class="mdesc">
\r
218 <div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles.
219 A non-null property value...</div>
\r
221 An object who's property names identify HTML tags to be considered invalid as drag handles.
222 A non-null property value identifies the tag as invalid. Defaults to the
223 following value which prevents drag operations from being initiated by <a> elements:<pre><code>{
225 }</code></pre> </div>
\r
228 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleTypes" href="output/Ext.dd.DragDrop.html#invalidHandleTypes">DragDrop</a></td>
\r
230 <tr class="property-row inherited">
\r
231 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
233 <a id="Ext.dd.DragZone-isTarget"></a>
\r
234 <b>isTarget</b> : boolean <div class="mdesc">
\r
235 By default, all instances can be a drop target. This can be disabled by
236 setting isTarget to false. </div>
\r
238 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isTarget" href="output/Ext.dd.DragDrop.html#isTarget">DragDrop</a></td>
\r
240 <tr class="property-row inherited alt expandable">
\r
241 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
243 <a id="Ext.dd.DragZone-maintainOffset"></a>
\r
244 <b>maintainOffset</b> : boolean <div class="mdesc">
\r
245 <div class="short">Maintain offsets when we resetconstraints. Set to true when you want
246 the position of the element relative to its par...</div>
\r
248 Maintain offsets when we resetconstraints. Set to true when you want
249 the position of the element relative to its parent to stay the same
250 when the page changes </div>
\r
253 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#maintainOffset" href="output/Ext.dd.DragDrop.html#maintainOffset">DragDrop</a></td>
\r
255 <tr class="property-row inherited expandable">
\r
256 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
258 <a id="Ext.dd.DragZone-moveOnly"></a>
\r
259 <b>moveOnly</b> : boolean <div class="mdesc">
\r
260 <div class="short">When set to true, other DD objects in cooperating DDGroups do not receive
261 notification events when this DD object is ...</div>
\r
263 When set to true, other DD objects in cooperating DDGroups do not receive
264 notification events when this DD object is dragged over them. Defaults to false. </div>
\r
267 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#moveOnly" href="output/Ext.dd.DragDrop.html#moveOnly">DragDrop</a></td>
\r
269 <tr class="property-row inherited alt expandable">
\r
270 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
272 <a id="Ext.dd.DragZone-onStartDrag"></a>
\r
273 <b>onStartDrag</b> : Object <div class="mdesc">
\r
274 <div class="short">An empty function by default, but provided so that you can perform a custom action once the initial
275 drag event has be...</div>
\r
277 An empty function by default, but provided so that you can perform a custom action once the initial
278 drag event has begun. The drag cannot be canceled from this function. </div>
\r
281 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#onStartDrag" href="output/Ext.dd.DragSource.html#onStartDrag">DragSource</a></td>
\r
283 <tr class="property-row inherited">
\r
284 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
286 <a id="Ext.dd.DragZone-padding"></a>
\r
287 <b>padding</b> : int[] <div class="mdesc">
\r
288 The padding configured for this drag and drop object for calculating
289 the drop zone intersection with this object. </div>
\r
291 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#padding" href="output/Ext.dd.DragDrop.html#padding">DragDrop</a></td>
\r
293 <tr class="property-row inherited alt expandable">
\r
294 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
296 <a id="Ext.dd.DragZone-primaryButtonOnly"></a>
\r
297 <b>primaryButtonOnly</b> : boolean <div class="mdesc">
\r
298 <div class="short">By default the drag and drop instance will only respond to the primary
299 button click (left button for a right-handed m...</div>
\r
301 By default the drag and drop instance will only respond to the primary
302 button click (left button for a right-handed mouse). Set to true to
303 allow drag and drop to start with any mouse click that is propogated
304 by the browser </div>
\r
307 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#primaryButtonOnly" href="output/Ext.dd.DragDrop.html#primaryButtonOnly">DragDrop</a></td>
\r
309 <tr class="property-row inherited expandable">
\r
310 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
312 <a id="Ext.dd.DragZone-resizeFrame"></a>
\r
313 <b>resizeFrame</b> : boolean <div class="mdesc">
\r
314 <div class="short">By default we resize the drag frame to be the same size as the element
315 we want to drag (this is to get the frame effe...</div>
\r
317 By default we resize the drag frame to be the same size as the element
318 we want to drag (this is to get the frame effect). We can turn it off
319 if we want a different behavior. </div>
\r
322 <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#resizeFrame" href="output/Ext.dd.DDProxy.html#resizeFrame">DDProxy</a></td>
\r
324 <tr class="property-row inherited alt expandable">
\r
325 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
327 <a id="Ext.dd.DragZone-scroll"></a>
\r
328 <b>scroll</b> : boolean <div class="mdesc">
\r
329 <div class="short">When set to true, the utility automatically tries to scroll the browser
330 window when a drag and drop element is dragge...</div>
\r
332 When set to true, the utility automatically tries to scroll the browser
333 window when a drag and drop element is dragged near the viewport boundary.
334 Defaults to true. </div>
\r
337 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#scroll" href="output/Ext.dd.DD.html#scroll">DD</a></td>
\r
339 <tr class="property-row inherited expandable">
\r
340 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
342 <a id="Ext.dd.DragZone-xTicks"></a>
\r
343 <b>xTicks</b> : int[] <div class="mdesc">
\r
344 <div class="short">Array of pixel locations the element will snap to if we specified a
345 horizontal graduation/interval. This array is ge...</div>
\r
347 Array of pixel locations the element will snap to if we specified a
348 horizontal graduation/interval. This array is generated automatically
349 when you define a tick interval. </div>
\r
352 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#xTicks" href="output/Ext.dd.DragDrop.html#xTicks">DragDrop</a></td>
\r
354 <tr class="property-row inherited alt expandable">
\r
355 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
357 <a id="Ext.dd.DragZone-yTicks"></a>
\r
358 <b>yTicks</b> : int[] <div class="mdesc">
\r
359 <div class="short">Array of pixel locations the element will snap to if we specified a
360 vertical graduation/interval. This array is gene...</div>
\r
362 Array of pixel locations the element will snap to if we specified a
363 vertical graduation/interval. This array is generated automatically
364 when you define a tick interval. </div>
\r
367 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#yTicks" href="output/Ext.dd.DragDrop.html#yTicks">DragDrop</a></td>
\r
370 <a id="Ext.dd.DragZone-methods"></a>
371 <h2>Public Methods</h2>
372 <table cellspacing="0" class="member-table">
374 <th class="sig-header" colspan="2">Method</th>
375 <th class="msource-header">Defined By</th>
377 <tr class="method-row expandable">
\r
378 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
380 <a id="Ext.dd.DragZone-DragZone"></a>
\r
381 <b>DragZone</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc">
\r
382 <div class="short"></div>
\r
384 <div class="mdetail-params">
\r
385 <strong>Parameters:</strong>
\r
386 <ul><li><code>el</code> : Mixed<div class="sub-desc">The container element</div></li><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>
\r
387 <strong>Returns:</strong>
\r
389 <li><code></code></li>
\r
395 <td class="msource">DragZone</td>
\r
397 <tr class="method-row inherited alt expandable">
\r
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
400 <a id="Ext.dd.DragZone-addInvalidHandleClass"></a>
\r
401 <b>addInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">
\r
402 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
\r
404 Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params">
\r
405 <strong>Parameters:</strong>
\r
406 <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul>
\r
407 <strong>Returns:</strong>
\r
409 <li><code>void</code></li>
\r
415 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleClass" href="output/Ext.dd.DragDrop.html#addInvalidHandleClass">DragDrop</a></td>
\r
417 <tr class="method-row inherited expandable">
\r
418 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
420 <a id="Ext.dd.DragZone-addInvalidHandleId"></a>
\r
421 <b>addInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">
\r
422 <div class="short">Lets you to specify an element id for a child of a drag handle
423 that should not initiate a drag</div>
\r
425 Lets you to specify an element id for a child of a drag handle
426 that should not initiate a drag <div class="mdetail-params">
\r
427 <strong>Parameters:</strong>
\r
428 <ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li> </ul>
\r
429 <strong>Returns:</strong>
\r
431 <li><code>void</code></li>
\r
437 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleId" href="output/Ext.dd.DragDrop.html#addInvalidHandleId">DragDrop</a></td>
\r
439 <tr class="method-row inherited alt expandable">
\r
440 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
442 <a id="Ext.dd.DragZone-addInvalidHandleType"></a>
\r
443 <b>addInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">
\r
444 <div class="short">Allows you to specify a tag name that should not start a drag operation
445 when clicked. This is designed to facilitate...</div>
\r
447 Allows you to specify a tag name that should not start a drag operation
448 when clicked. This is designed to facilitate embedding links within a
449 drag handle that do something other than start the drag. <div class="mdetail-params">
\r
450 <strong>Parameters:</strong>
\r
451 <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul>
\r
452 <strong>Returns:</strong>
\r
454 <li><code>void</code></li>
\r
460 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleType" href="output/Ext.dd.DragDrop.html#addInvalidHandleType">DragDrop</a></td>
\r
462 <tr class="method-row inherited expandable">
\r
463 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
465 <a id="Ext.dd.DragZone-addToGroup"></a>
\r
466 <b>addToGroup</b>( <code>sGroup {string}</code> ) : void <div class="mdesc">
\r
467 <div class="short">Add this instance to a group of related drag/drop objects. All
468 instances belong to at least one group, and can belon...</div>
\r
470 Add this instance to a group of related drag/drop objects. All
471 instances belong to at least one group, and can belong to as many
472 groups as needed. <div class="mdetail-params">
\r
473 <strong>Parameters:</strong>
\r
474 <ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul>
\r
475 <strong>Returns:</strong>
\r
477 <li><code>void</code></li>
\r
483 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addToGroup" href="output/Ext.dd.DragDrop.html#addToGroup">DragDrop</a></td>
\r
485 <tr class="method-row inherited alt expandable">
\r
486 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
488 <a id="Ext.dd.DragZone-afterDragDrop"></a>
\r
489 <b>afterDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
490 <div class="short">An empty function by default, but provided so that you can perform a custom action
491 after a valid drag drop has occurr...</div>
\r
493 An empty function by default, but provided so that you can perform a custom action
494 after a valid drag drop has occurred by providing an implementation. <div class="mdetail-params">
\r
495 <strong>Parameters:</strong>
\r
496 <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
497 <strong>Returns:</strong>
\r
499 <li><code>void</code></li>
\r
505 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragDrop" href="output/Ext.dd.DragSource.html#afterDragDrop">DragSource</a></td>
\r
507 <tr class="method-row inherited expandable">
\r
508 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
510 <a id="Ext.dd.DragZone-afterDragEnter"></a>
\r
511 <b>afterDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
512 <div class="short">An empty function by default, but provided so that you can perform a custom action
513 when the dragged item enters the d...</div>
\r
515 An empty function by default, but provided so that you can perform a custom action
516 when the dragged item enters the drop target by providing an implementation. <div class="mdetail-params">
\r
517 <strong>Parameters:</strong>
\r
518 <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
519 <strong>Returns:</strong>
\r
521 <li><code>void</code></li>
\r
527 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragEnter" href="output/Ext.dd.DragSource.html#afterDragEnter">DragSource</a></td>
\r
529 <tr class="method-row inherited alt expandable">
\r
530 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
532 <a id="Ext.dd.DragZone-afterDragOut"></a>
\r
533 <b>afterDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
534 <div class="short">An empty function by default, but provided so that you can perform a custom action
535 after the dragged item is dragged ...</div>
\r
537 An empty function by default, but provided so that you can perform a custom action
538 after the dragged item is dragged out of the target without dropping. <div class="mdetail-params">
\r
539 <strong>Parameters:</strong>
\r
540 <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
541 <strong>Returns:</strong>
\r
543 <li><code>void</code></li>
\r
549 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragOut" href="output/Ext.dd.DragSource.html#afterDragOut">DragSource</a></td>
\r
551 <tr class="method-row inherited expandable">
\r
552 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
554 <a id="Ext.dd.DragZone-afterDragOver"></a>
\r
555 <b>afterDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
556 <div class="short">An empty function by default, but provided so that you can perform a custom action
557 while the dragged item is over the...</div>
\r
559 An empty function by default, but provided so that you can perform a custom action
560 while the dragged item is over the drop target by providing an implementation. <div class="mdetail-params">
\r
561 <strong>Parameters:</strong>
\r
562 <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
563 <strong>Returns:</strong>
\r
565 <li><code>void</code></li>
\r
571 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragOver" href="output/Ext.dd.DragSource.html#afterDragOver">DragSource</a></td>
\r
573 <tr class="method-row inherited alt expandable">
\r
574 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
576 <a id="Ext.dd.DragZone-afterInvalidDrop"></a>
\r
577 <b>afterInvalidDrop</b>( <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
\r
578 <div class="short">An empty function by default, but provided so that you can perform a custom action
579 after an invalid drop has occurred...</div>
\r
581 An empty function by default, but provided so that you can perform a custom action
582 after an invalid drop has occurred by providing an implementation. <div class="mdetail-params">
\r
583 <strong>Parameters:</strong>
\r
584 <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
585 <strong>Returns:</strong>
\r
587 <li><code>void</code></li>
\r
593 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterInvalidDrop" href="output/Ext.dd.DragSource.html#afterInvalidDrop">DragSource</a></td>
\r
595 <tr class="method-row expandable">
\r
596 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
598 <a id="Ext.dd.DragZone-afterRepair"></a>
\r
599 <b>afterRepair</b>() : void <div class="mdesc">
\r
600 <div class="short">Called after a repair of an invalid drop. By default, highlights this.dragData.ddel</div>
\r
602 Called after a repair of an invalid drop. By default, highlights this.dragData.ddel <div class="mdetail-params">
\r
603 <strong>Parameters:</strong>
\r
604 <ul><li>None.</li> </ul>
\r
605 <strong>Returns:</strong>
\r
607 <li><code>void</code></li>
\r
613 <td class="msource">DragZone</td>
\r
615 <tr class="method-row inherited alt expandable">
\r
616 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
618 <a id="Ext.dd.DragZone-alignElWithMouse"></a>
\r
619 <b>alignElWithMouse</b>( <code>HTMLElement el</code>, <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
\r
620 <div class="short">Sets the element to the location of the mousedown or click event,
621 maintaining the cursor location relative to the loc...</div>
\r
623 Sets the element to the location of the mousedown or click event,
624 maintaining the cursor location relative to the location on the element
625 that was clicked. Override this if you want to place the element in a
626 location other than where the cursor is. <div class="mdetail-params">
\r
627 <strong>Parameters:</strong>
\r
628 <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
629 <strong>Returns:</strong>
\r
631 <li><code>void</code></li>
\r
637 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#alignElWithMouse" href="output/Ext.dd.DD.html#alignElWithMouse">DD</a></td>
\r
639 <tr class="method-row inherited expandable">
\r
640 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
642 <a id="Ext.dd.DragZone-applyConfig"></a>
\r
643 <b>applyConfig</b>() : void <div class="mdesc">
\r
644 <div class="short">Applies the configuration parameters that were passed into the constructor.
645 This is supposed to happen at each level ...</div>
\r
647 Applies the configuration parameters that were passed into the constructor.
648 This is supposed to happen at each level through the inheritance chain. So
649 a DDProxy implentation will execute apply config on DDProxy, DD, and
650 DragDrop in order to get all of the parameters that are available in
651 each object. <div class="mdetail-params">
\r
652 <strong>Parameters:</strong>
\r
653 <ul><li>None.</li> </ul>
\r
654 <strong>Returns:</strong>
\r
656 <li><code>void</code></li>
\r
662 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#applyConfig" href="output/Ext.dd.DragDrop.html#applyConfig">DragDrop</a></td>
\r
664 <tr class="method-row inherited alt expandable">
\r
665 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
667 <a id="Ext.dd.DragZone-autoOffset"></a>
\r
668 <b>autoOffset</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
\r
669 <div class="short">Sets the pointer offset to the distance between the linked element's top
670 left corner and the location the element was...</div>
\r
672 Sets the pointer offset to the distance between the linked element's top
673 left corner and the location the element was clicked <div class="mdetail-params">
\r
674 <strong>Parameters:</strong>
\r
675 <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
676 <strong>Returns:</strong>
\r
678 <li><code>void</code></li>
\r
684 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#autoOffset" href="output/Ext.dd.DD.html#autoOffset">DD</a></td>
\r
686 <tr class="method-row inherited expandable">
\r
687 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
689 <a id="Ext.dd.DragZone-b4Drag"></a>
\r
690 <b>b4Drag</b>() : void <div class="mdesc">
\r
691 <div class="short">Event that fires prior to the onDrag event. Overrides
692 Ext.dd.DragDrop.</div>
\r
694 Event that fires prior to the onDrag event. Overrides
695 Ext.dd.DragDrop. <div class="mdetail-params">
\r
696 <strong>Parameters:</strong>
\r
697 <ul><li>None.</li> </ul>
\r
698 <strong>Returns:</strong>
\r
700 <li><code>void</code></li>
\r
706 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4Drag" href="output/Ext.dd.DD.html#b4Drag">DD</a></td>
\r
708 <tr class="method-row inherited alt expandable">
\r
709 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
711 <a id="Ext.dd.DragZone-b4MouseDown"></a>
\r
712 <b>b4MouseDown</b>() : void <div class="mdesc">
\r
713 <div class="short">Event that fires prior to the onMouseDown event. Overrides
714 Ext.dd.DragDrop.</div>
\r
716 Event that fires prior to the onMouseDown event. Overrides
717 Ext.dd.DragDrop. <div class="mdetail-params">
\r
718 <strong>Parameters:</strong>
\r
719 <ul><li>None.</li> </ul>
\r
720 <strong>Returns:</strong>
\r
722 <li><code>void</code></li>
\r
728 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4MouseDown" href="output/Ext.dd.DD.html#b4MouseDown">DD</a></td>
\r
730 <tr class="method-row inherited expandable">
\r
731 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
733 <a id="Ext.dd.DragZone-beforeDragDrop"></a>
\r
734 <b>beforeDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
735 <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
736 item is dropped...</div>
\r
738 An empty function by default, but provided so that you can perform a custom action before the dragged
739 item is dropped onto the target and optionally cancel the onDragDrop. <div class="mdetail-params">
\r
740 <strong>Parameters:</strong>
\r
741 <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
742 <strong>Returns:</strong>
\r
744 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag drop event is valid, else false to cancel</div></li>
\r
750 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragDrop" href="output/Ext.dd.DragSource.html#beforeDragDrop">DragSource</a></td>
\r
752 <tr class="method-row inherited alt expandable">
\r
753 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
755 <a id="Ext.dd.DragZone-beforeDragEnter"></a>
\r
756 <b>beforeDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
757 <div class="short">An empty function by default, but provided so that you can perform a custom action
758 before the dragged item enters the...</div>
\r
760 An empty function by default, but provided so that you can perform a custom action
761 before the dragged item enters the drop target and optionally cancel the onDragEnter. <div class="mdetail-params">
\r
762 <strong>Parameters:</strong>
\r
763 <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
764 <strong>Returns:</strong>
\r
766 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
\r
772 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragEnter" href="output/Ext.dd.DragSource.html#beforeDragEnter">DragSource</a></td>
\r
774 <tr class="method-row inherited expandable">
\r
775 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
777 <a id="Ext.dd.DragZone-beforeDragOut"></a>
\r
778 <b>beforeDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
779 <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
780 item is dragged...</div>
\r
782 An empty function by default, but provided so that you can perform a custom action before the dragged
783 item is dragged out of the target without dropping, and optionally cancel the onDragOut. <div class="mdetail-params">
\r
784 <strong>Parameters:</strong>
\r
785 <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
786 <strong>Returns:</strong>
\r
788 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
\r
794 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragOut" href="output/Ext.dd.DragSource.html#beforeDragOut">DragSource</a></td>
\r
796 <tr class="method-row inherited alt expandable">
\r
797 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
799 <a id="Ext.dd.DragZone-beforeDragOver"></a>
\r
800 <b>beforeDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
801 <div class="short">An empty function by default, but provided so that you can perform a custom action
802 while the dragged item is over the...</div>
\r
804 An empty function by default, but provided so that you can perform a custom action
805 while the dragged item is over the drop target and optionally cancel the onDragOver. <div class="mdetail-params">
\r
806 <strong>Parameters:</strong>
\r
807 <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
808 <strong>Returns:</strong>
\r
810 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
\r
816 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragOver" href="output/Ext.dd.DragSource.html#beforeDragOver">DragSource</a></td>
\r
818 <tr class="method-row inherited expandable">
\r
819 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
821 <a id="Ext.dd.DragZone-beforeInvalidDrop"></a>
\r
822 <b>beforeInvalidDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
\r
823 <div class="short">An empty function by default, but provided so that you can perform a custom action after an invalid
824 drop has occurred.</div>
\r
826 An empty function by default, but provided so that you can perform a custom action after an invalid
827 drop has occurred. <div class="mdetail-params">
\r
828 <strong>Parameters:</strong>
\r
829 <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
830 <strong>Returns:</strong>
\r
832 <li><code>Boolean</code><div class="sub-desc">isValid True if the invalid drop should proceed, else false to cancel</div></li>
\r
838 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeInvalidDrop" href="output/Ext.dd.DragSource.html#beforeInvalidDrop">DragSource</a></td>
\r
840 <tr class="method-row inherited alt expandable">
\r
841 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
843 <a id="Ext.dd.DragZone-cachePosition"></a>
\r
844 <b>cachePosition</b>( <code>iPageX the</code>, <code>iPageY the</code> ) : void <div class="mdesc">
\r
845 <div class="short">Saves the most recent position so that we can reset the constraints and
846 tick marks on-demand. We need to know this s...</div>
\r
848 Saves the most recent position so that we can reset the constraints and
849 tick marks on-demand. We need to know this so that we can calculate the
850 number of pixels the element is offset from its original position. <div class="mdetail-params">
\r
851 <strong>Parameters:</strong>
\r
852 <ul><li><code>the</code> : iPageX<div class="sub-desc">current x position (optional, this just makes it so we
853 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
854 don't have to look it up again)</div></li> </ul>
\r
855 <strong>Returns:</strong>
\r
857 <li><code>void</code></li>
\r
863 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#cachePosition" href="output/Ext.dd.DD.html#cachePosition">DD</a></td>
\r
865 <tr class="method-row inherited expandable">
\r
866 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
868 <a id="Ext.dd.DragZone-clearConstraints"></a>
\r
869 <b>clearConstraints</b>() : void <div class="mdesc">
\r
870 <div class="short">Clears any constraints applied to this instance. Also clears ticks
871 since they can't exist independent of a constrain...</div>
\r
873 Clears any constraints applied to this instance. Also clears ticks
874 since they can't exist independent of a constraint at this time. <div class="mdetail-params">
\r
875 <strong>Parameters:</strong>
\r
876 <ul><li>None.</li> </ul>
\r
877 <strong>Returns:</strong>
\r
879 <li><code>void</code></li>
\r
885 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearConstraints" href="output/Ext.dd.DragDrop.html#clearConstraints">DragDrop</a></td>
\r
887 <tr class="method-row inherited alt expandable">
\r
888 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
890 <a id="Ext.dd.DragZone-clearTicks"></a>
\r
891 <b>clearTicks</b>() : void <div class="mdesc">
\r
892 <div class="short">Clears any tick interval defined for this instance</div>
\r
894 Clears any tick interval defined for this instance <div class="mdetail-params">
\r
895 <strong>Parameters:</strong>
\r
896 <ul><li>None.</li> </ul>
\r
897 <strong>Returns:</strong>
\r
899 <li><code>void</code></li>
\r
905 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearTicks" href="output/Ext.dd.DragDrop.html#clearTicks">DragDrop</a></td>
\r
907 <tr class="method-row inherited expandable">
\r
908 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
910 <a id="Ext.dd.DragZone-constrainTo"></a>
\r
911 <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
912 <div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element.
914 var dd = new Ext.d...</div>
\r
916 Initializes the drag drop object's constraints to restrict movement to a certain element.
918 <pre><code>var dd = <b>new</b> Ext.dd.DDProxy(<em>"dragDiv1"</em>, <em>"proxytest"</em>,
919 { dragElId: <em>"existingProxyDiv"</em> });
920 dd.startDrag = <b>function</b>(){
921 <b>this</b>.constrainTo(<em>"parent-id"</em>);
923 Or you can initalize it using the <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object:
\r
924 <pre><code>Ext.get(<em>"dragDiv1"</em>).initDDProxy(<em>"proxytest"</em>, {dragElId: <em>"existingProxyDiv"</em>}, {
925 startDrag : <b>function</b>(){
926 <b>this</b>.constrainTo(<em>"parent-id"</em>);
928 });</code></pre> <div class="mdetail-params">
\r
929 <strong>Parameters:</strong>
\r
930 <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,
931 and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
932 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
933 <strong>Returns:</strong>
\r
935 <li><code>void</code></li>
\r
941 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#constrainTo" href="output/Ext.dd.DragDrop.html#constrainTo">DragDrop</a></td>
\r
943 <tr class="method-row inherited alt expandable">
\r
944 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
946 <a id="Ext.dd.DragZone-createFrame"></a>
\r
947 <b>createFrame</b>() : void <div class="mdesc">
\r
948 <div class="short">Creates the proxy element if it does not yet exist</div>
\r
950 Creates the proxy element if it does not yet exist <div class="mdetail-params">
\r
951 <strong>Parameters:</strong>
\r
952 <ul><li>None.</li> </ul>
\r
953 <strong>Returns:</strong>
\r
955 <li><code>void</code></li>
\r
961 <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#createFrame" href="output/Ext.dd.DDProxy.html#createFrame">DDProxy</a></td>
\r
963 <tr class="method-row inherited expandable">
\r
964 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
966 <a id="Ext.dd.DragZone-endDrag"></a>
\r
967 <b>endDrag</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
968 <div class="short">Fired when we are done dragging the object</div>
\r
970 Fired when we are done dragging the object <div class="mdetail-params">
\r
971 <strong>Parameters:</strong>
\r
972 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
973 <strong>Returns:</strong>
\r
975 <li><code>void</code></li>
\r
981 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#endDrag" href="output/Ext.dd.DragDrop.html#endDrag">DragDrop</a></td>
\r
983 <tr class="method-row alt expandable">
\r
984 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
986 <a id="Ext.dd.DragZone-getDragData"></a>
\r
987 <b>getDragData</b>( <code>EventObject e</code> ) : Object <div class="mdesc">
\r
989 Called when a mousedown occurs in this container. Looks in Ext.dd.Registry
990 for a valid target to drag based on the m...</div>
\r
993 Called when a mousedown occurs in this container. Looks in <a ext:cls="Ext.dd.Registry" href="output/Ext.dd.Registry.html">Ext.dd.Registry</a>
994 for a valid target to drag based on the mouse down. Override this method
995 to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned
996 object has a "ddel" attribute (with an HTML Element) for other functions to work. <div class="mdetail-params">
\r
997 <strong>Parameters:</strong>
\r
998 <ul><li><code>e</code> : EventObject<div class="sub-desc">The mouse down event</div></li> </ul>
\r
999 <strong>Returns:</strong>
\r
1001 <li><code>Object</code><div class="sub-desc">The dragData</div></li>
\r
1007 <td class="msource">DragZone</td>
\r
1009 <tr class="method-row inherited expandable">
\r
1010 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1012 <a id="Ext.dd.DragZone-getDragEl"></a>
\r
1013 <b>getDragEl</b>() : HTMLElement <div class="mdesc">
\r
1014 <div class="short">Returns a reference to the actual element to drag. By default this is
1015 the same as the html element, but it can be as...</div>
\r
1016 <div class="long">
\r
1017 Returns a reference to the actual element to drag. By default this is
1018 the same as the html element, but it can be assigned to another
1019 element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params">
\r
1020 <strong>Parameters:</strong>
\r
1021 <ul><li>None.</li> </ul>
\r
1022 <strong>Returns:</strong>
\r
1024 <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
\r
1030 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getDragEl" href="output/Ext.dd.DragDrop.html#getDragEl">DragDrop</a></td>
\r
1032 <tr class="method-row inherited alt expandable">
\r
1033 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1035 <a id="Ext.dd.DragZone-getEl"></a>
\r
1036 <b>getEl</b>() : HTMLElement <div class="mdesc">
\r
1037 <div class="short">Returns a reference to the linked element</div>
\r
1038 <div class="long">
\r
1039 Returns a reference to the linked element <div class="mdetail-params">
\r
1040 <strong>Parameters:</strong>
\r
1041 <ul><li>None.</li> </ul>
\r
1042 <strong>Returns:</strong>
\r
1044 <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
\r
1050 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getEl" href="output/Ext.dd.DragDrop.html#getEl">DragDrop</a></td>
\r
1052 <tr class="method-row inherited expandable">
\r
1053 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1055 <a id="Ext.dd.DragZone-getProxy"></a>
\r
1056 <b>getProxy</b>() : Ext.dd.StatusProxy <div class="mdesc">
\r
1057 <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
1058 <div class="long">
\r
1059 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
1060 <strong>Parameters:</strong>
\r
1061 <ul><li>None.</li> </ul>
\r
1062 <strong>Returns:</strong>
\r
1064 <li><code>Ext.dd.StatusProxy</code><div class="sub-desc">proxy The StatusProxy</div></li>
\r
1070 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#getProxy" href="output/Ext.dd.DragSource.html#getProxy">DragSource</a></td>
\r
1072 <tr class="method-row alt expandable">
\r
1073 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1075 <a id="Ext.dd.DragZone-getRepairXY"></a>
\r
1076 <b>getRepairXY</b>( <code>EventObject e</code> ) : Array <div class="mdesc">
\r
1077 <div class="short">Called before a repair of an invalid drop to get the XY to animate to. By default returns
1078 the XY of this.dragData.ddel</div>
\r
1079 <div class="long">
\r
1080 Called before a repair of an invalid drop to get the XY to animate to. By default returns
1081 the XY of this.dragData.ddel <div class="mdetail-params">
\r
1082 <strong>Parameters:</strong>
\r
1083 <ul><li><code>e</code> : EventObject<div class="sub-desc">The mouse up event</div></li> </ul>
\r
1084 <strong>Returns:</strong>
\r
1086 <li><code>Array</code><div class="sub-desc">The xy location (e.g. [100, 200])</div></li>
\r
1092 <td class="msource">DragZone</td>
\r
1094 <tr class="method-row inherited expandable">
\r
1095 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1097 <a id="Ext.dd.DragZone-hideProxy"></a>
\r
1098 <b>hideProxy</b>() : void <div class="mdesc">
\r
1099 <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
1100 <div class="long">
\r
1101 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
1102 <strong>Parameters:</strong>
\r
1103 <ul><li>None.</li> </ul>
\r
1104 <strong>Returns:</strong>
\r
1106 <li><code>void</code></li>
\r
1112 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#hideProxy" href="output/Ext.dd.DragSource.html#hideProxy">DragSource</a></td>
\r
1114 <tr class="method-row inherited alt expandable">
\r
1115 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1117 <a id="Ext.dd.DragZone-init"></a>
\r
1118 <b>init</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">
\r
1119 <div class="short">Sets up the DragDrop object. Must be called in the constructor of any
1120 Ext.dd.DragDrop subclass</div>
\r
1121 <div class="long">
\r
1122 Sets up the DragDrop object. Must be called in the constructor of any
1123 Ext.dd.DragDrop subclass <div class="mdetail-params">
\r
1124 <strong>Parameters:</strong>
\r
1125 <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
1126 <strong>Returns:</strong>
\r
1128 <li><code>void</code></li>
\r
1134 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#init" href="output/Ext.dd.DragDrop.html#init">DragDrop</a></td>
\r
1136 <tr class="method-row inherited expandable">
\r
1137 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1139 <a id="Ext.dd.DragZone-initFrame"></a>
\r
1140 <b>initFrame</b>() : void <div class="mdesc">
\r
1141 <div class="short">Initialization for the drag frame element. Must be called in the
1142 constructor of all subclasses</div>
\r
1143 <div class="long">
\r
1144 Initialization for the drag frame element. Must be called in the
1145 constructor of all subclasses <div class="mdetail-params">
\r
1146 <strong>Parameters:</strong>
\r
1147 <ul><li>None.</li> </ul>
\r
1148 <strong>Returns:</strong>
\r
1150 <li><code>void</code></li>
\r
1156 <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#initFrame" href="output/Ext.dd.DDProxy.html#initFrame">DDProxy</a></td>
\r
1158 <tr class="method-row inherited alt expandable">
\r
1159 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1161 <a id="Ext.dd.DragZone-initTarget"></a>
\r
1162 <b>initTarget</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">
\r
1163 <div class="short">Initializes Targeting functionality only... the object does not
1164 get a mousedown handler.</div>
\r
1165 <div class="long">
\r
1166 Initializes Targeting functionality only... the object does not
1167 get a mousedown handler. <div class="mdetail-params">
\r
1168 <strong>Parameters:</strong>
\r
1169 <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
1170 <strong>Returns:</strong>
\r
1172 <li><code>void</code></li>
\r
1178 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#initTarget" href="output/Ext.dd.DragDrop.html#initTarget">DragDrop</a></td>
\r
1180 <tr class="method-row inherited expandable">
\r
1181 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1183 <a id="Ext.dd.DragZone-isLocked"></a>
\r
1184 <b>isLocked</b>() : boolean <div class="mdesc">
\r
1185 <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
1186 (meaning that all drag/drop is disabled on th...</div>
\r
1187 <div class="long">
\r
1188 Returns true if this instance is locked, or the drag drop mgr is locked
1189 (meaning that all drag/drop is disabled on the page.) <div class="mdetail-params">
\r
1190 <strong>Parameters:</strong>
\r
1191 <ul><li>None.</li> </ul>
\r
1192 <strong>Returns:</strong>
\r
1194 <li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li>
\r
1200 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isLocked" href="output/Ext.dd.DragDrop.html#isLocked">DragDrop</a></td>
\r
1202 <tr class="method-row inherited alt expandable">
\r
1203 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1205 <a id="Ext.dd.DragZone-isValidHandleChild"></a>
\r
1206 <b>isValidHandleChild</b>( <code>HTMLElement node</code> ) : boolean <div class="mdesc">
\r
1207 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
\r
1208 <div class="long">
\r
1209 Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params">
\r
1210 <strong>Parameters:</strong>
\r
1211 <ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul>
\r
1212 <strong>Returns:</strong>
\r
1214 <li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li>
\r
1220 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isValidHandleChild" href="output/Ext.dd.DragDrop.html#isValidHandleChild">DragDrop</a></td>
\r
1222 <tr class="method-row inherited expandable">
\r
1223 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1225 <a id="Ext.dd.DragZone-lock"></a>
\r
1226 <b>lock</b>() : void <div class="mdesc">
\r
1227 <div class="short">Lock this instance</div>
\r
1228 <div class="long">
\r
1229 Lock this instance <div class="mdetail-params">
\r
1230 <strong>Parameters:</strong>
\r
1231 <ul><li>None.</li> </ul>
\r
1232 <strong>Returns:</strong>
\r
1234 <li><code>void</code></li>
\r
1240 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#lock" href="output/Ext.dd.DragDrop.html#lock">DragDrop</a></td>
\r
1242 <tr class="method-row inherited alt expandable">
\r
1243 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1245 <a id="Ext.dd.DragZone-onAvailable"></a>
\r
1246 <b>onAvailable</b>() : void <div class="mdesc">
\r
1247 <div class="short">Override the onAvailable method to do what is needed after the initial
1248 position was determined.</div>
\r
1249 <div class="long">
\r
1250 Override the onAvailable method to do what is needed after the initial
1251 position was determined. <div class="mdetail-params">
\r
1252 <strong>Parameters:</strong>
\r
1253 <ul><li>None.</li> </ul>
\r
1254 <strong>Returns:</strong>
\r
1256 <li><code>void</code></li>
\r
1262 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onAvailable" href="output/Ext.dd.DragDrop.html#onAvailable">DragDrop</a></td>
\r
1264 <tr class="method-row inherited expandable">
\r
1265 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1267 <a id="Ext.dd.DragZone-onBeforeDrag"></a>
\r
1268 <b>onBeforeDrag</b>( <code>Object data</code>, <code>Event e</code> ) : Boolean <div class="mdesc">
\r
1269 <div class="short">An empty function by default, but provided so that you can perform a custom action before the initial
1270 drag event begi...</div>
\r
1271 <div class="long">
\r
1272 An empty function by default, but provided so that you can perform a custom action before the initial
1273 drag event begins and optionally cancel it. <div class="mdetail-params">
\r
1274 <strong>Parameters:</strong>
\r
1275 <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
1276 <strong>Returns:</strong>
\r
1278 <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
\r
1284 <td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#onBeforeDrag" href="output/Ext.dd.DragSource.html#onBeforeDrag">DragSource</a></td>
\r
1286 <tr class="method-row inherited alt expandable">
\r
1287 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1289 <a id="Ext.dd.DragZone-onDrag"></a>
\r
1290 <b>onDrag</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
1291 <div class="short">Abstract method called during the onMouseMove event while dragging an
1293 <div class="long">
\r
1294 Abstract method called during the onMouseMove event while dragging an
1295 object. <div class="mdetail-params">
\r
1296 <strong>Parameters:</strong>
\r
1297 <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul>
\r
1298 <strong>Returns:</strong>
\r
1300 <li><code>void</code></li>
\r
1306 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDrag" href="output/Ext.dd.DragDrop.html#onDrag">DragDrop</a></td>
\r
1308 <tr class="method-row inherited expandable">
\r
1309 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1311 <a id="Ext.dd.DragZone-onDragDrop"></a>
\r
1312 <b>onDragDrop</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
1313 <div class="short">Abstract method called when this item is dropped on another DragDrop
1315 <div class="long">
\r
1316 Abstract method called when this item is dropped on another DragDrop
1317 obj <div class="mdetail-params">
\r
1318 <strong>Parameters:</strong>
\r
1319 <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
1320 id this was dropped on. In INTERSECT mode, an array of dd items this
1321 was dropped on.</div></li> </ul>
\r
1322 <strong>Returns:</strong>
\r
1324 <li><code>void</code></li>
\r
1330 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragDrop" href="output/Ext.dd.DragDrop.html#onDragDrop">DragDrop</a></td>
\r
1332 <tr class="method-row inherited alt expandable">
\r
1333 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1335 <a id="Ext.dd.DragZone-onDragEnter"></a>
\r
1336 <b>onDragEnter</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
1337 <div class="short">Abstract method called when this element fist begins hovering over
1338 another DragDrop obj</div>
\r
1339 <div class="long">
\r
1340 Abstract method called when this element fist begins hovering over
1341 another DragDrop obj <div class="mdetail-params">
\r
1342 <strong>Parameters:</strong>
\r
1343 <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
1344 id this is hovering over. In INTERSECT mode, an array of one or more
1345 dragdrop items being hovered over.</div></li> </ul>
\r
1346 <strong>Returns:</strong>
\r
1348 <li><code>void</code></li>
\r
1354 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragEnter" href="output/Ext.dd.DragDrop.html#onDragEnter">DragDrop</a></td>
\r
1356 <tr class="method-row inherited expandable">
\r
1357 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1359 <a id="Ext.dd.DragZone-onDragOut"></a>
\r
1360 <b>onDragOut</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
1361 <div class="short">Abstract method called when we are no longer hovering over an element</div>
\r
1362 <div class="long">
\r
1363 Abstract method called when we are no longer hovering over an element <div class="mdetail-params">
\r
1364 <strong>Parameters:</strong>
\r
1365 <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
1366 id this was hovering over. In INTERSECT mode, an array of dd items
1367 that the mouse is no longer over.</div></li> </ul>
\r
1368 <strong>Returns:</strong>
\r
1370 <li><code>void</code></li>
\r
1376 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOut" href="output/Ext.dd.DragDrop.html#onDragOut">DragDrop</a></td>
\r
1378 <tr class="method-row inherited alt expandable">
\r
1379 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1381 <a id="Ext.dd.DragZone-onDragOver"></a>
\r
1382 <b>onDragOver</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
1383 <div class="short">Abstract method called when this element is hovering over another
1384 DragDrop obj</div>
\r
1385 <div class="long">
\r
1386 Abstract method called when this element is hovering over another
1387 DragDrop obj <div class="mdetail-params">
\r
1388 <strong>Parameters:</strong>
\r
1389 <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
1390 id this is hovering over. In INTERSECT mode, an array of dd items
1391 being hovered over.</div></li> </ul>
\r
1392 <strong>Returns:</strong>
\r
1394 <li><code>void</code></li>
\r
1400 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOver" href="output/Ext.dd.DragDrop.html#onDragOver">DragDrop</a></td>
\r
1402 <tr class="method-row expandable">
\r
1403 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1405 <a id="Ext.dd.DragZone-onInitDrag"></a>
\r
1406 <b>onInitDrag</b>( <code>Number x</code>, <code>Number y</code> ) : Boolean <div class="mdesc">
\r
1407 <div class="short">Called once drag threshold has been reached to initialize the proxy element. By default, it clones the
1408 this.dragData....</div>
\r
1409 <div class="long">
\r
1410 Called once drag threshold has been reached to initialize the proxy element. By default, it clones the
1411 this.dragData.ddel <div class="mdetail-params">
\r
1412 <strong>Parameters:</strong>
\r
1413 <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
1414 <strong>Returns:</strong>
\r
1416 <li><code>Boolean</code><div class="sub-desc">true to continue the drag, false to cancel</div></li>
\r
1422 <td class="msource">DragZone</td>
\r
1424 <tr class="method-row inherited alt expandable">
\r
1425 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1427 <a id="Ext.dd.DragZone-onInvalidDrop"></a>
\r
1428 <b>onInvalidDrop</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
1429 <div class="short">Abstract method called when this item is dropped on an area with no
1431 <div class="long">
\r
1432 Abstract method called when this item is dropped on an area with no
1433 drop target <div class="mdetail-params">
\r
1434 <strong>Parameters:</strong>
\r
1435 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
1436 <strong>Returns:</strong>
\r
1438 <li><code>void</code></li>
\r
1444 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onInvalidDrop" href="output/Ext.dd.DragDrop.html#onInvalidDrop">DragDrop</a></td>
\r
1446 <tr class="method-row inherited expandable">
\r
1447 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1449 <a id="Ext.dd.DragZone-onMouseDown"></a>
\r
1450 <b>onMouseDown</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
1451 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
\r
1452 <div class="long">
\r
1453 Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params">
\r
1454 <strong>Parameters:</strong>
\r
1455 <ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul>
\r
1456 <strong>Returns:</strong>
\r
1458 <li><code>void</code></li>
\r
1464 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseDown" href="output/Ext.dd.DragDrop.html#onMouseDown">DragDrop</a></td>
\r
1466 <tr class="method-row inherited alt expandable">
\r
1467 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1469 <a id="Ext.dd.DragZone-onMouseUp"></a>
\r
1470 <b>onMouseUp</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
1471 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
\r
1472 <div class="long">
\r
1473 Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params">
\r
1474 <strong>Parameters:</strong>
\r
1475 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
1476 <strong>Returns:</strong>
\r
1478 <li><code>void</code></li>
\r
1484 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseUp" href="output/Ext.dd.DragDrop.html#onMouseUp">DragDrop</a></td>
\r
1486 <tr class="method-row inherited expandable">
\r
1487 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1489 <a id="Ext.dd.DragZone-removeFromGroup"></a>
\r
1490 <b>removeFromGroup</b>( <code>string sGroup</code> ) : void <div class="mdesc">
\r
1491 <div class="short">Remove's this instance from the supplied interaction group</div>
\r
1492 <div class="long">
\r
1493 Remove's this instance from the supplied interaction group <div class="mdetail-params">
\r
1494 <strong>Parameters:</strong>
\r
1495 <ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul>
\r
1496 <strong>Returns:</strong>
\r
1498 <li><code>void</code></li>
\r
1504 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeFromGroup" href="output/Ext.dd.DragDrop.html#removeFromGroup">DragDrop</a></td>
\r
1506 <tr class="method-row inherited alt expandable">
\r
1507 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1509 <a id="Ext.dd.DragZone-removeInvalidHandleClass"></a>
\r
1510 <b>removeInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">
\r
1511 <div class="short">Unsets an invalid css class</div>
\r
1512 <div class="long">
\r
1513 Unsets an invalid css class <div class="mdetail-params">
\r
1514 <strong>Parameters:</strong>
\r
1515 <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to
1516 re-enable</div></li> </ul>
\r
1517 <strong>Returns:</strong>
\r
1519 <li><code>void</code></li>
\r
1525 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleClass" href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass">DragDrop</a></td>
\r
1527 <tr class="method-row inherited expandable">
\r
1528 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1530 <a id="Ext.dd.DragZone-removeInvalidHandleId"></a>
\r
1531 <b>removeInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">
\r
1532 <div class="short">Unsets an invalid handle id</div>
\r
1533 <div class="long">
\r
1534 Unsets an invalid handle id <div class="mdetail-params">
\r
1535 <strong>Parameters:</strong>
\r
1536 <ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul>
\r
1537 <strong>Returns:</strong>
\r
1539 <li><code>void</code></li>
\r
1545 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleId" href="output/Ext.dd.DragDrop.html#removeInvalidHandleId">DragDrop</a></td>
\r
1547 <tr class="method-row inherited alt expandable">
\r
1548 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1550 <a id="Ext.dd.DragZone-removeInvalidHandleType"></a>
\r
1551 <b>removeInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">
\r
1552 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
\r
1553 <div class="long">
\r
1554 Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params">
\r
1555 <strong>Parameters:</strong>
\r
1556 <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li> </ul>
\r
1557 <strong>Returns:</strong>
\r
1559 <li><code>void</code></li>
\r
1565 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleType" href="output/Ext.dd.DragDrop.html#removeInvalidHandleType">DragDrop</a></td>
\r
1567 <tr class="method-row inherited expandable">
\r
1568 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1570 <a id="Ext.dd.DragZone-resetConstraints"></a>
\r
1571 <b>resetConstraints</b>( <code>boolean maintainOffset</code> ) : void <div class="mdesc">
\r
1572 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
\r
1573 <div class="long">
\r
1574 resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params">
\r
1575 <strong>Parameters:</strong>
\r
1576 <ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul>
\r
1577 <strong>Returns:</strong>
\r
1579 <li><code>void</code></li>
\r
1585 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#resetConstraints" href="output/Ext.dd.DragDrop.html#resetConstraints">DragDrop</a></td>
\r
1587 <tr class="method-row inherited alt expandable">
\r
1588 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1590 <a id="Ext.dd.DragZone-setDelta"></a>
\r
1591 <b>setDelta</b>( <code>int iDeltaX</code>, <code>int iDeltaY</code> ) : void <div class="mdesc">
\r
1592 <div class="short">Sets the pointer offset. You can call this directly to force the
1593 offset to be in a particular location (e.g., pass i...</div>
\r
1594 <div class="long">
\r
1595 Sets the pointer offset. You can call this directly to force the
1596 offset to be in a particular location (e.g., pass in 0,0 to set it
1597 to the center of the object) <div class="mdetail-params">
\r
1598 <strong>Parameters:</strong>
\r
1599 <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
1600 <strong>Returns:</strong>
\r
1602 <li><code>void</code></li>
\r
1608 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDelta" href="output/Ext.dd.DD.html#setDelta">DD</a></td>
\r
1610 <tr class="method-row inherited expandable">
\r
1611 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1613 <a id="Ext.dd.DragZone-setDragElId"></a>
\r
1614 <b>setDragElId</b>( <code>id {string}</code> ) : void <div class="mdesc">
\r
1615 <div class="short">Allows you to specify that an element other than the linked element
1616 will be moved with the cursor during a drag</div>
\r
1617 <div class="long">
\r
1618 Allows you to specify that an element other than the linked element
1619 will be moved with the cursor during a drag <div class="mdetail-params">
\r
1620 <strong>Parameters:</strong>
\r
1621 <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
1622 <strong>Returns:</strong>
\r
1624 <li><code>void</code></li>
\r
1630 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setDragElId" href="output/Ext.dd.DragDrop.html#setDragElId">DragDrop</a></td>
\r
1632 <tr class="method-row inherited alt expandable">
\r
1633 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1635 <a id="Ext.dd.DragZone-setDragElPos"></a>
\r
1636 <b>setDragElPos</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
\r
1637 <div class="short">Sets the drag element to the location of the mousedown or click event,
1638 maintaining the cursor location relative to th...</div>
\r
1639 <div class="long">
\r
1640 Sets the drag element to the location of the mousedown or click event,
1641 maintaining the cursor location relative to the location on the element
1642 that was clicked. Override this if you want to place the element in a
1643 location other than where the cursor is. <div class="mdetail-params">
\r
1644 <strong>Parameters:</strong>
\r
1645 <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
1646 <strong>Returns:</strong>
\r
1648 <li><code>void</code></li>
\r
1654 <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDragElPos" href="output/Ext.dd.DD.html#setDragElPos">DD</a></td>
\r
1656 <tr class="method-row inherited expandable">
\r
1657 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1659 <a id="Ext.dd.DragZone-setHandleElId"></a>
\r
1660 <b>setHandleElId</b>( <code>id {string}</code> ) : void <div class="mdesc">
\r
1661 <div class="short">Allows you to specify a child of the linked element that should be
1662 used to initiate the drag operation. An example o...</div>
\r
1663 <div class="long">
\r
1664 Allows you to specify a child of the linked element that should be
1665 used to initiate the drag operation. An example of this would be if
1666 you have a content div with text and links. Clicking anywhere in the
1667 content area would normally start the drag operation. Use this method
1668 to specify that an element inside of the content div is the element
1669 that starts the drag operation. <div class="mdetail-params">
\r
1670 <strong>Parameters:</strong>
\r
1671 <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to
1672 initiate the drag.</div></li> </ul>
\r
1673 <strong>Returns:</strong>
\r
1675 <li><code>void</code></li>
\r
1681 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setHandleElId" href="output/Ext.dd.DragDrop.html#setHandleElId">DragDrop</a></td>
\r
1683 <tr class="method-row inherited alt expandable">
\r
1684 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1686 <a id="Ext.dd.DragZone-setInitialPosition"></a>
\r
1687 <b>setInitialPosition</b>( <code>int diffX</code>, <code>int diffY</code> ) : void <div class="mdesc">
\r
1688 <div class="short">Stores the initial placement of the linked element.</div>
\r
1689 <div class="long">
\r
1690 Stores the initial placement of the linked element. <div class="mdetail-params">
\r
1691 <strong>Parameters:</strong>
\r
1692 <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
1693 <strong>Returns:</strong>
\r
1695 <li><code>void</code></li>
\r
1701 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setInitialPosition" href="output/Ext.dd.DragDrop.html#setInitialPosition">DragDrop</a></td>
\r
1703 <tr class="method-row inherited expandable">
\r
1704 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1706 <a id="Ext.dd.DragZone-setOuterHandleElId"></a>
\r
1707 <b>setOuterHandleElId</b>( <code>id the</code> ) : void <div class="mdesc">
\r
1708 <div class="short">Allows you to set an element outside of the linked element as a drag
1710 <div class="long">
\r
1711 Allows you to set an element outside of the linked element as a drag
1712 handle <div class="mdetail-params">
\r
1713 <strong>Parameters:</strong>
\r
1714 <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
1715 <strong>Returns:</strong>
\r
1717 <li><code>void</code></li>
\r
1723 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setOuterHandleElId" href="output/Ext.dd.DragDrop.html#setOuterHandleElId">DragDrop</a></td>
\r
1725 <tr class="method-row inherited alt expandable">
\r
1726 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1728 <a id="Ext.dd.DragZone-setPadding"></a>
\r
1729 <b>setPadding</b>( <code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code> ) : void <div class="mdesc">
\r
1730 <div class="short">Configures the padding for the target zone in px. Effectively expands
1731 (or reduces) the virtual object size for targe...</div>
\r
1732 <div class="long">
\r
1733 Configures the padding for the target zone in px. Effectively expands
1734 (or reduces) the virtual object size for targeting calculations.
1735 Supports css-style shorthand; if only one parameter is passed, all sides
1736 will have that padding, and if only two are passed, the top and bottom
1737 will have the first param, the left and right the second. <div class="mdetail-params">
\r
1738 <strong>Parameters:</strong>
\r
1739 <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
1740 <strong>Returns:</strong>
\r
1742 <li><code>void</code></li>
\r
1748 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setPadding" href="output/Ext.dd.DragDrop.html#setPadding">DragDrop</a></td>
\r
1750 <tr class="method-row inherited expandable">
\r
1751 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1753 <a id="Ext.dd.DragZone-setXConstraint"></a>
\r
1754 <b>setXConstraint</b>( <code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code> ) : void <div class="mdesc">
\r
1755 <div class="short">By default, the element can be dragged any place on the screen. Use
1756 this method to limit the horizontal travel of th...</div>
\r
1757 <div class="long">
\r
1758 By default, the element can be dragged any place on the screen. Use
1759 this method to limit the horizontal travel of the element. Pass in
1760 0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params">
\r
1761 <strong>Parameters:</strong>
\r
1762 <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
1763 right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
1765 should move iTickSize pixels at a time.</div></li> </ul>
\r
1766 <strong>Returns:</strong>
\r
1768 <li><code>void</code></li>
\r
1774 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setXConstraint" href="output/Ext.dd.DragDrop.html#setXConstraint">DragDrop</a></td>
\r
1776 <tr class="method-row inherited alt expandable">
\r
1777 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1779 <a id="Ext.dd.DragZone-setYConstraint"></a>
\r
1780 <b>setYConstraint</b>( <code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code> ) : void <div class="mdesc">
\r
1781 <div class="short">By default, the element can be dragged any place on the screen. Set
1782 this to limit the vertical travel of the element...</div>
\r
1783 <div class="long">
\r
1784 By default, the element can be dragged any place on the screen. Set
1785 this to limit the vertical travel of the element. Pass in 0,0 for the
1786 parameters if you want to lock the drag to the x axis. <div class="mdetail-params">
\r
1787 <strong>Parameters:</strong>
\r
1788 <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
1789 element should move iTickSize pixels at a time.</div></li> </ul>
\r
1790 <strong>Returns:</strong>
\r
1792 <li><code>void</code></li>
\r
1798 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setYConstraint" href="output/Ext.dd.DragDrop.html#setYConstraint">DragDrop</a></td>
\r
1800 <tr class="method-row inherited expandable">
\r
1801 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1803 <a id="Ext.dd.DragZone-startDrag"></a>
\r
1804 <b>startDrag</b>( <code>int X</code>, <code>int Y</code> ) : void <div class="mdesc">
\r
1805 <div class="short">Abstract method called after a drag/drop object is clicked
1806 and the drag or mousedown time thresholds have beeen met.</div>
\r
1807 <div class="long">
\r
1808 Abstract method called after a drag/drop object is clicked
1809 and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params">
\r
1810 <strong>Parameters:</strong>
\r
1811 <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
1812 <strong>Returns:</strong>
\r
1814 <li><code>void</code></li>
\r
1820 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#startDrag" href="output/Ext.dd.DragDrop.html#startDrag">DragDrop</a></td>
\r
1822 <tr class="method-row inherited alt expandable">
\r
1823 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1825 <a id="Ext.dd.DragZone-toString"></a>
\r
1826 <b>toString</b>() : string <div class="mdesc">
\r
1827 <div class="short">toString method</div>
\r
1828 <div class="long">
\r
1829 toString method <div class="mdetail-params">
\r
1830 <strong>Parameters:</strong>
\r
1831 <ul><li>None.</li> </ul>
\r
1832 <strong>Returns:</strong>
\r
1834 <li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li>
\r
1840 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#toString" href="output/Ext.dd.DragDrop.html#toString">DragDrop</a></td>
\r
1842 <tr class="method-row inherited expandable">
\r
1843 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1845 <a id="Ext.dd.DragZone-unlock"></a>
\r
1846 <b>unlock</b>() : void <div class="mdesc">
\r
1847 <div class="short">Unlock this instace</div>
\r
1848 <div class="long">
\r
1849 Unlock this instace <div class="mdetail-params">
\r
1850 <strong>Parameters:</strong>
\r
1851 <ul><li>None.</li> </ul>
\r
1852 <strong>Returns:</strong>
\r
1854 <li><code>void</code></li>
\r
1860 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unlock" href="output/Ext.dd.DragDrop.html#unlock">DragDrop</a></td>
\r
1862 <tr class="method-row inherited alt expandable">
\r
1863 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1865 <a id="Ext.dd.DragZone-unreg"></a>
\r
1866 <b>unreg</b>() : void <div class="mdesc">
\r
1867 <div class="short">Remove all drag and drop hooks for this element</div>
\r
1868 <div class="long">
\r
1869 Remove all drag and drop hooks for this element <div class="mdetail-params">
\r
1870 <strong>Parameters:</strong>
\r
1871 <ul><li>None.</li> </ul>
\r
1872 <strong>Returns:</strong>
\r
1874 <li><code>void</code></li>
\r
1880 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unreg" href="output/Ext.dd.DragDrop.html#unreg">DragDrop</a></td>
\r
1883 <a id="Ext.dd.DragZone-events"></a>
1884 <h2>Public Events</h2>
1885 <div class="no-members">This class has no public events.</div>