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