1 <div class="body-wrap">
2 <div class="top-tools">
3 <a class="inner-link" href="#Ext.dd.DropTarget-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 <a class="inner-link" href="#Ext.dd.DropTarget-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 <a class="inner-link" href="#Ext.dd.DropTarget-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 <a class="inner-link" href="#Ext.dd.DropTarget-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.DropTarget"><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.DDTarget" ext:member="" href="output/Ext.dd.DDTarget.html">DDTarget</a>
12 <img src="resources/elbow-end.gif"/>DropTarget</pre></div>
13 <h1>Class Ext.dd.DropTarget</h1>
14 <table cellspacing="0">
15 <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
16 <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DropTarget.js" target="_blank">DropTarget.js</a></td></tr>
17 <tr><td class="label">Class:</td><td class="hd-info">DropTarget</td></tr>
18 <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.dd.DropZone" href="output/Ext.dd.DropZone.html">DropZone</a></td></tr>
19 <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.dd.DDTarget" ext:member="" href="output/Ext.dd.DDTarget.html">DDTarget</a></td></tr>
21 <div class="description">
23 A simple class that provides the basic implementation needed to make any element a drop target that can have
24 draggable items dropped onto it. The drop has no effect until an implementation of notifyDrop is provided. </div>
26 <div class="hr"></div>
27 <a id="Ext.dd.DropTarget-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 expandable">
\r
35 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
37 <a id="Ext.dd.DropTarget-ddGroup"></a>
\r
38 <b>ddGroup</b> : String <div class="mdesc">
\r
39 <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
41 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
44 <td class="msource">DropTarget</td>
\r
46 <tr class="config-row alt">
\r
47 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
49 <a id="Ext.dd.DropTarget-dropAllowed"></a>
\r
50 <b>dropAllowed</b> : String <div class="mdesc">
\r
51 The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). </div>
\r
53 <td class="msource">DropTarget</td>
\r
55 <tr class="config-row">
\r
56 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
58 <a id="Ext.dd.DropTarget-dropNotAllowed"></a>
\r
59 <b>dropNotAllowed</b> : String <div class="mdesc">
\r
60 The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div>
\r
62 <td class="msource">DropTarget</td>
\r
64 <tr class="config-row alt">
\r
65 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
67 <a id="Ext.dd.DropTarget-overClass"></a>
\r
68 <b>overClass</b> : String <div class="mdesc">
\r
69 The CSS class applied to the drop target element while the drag source is over it (defaults to ""). </div>
\r
71 <td class="msource">DropTarget</td>
\r
74 <a id="Ext.dd.DropTarget-props"></a>
75 <h2>Public Properties</h2>
76 <table cellspacing="0" class="member-table">
78 <th class="sig-header" colspan="2">Property</th>
79 <th class="msource-header">Defined By</th>
81 <tr class="property-row inherited">
\r
82 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
84 <a id="Ext.dd.DropTarget-available"></a>
\r
85 <b>available</b> : boolean <div class="mdesc">
\r
86 The availabe property is false until the linked dom element is accessible. </div>
\r
88 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#available" href="output/Ext.dd.DragDrop.html#available">DragDrop</a></td>
\r
90 <tr class="property-row inherited alt">
\r
91 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
93 <a id="Ext.dd.DropTarget-config"></a>
\r
94 <b>config</b> : object <div class="mdesc">
\r
95 Configuration attributes passed into the constructor </div>
\r
97 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#config" href="output/Ext.dd.DragDrop.html#config">DragDrop</a></td>
\r
99 <tr class="property-row inherited">
\r
100 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
102 <a id="Ext.dd.DropTarget-defaultPadding"></a>
\r
103 <b>defaultPadding</b> : Object <div class="mdesc">
\r
104 Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). </div>
\r
106 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#defaultPadding" href="output/Ext.dd.DragDrop.html#defaultPadding">DragDrop</a></td>
\r
108 <tr class="property-row inherited alt expandable">
\r
109 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
111 <a id="Ext.dd.DropTarget-groups"></a>
\r
112 <b>groups</b> : object <div class="mdesc">
\r
113 <div class="short">The group defines a logical collection of DragDrop objects that are
114 related. Instances only get events when interact...</div>
\r
116 The group defines a logical collection of DragDrop objects that are
117 related. Instances only get events when interacting with other
118 DragDrop object in the same group. This lets us define multiple
119 groups using a single DragDrop subclass if we want. </div>
\r
122 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#groups" href="output/Ext.dd.DragDrop.html#groups">DragDrop</a></td>
\r
124 <tr class="property-row inherited expandable">
\r
125 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
127 <a id="Ext.dd.DropTarget-hasOuterHandles"></a>
\r
128 <b>hasOuterHandles</b> : boolean <div class="mdesc">
\r
129 <div class="short">By default, drags can only be initiated if the mousedown occurs in the
130 region the linked element is. This is done in...</div>
\r
132 By default, drags can only be initiated if the mousedown occurs in the
133 region the linked element is. This is done in part to work around a
134 bug in some browsers that mis-report the mousedown if the previous
135 mouseup happened outside of the window. This property is set to true
136 if outer handles are defined. </div>
\r
139 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#hasOuterHandles" href="output/Ext.dd.DragDrop.html#hasOuterHandles">DragDrop</a></td>
\r
141 <tr class="property-row inherited alt expandable">
\r
142 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
144 <a id="Ext.dd.DropTarget-id"></a>
\r
145 <b>id</b> : String <div class="mdesc">
\r
146 <div class="short">The id of the element associated with this object. This is what we
147 refer to as the "linked element" because the size...</div>
\r
149 The id of the element associated with this object. This is what we
150 refer to as the "linked element" because the size and position of
151 this element is used to determine when the drag and drop objects have
155 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#id" href="output/Ext.dd.DragDrop.html#id">DragDrop</a></td>
\r
157 <tr class="property-row inherited">
\r
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
160 <a id="Ext.dd.DropTarget-invalidHandleClasses"></a>
\r
161 <b>invalidHandleClasses</b> : Array <div class="mdesc">
\r
162 An Array of CSS class names for elements to be considered in valid as drag handles. </div>
\r
164 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleClasses" href="output/Ext.dd.DragDrop.html#invalidHandleClasses">DragDrop</a></td>
\r
166 <tr class="property-row inherited alt expandable">
\r
167 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
169 <a id="Ext.dd.DropTarget-invalidHandleIds"></a>
\r
170 <b>invalidHandleIds</b> : Object <div class="mdesc">
\r
171 <div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles.
172 A non-null prop...</div>
\r
174 An object who's property names identify the IDs of elements to be considered invalid as drag handles.
175 A non-null property value identifies the ID as invalid. For example, to prevent
176 dragging from being initiated on element ID "foo", use:<pre><code>{
178 }</code></pre> </div>
\r
181 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleIds" href="output/Ext.dd.DragDrop.html#invalidHandleIds">DragDrop</a></td>
\r
183 <tr class="property-row inherited expandable">
\r
184 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
186 <a id="Ext.dd.DropTarget-invalidHandleTypes"></a>
\r
187 <b>invalidHandleTypes</b> : Object <div class="mdesc">
\r
188 <div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles.
189 A non-null property value...</div>
\r
191 An object who's property names identify HTML tags to be considered invalid as drag handles.
192 A non-null property value identifies the tag as invalid. Defaults to the
193 following value which prevents drag operations from being initiated by <a> elements:<pre><code>{
195 }</code></pre> </div>
\r
198 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleTypes" href="output/Ext.dd.DragDrop.html#invalidHandleTypes">DragDrop</a></td>
\r
200 <tr class="property-row inherited alt">
\r
201 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
203 <a id="Ext.dd.DropTarget-isTarget"></a>
\r
204 <b>isTarget</b> : boolean <div class="mdesc">
\r
205 By default, all instances can be a drop target. This can be disabled by
206 setting isTarget to false. </div>
\r
208 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isTarget" href="output/Ext.dd.DragDrop.html#isTarget">DragDrop</a></td>
\r
210 <tr class="property-row inherited expandable">
\r
211 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
213 <a id="Ext.dd.DropTarget-maintainOffset"></a>
\r
214 <b>maintainOffset</b> : boolean <div class="mdesc">
\r
215 <div class="short">Maintain offsets when we resetconstraints. Set to true when you want
216 the position of the element relative to its par...</div>
\r
218 Maintain offsets when we resetconstraints. Set to true when you want
219 the position of the element relative to its parent to stay the same
220 when the page changes </div>
\r
223 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#maintainOffset" href="output/Ext.dd.DragDrop.html#maintainOffset">DragDrop</a></td>
\r
225 <tr class="property-row inherited alt expandable">
\r
226 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
228 <a id="Ext.dd.DropTarget-moveOnly"></a>
\r
229 <b>moveOnly</b> : boolean <div class="mdesc">
\r
230 <div class="short">When set to true, other DD objects in cooperating DDGroups do not receive
231 notification events when this DD object is ...</div>
\r
233 When set to true, other DD objects in cooperating DDGroups do not receive
234 notification events when this DD object is dragged over them. Defaults to false. </div>
\r
237 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#moveOnly" href="output/Ext.dd.DragDrop.html#moveOnly">DragDrop</a></td>
\r
239 <tr class="property-row inherited">
\r
240 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
242 <a id="Ext.dd.DropTarget-padding"></a>
\r
243 <b>padding</b> : int[] <div class="mdesc">
\r
244 The padding configured for this drag and drop object for calculating
245 the drop zone intersection with this object. </div>
\r
247 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#padding" href="output/Ext.dd.DragDrop.html#padding">DragDrop</a></td>
\r
249 <tr class="property-row inherited alt expandable">
\r
250 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
252 <a id="Ext.dd.DropTarget-primaryButtonOnly"></a>
\r
253 <b>primaryButtonOnly</b> : boolean <div class="mdesc">
\r
254 <div class="short">By default the drag and drop instance will only respond to the primary
255 button click (left button for a right-handed m...</div>
\r
257 By default the drag and drop instance will only respond to the primary
258 button click (left button for a right-handed mouse). Set to true to
259 allow drag and drop to start with any mouse click that is propogated
260 by the browser </div>
\r
263 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#primaryButtonOnly" href="output/Ext.dd.DragDrop.html#primaryButtonOnly">DragDrop</a></td>
\r
265 <tr class="property-row inherited expandable">
\r
266 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
268 <a id="Ext.dd.DropTarget-xTicks"></a>
\r
269 <b>xTicks</b> : int[] <div class="mdesc">
\r
270 <div class="short">Array of pixel locations the element will snap to if we specified a
271 horizontal graduation/interval. This array is ge...</div>
\r
273 Array of pixel locations the element will snap to if we specified a
274 horizontal graduation/interval. This array is generated automatically
275 when you define a tick interval. </div>
\r
278 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#xTicks" href="output/Ext.dd.DragDrop.html#xTicks">DragDrop</a></td>
\r
280 <tr class="property-row inherited alt expandable">
\r
281 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
283 <a id="Ext.dd.DropTarget-yTicks"></a>
\r
284 <b>yTicks</b> : int[] <div class="mdesc">
\r
285 <div class="short">Array of pixel locations the element will snap to if we specified a
286 vertical graduation/interval. This array is gene...</div>
\r
288 Array of pixel locations the element will snap to if we specified a
289 vertical graduation/interval. This array is generated automatically
290 when you define a tick interval. </div>
\r
293 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#yTicks" href="output/Ext.dd.DragDrop.html#yTicks">DragDrop</a></td>
\r
296 <a id="Ext.dd.DropTarget-methods"></a>
297 <h2>Public Methods</h2>
298 <table cellspacing="0" class="member-table">
300 <th class="sig-header" colspan="2">Method</th>
301 <th class="msource-header">Defined By</th>
303 <tr class="method-row expandable">
\r
304 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
306 <a id="Ext.dd.DropTarget-DropTarget"></a>
\r
307 <b>DropTarget</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc">
\r
308 <div class="short"></div>
\r
310 <div class="mdetail-params">
\r
311 <strong>Parameters:</strong>
\r
312 <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
313 <strong>Returns:</strong>
\r
315 <li><code></code></li>
\r
321 <td class="msource">DropTarget</td>
\r
323 <tr class="method-row inherited alt expandable">
\r
324 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
326 <a id="Ext.dd.DropTarget-addInvalidHandleClass"></a>
\r
327 <b>addInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">
\r
328 <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
\r
330 Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params">
\r
331 <strong>Parameters:</strong>
\r
332 <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul>
\r
333 <strong>Returns:</strong>
\r
335 <li><code>void</code></li>
\r
341 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleClass" href="output/Ext.dd.DragDrop.html#addInvalidHandleClass">DragDrop</a></td>
\r
343 <tr class="method-row inherited expandable">
\r
344 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
346 <a id="Ext.dd.DropTarget-addInvalidHandleId"></a>
\r
347 <b>addInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">
\r
348 <div class="short">Lets you to specify an element id for a child of a drag handle
349 that should not initiate a drag</div>
\r
351 Lets you to specify an element id for a child of a drag handle
352 that should not initiate a drag <div class="mdetail-params">
\r
353 <strong>Parameters:</strong>
\r
354 <ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li> </ul>
\r
355 <strong>Returns:</strong>
\r
357 <li><code>void</code></li>
\r
363 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleId" href="output/Ext.dd.DragDrop.html#addInvalidHandleId">DragDrop</a></td>
\r
365 <tr class="method-row inherited alt expandable">
\r
366 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
368 <a id="Ext.dd.DropTarget-addInvalidHandleType"></a>
\r
369 <b>addInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">
\r
370 <div class="short">Allows you to specify a tag name that should not start a drag operation
371 when clicked. This is designed to facilitate...</div>
\r
373 Allows you to specify a tag name that should not start a drag operation
374 when clicked. This is designed to facilitate embedding links within a
375 drag handle that do something other than start the drag. <div class="mdetail-params">
\r
376 <strong>Parameters:</strong>
\r
377 <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul>
\r
378 <strong>Returns:</strong>
\r
380 <li><code>void</code></li>
\r
386 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleType" href="output/Ext.dd.DragDrop.html#addInvalidHandleType">DragDrop</a></td>
\r
388 <tr class="method-row inherited expandable">
\r
389 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
391 <a id="Ext.dd.DropTarget-addToGroup"></a>
\r
392 <b>addToGroup</b>( <code>sGroup {string}</code> ) : void <div class="mdesc">
\r
393 <div class="short">Add this instance to a group of related drag/drop objects. All
394 instances belong to at least one group, and can belon...</div>
\r
396 Add this instance to a group of related drag/drop objects. All
397 instances belong to at least one group, and can belong to as many
398 groups as needed. <div class="mdetail-params">
\r
399 <strong>Parameters:</strong>
\r
400 <ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul>
\r
401 <strong>Returns:</strong>
\r
403 <li><code>void</code></li>
\r
409 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addToGroup" href="output/Ext.dd.DragDrop.html#addToGroup">DragDrop</a></td>
\r
411 <tr class="method-row inherited alt expandable">
\r
412 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
414 <a id="Ext.dd.DropTarget-applyConfig"></a>
\r
415 <b>applyConfig</b>() : void <div class="mdesc">
\r
416 <div class="short">Applies the configuration parameters that were passed into the constructor.
417 This is supposed to happen at each level ...</div>
\r
419 Applies the configuration parameters that were passed into the constructor.
420 This is supposed to happen at each level through the inheritance chain. So
421 a DDProxy implentation will execute apply config on DDProxy, DD, and
422 DragDrop in order to get all of the parameters that are available in
423 each object. <div class="mdetail-params">
\r
424 <strong>Parameters:</strong>
\r
425 <ul><li>None.</li> </ul>
\r
426 <strong>Returns:</strong>
\r
428 <li><code>void</code></li>
\r
434 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#applyConfig" href="output/Ext.dd.DragDrop.html#applyConfig">DragDrop</a></td>
\r
436 <tr class="method-row inherited expandable">
\r
437 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
439 <a id="Ext.dd.DropTarget-clearConstraints"></a>
\r
440 <b>clearConstraints</b>() : void <div class="mdesc">
\r
441 <div class="short">Clears any constraints applied to this instance. Also clears ticks
442 since they can't exist independent of a constrain...</div>
\r
444 Clears any constraints applied to this instance. Also clears ticks
445 since they can't exist independent of a constraint at this time. <div class="mdetail-params">
\r
446 <strong>Parameters:</strong>
\r
447 <ul><li>None.</li> </ul>
\r
448 <strong>Returns:</strong>
\r
450 <li><code>void</code></li>
\r
456 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearConstraints" href="output/Ext.dd.DragDrop.html#clearConstraints">DragDrop</a></td>
\r
458 <tr class="method-row inherited alt expandable">
\r
459 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
461 <a id="Ext.dd.DropTarget-clearTicks"></a>
\r
462 <b>clearTicks</b>() : void <div class="mdesc">
\r
463 <div class="short">Clears any tick interval defined for this instance</div>
\r
465 Clears any tick interval defined for this instance <div class="mdetail-params">
\r
466 <strong>Parameters:</strong>
\r
467 <ul><li>None.</li> </ul>
\r
468 <strong>Returns:</strong>
\r
470 <li><code>void</code></li>
\r
476 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearTicks" href="output/Ext.dd.DragDrop.html#clearTicks">DragDrop</a></td>
\r
478 <tr class="method-row inherited expandable">
\r
479 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
481 <a id="Ext.dd.DropTarget-constrainTo"></a>
\r
482 <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
483 <div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element.
485 var dd = new Ext.d...</div>
\r
487 Initializes the drag drop object's constraints to restrict movement to a certain element.
489 <pre><code>var dd = <b>new</b> Ext.dd.DDProxy(<em>"dragDiv1"</em>, <em>"proxytest"</em>,
490 { dragElId: <em>"existingProxyDiv"</em> });
491 dd.startDrag = <b>function</b>(){
492 <b>this</b>.constrainTo(<em>"parent-id"</em>);
494 Or you can initalize it using the <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object:
\r
495 <pre><code>Ext.get(<em>"dragDiv1"</em>).initDDProxy(<em>"proxytest"</em>, {dragElId: <em>"existingProxyDiv"</em>}, {
496 startDrag : <b>function</b>(){
497 <b>this</b>.constrainTo(<em>"parent-id"</em>);
499 });</code></pre> <div class="mdetail-params">
\r
500 <strong>Parameters:</strong>
\r
501 <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,
502 and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
503 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
504 <strong>Returns:</strong>
\r
506 <li><code>void</code></li>
\r
512 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#constrainTo" href="output/Ext.dd.DragDrop.html#constrainTo">DragDrop</a></td>
\r
514 <tr class="method-row inherited alt expandable">
\r
515 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
517 <a id="Ext.dd.DropTarget-endDrag"></a>
\r
518 <b>endDrag</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
519 <div class="short">Fired when we are done dragging the object</div>
\r
521 Fired when we are done dragging the object <div class="mdetail-params">
\r
522 <strong>Parameters:</strong>
\r
523 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
524 <strong>Returns:</strong>
\r
526 <li><code>void</code></li>
\r
532 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#endDrag" href="output/Ext.dd.DragDrop.html#endDrag">DragDrop</a></td>
\r
534 <tr class="method-row inherited expandable">
\r
535 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
537 <a id="Ext.dd.DropTarget-getDragEl"></a>
\r
538 <b>getDragEl</b>() : HTMLElement <div class="mdesc">
\r
539 <div class="short">Returns a reference to the actual element to drag. By default this is
540 the same as the html element, but it can be as...</div>
\r
542 Returns a reference to the actual element to drag. By default this is
543 the same as the html element, but it can be assigned to another
544 element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params">
\r
545 <strong>Parameters:</strong>
\r
546 <ul><li>None.</li> </ul>
\r
547 <strong>Returns:</strong>
\r
549 <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
\r
555 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getDragEl" href="output/Ext.dd.DragDrop.html#getDragEl">DragDrop</a></td>
\r
557 <tr class="method-row inherited alt expandable">
\r
558 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
560 <a id="Ext.dd.DropTarget-getEl"></a>
\r
561 <b>getEl</b>() : HTMLElement <div class="mdesc">
\r
562 <div class="short">Returns a reference to the linked element</div>
\r
564 Returns a reference to the linked element <div class="mdetail-params">
\r
565 <strong>Parameters:</strong>
\r
566 <ul><li>None.</li> </ul>
\r
567 <strong>Returns:</strong>
\r
569 <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
\r
575 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getEl" href="output/Ext.dd.DragDrop.html#getEl">DragDrop</a></td>
\r
577 <tr class="method-row inherited expandable">
\r
578 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
580 <a id="Ext.dd.DropTarget-init"></a>
\r
581 <b>init</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">
\r
582 <div class="short">Sets up the DragDrop object. Must be called in the constructor of any
583 Ext.dd.DragDrop subclass</div>
\r
585 Sets up the DragDrop object. Must be called in the constructor of any
586 Ext.dd.DragDrop subclass <div class="mdetail-params">
\r
587 <strong>Parameters:</strong>
\r
588 <ul><li><code>the</code> : id<div class="sub-desc">id of the linked element</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related items</div></li><li><code>config</code> : object<div class="sub-desc">configuration attributes</div></li> </ul>
\r
589 <strong>Returns:</strong>
\r
591 <li><code>void</code></li>
\r
597 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#init" href="output/Ext.dd.DragDrop.html#init">DragDrop</a></td>
\r
599 <tr class="method-row inherited alt expandable">
\r
600 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
602 <a id="Ext.dd.DropTarget-initTarget"></a>
\r
603 <b>initTarget</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">
\r
604 <div class="short">Initializes Targeting functionality only... the object does not
605 get a mousedown handler.</div>
\r
607 Initializes Targeting functionality only... the object does not
608 get a mousedown handler. <div class="mdetail-params">
\r
609 <strong>Parameters:</strong>
\r
610 <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
611 <strong>Returns:</strong>
\r
613 <li><code>void</code></li>
\r
619 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#initTarget" href="output/Ext.dd.DragDrop.html#initTarget">DragDrop</a></td>
\r
621 <tr class="method-row inherited expandable">
\r
622 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
624 <a id="Ext.dd.DropTarget-isLocked"></a>
\r
625 <b>isLocked</b>() : boolean <div class="mdesc">
\r
626 <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
627 (meaning that all drag/drop is disabled on th...</div>
\r
629 Returns true if this instance is locked, or the drag drop mgr is locked
630 (meaning that all drag/drop is disabled on the page.) <div class="mdetail-params">
\r
631 <strong>Parameters:</strong>
\r
632 <ul><li>None.</li> </ul>
\r
633 <strong>Returns:</strong>
\r
635 <li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li>
\r
641 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isLocked" href="output/Ext.dd.DragDrop.html#isLocked">DragDrop</a></td>
\r
643 <tr class="method-row inherited alt expandable">
\r
644 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
646 <a id="Ext.dd.DropTarget-isValidHandleChild"></a>
\r
647 <b>isValidHandleChild</b>( <code>HTMLElement node</code> ) : boolean <div class="mdesc">
\r
648 <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
\r
650 Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params">
\r
651 <strong>Parameters:</strong>
\r
652 <ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul>
\r
653 <strong>Returns:</strong>
\r
655 <li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li>
\r
661 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isValidHandleChild" href="output/Ext.dd.DragDrop.html#isValidHandleChild">DragDrop</a></td>
\r
663 <tr class="method-row inherited expandable">
\r
664 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
666 <a id="Ext.dd.DropTarget-lock"></a>
\r
667 <b>lock</b>() : void <div class="mdesc">
\r
668 <div class="short">Lock this instance</div>
\r
670 Lock this instance <div class="mdetail-params">
\r
671 <strong>Parameters:</strong>
\r
672 <ul><li>None.</li> </ul>
\r
673 <strong>Returns:</strong>
\r
675 <li><code>void</code></li>
\r
681 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#lock" href="output/Ext.dd.DragDrop.html#lock">DragDrop</a></td>
\r
683 <tr class="method-row alt expandable">
\r
684 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
686 <a id="Ext.dd.DropTarget-notifyDrop"></a>
\r
687 <b>notifyDrop</b>( <code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code> ) : Boolean <div class="mdesc">
\r
688 <div class="short">The function a Ext.dd.DragSource calls once to notify this drop target that the dragged item has
689 been dropped on it. ...</div>
\r
691 The function a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> calls once to notify this drop target that the dragged item has
692 been dropped on it. This method has no default implementation and returns false, so you must provide an
693 implementation that does something to process the drop event and returns true so that the drag source's
694 repair action does not run. <div class="mdetail-params">
\r
695 <strong>Parameters:</strong>
\r
696 <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
\r
697 <strong>Returns:</strong>
\r
699 <li><code>Boolean</code><div class="sub-desc">True if the drop was valid, else false</div></li>
\r
705 <td class="msource">DropTarget</td>
\r
707 <tr class="method-row expandable">
\r
708 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
710 <a id="Ext.dd.DropTarget-notifyEnter"></a>
\r
711 <b>notifyEnter</b>( <code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code> ) : String <div class="mdesc">
\r
712 <div class="short">The function a Ext.dd.DragSource calls once to notify this drop target that the source is now over the
713 target. This ...</div>
\r
715 The function a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> calls once to notify this drop target that the source is now over the
716 target. This default implementation adds the CSS class specified by overClass (if any) to the drop element
717 and returns the dropAllowed config value. This method should be overridden if drop validation is required. <div class="mdetail-params">
\r
718 <strong>Parameters:</strong>
\r
719 <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
\r
720 <strong>Returns:</strong>
\r
722 <li><code>String</code><div class="sub-desc">status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated</div></li>
\r
728 <td class="msource">DropTarget</td>
\r
730 <tr class="method-row alt expandable">
\r
731 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
733 <a id="Ext.dd.DropTarget-notifyOut"></a>
\r
734 <b>notifyOut</b>( <code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code> ) : void <div class="mdesc">
\r
735 <div class="short">The function a Ext.dd.DragSource calls once to notify this drop target that the source has been dragged
736 out of the ta...</div>
\r
738 The function a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> calls once to notify this drop target that the source has been dragged
739 out of the target without dropping. This default implementation simply removes the CSS class specified by
740 overClass (if any) from the drop element. <div class="mdetail-params">
\r
741 <strong>Parameters:</strong>
\r
742 <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
\r
743 <strong>Returns:</strong>
\r
745 <li><code>void</code></li>
\r
751 <td class="msource">DropTarget</td>
\r
753 <tr class="method-row expandable">
\r
754 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
756 <a id="Ext.dd.DropTarget-notifyOver"></a>
\r
757 <b>notifyOver</b>( <code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code> ) : String <div class="mdesc">
\r
758 <div class="short">The function a Ext.dd.DragSource calls continuously while it is being dragged over the target.
759 This method will be ca...</div>
\r
761 The function a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> calls continuously while it is being dragged over the target.
762 This method will be called on every mouse movement while the drag source is over the drop target.
763 This default implementation simply returns the dropAllowed config value. <div class="mdetail-params">
\r
764 <strong>Parameters:</strong>
\r
765 <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
\r
766 <strong>Returns:</strong>
\r
768 <li><code>String</code><div class="sub-desc">status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated</div></li>
\r
774 <td class="msource">DropTarget</td>
\r
776 <tr class="method-row inherited alt expandable">
\r
777 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
779 <a id="Ext.dd.DropTarget-onAvailable"></a>
\r
780 <b>onAvailable</b>() : void <div class="mdesc">
\r
781 <div class="short">Override the onAvailable method to do what is needed after the initial
782 position was determined.</div>
\r
784 Override the onAvailable method to do what is needed after the initial
785 position was determined. <div class="mdetail-params">
\r
786 <strong>Parameters:</strong>
\r
787 <ul><li>None.</li> </ul>
\r
788 <strong>Returns:</strong>
\r
790 <li><code>void</code></li>
\r
796 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onAvailable" href="output/Ext.dd.DragDrop.html#onAvailable">DragDrop</a></td>
\r
798 <tr class="method-row inherited expandable">
\r
799 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
801 <a id="Ext.dd.DropTarget-onDrag"></a>
\r
802 <b>onDrag</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
803 <div class="short">Abstract method called during the onMouseMove event while dragging an
806 Abstract method called during the onMouseMove event while dragging an
807 object. <div class="mdetail-params">
\r
808 <strong>Parameters:</strong>
\r
809 <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul>
\r
810 <strong>Returns:</strong>
\r
812 <li><code>void</code></li>
\r
818 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDrag" href="output/Ext.dd.DragDrop.html#onDrag">DragDrop</a></td>
\r
820 <tr class="method-row inherited alt expandable">
\r
821 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
823 <a id="Ext.dd.DropTarget-onDragDrop"></a>
\r
824 <b>onDragDrop</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
825 <div class="short">Abstract method called when this item is dropped on another DragDrop
828 Abstract method called when this item is dropped on another DragDrop
829 obj <div class="mdetail-params">
\r
830 <strong>Parameters:</strong>
\r
831 <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
832 id this was dropped on. In INTERSECT mode, an array of dd items this
833 was dropped on.</div></li> </ul>
\r
834 <strong>Returns:</strong>
\r
836 <li><code>void</code></li>
\r
842 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragDrop" href="output/Ext.dd.DragDrop.html#onDragDrop">DragDrop</a></td>
\r
844 <tr class="method-row inherited expandable">
\r
845 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
847 <a id="Ext.dd.DropTarget-onDragEnter"></a>
\r
848 <b>onDragEnter</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
849 <div class="short">Abstract method called when this element fist begins hovering over
850 another DragDrop obj</div>
\r
852 Abstract method called when this element fist begins hovering over
853 another DragDrop obj <div class="mdetail-params">
\r
854 <strong>Parameters:</strong>
\r
855 <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
856 id this is hovering over. In INTERSECT mode, an array of one or more
857 dragdrop items being hovered over.</div></li> </ul>
\r
858 <strong>Returns:</strong>
\r
860 <li><code>void</code></li>
\r
866 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragEnter" href="output/Ext.dd.DragDrop.html#onDragEnter">DragDrop</a></td>
\r
868 <tr class="method-row inherited alt expandable">
\r
869 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
871 <a id="Ext.dd.DropTarget-onDragOut"></a>
\r
872 <b>onDragOut</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
873 <div class="short">Abstract method called when we are no longer hovering over an element</div>
\r
875 Abstract method called when we are no longer hovering over an element <div class="mdetail-params">
\r
876 <strong>Parameters:</strong>
\r
877 <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
878 id this was hovering over. In INTERSECT mode, an array of dd items
879 that the mouse is no longer over.</div></li> </ul>
\r
880 <strong>Returns:</strong>
\r
882 <li><code>void</code></li>
\r
888 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOut" href="output/Ext.dd.DragDrop.html#onDragOut">DragDrop</a></td>
\r
890 <tr class="method-row inherited expandable">
\r
891 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
893 <a id="Ext.dd.DropTarget-onDragOver"></a>
\r
894 <b>onDragOver</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
\r
895 <div class="short">Abstract method called when this element is hovering over another
898 Abstract method called when this element is hovering over another
899 DragDrop obj <div class="mdetail-params">
\r
900 <strong>Parameters:</strong>
\r
901 <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
902 id this is hovering over. In INTERSECT mode, an array of dd items
903 being hovered over.</div></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="#onDragOver" href="output/Ext.dd.DragDrop.html#onDragOver">DragDrop</a></td>
\r
914 <tr class="method-row inherited alt expandable">
\r
915 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
917 <a id="Ext.dd.DropTarget-onInvalidDrop"></a>
\r
918 <b>onInvalidDrop</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
919 <div class="short">Abstract method called when this item is dropped on an area with no
922 Abstract method called when this item is dropped on an area with no
923 drop target <div class="mdetail-params">
\r
924 <strong>Parameters:</strong>
\r
925 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
926 <strong>Returns:</strong>
\r
928 <li><code>void</code></li>
\r
934 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onInvalidDrop" href="output/Ext.dd.DragDrop.html#onInvalidDrop">DragDrop</a></td>
\r
936 <tr class="method-row inherited expandable">
\r
937 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
939 <a id="Ext.dd.DropTarget-onMouseDown"></a>
\r
940 <b>onMouseDown</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
941 <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
\r
943 Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params">
\r
944 <strong>Parameters:</strong>
\r
945 <ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul>
\r
946 <strong>Returns:</strong>
\r
948 <li><code>void</code></li>
\r
954 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseDown" href="output/Ext.dd.DragDrop.html#onMouseDown">DragDrop</a></td>
\r
956 <tr class="method-row inherited alt expandable">
\r
957 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
959 <a id="Ext.dd.DropTarget-onMouseUp"></a>
\r
960 <b>onMouseUp</b>( <code>Event e</code> ) : void <div class="mdesc">
\r
961 <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
\r
963 Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params">
\r
964 <strong>Parameters:</strong>
\r
965 <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
\r
966 <strong>Returns:</strong>
\r
968 <li><code>void</code></li>
\r
974 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseUp" href="output/Ext.dd.DragDrop.html#onMouseUp">DragDrop</a></td>
\r
976 <tr class="method-row inherited expandable">
\r
977 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
979 <a id="Ext.dd.DropTarget-removeFromGroup"></a>
\r
980 <b>removeFromGroup</b>( <code>string sGroup</code> ) : void <div class="mdesc">
\r
981 <div class="short">Remove's this instance from the supplied interaction group</div>
\r
983 Remove's this instance from the supplied interaction group <div class="mdetail-params">
\r
984 <strong>Parameters:</strong>
\r
985 <ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul>
\r
986 <strong>Returns:</strong>
\r
988 <li><code>void</code></li>
\r
994 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeFromGroup" href="output/Ext.dd.DragDrop.html#removeFromGroup">DragDrop</a></td>
\r
996 <tr class="method-row inherited alt expandable">
\r
997 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
999 <a id="Ext.dd.DropTarget-removeInvalidHandleClass"></a>
\r
1000 <b>removeInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">
\r
1001 <div class="short">Unsets an invalid css class</div>
\r
1002 <div class="long">
\r
1003 Unsets an invalid css class <div class="mdetail-params">
\r
1004 <strong>Parameters:</strong>
\r
1005 <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to
1006 re-enable</div></li> </ul>
\r
1007 <strong>Returns:</strong>
\r
1009 <li><code>void</code></li>
\r
1015 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleClass" href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass">DragDrop</a></td>
\r
1017 <tr class="method-row inherited expandable">
\r
1018 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1020 <a id="Ext.dd.DropTarget-removeInvalidHandleId"></a>
\r
1021 <b>removeInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">
\r
1022 <div class="short">Unsets an invalid handle id</div>
\r
1023 <div class="long">
\r
1024 Unsets an invalid handle id <div class="mdetail-params">
\r
1025 <strong>Parameters:</strong>
\r
1026 <ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul>
\r
1027 <strong>Returns:</strong>
\r
1029 <li><code>void</code></li>
\r
1035 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleId" href="output/Ext.dd.DragDrop.html#removeInvalidHandleId">DragDrop</a></td>
\r
1037 <tr class="method-row inherited alt expandable">
\r
1038 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1040 <a id="Ext.dd.DropTarget-removeInvalidHandleType"></a>
\r
1041 <b>removeInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">
\r
1042 <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
\r
1043 <div class="long">
\r
1044 Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params">
\r
1045 <strong>Parameters:</strong>
\r
1046 <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li> </ul>
\r
1047 <strong>Returns:</strong>
\r
1049 <li><code>void</code></li>
\r
1055 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleType" href="output/Ext.dd.DragDrop.html#removeInvalidHandleType">DragDrop</a></td>
\r
1057 <tr class="method-row inherited expandable">
\r
1058 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1060 <a id="Ext.dd.DropTarget-resetConstraints"></a>
\r
1061 <b>resetConstraints</b>( <code>boolean maintainOffset</code> ) : void <div class="mdesc">
\r
1062 <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
\r
1063 <div class="long">
\r
1064 resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params">
\r
1065 <strong>Parameters:</strong>
\r
1066 <ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul>
\r
1067 <strong>Returns:</strong>
\r
1069 <li><code>void</code></li>
\r
1075 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#resetConstraints" href="output/Ext.dd.DragDrop.html#resetConstraints">DragDrop</a></td>
\r
1077 <tr class="method-row inherited alt expandable">
\r
1078 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1080 <a id="Ext.dd.DropTarget-setDragElId"></a>
\r
1081 <b>setDragElId</b>( <code>id {string}</code> ) : void <div class="mdesc">
\r
1082 <div class="short">Allows you to specify that an element other than the linked element
1083 will be moved with the cursor during a drag</div>
\r
1084 <div class="long">
\r
1085 Allows you to specify that an element other than the linked element
1086 will be moved with the cursor during a drag <div class="mdetail-params">
\r
1087 <strong>Parameters:</strong>
\r
1088 <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
1089 <strong>Returns:</strong>
\r
1091 <li><code>void</code></li>
\r
1097 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setDragElId" href="output/Ext.dd.DragDrop.html#setDragElId">DragDrop</a></td>
\r
1099 <tr class="method-row inherited expandable">
\r
1100 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1102 <a id="Ext.dd.DropTarget-setHandleElId"></a>
\r
1103 <b>setHandleElId</b>( <code>id {string}</code> ) : void <div class="mdesc">
\r
1104 <div class="short">Allows you to specify a child of the linked element that should be
1105 used to initiate the drag operation. An example o...</div>
\r
1106 <div class="long">
\r
1107 Allows you to specify a child of the linked element that should be
1108 used to initiate the drag operation. An example of this would be if
1109 you have a content div with text and links. Clicking anywhere in the
1110 content area would normally start the drag operation. Use this method
1111 to specify that an element inside of the content div is the element
1112 that starts the drag operation. <div class="mdetail-params">
\r
1113 <strong>Parameters:</strong>
\r
1114 <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to
1115 initiate the drag.</div></li> </ul>
\r
1116 <strong>Returns:</strong>
\r
1118 <li><code>void</code></li>
\r
1124 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setHandleElId" href="output/Ext.dd.DragDrop.html#setHandleElId">DragDrop</a></td>
\r
1126 <tr class="method-row inherited alt expandable">
\r
1127 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1129 <a id="Ext.dd.DropTarget-setInitialPosition"></a>
\r
1130 <b>setInitialPosition</b>( <code>int diffX</code>, <code>int diffY</code> ) : void <div class="mdesc">
\r
1131 <div class="short">Stores the initial placement of the linked element.</div>
\r
1132 <div class="long">
\r
1133 Stores the initial placement of the linked element. <div class="mdetail-params">
\r
1134 <strong>Parameters:</strong>
\r
1135 <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
1136 <strong>Returns:</strong>
\r
1138 <li><code>void</code></li>
\r
1144 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setInitialPosition" href="output/Ext.dd.DragDrop.html#setInitialPosition">DragDrop</a></td>
\r
1146 <tr class="method-row inherited expandable">
\r
1147 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1149 <a id="Ext.dd.DropTarget-setOuterHandleElId"></a>
\r
1150 <b>setOuterHandleElId</b>( <code>id the</code> ) : void <div class="mdesc">
\r
1151 <div class="short">Allows you to set an element outside of the linked element as a drag
1153 <div class="long">
\r
1154 Allows you to set an element outside of the linked element as a drag
1155 handle <div class="mdetail-params">
\r
1156 <strong>Parameters:</strong>
\r
1157 <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
1158 <strong>Returns:</strong>
\r
1160 <li><code>void</code></li>
\r
1166 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setOuterHandleElId" href="output/Ext.dd.DragDrop.html#setOuterHandleElId">DragDrop</a></td>
\r
1168 <tr class="method-row inherited alt expandable">
\r
1169 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1171 <a id="Ext.dd.DropTarget-setPadding"></a>
\r
1172 <b>setPadding</b>( <code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code> ) : void <div class="mdesc">
\r
1173 <div class="short">Configures the padding for the target zone in px. Effectively expands
1174 (or reduces) the virtual object size for targe...</div>
\r
1175 <div class="long">
\r
1176 Configures the padding for the target zone in px. Effectively expands
1177 (or reduces) the virtual object size for targeting calculations.
1178 Supports css-style shorthand; if only one parameter is passed, all sides
1179 will have that padding, and if only two are passed, the top and bottom
1180 will have the first param, the left and right the second. <div class="mdetail-params">
\r
1181 <strong>Parameters:</strong>
\r
1182 <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
1183 <strong>Returns:</strong>
\r
1185 <li><code>void</code></li>
\r
1191 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setPadding" href="output/Ext.dd.DragDrop.html#setPadding">DragDrop</a></td>
\r
1193 <tr class="method-row inherited expandable">
\r
1194 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1196 <a id="Ext.dd.DropTarget-setXConstraint"></a>
\r
1197 <b>setXConstraint</b>( <code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code> ) : void <div class="mdesc">
\r
1198 <div class="short">By default, the element can be dragged any place on the screen. Use
1199 this method to limit the horizontal travel of th...</div>
\r
1200 <div class="long">
\r
1201 By default, the element can be dragged any place on the screen. Use
1202 this method to limit the horizontal travel of the element. Pass in
1203 0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params">
\r
1204 <strong>Parameters:</strong>
\r
1205 <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
1206 right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
1208 should move iTickSize pixels at a time.</div></li> </ul>
\r
1209 <strong>Returns:</strong>
\r
1211 <li><code>void</code></li>
\r
1217 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setXConstraint" href="output/Ext.dd.DragDrop.html#setXConstraint">DragDrop</a></td>
\r
1219 <tr class="method-row inherited alt expandable">
\r
1220 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1222 <a id="Ext.dd.DropTarget-setYConstraint"></a>
\r
1223 <b>setYConstraint</b>( <code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code> ) : void <div class="mdesc">
\r
1224 <div class="short">By default, the element can be dragged any place on the screen. Set
1225 this to limit the vertical travel of the element...</div>
\r
1226 <div class="long">
\r
1227 By default, the element can be dragged any place on the screen. Set
1228 this to limit the vertical travel of the element. Pass in 0,0 for the
1229 parameters if you want to lock the drag to the x axis. <div class="mdetail-params">
\r
1230 <strong>Parameters:</strong>
\r
1231 <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
1232 element should move iTickSize pixels at a time.</div></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="#setYConstraint" href="output/Ext.dd.DragDrop.html#setYConstraint">DragDrop</a></td>
\r
1243 <tr class="method-row inherited expandable">
\r
1244 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1246 <a id="Ext.dd.DropTarget-startDrag"></a>
\r
1247 <b>startDrag</b>( <code>int X</code>, <code>int Y</code> ) : void <div class="mdesc">
\r
1248 <div class="short">Abstract method called after a drag/drop object is clicked
1249 and the drag or mousedown time thresholds have beeen met.</div>
\r
1250 <div class="long">
\r
1251 Abstract method called after a drag/drop object is clicked
1252 and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params">
\r
1253 <strong>Parameters:</strong>
\r
1254 <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
1255 <strong>Returns:</strong>
\r
1257 <li><code>void</code></li>
\r
1263 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#startDrag" href="output/Ext.dd.DragDrop.html#startDrag">DragDrop</a></td>
\r
1265 <tr class="method-row inherited alt expandable">
\r
1266 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1268 <a id="Ext.dd.DropTarget-toString"></a>
\r
1269 <b>toString</b>() : string <div class="mdesc">
\r
1270 <div class="short">toString method</div>
\r
1271 <div class="long">
\r
1272 toString method <div class="mdetail-params">
\r
1273 <strong>Parameters:</strong>
\r
1274 <ul><li>None.</li> </ul>
\r
1275 <strong>Returns:</strong>
\r
1277 <li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li>
\r
1283 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#toString" href="output/Ext.dd.DragDrop.html#toString">DragDrop</a></td>
\r
1285 <tr class="method-row inherited expandable">
\r
1286 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1288 <a id="Ext.dd.DropTarget-unlock"></a>
\r
1289 <b>unlock</b>() : void <div class="mdesc">
\r
1290 <div class="short">Unlock this instace</div>
\r
1291 <div class="long">
\r
1292 Unlock this instace <div class="mdetail-params">
\r
1293 <strong>Parameters:</strong>
\r
1294 <ul><li>None.</li> </ul>
\r
1295 <strong>Returns:</strong>
\r
1297 <li><code>void</code></li>
\r
1303 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unlock" href="output/Ext.dd.DragDrop.html#unlock">DragDrop</a></td>
\r
1305 <tr class="method-row inherited alt expandable">
\r
1306 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1308 <a id="Ext.dd.DropTarget-unreg"></a>
\r
1309 <b>unreg</b>() : void <div class="mdesc">
\r
1310 <div class="short">Remove all drag and drop hooks for this element</div>
\r
1311 <div class="long">
\r
1312 Remove all drag and drop hooks for this element <div class="mdetail-params">
\r
1313 <strong>Parameters:</strong>
\r
1314 <ul><li>None.</li> </ul>
\r
1315 <strong>Returns:</strong>
\r
1317 <li><code>void</code></li>
\r
1323 <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unreg" href="output/Ext.dd.DragDrop.html#unreg">DragDrop</a></td>
\r
1326 <a id="Ext.dd.DropTarget-events"></a>
1327 <h2>Public Events</h2>
1328 <div class="no-members">This class has no public events.</div>