1 | <div class="body-wrap"> |
---|
2 | <div class="top-tools"> |
---|
3 | <a class="inner-link" href="#Ext.dd.DragSource-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
4 | <a class="inner-link" href="#Ext.dd.DragSource-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
5 | <a class="inner-link" href="#Ext.dd.DragSource-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
6 | <a class="inner-link" href="#Ext.dd.DragSource-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.DragSource"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
8 | </div> |
---|
9 | <div class="inheritance res-block"> |
---|
10 | <pre class="res-block-inner"><a ext:cls="Ext.dd.DragDrop" ext:member="" href="output/Ext.dd.DragDrop.html">DragDrop</a> |
---|
11 | <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DD" ext:member="" href="output/Ext.dd.DD.html">DD</a> |
---|
12 | <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DDProxy" ext:member="" href="output/Ext.dd.DDProxy.html">DDProxy</a> |
---|
13 | <img src="resources/elbow-end.gif"/>DragSource</pre></div> |
---|
14 | <h1>Class Ext.dd.DragSource</h1> |
---|
15 | <table cellspacing="0"> |
---|
16 | <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr> |
---|
17 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DragSource.js" target="_blank">DragSource.js</a></td></tr> |
---|
18 | <tr><td class="label">Class:</td><td class="hd-info">DragSource</td></tr> |
---|
19 | <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.dd.DragZone" href="output/Ext.dd.DragZone.html">DragZone</a></td></tr> |
---|
20 | <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.dd.DDProxy" ext:member="" href="output/Ext.dd.DDProxy.html">DDProxy</a></td></tr> |
---|
21 | </table> |
---|
22 | <div class="description"> |
---|
23 | * |
---|
24 | A simple class that provides the basic implementation needed to make any element draggable. </div> |
---|
25 | |
---|
26 | <div class="hr"></div> |
---|
27 | <a id="Ext.dd.DragSource-configs"></a> |
---|
28 | <h2>Config Options</h2> |
---|
29 | <table cellspacing="0" class="member-table"> |
---|
30 | <tr> |
---|
31 | <th class="sig-header" colspan="2">Config Options</th> |
---|
32 | <th class="msource-header">Defined By</th> |
---|
33 | </tr> |
---|
34 | <tr class="config-row expandable"> |
---|
35 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
36 | <td class="sig"> |
---|
37 | <a id="Ext.dd.DragSource-ddGroup"></a> |
---|
38 | <b>ddGroup</b> : String <div class="mdesc"> |
---|
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> |
---|
40 | <div class="long"> |
---|
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> |
---|
42 | </div> |
---|
43 | </td> |
---|
44 | <td class="msource">DragSource</td> |
---|
45 | </tr> |
---|
46 | <tr class="config-row alt"> |
---|
47 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
48 | <td class="sig"> |
---|
49 | <a id="Ext.dd.DragSource-dropAllowed"></a> |
---|
50 | <b>dropAllowed</b> : String <div class="mdesc"> |
---|
51 | The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). </div> |
---|
52 | </td> |
---|
53 | <td class="msource">DragSource</td> |
---|
54 | </tr> |
---|
55 | <tr class="config-row"> |
---|
56 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
57 | <td class="sig"> |
---|
58 | <a id="Ext.dd.DragSource-dropNotAllowed"></a> |
---|
59 | <b>dropNotAllowed</b> : String <div class="mdesc"> |
---|
60 | The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div> |
---|
61 | </td> |
---|
62 | <td class="msource">DragSource</td> |
---|
63 | </tr> |
---|
64 | </table> |
---|
65 | <a id="Ext.dd.DragSource-props"></a> |
---|
66 | <h2>Public Properties</h2> |
---|
67 | <table cellspacing="0" class="member-table"> |
---|
68 | <tr> |
---|
69 | <th class="sig-header" colspan="2">Property</th> |
---|
70 | <th class="msource-header">Defined By</th> |
---|
71 | </tr> |
---|
72 | <tr class="property-row inherited"> |
---|
73 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
74 | <td class="sig"> |
---|
75 | <a id="Ext.dd.DragSource-available"></a> |
---|
76 | <b>available</b> : boolean <div class="mdesc"> |
---|
77 | The availabe property is false until the linked dom element is accessible. </div> |
---|
78 | </td> |
---|
79 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#available" href="output/Ext.dd.DragDrop.html#available">DragDrop</a></td> |
---|
80 | </tr> |
---|
81 | <tr class="property-row inherited alt expandable"> |
---|
82 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
83 | <td class="sig"> |
---|
84 | <a id="Ext.dd.DragSource-centerFrame"></a> |
---|
85 | <b>centerFrame</b> : boolean <div class="mdesc"> |
---|
86 | <div class="short">By default the frame is positioned exactly where the drag element is, so |
---|
87 | we use the cursor offset provided by Ext.dd....</div> |
---|
88 | <div class="long"> |
---|
89 | By default the frame is positioned exactly where the drag element is, so |
---|
90 | we use the cursor offset provided by Ext.dd.DD. Another option that works only if |
---|
91 | you do not have constraints on the obj is to have the drag frame centered |
---|
92 | around the cursor. Set centerFrame to true for this effect. </div> |
---|
93 | </div> |
---|
94 | </td> |
---|
95 | <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#centerFrame" href="output/Ext.dd.DDProxy.html#centerFrame">DDProxy</a></td> |
---|
96 | </tr> |
---|
97 | <tr class="property-row inherited"> |
---|
98 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
99 | <td class="sig"> |
---|
100 | <a id="Ext.dd.DragSource-config"></a> |
---|
101 | <b>config</b> : object <div class="mdesc"> |
---|
102 | Configuration attributes passed into the constructor </div> |
---|
103 | </td> |
---|
104 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#config" href="output/Ext.dd.DragDrop.html#config">DragDrop</a></td> |
---|
105 | </tr> |
---|
106 | <tr class="property-row inherited alt"> |
---|
107 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
108 | <td class="sig"> |
---|
109 | <a id="Ext.dd.DragSource-defaultPadding"></a> |
---|
110 | <b>defaultPadding</b> : Object <div class="mdesc"> |
---|
111 | Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). </div> |
---|
112 | </td> |
---|
113 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#defaultPadding" href="output/Ext.dd.DragDrop.html#defaultPadding">DragDrop</a></td> |
---|
114 | </tr> |
---|
115 | <tr class="property-row inherited expandable"> |
---|
116 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
117 | <td class="sig"> |
---|
118 | <a id="Ext.dd.DragSource-groups"></a> |
---|
119 | <b>groups</b> : object <div class="mdesc"> |
---|
120 | <div class="short">The group defines a logical collection of DragDrop objects that are |
---|
121 | related. Instances only get events when interact...</div> |
---|
122 | <div class="long"> |
---|
123 | The group defines a logical collection of DragDrop objects that are |
---|
124 | related. Instances only get events when interacting with other |
---|
125 | DragDrop object in the same group. This lets us define multiple |
---|
126 | groups using a single DragDrop subclass if we want. </div> |
---|
127 | </div> |
---|
128 | </td> |
---|
129 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#groups" href="output/Ext.dd.DragDrop.html#groups">DragDrop</a></td> |
---|
130 | </tr> |
---|
131 | <tr class="property-row inherited alt expandable"> |
---|
132 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
133 | <td class="sig"> |
---|
134 | <a id="Ext.dd.DragSource-hasOuterHandles"></a> |
---|
135 | <b>hasOuterHandles</b> : boolean <div class="mdesc"> |
---|
136 | <div class="short">By default, drags can only be initiated if the mousedown occurs in the |
---|
137 | region the linked element is. This is done in...</div> |
---|
138 | <div class="long"> |
---|
139 | By default, drags can only be initiated if the mousedown occurs in the |
---|
140 | region the linked element is. This is done in part to work around a |
---|
141 | bug in some browsers that mis-report the mousedown if the previous |
---|
142 | mouseup happened outside of the window. This property is set to true |
---|
143 | if outer handles are defined. </div> |
---|
144 | </div> |
---|
145 | </td> |
---|
146 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#hasOuterHandles" href="output/Ext.dd.DragDrop.html#hasOuterHandles">DragDrop</a></td> |
---|
147 | </tr> |
---|
148 | <tr class="property-row inherited expandable"> |
---|
149 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
150 | <td class="sig"> |
---|
151 | <a id="Ext.dd.DragSource-id"></a> |
---|
152 | <b>id</b> : String <div class="mdesc"> |
---|
153 | <div class="short">The id of the element associated with this object. This is what we |
---|
154 | refer to as the "linked element" because the size...</div> |
---|
155 | <div class="long"> |
---|
156 | The id of the element associated with this object. This is what we |
---|
157 | refer to as the "linked element" because the size and position of |
---|
158 | this element is used to determine when the drag and drop objects have |
---|
159 | interacted. </div> |
---|
160 | </div> |
---|
161 | </td> |
---|
162 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#id" href="output/Ext.dd.DragDrop.html#id">DragDrop</a></td> |
---|
163 | </tr> |
---|
164 | <tr class="property-row inherited alt"> |
---|
165 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
166 | <td class="sig"> |
---|
167 | <a id="Ext.dd.DragSource-invalidHandleClasses"></a> |
---|
168 | <b>invalidHandleClasses</b> : Array <div class="mdesc"> |
---|
169 | An Array of CSS class names for elements to be considered in valid as drag handles. </div> |
---|
170 | </td> |
---|
171 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleClasses" href="output/Ext.dd.DragDrop.html#invalidHandleClasses">DragDrop</a></td> |
---|
172 | </tr> |
---|
173 | <tr class="property-row inherited expandable"> |
---|
174 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
175 | <td class="sig"> |
---|
176 | <a id="Ext.dd.DragSource-invalidHandleIds"></a> |
---|
177 | <b>invalidHandleIds</b> : Object <div class="mdesc"> |
---|
178 | <div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles. |
---|
179 | A non-null prop...</div> |
---|
180 | <div class="long"> |
---|
181 | An object who's property names identify the IDs of elements to be considered invalid as drag handles. |
---|
182 | A non-null property value identifies the ID as invalid. For example, to prevent |
---|
183 | dragging from being initiated on element ID "foo", use:<pre><code>{ |
---|
184 | foo: true |
---|
185 | }</code></pre> </div> |
---|
186 | </div> |
---|
187 | </td> |
---|
188 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleIds" href="output/Ext.dd.DragDrop.html#invalidHandleIds">DragDrop</a></td> |
---|
189 | </tr> |
---|
190 | <tr class="property-row inherited alt expandable"> |
---|
191 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
192 | <td class="sig"> |
---|
193 | <a id="Ext.dd.DragSource-invalidHandleTypes"></a> |
---|
194 | <b>invalidHandleTypes</b> : Object <div class="mdesc"> |
---|
195 | <div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles. |
---|
196 | A non-null property value...</div> |
---|
197 | <div class="long"> |
---|
198 | An object who's property names identify HTML tags to be considered invalid as drag handles. |
---|
199 | A non-null property value identifies the tag as invalid. Defaults to the |
---|
200 | following value which prevents drag operations from being initiated by <a> elements:<pre><code>{ |
---|
201 | A: <em>"A"</em> |
---|
202 | }</code></pre> </div> |
---|
203 | </div> |
---|
204 | </td> |
---|
205 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleTypes" href="output/Ext.dd.DragDrop.html#invalidHandleTypes">DragDrop</a></td> |
---|
206 | </tr> |
---|
207 | <tr class="property-row inherited"> |
---|
208 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
209 | <td class="sig"> |
---|
210 | <a id="Ext.dd.DragSource-isTarget"></a> |
---|
211 | <b>isTarget</b> : boolean <div class="mdesc"> |
---|
212 | By default, all instances can be a drop target. This can be disabled by |
---|
213 | setting isTarget to false. </div> |
---|
214 | </td> |
---|
215 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isTarget" href="output/Ext.dd.DragDrop.html#isTarget">DragDrop</a></td> |
---|
216 | </tr> |
---|
217 | <tr class="property-row inherited alt expandable"> |
---|
218 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
219 | <td class="sig"> |
---|
220 | <a id="Ext.dd.DragSource-maintainOffset"></a> |
---|
221 | <b>maintainOffset</b> : boolean <div class="mdesc"> |
---|
222 | <div class="short">Maintain offsets when we resetconstraints. Set to true when you want |
---|
223 | the position of the element relative to its par...</div> |
---|
224 | <div class="long"> |
---|
225 | Maintain offsets when we resetconstraints. Set to true when you want |
---|
226 | the position of the element relative to its parent to stay the same |
---|
227 | when the page changes </div> |
---|
228 | </div> |
---|
229 | </td> |
---|
230 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#maintainOffset" href="output/Ext.dd.DragDrop.html#maintainOffset">DragDrop</a></td> |
---|
231 | </tr> |
---|
232 | <tr class="property-row inherited expandable"> |
---|
233 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
234 | <td class="sig"> |
---|
235 | <a id="Ext.dd.DragSource-moveOnly"></a> |
---|
236 | <b>moveOnly</b> : boolean <div class="mdesc"> |
---|
237 | <div class="short">When set to true, other DD objects in cooperating DDGroups do not receive |
---|
238 | notification events when this DD object is ...</div> |
---|
239 | <div class="long"> |
---|
240 | When set to true, other DD objects in cooperating DDGroups do not receive |
---|
241 | notification events when this DD object is dragged over them. Defaults to false. </div> |
---|
242 | </div> |
---|
243 | </td> |
---|
244 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#moveOnly" href="output/Ext.dd.DragDrop.html#moveOnly">DragDrop</a></td> |
---|
245 | </tr> |
---|
246 | <tr class="property-row alt expandable"> |
---|
247 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
248 | <td class="sig"> |
---|
249 | <a id="Ext.dd.DragSource-onStartDrag"></a> |
---|
250 | <b>onStartDrag</b> : Object <div class="mdesc"> |
---|
251 | <div class="short">An empty function by default, but provided so that you can perform a custom action once the initial |
---|
252 | drag event has be...</div> |
---|
253 | <div class="long"> |
---|
254 | An empty function by default, but provided so that you can perform a custom action once the initial |
---|
255 | drag event has begun. The drag cannot be canceled from this function. </div> |
---|
256 | </div> |
---|
257 | </td> |
---|
258 | <td class="msource">DragSource</td> |
---|
259 | </tr> |
---|
260 | <tr class="property-row inherited"> |
---|
261 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
262 | <td class="sig"> |
---|
263 | <a id="Ext.dd.DragSource-padding"></a> |
---|
264 | <b>padding</b> : int[] <div class="mdesc"> |
---|
265 | The padding configured for this drag and drop object for calculating |
---|
266 | the drop zone intersection with this object. </div> |
---|
267 | </td> |
---|
268 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#padding" href="output/Ext.dd.DragDrop.html#padding">DragDrop</a></td> |
---|
269 | </tr> |
---|
270 | <tr class="property-row inherited alt expandable"> |
---|
271 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
272 | <td class="sig"> |
---|
273 | <a id="Ext.dd.DragSource-primaryButtonOnly"></a> |
---|
274 | <b>primaryButtonOnly</b> : boolean <div class="mdesc"> |
---|
275 | <div class="short">By default the drag and drop instance will only respond to the primary |
---|
276 | button click (left button for a right-handed m...</div> |
---|
277 | <div class="long"> |
---|
278 | By default the drag and drop instance will only respond to the primary |
---|
279 | button click (left button for a right-handed mouse). Set to true to |
---|
280 | allow drag and drop to start with any mouse click that is propogated |
---|
281 | by the browser </div> |
---|
282 | </div> |
---|
283 | </td> |
---|
284 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#primaryButtonOnly" href="output/Ext.dd.DragDrop.html#primaryButtonOnly">DragDrop</a></td> |
---|
285 | </tr> |
---|
286 | <tr class="property-row inherited expandable"> |
---|
287 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
288 | <td class="sig"> |
---|
289 | <a id="Ext.dd.DragSource-resizeFrame"></a> |
---|
290 | <b>resizeFrame</b> : boolean <div class="mdesc"> |
---|
291 | <div class="short">By default we resize the drag frame to be the same size as the element |
---|
292 | we want to drag (this is to get the frame effe...</div> |
---|
293 | <div class="long"> |
---|
294 | By default we resize the drag frame to be the same size as the element |
---|
295 | we want to drag (this is to get the frame effect). We can turn it off |
---|
296 | if we want a different behavior. </div> |
---|
297 | </div> |
---|
298 | </td> |
---|
299 | <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#resizeFrame" href="output/Ext.dd.DDProxy.html#resizeFrame">DDProxy</a></td> |
---|
300 | </tr> |
---|
301 | <tr class="property-row inherited alt expandable"> |
---|
302 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
303 | <td class="sig"> |
---|
304 | <a id="Ext.dd.DragSource-scroll"></a> |
---|
305 | <b>scroll</b> : boolean <div class="mdesc"> |
---|
306 | <div class="short">When set to true, the utility automatically tries to scroll the browser |
---|
307 | window when a drag and drop element is dragge...</div> |
---|
308 | <div class="long"> |
---|
309 | When set to true, the utility automatically tries to scroll the browser |
---|
310 | window when a drag and drop element is dragged near the viewport boundary. |
---|
311 | Defaults to true. </div> |
---|
312 | </div> |
---|
313 | </td> |
---|
314 | <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#scroll" href="output/Ext.dd.DD.html#scroll">DD</a></td> |
---|
315 | </tr> |
---|
316 | <tr class="property-row inherited expandable"> |
---|
317 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
318 | <td class="sig"> |
---|
319 | <a id="Ext.dd.DragSource-xTicks"></a> |
---|
320 | <b>xTicks</b> : int[] <div class="mdesc"> |
---|
321 | <div class="short">Array of pixel locations the element will snap to if we specified a |
---|
322 | horizontal graduation/interval. This array is ge...</div> |
---|
323 | <div class="long"> |
---|
324 | Array of pixel locations the element will snap to if we specified a |
---|
325 | horizontal graduation/interval. This array is generated automatically |
---|
326 | when you define a tick interval. </div> |
---|
327 | </div> |
---|
328 | </td> |
---|
329 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#xTicks" href="output/Ext.dd.DragDrop.html#xTicks">DragDrop</a></td> |
---|
330 | </tr> |
---|
331 | <tr class="property-row inherited alt expandable"> |
---|
332 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
333 | <td class="sig"> |
---|
334 | <a id="Ext.dd.DragSource-yTicks"></a> |
---|
335 | <b>yTicks</b> : int[] <div class="mdesc"> |
---|
336 | <div class="short">Array of pixel locations the element will snap to if we specified a |
---|
337 | vertical graduation/interval. This array is gene...</div> |
---|
338 | <div class="long"> |
---|
339 | Array of pixel locations the element will snap to if we specified a |
---|
340 | vertical graduation/interval. This array is generated automatically |
---|
341 | when you define a tick interval. </div> |
---|
342 | </div> |
---|
343 | </td> |
---|
344 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#yTicks" href="output/Ext.dd.DragDrop.html#yTicks">DragDrop</a></td> |
---|
345 | </tr> |
---|
346 | </table> |
---|
347 | <a id="Ext.dd.DragSource-methods"></a> |
---|
348 | <h2>Public Methods</h2> |
---|
349 | <table cellspacing="0" class="member-table"> |
---|
350 | <tr> |
---|
351 | <th class="sig-header" colspan="2">Method</th> |
---|
352 | <th class="msource-header">Defined By</th> |
---|
353 | </tr> |
---|
354 | <tr class="method-row expandable"> |
---|
355 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
356 | <td class="sig"> |
---|
357 | <a id="Ext.dd.DragSource-DragSource"></a> |
---|
358 | <b>DragSource</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc"> |
---|
359 | <div class="short"></div> |
---|
360 | <div class="long"> |
---|
361 | <div class="mdetail-params"> |
---|
362 | <strong>Parameters:</strong> |
---|
363 | <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> |
---|
364 | <strong>Returns:</strong> |
---|
365 | <ul> |
---|
366 | <li><code></code></li> |
---|
367 | </ul> |
---|
368 | </div> |
---|
369 | </div> |
---|
370 | </div> |
---|
371 | </td> |
---|
372 | <td class="msource">DragSource</td> |
---|
373 | </tr> |
---|
374 | <tr class="method-row inherited alt expandable"> |
---|
375 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
376 | <td class="sig"> |
---|
377 | <a id="Ext.dd.DragSource-addInvalidHandleClass"></a> |
---|
378 | <b>addInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc"> |
---|
379 | <div class="short">Lets you specify a css class of elements that will not initiate a drag</div> |
---|
380 | <div class="long"> |
---|
381 | Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params"> |
---|
382 | <strong>Parameters:</strong> |
---|
383 | <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul> |
---|
384 | <strong>Returns:</strong> |
---|
385 | <ul> |
---|
386 | <li><code>void</code></li> |
---|
387 | </ul> |
---|
388 | </div> |
---|
389 | </div> |
---|
390 | </div> |
---|
391 | </td> |
---|
392 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleClass" href="output/Ext.dd.DragDrop.html#addInvalidHandleClass">DragDrop</a></td> |
---|
393 | </tr> |
---|
394 | <tr class="method-row inherited expandable"> |
---|
395 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
396 | <td class="sig"> |
---|
397 | <a id="Ext.dd.DragSource-addInvalidHandleId"></a> |
---|
398 | <b>addInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc"> |
---|
399 | <div class="short">Lets you to specify an element id for a child of a drag handle |
---|
400 | that should not initiate a drag</div> |
---|
401 | <div class="long"> |
---|
402 | Lets you to specify an element id for a child of a drag handle |
---|
403 | that should not initiate a drag <div class="mdetail-params"> |
---|
404 | <strong>Parameters:</strong> |
---|
405 | <ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li> </ul> |
---|
406 | <strong>Returns:</strong> |
---|
407 | <ul> |
---|
408 | <li><code>void</code></li> |
---|
409 | </ul> |
---|
410 | </div> |
---|
411 | </div> |
---|
412 | </div> |
---|
413 | </td> |
---|
414 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleId" href="output/Ext.dd.DragDrop.html#addInvalidHandleId">DragDrop</a></td> |
---|
415 | </tr> |
---|
416 | <tr class="method-row inherited alt expandable"> |
---|
417 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
418 | <td class="sig"> |
---|
419 | <a id="Ext.dd.DragSource-addInvalidHandleType"></a> |
---|
420 | <b>addInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc"> |
---|
421 | <div class="short">Allows you to specify a tag name that should not start a drag operation |
---|
422 | when clicked. This is designed to facilitate...</div> |
---|
423 | <div class="long"> |
---|
424 | Allows you to specify a tag name that should not start a drag operation |
---|
425 | when clicked. This is designed to facilitate embedding links within a |
---|
426 | drag handle that do something other than start the drag. <div class="mdetail-params"> |
---|
427 | <strong>Parameters:</strong> |
---|
428 | <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul> |
---|
429 | <strong>Returns:</strong> |
---|
430 | <ul> |
---|
431 | <li><code>void</code></li> |
---|
432 | </ul> |
---|
433 | </div> |
---|
434 | </div> |
---|
435 | </div> |
---|
436 | </td> |
---|
437 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleType" href="output/Ext.dd.DragDrop.html#addInvalidHandleType">DragDrop</a></td> |
---|
438 | </tr> |
---|
439 | <tr class="method-row inherited expandable"> |
---|
440 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
441 | <td class="sig"> |
---|
442 | <a id="Ext.dd.DragSource-addToGroup"></a> |
---|
443 | <b>addToGroup</b>( <code>sGroup {string}</code> ) : void <div class="mdesc"> |
---|
444 | <div class="short">Add this instance to a group of related drag/drop objects. All |
---|
445 | instances belong to at least one group, and can belon...</div> |
---|
446 | <div class="long"> |
---|
447 | Add this instance to a group of related drag/drop objects. All |
---|
448 | instances belong to at least one group, and can belong to as many |
---|
449 | groups as needed. <div class="mdetail-params"> |
---|
450 | <strong>Parameters:</strong> |
---|
451 | <ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul> |
---|
452 | <strong>Returns:</strong> |
---|
453 | <ul> |
---|
454 | <li><code>void</code></li> |
---|
455 | </ul> |
---|
456 | </div> |
---|
457 | </div> |
---|
458 | </div> |
---|
459 | </td> |
---|
460 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addToGroup" href="output/Ext.dd.DragDrop.html#addToGroup">DragDrop</a></td> |
---|
461 | </tr> |
---|
462 | <tr class="method-row alt expandable"> |
---|
463 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
464 | <td class="sig"> |
---|
465 | <a id="Ext.dd.DragSource-afterDragDrop"></a> |
---|
466 | <b>afterDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
---|
467 | <div class="short">An empty function by default, but provided so that you can perform a custom action |
---|
468 | after a valid drag drop has occurr...</div> |
---|
469 | <div class="long"> |
---|
470 | An empty function by default, but provided so that you can perform a custom action |
---|
471 | after a valid drag drop has occurred by providing an implementation. <div class="mdetail-params"> |
---|
472 | <strong>Parameters:</strong> |
---|
473 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dropped element</div></li> </ul> |
---|
474 | <strong>Returns:</strong> |
---|
475 | <ul> |
---|
476 | <li><code>void</code></li> |
---|
477 | </ul> |
---|
478 | </div> |
---|
479 | </div> |
---|
480 | </div> |
---|
481 | </td> |
---|
482 | <td class="msource">DragSource</td> |
---|
483 | </tr> |
---|
484 | <tr class="method-row expandable"> |
---|
485 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
486 | <td class="sig"> |
---|
487 | <a id="Ext.dd.DragSource-afterDragEnter"></a> |
---|
488 | <b>afterDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
---|
489 | <div class="short">An empty function by default, but provided so that you can perform a custom action |
---|
490 | when the dragged item enters the d...</div> |
---|
491 | <div class="long"> |
---|
492 | An empty function by default, but provided so that you can perform a custom action |
---|
493 | when the dragged item enters the drop target by providing an implementation. <div class="mdetail-params"> |
---|
494 | <strong>Parameters:</strong> |
---|
495 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul> |
---|
496 | <strong>Returns:</strong> |
---|
497 | <ul> |
---|
498 | <li><code>void</code></li> |
---|
499 | </ul> |
---|
500 | </div> |
---|
501 | </div> |
---|
502 | </div> |
---|
503 | </td> |
---|
504 | <td class="msource">DragSource</td> |
---|
505 | </tr> |
---|
506 | <tr class="method-row alt expandable"> |
---|
507 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
508 | <td class="sig"> |
---|
509 | <a id="Ext.dd.DragSource-afterDragOut"></a> |
---|
510 | <b>afterDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
---|
511 | <div class="short">An empty function by default, but provided so that you can perform a custom action |
---|
512 | after the dragged item is dragged ...</div> |
---|
513 | <div class="long"> |
---|
514 | An empty function by default, but provided so that you can perform a custom action |
---|
515 | after the dragged item is dragged out of the target without dropping. <div class="mdetail-params"> |
---|
516 | <strong>Parameters:</strong> |
---|
517 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul> |
---|
518 | <strong>Returns:</strong> |
---|
519 | <ul> |
---|
520 | <li><code>void</code></li> |
---|
521 | </ul> |
---|
522 | </div> |
---|
523 | </div> |
---|
524 | </div> |
---|
525 | </td> |
---|
526 | <td class="msource">DragSource</td> |
---|
527 | </tr> |
---|
528 | <tr class="method-row expandable"> |
---|
529 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
530 | <td class="sig"> |
---|
531 | <a id="Ext.dd.DragSource-afterDragOver"></a> |
---|
532 | <b>afterDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
---|
533 | <div class="short">An empty function by default, but provided so that you can perform a custom action |
---|
534 | while the dragged item is over the...</div> |
---|
535 | <div class="long"> |
---|
536 | An empty function by default, but provided so that you can perform a custom action |
---|
537 | while the dragged item is over the drop target by providing an implementation. <div class="mdetail-params"> |
---|
538 | <strong>Parameters:</strong> |
---|
539 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul> |
---|
540 | <strong>Returns:</strong> |
---|
541 | <ul> |
---|
542 | <li><code>void</code></li> |
---|
543 | </ul> |
---|
544 | </div> |
---|
545 | </div> |
---|
546 | </div> |
---|
547 | </td> |
---|
548 | <td class="msource">DragSource</td> |
---|
549 | </tr> |
---|
550 | <tr class="method-row alt expandable"> |
---|
551 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
552 | <td class="sig"> |
---|
553 | <a id="Ext.dd.DragSource-afterInvalidDrop"></a> |
---|
554 | <b>afterInvalidDrop</b>( <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
---|
555 | <div class="short">An empty function by default, but provided so that you can perform a custom action |
---|
556 | after an invalid drop has occurred...</div> |
---|
557 | <div class="long"> |
---|
558 | An empty function by default, but provided so that you can perform a custom action |
---|
559 | after an invalid drop has occurred by providing an implementation. <div class="mdetail-params"> |
---|
560 | <strong>Parameters:</strong> |
---|
561 | <ul><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dropped element</div></li> </ul> |
---|
562 | <strong>Returns:</strong> |
---|
563 | <ul> |
---|
564 | <li><code>void</code></li> |
---|
565 | </ul> |
---|
566 | </div> |
---|
567 | </div> |
---|
568 | </div> |
---|
569 | </td> |
---|
570 | <td class="msource">DragSource</td> |
---|
571 | </tr> |
---|
572 | <tr class="method-row inherited expandable"> |
---|
573 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
574 | <td class="sig"> |
---|
575 | <a id="Ext.dd.DragSource-alignElWithMouse"></a> |
---|
576 | <b>alignElWithMouse</b>( <code>HTMLElement el</code>, <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc"> |
---|
577 | <div class="short">Sets the element to the location of the mousedown or click event, |
---|
578 | maintaining the cursor location relative to the loc...</div> |
---|
579 | <div class="long"> |
---|
580 | Sets the element to the location of the mousedown or click event, |
---|
581 | maintaining the cursor location relative to the location on the element |
---|
582 | that was clicked. Override this if you want to place the element in a |
---|
583 | location other than where the cursor is. <div class="mdetail-params"> |
---|
584 | <strong>Parameters:</strong> |
---|
585 | <ul><li><code>el</code> : HTMLElement<div class="sub-desc">the element to move</div></li><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the mousedown or drag event</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the mousedown or drag event</div></li> </ul> |
---|
586 | <strong>Returns:</strong> |
---|
587 | <ul> |
---|
588 | <li><code>void</code></li> |
---|
589 | </ul> |
---|
590 | </div> |
---|
591 | </div> |
---|
592 | </div> |
---|
593 | </td> |
---|
594 | <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#alignElWithMouse" href="output/Ext.dd.DD.html#alignElWithMouse">DD</a></td> |
---|
595 | </tr> |
---|
596 | <tr class="method-row inherited alt expandable"> |
---|
597 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
598 | <td class="sig"> |
---|
599 | <a id="Ext.dd.DragSource-applyConfig"></a> |
---|
600 | <b>applyConfig</b>() : void <div class="mdesc"> |
---|
601 | <div class="short">Applies the configuration parameters that were passed into the constructor. |
---|
602 | This is supposed to happen at each level ...</div> |
---|
603 | <div class="long"> |
---|
604 | Applies the configuration parameters that were passed into the constructor. |
---|
605 | This is supposed to happen at each level through the inheritance chain. So |
---|
606 | a DDProxy implentation will execute apply config on DDProxy, DD, and |
---|
607 | DragDrop in order to get all of the parameters that are available in |
---|
608 | each object. <div class="mdetail-params"> |
---|
609 | <strong>Parameters:</strong> |
---|
610 | <ul><li>None.</li> </ul> |
---|
611 | <strong>Returns:</strong> |
---|
612 | <ul> |
---|
613 | <li><code>void</code></li> |
---|
614 | </ul> |
---|
615 | </div> |
---|
616 | </div> |
---|
617 | </div> |
---|
618 | </td> |
---|
619 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#applyConfig" href="output/Ext.dd.DragDrop.html#applyConfig">DragDrop</a></td> |
---|
620 | </tr> |
---|
621 | <tr class="method-row inherited expandable"> |
---|
622 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
623 | <td class="sig"> |
---|
624 | <a id="Ext.dd.DragSource-autoOffset"></a> |
---|
625 | <b>autoOffset</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc"> |
---|
626 | <div class="short">Sets the pointer offset to the distance between the linked element's top |
---|
627 | left corner and the location the element was...</div> |
---|
628 | <div class="long"> |
---|
629 | Sets the pointer offset to the distance between the linked element's top |
---|
630 | left corner and the location the element was clicked <div class="mdetail-params"> |
---|
631 | <strong>Parameters:</strong> |
---|
632 | <ul><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the click</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the click</div></li> </ul> |
---|
633 | <strong>Returns:</strong> |
---|
634 | <ul> |
---|
635 | <li><code>void</code></li> |
---|
636 | </ul> |
---|
637 | </div> |
---|
638 | </div> |
---|
639 | </div> |
---|
640 | </td> |
---|
641 | <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#autoOffset" href="output/Ext.dd.DD.html#autoOffset">DD</a></td> |
---|
642 | </tr> |
---|
643 | <tr class="method-row inherited alt expandable"> |
---|
644 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
645 | <td class="sig"> |
---|
646 | <a id="Ext.dd.DragSource-b4Drag"></a> |
---|
647 | <b>b4Drag</b>() : void <div class="mdesc"> |
---|
648 | <div class="short">Event that fires prior to the onDrag event. Overrides |
---|
649 | Ext.dd.DragDrop.</div> |
---|
650 | <div class="long"> |
---|
651 | Event that fires prior to the onDrag event. Overrides |
---|
652 | Ext.dd.DragDrop. <div class="mdetail-params"> |
---|
653 | <strong>Parameters:</strong> |
---|
654 | <ul><li>None.</li> </ul> |
---|
655 | <strong>Returns:</strong> |
---|
656 | <ul> |
---|
657 | <li><code>void</code></li> |
---|
658 | </ul> |
---|
659 | </div> |
---|
660 | </div> |
---|
661 | </div> |
---|
662 | </td> |
---|
663 | <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4Drag" href="output/Ext.dd.DD.html#b4Drag">DD</a></td> |
---|
664 | </tr> |
---|
665 | <tr class="method-row inherited expandable"> |
---|
666 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
667 | <td class="sig"> |
---|
668 | <a id="Ext.dd.DragSource-b4MouseDown"></a> |
---|
669 | <b>b4MouseDown</b>() : void <div class="mdesc"> |
---|
670 | <div class="short">Event that fires prior to the onMouseDown event. Overrides |
---|
671 | Ext.dd.DragDrop.</div> |
---|
672 | <div class="long"> |
---|
673 | Event that fires prior to the onMouseDown event. Overrides |
---|
674 | Ext.dd.DragDrop. <div class="mdetail-params"> |
---|
675 | <strong>Parameters:</strong> |
---|
676 | <ul><li>None.</li> </ul> |
---|
677 | <strong>Returns:</strong> |
---|
678 | <ul> |
---|
679 | <li><code>void</code></li> |
---|
680 | </ul> |
---|
681 | </div> |
---|
682 | </div> |
---|
683 | </div> |
---|
684 | </td> |
---|
685 | <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4MouseDown" href="output/Ext.dd.DD.html#b4MouseDown">DD</a></td> |
---|
686 | </tr> |
---|
687 | <tr class="method-row alt expandable"> |
---|
688 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
689 | <td class="sig"> |
---|
690 | <a id="Ext.dd.DragSource-beforeDragDrop"></a> |
---|
691 | <b>beforeDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
---|
692 | <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged |
---|
693 | item is dropped...</div> |
---|
694 | <div class="long"> |
---|
695 | An empty function by default, but provided so that you can perform a custom action before the dragged |
---|
696 | item is dropped onto the target and optionally cancel the onDragDrop. <div class="mdetail-params"> |
---|
697 | <strong>Parameters:</strong> |
---|
698 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul> |
---|
699 | <strong>Returns:</strong> |
---|
700 | <ul> |
---|
701 | <li><code>Boolean</code><div class="sub-desc">isValid True if the drag drop event is valid, else false to cancel</div></li> |
---|
702 | </ul> |
---|
703 | </div> |
---|
704 | </div> |
---|
705 | </div> |
---|
706 | </td> |
---|
707 | <td class="msource">DragSource</td> |
---|
708 | </tr> |
---|
709 | <tr class="method-row expandable"> |
---|
710 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
711 | <td class="sig"> |
---|
712 | <a id="Ext.dd.DragSource-beforeDragEnter"></a> |
---|
713 | <b>beforeDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
---|
714 | <div class="short">An empty function by default, but provided so that you can perform a custom action |
---|
715 | before the dragged item enters the...</div> |
---|
716 | <div class="long"> |
---|
717 | An empty function by default, but provided so that you can perform a custom action |
---|
718 | before the dragged item enters the drop target and optionally cancel the onDragEnter. <div class="mdetail-params"> |
---|
719 | <strong>Parameters:</strong> |
---|
720 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul> |
---|
721 | <strong>Returns:</strong> |
---|
722 | <ul> |
---|
723 | <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li> |
---|
724 | </ul> |
---|
725 | </div> |
---|
726 | </div> |
---|
727 | </div> |
---|
728 | </td> |
---|
729 | <td class="msource">DragSource</td> |
---|
730 | </tr> |
---|
731 | <tr class="method-row alt expandable"> |
---|
732 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
733 | <td class="sig"> |
---|
734 | <a id="Ext.dd.DragSource-beforeDragOut"></a> |
---|
735 | <b>beforeDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
---|
736 | <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged |
---|
737 | item is dragged...</div> |
---|
738 | <div class="long"> |
---|
739 | An empty function by default, but provided so that you can perform a custom action before the dragged |
---|
740 | item is dragged out of the target without dropping, and optionally cancel the onDragOut. <div class="mdetail-params"> |
---|
741 | <strong>Parameters:</strong> |
---|
742 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul> |
---|
743 | <strong>Returns:</strong> |
---|
744 | <ul> |
---|
745 | <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li> |
---|
746 | </ul> |
---|
747 | </div> |
---|
748 | </div> |
---|
749 | </div> |
---|
750 | </td> |
---|
751 | <td class="msource">DragSource</td> |
---|
752 | </tr> |
---|
753 | <tr class="method-row expandable"> |
---|
754 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
755 | <td class="sig"> |
---|
756 | <a id="Ext.dd.DragSource-beforeDragOver"></a> |
---|
757 | <b>beforeDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
---|
758 | <div class="short">An empty function by default, but provided so that you can perform a custom action |
---|
759 | while the dragged item is over the...</div> |
---|
760 | <div class="long"> |
---|
761 | An empty function by default, but provided so that you can perform a custom action |
---|
762 | while the dragged item is over the drop target and optionally cancel the onDragOver. <div class="mdetail-params"> |
---|
763 | <strong>Parameters:</strong> |
---|
764 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul> |
---|
765 | <strong>Returns:</strong> |
---|
766 | <ul> |
---|
767 | <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li> |
---|
768 | </ul> |
---|
769 | </div> |
---|
770 | </div> |
---|
771 | </div> |
---|
772 | </td> |
---|
773 | <td class="msource">DragSource</td> |
---|
774 | </tr> |
---|
775 | <tr class="method-row alt expandable"> |
---|
776 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
777 | <td class="sig"> |
---|
778 | <a id="Ext.dd.DragSource-beforeInvalidDrop"></a> |
---|
779 | <b>beforeInvalidDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
---|
780 | <div class="short">An empty function by default, but provided so that you can perform a custom action after an invalid |
---|
781 | drop has occurred.</div> |
---|
782 | <div class="long"> |
---|
783 | An empty function by default, but provided so that you can perform a custom action after an invalid |
---|
784 | drop has occurred. <div class="mdetail-params"> |
---|
785 | <strong>Parameters:</strong> |
---|
786 | <ul><li><code>target</code> : Ext.dd.DragDrop<div class="sub-desc">The drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li><li><code>id</code> : String<div class="sub-desc">The id of the dragged element</div></li> </ul> |
---|
787 | <strong>Returns:</strong> |
---|
788 | <ul> |
---|
789 | <li><code>Boolean</code><div class="sub-desc">isValid True if the invalid drop should proceed, else false to cancel</div></li> |
---|
790 | </ul> |
---|
791 | </div> |
---|
792 | </div> |
---|
793 | </div> |
---|
794 | </td> |
---|
795 | <td class="msource">DragSource</td> |
---|
796 | </tr> |
---|
797 | <tr class="method-row inherited expandable"> |
---|
798 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
799 | <td class="sig"> |
---|
800 | <a id="Ext.dd.DragSource-cachePosition"></a> |
---|
801 | <b>cachePosition</b>( <code>iPageX the</code>, <code>iPageY the</code> ) : void <div class="mdesc"> |
---|
802 | <div class="short">Saves the most recent position so that we can reset the constraints and |
---|
803 | tick marks on-demand. We need to know this s...</div> |
---|
804 | <div class="long"> |
---|
805 | Saves the most recent position so that we can reset the constraints and |
---|
806 | tick marks on-demand. We need to know this so that we can calculate the |
---|
807 | number of pixels the element is offset from its original position. <div class="mdetail-params"> |
---|
808 | <strong>Parameters:</strong> |
---|
809 | <ul><li><code>the</code> : iPageX<div class="sub-desc">current x position (optional, this just makes it so we |
---|
810 | don't have to look it up again)</div></li><li><code>the</code> : iPageY<div class="sub-desc">current y position (optional, this just makes it so we |
---|
811 | don't have to look it up again)</div></li> </ul> |
---|
812 | <strong>Returns:</strong> |
---|
813 | <ul> |
---|
814 | <li><code>void</code></li> |
---|
815 | </ul> |
---|
816 | </div> |
---|
817 | </div> |
---|
818 | </div> |
---|
819 | </td> |
---|
820 | <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#cachePosition" href="output/Ext.dd.DD.html#cachePosition">DD</a></td> |
---|
821 | </tr> |
---|
822 | <tr class="method-row inherited alt expandable"> |
---|
823 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
824 | <td class="sig"> |
---|
825 | <a id="Ext.dd.DragSource-clearConstraints"></a> |
---|
826 | <b>clearConstraints</b>() : void <div class="mdesc"> |
---|
827 | <div class="short">Clears any constraints applied to this instance. Also clears ticks |
---|
828 | since they can't exist independent of a constrain...</div> |
---|
829 | <div class="long"> |
---|
830 | Clears any constraints applied to this instance. Also clears ticks |
---|
831 | since they can't exist independent of a constraint at this time. <div class="mdetail-params"> |
---|
832 | <strong>Parameters:</strong> |
---|
833 | <ul><li>None.</li> </ul> |
---|
834 | <strong>Returns:</strong> |
---|
835 | <ul> |
---|
836 | <li><code>void</code></li> |
---|
837 | </ul> |
---|
838 | </div> |
---|
839 | </div> |
---|
840 | </div> |
---|
841 | </td> |
---|
842 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearConstraints" href="output/Ext.dd.DragDrop.html#clearConstraints">DragDrop</a></td> |
---|
843 | </tr> |
---|
844 | <tr class="method-row inherited expandable"> |
---|
845 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
846 | <td class="sig"> |
---|
847 | <a id="Ext.dd.DragSource-clearTicks"></a> |
---|
848 | <b>clearTicks</b>() : void <div class="mdesc"> |
---|
849 | <div class="short">Clears any tick interval defined for this instance</div> |
---|
850 | <div class="long"> |
---|
851 | Clears any tick interval defined for this instance <div class="mdetail-params"> |
---|
852 | <strong>Parameters:</strong> |
---|
853 | <ul><li>None.</li> </ul> |
---|
854 | <strong>Returns:</strong> |
---|
855 | <ul> |
---|
856 | <li><code>void</code></li> |
---|
857 | </ul> |
---|
858 | </div> |
---|
859 | </div> |
---|
860 | </div> |
---|
861 | </td> |
---|
862 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearTicks" href="output/Ext.dd.DragDrop.html#clearTicks">DragDrop</a></td> |
---|
863 | </tr> |
---|
864 | <tr class="method-row inherited alt expandable"> |
---|
865 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
866 | <td class="sig"> |
---|
867 | <a id="Ext.dd.DragSource-constrainTo"></a> |
---|
868 | <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"> |
---|
869 | <div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element. |
---|
870 | Usage: |
---|
871 | var dd = new Ext.d...</div> |
---|
872 | <div class="long"> |
---|
873 | Initializes the drag drop object's constraints to restrict movement to a certain element. |
---|
874 | Usage: |
---|
875 | <pre><code>var dd = <b>new</b> Ext.dd.DDProxy(<em>"dragDiv1"</em>, <em>"proxytest"</em>, |
---|
876 | { dragElId: <em>"existingProxyDiv"</em> }); |
---|
877 | dd.startDrag = <b>function</b>(){ |
---|
878 | <b>this</b>.constrainTo(<em>"parent-id"</em>); |
---|
879 | };</code></pre> |
---|
880 | Or you can initalize it using the <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object: |
---|
881 | <pre><code>Ext.get(<em>"dragDiv1"</em>).initDDProxy(<em>"proxytest"</em>, {dragElId: <em>"existingProxyDiv"</em>}, { |
---|
882 | startDrag : <b>function</b>(){ |
---|
883 | <b>this</b>.constrainTo(<em>"parent-id"</em>); |
---|
884 | } |
---|
885 | });</code></pre> <div class="mdetail-params"> |
---|
886 | <strong>Parameters:</strong> |
---|
887 | <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, |
---|
888 | and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or |
---|
889 | 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> |
---|
890 | <strong>Returns:</strong> |
---|
891 | <ul> |
---|
892 | <li><code>void</code></li> |
---|
893 | </ul> |
---|
894 | </div> |
---|
895 | </div> |
---|
896 | </div> |
---|
897 | </td> |
---|
898 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#constrainTo" href="output/Ext.dd.DragDrop.html#constrainTo">DragDrop</a></td> |
---|
899 | </tr> |
---|
900 | <tr class="method-row inherited expandable"> |
---|
901 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
902 | <td class="sig"> |
---|
903 | <a id="Ext.dd.DragSource-createFrame"></a> |
---|
904 | <b>createFrame</b>() : void <div class="mdesc"> |
---|
905 | <div class="short">Creates the proxy element if it does not yet exist</div> |
---|
906 | <div class="long"> |
---|
907 | Creates the proxy element if it does not yet exist <div class="mdetail-params"> |
---|
908 | <strong>Parameters:</strong> |
---|
909 | <ul><li>None.</li> </ul> |
---|
910 | <strong>Returns:</strong> |
---|
911 | <ul> |
---|
912 | <li><code>void</code></li> |
---|
913 | </ul> |
---|
914 | </div> |
---|
915 | </div> |
---|
916 | </div> |
---|
917 | </td> |
---|
918 | <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#createFrame" href="output/Ext.dd.DDProxy.html#createFrame">DDProxy</a></td> |
---|
919 | </tr> |
---|
920 | <tr class="method-row inherited alt expandable"> |
---|
921 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
922 | <td class="sig"> |
---|
923 | <a id="Ext.dd.DragSource-endDrag"></a> |
---|
924 | <b>endDrag</b>( <code>Event e</code> ) : void <div class="mdesc"> |
---|
925 | <div class="short">Fired when we are done dragging the object</div> |
---|
926 | <div class="long"> |
---|
927 | Fired when we are done dragging the object <div class="mdetail-params"> |
---|
928 | <strong>Parameters:</strong> |
---|
929 | <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul> |
---|
930 | <strong>Returns:</strong> |
---|
931 | <ul> |
---|
932 | <li><code>void</code></li> |
---|
933 | </ul> |
---|
934 | </div> |
---|
935 | </div> |
---|
936 | </div> |
---|
937 | </td> |
---|
938 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#endDrag" href="output/Ext.dd.DragDrop.html#endDrag">DragDrop</a></td> |
---|
939 | </tr> |
---|
940 | <tr class="method-row expandable"> |
---|
941 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
942 | <td class="sig"> |
---|
943 | <a id="Ext.dd.DragSource-getDragData"></a> |
---|
944 | <b>getDragData</b>() : Object <div class="mdesc"> |
---|
945 | <div class="short">Returns the data object associated with this drag source</div> |
---|
946 | <div class="long"> |
---|
947 | Returns the data object associated with this drag source <div class="mdetail-params"> |
---|
948 | <strong>Parameters:</strong> |
---|
949 | <ul><li>None.</li> </ul> |
---|
950 | <strong>Returns:</strong> |
---|
951 | <ul> |
---|
952 | <li><code>Object</code><div class="sub-desc">data An object containing arbitrary data</div></li> |
---|
953 | </ul> |
---|
954 | </div> |
---|
955 | </div> |
---|
956 | </div> |
---|
957 | </td> |
---|
958 | <td class="msource">DragSource</td> |
---|
959 | </tr> |
---|
960 | <tr class="method-row inherited alt expandable"> |
---|
961 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
962 | <td class="sig"> |
---|
963 | <a id="Ext.dd.DragSource-getDragEl"></a> |
---|
964 | <b>getDragEl</b>() : HTMLElement <div class="mdesc"> |
---|
965 | <div class="short">Returns a reference to the actual element to drag. By default this is |
---|
966 | the same as the html element, but it can be as...</div> |
---|
967 | <div class="long"> |
---|
968 | Returns a reference to the actual element to drag. By default this is |
---|
969 | the same as the html element, but it can be assigned to another |
---|
970 | element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params"> |
---|
971 | <strong>Parameters:</strong> |
---|
972 | <ul><li>None.</li> </ul> |
---|
973 | <strong>Returns:</strong> |
---|
974 | <ul> |
---|
975 | <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li> |
---|
976 | </ul> |
---|
977 | </div> |
---|
978 | </div> |
---|
979 | </div> |
---|
980 | </td> |
---|
981 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getDragEl" href="output/Ext.dd.DragDrop.html#getDragEl">DragDrop</a></td> |
---|
982 | </tr> |
---|
983 | <tr class="method-row inherited expandable"> |
---|
984 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
985 | <td class="sig"> |
---|
986 | <a id="Ext.dd.DragSource-getEl"></a> |
---|
987 | <b>getEl</b>() : HTMLElement <div class="mdesc"> |
---|
988 | <div class="short">Returns a reference to the linked element</div> |
---|
989 | <div class="long"> |
---|
990 | Returns a reference to the linked element <div class="mdetail-params"> |
---|
991 | <strong>Parameters:</strong> |
---|
992 | <ul><li>None.</li> </ul> |
---|
993 | <strong>Returns:</strong> |
---|
994 | <ul> |
---|
995 | <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li> |
---|
996 | </ul> |
---|
997 | </div> |
---|
998 | </div> |
---|
999 | </div> |
---|
1000 | </td> |
---|
1001 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getEl" href="output/Ext.dd.DragDrop.html#getEl">DragDrop</a></td> |
---|
1002 | </tr> |
---|
1003 | <tr class="method-row alt expandable"> |
---|
1004 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1005 | <td class="sig"> |
---|
1006 | <a id="Ext.dd.DragSource-getProxy"></a> |
---|
1007 | <b>getProxy</b>() : Ext.dd.StatusProxy <div class="mdesc"> |
---|
1008 | <div class="short">Returns the drag source's underlying <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a></div> |
---|
1009 | <div class="long"> |
---|
1010 | Returns the drag source's underlying <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a> <div class="mdetail-params"> |
---|
1011 | <strong>Parameters:</strong> |
---|
1012 | <ul><li>None.</li> </ul> |
---|
1013 | <strong>Returns:</strong> |
---|
1014 | <ul> |
---|
1015 | <li><code>Ext.dd.StatusProxy</code><div class="sub-desc">proxy The StatusProxy</div></li> |
---|
1016 | </ul> |
---|
1017 | </div> |
---|
1018 | </div> |
---|
1019 | </div> |
---|
1020 | </td> |
---|
1021 | <td class="msource">DragSource</td> |
---|
1022 | </tr> |
---|
1023 | <tr class="method-row expandable"> |
---|
1024 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1025 | <td class="sig"> |
---|
1026 | <a id="Ext.dd.DragSource-hideProxy"></a> |
---|
1027 | <b>hideProxy</b>() : void <div class="mdesc"> |
---|
1028 | <div class="short">Hides the drag source's <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a></div> |
---|
1029 | <div class="long"> |
---|
1030 | Hides the drag source's <a ext:cls="Ext.dd.StatusProxy" href="output/Ext.dd.StatusProxy.html">Ext.dd.StatusProxy</a> <div class="mdetail-params"> |
---|
1031 | <strong>Parameters:</strong> |
---|
1032 | <ul><li>None.</li> </ul> |
---|
1033 | <strong>Returns:</strong> |
---|
1034 | <ul> |
---|
1035 | <li><code>void</code></li> |
---|
1036 | </ul> |
---|
1037 | </div> |
---|
1038 | </div> |
---|
1039 | </div> |
---|
1040 | </td> |
---|
1041 | <td class="msource">DragSource</td> |
---|
1042 | </tr> |
---|
1043 | <tr class="method-row inherited alt expandable"> |
---|
1044 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1045 | <td class="sig"> |
---|
1046 | <a id="Ext.dd.DragSource-init"></a> |
---|
1047 | <b>init</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc"> |
---|
1048 | <div class="short">Sets up the DragDrop object. Must be called in the constructor of any |
---|
1049 | Ext.dd.DragDrop subclass</div> |
---|
1050 | <div class="long"> |
---|
1051 | Sets up the DragDrop object. Must be called in the constructor of any |
---|
1052 | Ext.dd.DragDrop subclass <div class="mdetail-params"> |
---|
1053 | <strong>Parameters:</strong> |
---|
1054 | <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> |
---|
1055 | <strong>Returns:</strong> |
---|
1056 | <ul> |
---|
1057 | <li><code>void</code></li> |
---|
1058 | </ul> |
---|
1059 | </div> |
---|
1060 | </div> |
---|
1061 | </div> |
---|
1062 | </td> |
---|
1063 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#init" href="output/Ext.dd.DragDrop.html#init">DragDrop</a></td> |
---|
1064 | </tr> |
---|
1065 | <tr class="method-row inherited expandable"> |
---|
1066 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1067 | <td class="sig"> |
---|
1068 | <a id="Ext.dd.DragSource-initFrame"></a> |
---|
1069 | <b>initFrame</b>() : void <div class="mdesc"> |
---|
1070 | <div class="short">Initialization for the drag frame element. Must be called in the |
---|
1071 | constructor of all subclasses</div> |
---|
1072 | <div class="long"> |
---|
1073 | Initialization for the drag frame element. Must be called in the |
---|
1074 | constructor of all subclasses <div class="mdetail-params"> |
---|
1075 | <strong>Parameters:</strong> |
---|
1076 | <ul><li>None.</li> </ul> |
---|
1077 | <strong>Returns:</strong> |
---|
1078 | <ul> |
---|
1079 | <li><code>void</code></li> |
---|
1080 | </ul> |
---|
1081 | </div> |
---|
1082 | </div> |
---|
1083 | </div> |
---|
1084 | </td> |
---|
1085 | <td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#initFrame" href="output/Ext.dd.DDProxy.html#initFrame">DDProxy</a></td> |
---|
1086 | </tr> |
---|
1087 | <tr class="method-row inherited alt expandable"> |
---|
1088 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1089 | <td class="sig"> |
---|
1090 | <a id="Ext.dd.DragSource-initTarget"></a> |
---|
1091 | <b>initTarget</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc"> |
---|
1092 | <div class="short">Initializes Targeting functionality only... the object does not |
---|
1093 | get a mousedown handler.</div> |
---|
1094 | <div class="long"> |
---|
1095 | Initializes Targeting functionality only... the object does not |
---|
1096 | get a mousedown handler. <div class="mdetail-params"> |
---|
1097 | <strong>Parameters:</strong> |
---|
1098 | <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> |
---|
1099 | <strong>Returns:</strong> |
---|
1100 | <ul> |
---|
1101 | <li><code>void</code></li> |
---|
1102 | </ul> |
---|
1103 | </div> |
---|
1104 | </div> |
---|
1105 | </div> |
---|
1106 | </td> |
---|
1107 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#initTarget" href="output/Ext.dd.DragDrop.html#initTarget">DragDrop</a></td> |
---|
1108 | </tr> |
---|
1109 | <tr class="method-row inherited expandable"> |
---|
1110 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1111 | <td class="sig"> |
---|
1112 | <a id="Ext.dd.DragSource-isLocked"></a> |
---|
1113 | <b>isLocked</b>() : boolean <div class="mdesc"> |
---|
1114 | <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked |
---|
1115 | (meaning that all drag/drop is disabled on th...</div> |
---|
1116 | <div class="long"> |
---|
1117 | Returns true if this instance is locked, or the drag drop mgr is locked |
---|
1118 | (meaning that all drag/drop is disabled on the page.) <div class="mdetail-params"> |
---|
1119 | <strong>Parameters:</strong> |
---|
1120 | <ul><li>None.</li> </ul> |
---|
1121 | <strong>Returns:</strong> |
---|
1122 | <ul> |
---|
1123 | <li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li> |
---|
1124 | </ul> |
---|
1125 | </div> |
---|
1126 | </div> |
---|
1127 | </div> |
---|
1128 | </td> |
---|
1129 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isLocked" href="output/Ext.dd.DragDrop.html#isLocked">DragDrop</a></td> |
---|
1130 | </tr> |
---|
1131 | <tr class="method-row inherited alt expandable"> |
---|
1132 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1133 | <td class="sig"> |
---|
1134 | <a id="Ext.dd.DragSource-isValidHandleChild"></a> |
---|
1135 | <b>isValidHandleChild</b>( <code>HTMLElement node</code> ) : boolean <div class="mdesc"> |
---|
1136 | <div class="short">Checks the tag exclusion list to see if this click should be ignored</div> |
---|
1137 | <div class="long"> |
---|
1138 | Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params"> |
---|
1139 | <strong>Parameters:</strong> |
---|
1140 | <ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul> |
---|
1141 | <strong>Returns:</strong> |
---|
1142 | <ul> |
---|
1143 | <li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li> |
---|
1144 | </ul> |
---|
1145 | </div> |
---|
1146 | </div> |
---|
1147 | </div> |
---|
1148 | </td> |
---|
1149 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isValidHandleChild" href="output/Ext.dd.DragDrop.html#isValidHandleChild">DragDrop</a></td> |
---|
1150 | </tr> |
---|
1151 | <tr class="method-row inherited expandable"> |
---|
1152 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1153 | <td class="sig"> |
---|
1154 | <a id="Ext.dd.DragSource-lock"></a> |
---|
1155 | <b>lock</b>() : void <div class="mdesc"> |
---|
1156 | <div class="short">Lock this instance</div> |
---|
1157 | <div class="long"> |
---|
1158 | Lock this instance <div class="mdetail-params"> |
---|
1159 | <strong>Parameters:</strong> |
---|
1160 | <ul><li>None.</li> </ul> |
---|
1161 | <strong>Returns:</strong> |
---|
1162 | <ul> |
---|
1163 | <li><code>void</code></li> |
---|
1164 | </ul> |
---|
1165 | </div> |
---|
1166 | </div> |
---|
1167 | </div> |
---|
1168 | </td> |
---|
1169 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#lock" href="output/Ext.dd.DragDrop.html#lock">DragDrop</a></td> |
---|
1170 | </tr> |
---|
1171 | <tr class="method-row inherited alt expandable"> |
---|
1172 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1173 | <td class="sig"> |
---|
1174 | <a id="Ext.dd.DragSource-onAvailable"></a> |
---|
1175 | <b>onAvailable</b>() : void <div class="mdesc"> |
---|
1176 | <div class="short">Override the onAvailable method to do what is needed after the initial |
---|
1177 | position was determined.</div> |
---|
1178 | <div class="long"> |
---|
1179 | Override the onAvailable method to do what is needed after the initial |
---|
1180 | position was determined. <div class="mdetail-params"> |
---|
1181 | <strong>Parameters:</strong> |
---|
1182 | <ul><li>None.</li> </ul> |
---|
1183 | <strong>Returns:</strong> |
---|
1184 | <ul> |
---|
1185 | <li><code>void</code></li> |
---|
1186 | </ul> |
---|
1187 | </div> |
---|
1188 | </div> |
---|
1189 | </div> |
---|
1190 | </td> |
---|
1191 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onAvailable" href="output/Ext.dd.DragDrop.html#onAvailable">DragDrop</a></td> |
---|
1192 | </tr> |
---|
1193 | <tr class="method-row expandable"> |
---|
1194 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1195 | <td class="sig"> |
---|
1196 | <a id="Ext.dd.DragSource-onBeforeDrag"></a> |
---|
1197 | <b>onBeforeDrag</b>( <code>Object data</code>, <code>Event e</code> ) : Boolean <div class="mdesc"> |
---|
1198 | <div class="short">An empty function by default, but provided so that you can perform a custom action before the initial |
---|
1199 | drag event begi...</div> |
---|
1200 | <div class="long"> |
---|
1201 | An empty function by default, but provided so that you can perform a custom action before the initial |
---|
1202 | drag event begins and optionally cancel it. <div class="mdetail-params"> |
---|
1203 | <strong>Parameters:</strong> |
---|
1204 | <ul><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data to be shared with drop targets</div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li> </ul> |
---|
1205 | <strong>Returns:</strong> |
---|
1206 | <ul> |
---|
1207 | <li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li> |
---|
1208 | </ul> |
---|
1209 | </div> |
---|
1210 | </div> |
---|
1211 | </div> |
---|
1212 | </td> |
---|
1213 | <td class="msource">DragSource</td> |
---|
1214 | </tr> |
---|
1215 | <tr class="method-row inherited alt expandable"> |
---|
1216 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1217 | <td class="sig"> |
---|
1218 | <a id="Ext.dd.DragSource-onDrag"></a> |
---|
1219 | <b>onDrag</b>( <code>Event e</code> ) : void <div class="mdesc"> |
---|
1220 | <div class="short">Abstract method called during the onMouseMove event while dragging an |
---|
1221 | object.</div> |
---|
1222 | <div class="long"> |
---|
1223 | Abstract method called during the onMouseMove event while dragging an |
---|
1224 | object. <div class="mdetail-params"> |
---|
1225 | <strong>Parameters:</strong> |
---|
1226 | <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul> |
---|
1227 | <strong>Returns:</strong> |
---|
1228 | <ul> |
---|
1229 | <li><code>void</code></li> |
---|
1230 | </ul> |
---|
1231 | </div> |
---|
1232 | </div> |
---|
1233 | </div> |
---|
1234 | </td> |
---|
1235 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDrag" href="output/Ext.dd.DragDrop.html#onDrag">DragDrop</a></td> |
---|
1236 | </tr> |
---|
1237 | <tr class="method-row inherited expandable"> |
---|
1238 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1239 | <td class="sig"> |
---|
1240 | <a id="Ext.dd.DragSource-onDragDrop"></a> |
---|
1241 | <b>onDragDrop</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc"> |
---|
1242 | <div class="short">Abstract method called when this item is dropped on another DragDrop |
---|
1243 | obj</div> |
---|
1244 | <div class="long"> |
---|
1245 | Abstract method called when this item is dropped on another DragDrop |
---|
1246 | obj <div class="mdetail-params"> |
---|
1247 | <strong>Parameters:</strong> |
---|
1248 | <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 |
---|
1249 | id this was dropped on. In INTERSECT mode, an array of dd items this |
---|
1250 | was dropped on.</div></li> </ul> |
---|
1251 | <strong>Returns:</strong> |
---|
1252 | <ul> |
---|
1253 | <li><code>void</code></li> |
---|
1254 | </ul> |
---|
1255 | </div> |
---|
1256 | </div> |
---|
1257 | </div> |
---|
1258 | </td> |
---|
1259 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragDrop" href="output/Ext.dd.DragDrop.html#onDragDrop">DragDrop</a></td> |
---|
1260 | </tr> |
---|
1261 | <tr class="method-row inherited alt expandable"> |
---|
1262 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1263 | <td class="sig"> |
---|
1264 | <a id="Ext.dd.DragSource-onDragEnter"></a> |
---|
1265 | <b>onDragEnter</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc"> |
---|
1266 | <div class="short">Abstract method called when this element fist begins hovering over |
---|
1267 | another DragDrop obj</div> |
---|
1268 | <div class="long"> |
---|
1269 | Abstract method called when this element fist begins hovering over |
---|
1270 | another DragDrop obj <div class="mdetail-params"> |
---|
1271 | <strong>Parameters:</strong> |
---|
1272 | <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 |
---|
1273 | id this is hovering over. In INTERSECT mode, an array of one or more |
---|
1274 | dragdrop items being hovered over.</div></li> </ul> |
---|
1275 | <strong>Returns:</strong> |
---|
1276 | <ul> |
---|
1277 | <li><code>void</code></li> |
---|
1278 | </ul> |
---|
1279 | </div> |
---|
1280 | </div> |
---|
1281 | </div> |
---|
1282 | </td> |
---|
1283 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragEnter" href="output/Ext.dd.DragDrop.html#onDragEnter">DragDrop</a></td> |
---|
1284 | </tr> |
---|
1285 | <tr class="method-row inherited expandable"> |
---|
1286 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1287 | <td class="sig"> |
---|
1288 | <a id="Ext.dd.DragSource-onDragOut"></a> |
---|
1289 | <b>onDragOut</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc"> |
---|
1290 | <div class="short">Abstract method called when we are no longer hovering over an element</div> |
---|
1291 | <div class="long"> |
---|
1292 | Abstract method called when we are no longer hovering over an element <div class="mdetail-params"> |
---|
1293 | <strong>Parameters:</strong> |
---|
1294 | <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 |
---|
1295 | id this was hovering over. In INTERSECT mode, an array of dd items |
---|
1296 | that the mouse is no longer over.</div></li> </ul> |
---|
1297 | <strong>Returns:</strong> |
---|
1298 | <ul> |
---|
1299 | <li><code>void</code></li> |
---|
1300 | </ul> |
---|
1301 | </div> |
---|
1302 | </div> |
---|
1303 | </div> |
---|
1304 | </td> |
---|
1305 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOut" href="output/Ext.dd.DragDrop.html#onDragOut">DragDrop</a></td> |
---|
1306 | </tr> |
---|
1307 | <tr class="method-row inherited alt expandable"> |
---|
1308 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1309 | <td class="sig"> |
---|
1310 | <a id="Ext.dd.DragSource-onDragOver"></a> |
---|
1311 | <b>onDragOver</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc"> |
---|
1312 | <div class="short">Abstract method called when this element is hovering over another |
---|
1313 | DragDrop obj</div> |
---|
1314 | <div class="long"> |
---|
1315 | Abstract method called when this element is hovering over another |
---|
1316 | DragDrop obj <div class="mdetail-params"> |
---|
1317 | <strong>Parameters:</strong> |
---|
1318 | <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 |
---|
1319 | id this is hovering over. In INTERSECT mode, an array of dd items |
---|
1320 | being hovered over.</div></li> </ul> |
---|
1321 | <strong>Returns:</strong> |
---|
1322 | <ul> |
---|
1323 | <li><code>void</code></li> |
---|
1324 | </ul> |
---|
1325 | </div> |
---|
1326 | </div> |
---|
1327 | </div> |
---|
1328 | </td> |
---|
1329 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOver" href="output/Ext.dd.DragDrop.html#onDragOver">DragDrop</a></td> |
---|
1330 | </tr> |
---|
1331 | <tr class="method-row inherited expandable"> |
---|
1332 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1333 | <td class="sig"> |
---|
1334 | <a id="Ext.dd.DragSource-onInvalidDrop"></a> |
---|
1335 | <b>onInvalidDrop</b>( <code>Event e</code> ) : void <div class="mdesc"> |
---|
1336 | <div class="short">Abstract method called when this item is dropped on an area with no |
---|
1337 | drop target</div> |
---|
1338 | <div class="long"> |
---|
1339 | Abstract method called when this item is dropped on an area with no |
---|
1340 | drop target <div class="mdetail-params"> |
---|
1341 | <strong>Parameters:</strong> |
---|
1342 | <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul> |
---|
1343 | <strong>Returns:</strong> |
---|
1344 | <ul> |
---|
1345 | <li><code>void</code></li> |
---|
1346 | </ul> |
---|
1347 | </div> |
---|
1348 | </div> |
---|
1349 | </div> |
---|
1350 | </td> |
---|
1351 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onInvalidDrop" href="output/Ext.dd.DragDrop.html#onInvalidDrop">DragDrop</a></td> |
---|
1352 | </tr> |
---|
1353 | <tr class="method-row inherited alt expandable"> |
---|
1354 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1355 | <td class="sig"> |
---|
1356 | <a id="Ext.dd.DragSource-onMouseDown"></a> |
---|
1357 | <b>onMouseDown</b>( <code>Event e</code> ) : void <div class="mdesc"> |
---|
1358 | <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div> |
---|
1359 | <div class="long"> |
---|
1360 | Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params"> |
---|
1361 | <strong>Parameters:</strong> |
---|
1362 | <ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul> |
---|
1363 | <strong>Returns:</strong> |
---|
1364 | <ul> |
---|
1365 | <li><code>void</code></li> |
---|
1366 | </ul> |
---|
1367 | </div> |
---|
1368 | </div> |
---|
1369 | </div> |
---|
1370 | </td> |
---|
1371 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseDown" href="output/Ext.dd.DragDrop.html#onMouseDown">DragDrop</a></td> |
---|
1372 | </tr> |
---|
1373 | <tr class="method-row inherited expandable"> |
---|
1374 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1375 | <td class="sig"> |
---|
1376 | <a id="Ext.dd.DragSource-onMouseUp"></a> |
---|
1377 | <b>onMouseUp</b>( <code>Event e</code> ) : void <div class="mdesc"> |
---|
1378 | <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div> |
---|
1379 | <div class="long"> |
---|
1380 | Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params"> |
---|
1381 | <strong>Parameters:</strong> |
---|
1382 | <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul> |
---|
1383 | <strong>Returns:</strong> |
---|
1384 | <ul> |
---|
1385 | <li><code>void</code></li> |
---|
1386 | </ul> |
---|
1387 | </div> |
---|
1388 | </div> |
---|
1389 | </div> |
---|
1390 | </td> |
---|
1391 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseUp" href="output/Ext.dd.DragDrop.html#onMouseUp">DragDrop</a></td> |
---|
1392 | </tr> |
---|
1393 | <tr class="method-row inherited alt expandable"> |
---|
1394 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1395 | <td class="sig"> |
---|
1396 | <a id="Ext.dd.DragSource-removeFromGroup"></a> |
---|
1397 | <b>removeFromGroup</b>( <code>string sGroup</code> ) : void <div class="mdesc"> |
---|
1398 | <div class="short">Remove's this instance from the supplied interaction group</div> |
---|
1399 | <div class="long"> |
---|
1400 | Remove's this instance from the supplied interaction group <div class="mdetail-params"> |
---|
1401 | <strong>Parameters:</strong> |
---|
1402 | <ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul> |
---|
1403 | <strong>Returns:</strong> |
---|
1404 | <ul> |
---|
1405 | <li><code>void</code></li> |
---|
1406 | </ul> |
---|
1407 | </div> |
---|
1408 | </div> |
---|
1409 | </div> |
---|
1410 | </td> |
---|
1411 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeFromGroup" href="output/Ext.dd.DragDrop.html#removeFromGroup">DragDrop</a></td> |
---|
1412 | </tr> |
---|
1413 | <tr class="method-row inherited expandable"> |
---|
1414 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1415 | <td class="sig"> |
---|
1416 | <a id="Ext.dd.DragSource-removeInvalidHandleClass"></a> |
---|
1417 | <b>removeInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc"> |
---|
1418 | <div class="short">Unsets an invalid css class</div> |
---|
1419 | <div class="long"> |
---|
1420 | Unsets an invalid css class <div class="mdetail-params"> |
---|
1421 | <strong>Parameters:</strong> |
---|
1422 | <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to |
---|
1423 | re-enable</div></li> </ul> |
---|
1424 | <strong>Returns:</strong> |
---|
1425 | <ul> |
---|
1426 | <li><code>void</code></li> |
---|
1427 | </ul> |
---|
1428 | </div> |
---|
1429 | </div> |
---|
1430 | </div> |
---|
1431 | </td> |
---|
1432 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleClass" href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass">DragDrop</a></td> |
---|
1433 | </tr> |
---|
1434 | <tr class="method-row inherited alt expandable"> |
---|
1435 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1436 | <td class="sig"> |
---|
1437 | <a id="Ext.dd.DragSource-removeInvalidHandleId"></a> |
---|
1438 | <b>removeInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc"> |
---|
1439 | <div class="short">Unsets an invalid handle id</div> |
---|
1440 | <div class="long"> |
---|
1441 | Unsets an invalid handle id <div class="mdetail-params"> |
---|
1442 | <strong>Parameters:</strong> |
---|
1443 | <ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul> |
---|
1444 | <strong>Returns:</strong> |
---|
1445 | <ul> |
---|
1446 | <li><code>void</code></li> |
---|
1447 | </ul> |
---|
1448 | </div> |
---|
1449 | </div> |
---|
1450 | </div> |
---|
1451 | </td> |
---|
1452 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleId" href="output/Ext.dd.DragDrop.html#removeInvalidHandleId">DragDrop</a></td> |
---|
1453 | </tr> |
---|
1454 | <tr class="method-row inherited expandable"> |
---|
1455 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1456 | <td class="sig"> |
---|
1457 | <a id="Ext.dd.DragSource-removeInvalidHandleType"></a> |
---|
1458 | <b>removeInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc"> |
---|
1459 | <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div> |
---|
1460 | <div class="long"> |
---|
1461 | Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params"> |
---|
1462 | <strong>Parameters:</strong> |
---|
1463 | <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li> </ul> |
---|
1464 | <strong>Returns:</strong> |
---|
1465 | <ul> |
---|
1466 | <li><code>void</code></li> |
---|
1467 | </ul> |
---|
1468 | </div> |
---|
1469 | </div> |
---|
1470 | </div> |
---|
1471 | </td> |
---|
1472 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleType" href="output/Ext.dd.DragDrop.html#removeInvalidHandleType">DragDrop</a></td> |
---|
1473 | </tr> |
---|
1474 | <tr class="method-row inherited alt expandable"> |
---|
1475 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1476 | <td class="sig"> |
---|
1477 | <a id="Ext.dd.DragSource-resetConstraints"></a> |
---|
1478 | <b>resetConstraints</b>( <code>boolean maintainOffset</code> ) : void <div class="mdesc"> |
---|
1479 | <div class="short">resetConstraints must be called if you manually reposition a dd element.</div> |
---|
1480 | <div class="long"> |
---|
1481 | resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params"> |
---|
1482 | <strong>Parameters:</strong> |
---|
1483 | <ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul> |
---|
1484 | <strong>Returns:</strong> |
---|
1485 | <ul> |
---|
1486 | <li><code>void</code></li> |
---|
1487 | </ul> |
---|
1488 | </div> |
---|
1489 | </div> |
---|
1490 | </div> |
---|
1491 | </td> |
---|
1492 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#resetConstraints" href="output/Ext.dd.DragDrop.html#resetConstraints">DragDrop</a></td> |
---|
1493 | </tr> |
---|
1494 | <tr class="method-row inherited expandable"> |
---|
1495 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1496 | <td class="sig"> |
---|
1497 | <a id="Ext.dd.DragSource-setDelta"></a> |
---|
1498 | <b>setDelta</b>( <code>int iDeltaX</code>, <code>int iDeltaY</code> ) : void <div class="mdesc"> |
---|
1499 | <div class="short">Sets the pointer offset. You can call this directly to force the |
---|
1500 | offset to be in a particular location (e.g., pass i...</div> |
---|
1501 | <div class="long"> |
---|
1502 | Sets the pointer offset. You can call this directly to force the |
---|
1503 | offset to be in a particular location (e.g., pass in 0,0 to set it |
---|
1504 | to the center of the object) <div class="mdetail-params"> |
---|
1505 | <strong>Parameters:</strong> |
---|
1506 | <ul><li><code>iDeltaX</code> : int<div class="sub-desc">the distance from the left</div></li><li><code>iDeltaY</code> : int<div class="sub-desc">the distance from the top</div></li> </ul> |
---|
1507 | <strong>Returns:</strong> |
---|
1508 | <ul> |
---|
1509 | <li><code>void</code></li> |
---|
1510 | </ul> |
---|
1511 | </div> |
---|
1512 | </div> |
---|
1513 | </div> |
---|
1514 | </td> |
---|
1515 | <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDelta" href="output/Ext.dd.DD.html#setDelta">DD</a></td> |
---|
1516 | </tr> |
---|
1517 | <tr class="method-row inherited alt expandable"> |
---|
1518 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1519 | <td class="sig"> |
---|
1520 | <a id="Ext.dd.DragSource-setDragElId"></a> |
---|
1521 | <b>setDragElId</b>( <code>id {string}</code> ) : void <div class="mdesc"> |
---|
1522 | <div class="short">Allows you to specify that an element other than the linked element |
---|
1523 | will be moved with the cursor during a drag</div> |
---|
1524 | <div class="long"> |
---|
1525 | Allows you to specify that an element other than the linked element |
---|
1526 | will be moved with the cursor during a drag <div class="mdetail-params"> |
---|
1527 | <strong>Parameters:</strong> |
---|
1528 | <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> |
---|
1529 | <strong>Returns:</strong> |
---|
1530 | <ul> |
---|
1531 | <li><code>void</code></li> |
---|
1532 | </ul> |
---|
1533 | </div> |
---|
1534 | </div> |
---|
1535 | </div> |
---|
1536 | </td> |
---|
1537 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setDragElId" href="output/Ext.dd.DragDrop.html#setDragElId">DragDrop</a></td> |
---|
1538 | </tr> |
---|
1539 | <tr class="method-row inherited expandable"> |
---|
1540 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1541 | <td class="sig"> |
---|
1542 | <a id="Ext.dd.DragSource-setDragElPos"></a> |
---|
1543 | <b>setDragElPos</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc"> |
---|
1544 | <div class="short">Sets the drag element to the location of the mousedown or click event, |
---|
1545 | maintaining the cursor location relative to th...</div> |
---|
1546 | <div class="long"> |
---|
1547 | Sets the drag element to the location of the mousedown or click event, |
---|
1548 | maintaining the cursor location relative to the location on the element |
---|
1549 | that was clicked. Override this if you want to place the element in a |
---|
1550 | location other than where the cursor is. <div class="mdetail-params"> |
---|
1551 | <strong>Parameters:</strong> |
---|
1552 | <ul><li><code>iPageX</code> : int<div class="sub-desc">the X coordinate of the mousedown or drag event</div></li><li><code>iPageY</code> : int<div class="sub-desc">the Y coordinate of the mousedown or drag event</div></li> </ul> |
---|
1553 | <strong>Returns:</strong> |
---|
1554 | <ul> |
---|
1555 | <li><code>void</code></li> |
---|
1556 | </ul> |
---|
1557 | </div> |
---|
1558 | </div> |
---|
1559 | </div> |
---|
1560 | </td> |
---|
1561 | <td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDragElPos" href="output/Ext.dd.DD.html#setDragElPos">DD</a></td> |
---|
1562 | </tr> |
---|
1563 | <tr class="method-row inherited alt expandable"> |
---|
1564 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1565 | <td class="sig"> |
---|
1566 | <a id="Ext.dd.DragSource-setHandleElId"></a> |
---|
1567 | <b>setHandleElId</b>( <code>id {string}</code> ) : void <div class="mdesc"> |
---|
1568 | <div class="short">Allows you to specify a child of the linked element that should be |
---|
1569 | used to initiate the drag operation. An example o...</div> |
---|
1570 | <div class="long"> |
---|
1571 | Allows you to specify a child of the linked element that should be |
---|
1572 | used to initiate the drag operation. An example of this would be if |
---|
1573 | you have a content div with text and links. Clicking anywhere in the |
---|
1574 | content area would normally start the drag operation. Use this method |
---|
1575 | to specify that an element inside of the content div is the element |
---|
1576 | that starts the drag operation. <div class="mdetail-params"> |
---|
1577 | <strong>Parameters:</strong> |
---|
1578 | <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to |
---|
1579 | initiate the drag.</div></li> </ul> |
---|
1580 | <strong>Returns:</strong> |
---|
1581 | <ul> |
---|
1582 | <li><code>void</code></li> |
---|
1583 | </ul> |
---|
1584 | </div> |
---|
1585 | </div> |
---|
1586 | </div> |
---|
1587 | </td> |
---|
1588 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setHandleElId" href="output/Ext.dd.DragDrop.html#setHandleElId">DragDrop</a></td> |
---|
1589 | </tr> |
---|
1590 | <tr class="method-row inherited expandable"> |
---|
1591 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1592 | <td class="sig"> |
---|
1593 | <a id="Ext.dd.DragSource-setInitialPosition"></a> |
---|
1594 | <b>setInitialPosition</b>( <code>int diffX</code>, <code>int diffY</code> ) : void <div class="mdesc"> |
---|
1595 | <div class="short">Stores the initial placement of the linked element.</div> |
---|
1596 | <div class="long"> |
---|
1597 | Stores the initial placement of the linked element. <div class="mdetail-params"> |
---|
1598 | <strong>Parameters:</strong> |
---|
1599 | <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> |
---|
1600 | <strong>Returns:</strong> |
---|
1601 | <ul> |
---|
1602 | <li><code>void</code></li> |
---|
1603 | </ul> |
---|
1604 | </div> |
---|
1605 | </div> |
---|
1606 | </div> |
---|
1607 | </td> |
---|
1608 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setInitialPosition" href="output/Ext.dd.DragDrop.html#setInitialPosition">DragDrop</a></td> |
---|
1609 | </tr> |
---|
1610 | <tr class="method-row inherited alt expandable"> |
---|
1611 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1612 | <td class="sig"> |
---|
1613 | <a id="Ext.dd.DragSource-setOuterHandleElId"></a> |
---|
1614 | <b>setOuterHandleElId</b>( <code>id the</code> ) : void <div class="mdesc"> |
---|
1615 | <div class="short">Allows you to set an element outside of the linked element as a drag |
---|
1616 | handle</div> |
---|
1617 | <div class="long"> |
---|
1618 | Allows you to set an element outside of the linked element as a drag |
---|
1619 | handle <div class="mdetail-params"> |
---|
1620 | <strong>Parameters:</strong> |
---|
1621 | <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> |
---|
1622 | <strong>Returns:</strong> |
---|
1623 | <ul> |
---|
1624 | <li><code>void</code></li> |
---|
1625 | </ul> |
---|
1626 | </div> |
---|
1627 | </div> |
---|
1628 | </div> |
---|
1629 | </td> |
---|
1630 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setOuterHandleElId" href="output/Ext.dd.DragDrop.html#setOuterHandleElId">DragDrop</a></td> |
---|
1631 | </tr> |
---|
1632 | <tr class="method-row inherited expandable"> |
---|
1633 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1634 | <td class="sig"> |
---|
1635 | <a id="Ext.dd.DragSource-setPadding"></a> |
---|
1636 | <b>setPadding</b>( <code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code> ) : void <div class="mdesc"> |
---|
1637 | <div class="short">Configures the padding for the target zone in px. Effectively expands |
---|
1638 | (or reduces) the virtual object size for targe...</div> |
---|
1639 | <div class="long"> |
---|
1640 | Configures the padding for the target zone in px. Effectively expands |
---|
1641 | (or reduces) the virtual object size for targeting calculations. |
---|
1642 | Supports css-style shorthand; if only one parameter is passed, all sides |
---|
1643 | will have that padding, and if only two are passed, the top and bottom |
---|
1644 | will have the first param, the left and right the second. <div class="mdetail-params"> |
---|
1645 | <strong>Parameters:</strong> |
---|
1646 | <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> |
---|
1647 | <strong>Returns:</strong> |
---|
1648 | <ul> |
---|
1649 | <li><code>void</code></li> |
---|
1650 | </ul> |
---|
1651 | </div> |
---|
1652 | </div> |
---|
1653 | </div> |
---|
1654 | </td> |
---|
1655 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setPadding" href="output/Ext.dd.DragDrop.html#setPadding">DragDrop</a></td> |
---|
1656 | </tr> |
---|
1657 | <tr class="method-row inherited alt expandable"> |
---|
1658 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1659 | <td class="sig"> |
---|
1660 | <a id="Ext.dd.DragSource-setXConstraint"></a> |
---|
1661 | <b>setXConstraint</b>( <code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code> ) : void <div class="mdesc"> |
---|
1662 | <div class="short">By default, the element can be dragged any place on the screen. Use |
---|
1663 | this method to limit the horizontal travel of th...</div> |
---|
1664 | <div class="long"> |
---|
1665 | By default, the element can be dragged any place on the screen. Use |
---|
1666 | this method to limit the horizontal travel of the element. Pass in |
---|
1667 | 0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params"> |
---|
1668 | <strong>Parameters:</strong> |
---|
1669 | <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 |
---|
1670 | right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the |
---|
1671 | element |
---|
1672 | should move iTickSize pixels at a time.</div></li> </ul> |
---|
1673 | <strong>Returns:</strong> |
---|
1674 | <ul> |
---|
1675 | <li><code>void</code></li> |
---|
1676 | </ul> |
---|
1677 | </div> |
---|
1678 | </div> |
---|
1679 | </div> |
---|
1680 | </td> |
---|
1681 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setXConstraint" href="output/Ext.dd.DragDrop.html#setXConstraint">DragDrop</a></td> |
---|
1682 | </tr> |
---|
1683 | <tr class="method-row inherited expandable"> |
---|
1684 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1685 | <td class="sig"> |
---|
1686 | <a id="Ext.dd.DragSource-setYConstraint"></a> |
---|
1687 | <b>setYConstraint</b>( <code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code> ) : void <div class="mdesc"> |
---|
1688 | <div class="short">By default, the element can be dragged any place on the screen. Set |
---|
1689 | this to limit the vertical travel of the element...</div> |
---|
1690 | <div class="long"> |
---|
1691 | By default, the element can be dragged any place on the screen. Set |
---|
1692 | this to limit the vertical travel of the element. Pass in 0,0 for the |
---|
1693 | parameters if you want to lock the drag to the x axis. <div class="mdetail-params"> |
---|
1694 | <strong>Parameters:</strong> |
---|
1695 | <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 |
---|
1696 | element should move iTickSize pixels at a time.</div></li> </ul> |
---|
1697 | <strong>Returns:</strong> |
---|
1698 | <ul> |
---|
1699 | <li><code>void</code></li> |
---|
1700 | </ul> |
---|
1701 | </div> |
---|
1702 | </div> |
---|
1703 | </div> |
---|
1704 | </td> |
---|
1705 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setYConstraint" href="output/Ext.dd.DragDrop.html#setYConstraint">DragDrop</a></td> |
---|
1706 | </tr> |
---|
1707 | <tr class="method-row inherited alt expandable"> |
---|
1708 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1709 | <td class="sig"> |
---|
1710 | <a id="Ext.dd.DragSource-startDrag"></a> |
---|
1711 | <b>startDrag</b>( <code>int X</code>, <code>int Y</code> ) : void <div class="mdesc"> |
---|
1712 | <div class="short">Abstract method called after a drag/drop object is clicked |
---|
1713 | and the drag or mousedown time thresholds have beeen met.</div> |
---|
1714 | <div class="long"> |
---|
1715 | Abstract method called after a drag/drop object is clicked |
---|
1716 | and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params"> |
---|
1717 | <strong>Parameters:</strong> |
---|
1718 | <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> |
---|
1719 | <strong>Returns:</strong> |
---|
1720 | <ul> |
---|
1721 | <li><code>void</code></li> |
---|
1722 | </ul> |
---|
1723 | </div> |
---|
1724 | </div> |
---|
1725 | </div> |
---|
1726 | </td> |
---|
1727 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#startDrag" href="output/Ext.dd.DragDrop.html#startDrag">DragDrop</a></td> |
---|
1728 | </tr> |
---|
1729 | <tr class="method-row inherited expandable"> |
---|
1730 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1731 | <td class="sig"> |
---|
1732 | <a id="Ext.dd.DragSource-toString"></a> |
---|
1733 | <b>toString</b>() : string <div class="mdesc"> |
---|
1734 | <div class="short">toString method</div> |
---|
1735 | <div class="long"> |
---|
1736 | toString method <div class="mdetail-params"> |
---|
1737 | <strong>Parameters:</strong> |
---|
1738 | <ul><li>None.</li> </ul> |
---|
1739 | <strong>Returns:</strong> |
---|
1740 | <ul> |
---|
1741 | <li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li> |
---|
1742 | </ul> |
---|
1743 | </div> |
---|
1744 | </div> |
---|
1745 | </div> |
---|
1746 | </td> |
---|
1747 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#toString" href="output/Ext.dd.DragDrop.html#toString">DragDrop</a></td> |
---|
1748 | </tr> |
---|
1749 | <tr class="method-row inherited alt expandable"> |
---|
1750 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1751 | <td class="sig"> |
---|
1752 | <a id="Ext.dd.DragSource-unlock"></a> |
---|
1753 | <b>unlock</b>() : void <div class="mdesc"> |
---|
1754 | <div class="short">Unlock this instace</div> |
---|
1755 | <div class="long"> |
---|
1756 | Unlock this instace <div class="mdetail-params"> |
---|
1757 | <strong>Parameters:</strong> |
---|
1758 | <ul><li>None.</li> </ul> |
---|
1759 | <strong>Returns:</strong> |
---|
1760 | <ul> |
---|
1761 | <li><code>void</code></li> |
---|
1762 | </ul> |
---|
1763 | </div> |
---|
1764 | </div> |
---|
1765 | </div> |
---|
1766 | </td> |
---|
1767 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unlock" href="output/Ext.dd.DragDrop.html#unlock">DragDrop</a></td> |
---|
1768 | </tr> |
---|
1769 | <tr class="method-row inherited expandable"> |
---|
1770 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
1771 | <td class="sig"> |
---|
1772 | <a id="Ext.dd.DragSource-unreg"></a> |
---|
1773 | <b>unreg</b>() : void <div class="mdesc"> |
---|
1774 | <div class="short">Remove all drag and drop hooks for this element</div> |
---|
1775 | <div class="long"> |
---|
1776 | Remove all drag and drop hooks for this element <div class="mdetail-params"> |
---|
1777 | <strong>Parameters:</strong> |
---|
1778 | <ul><li>None.</li> </ul> |
---|
1779 | <strong>Returns:</strong> |
---|
1780 | <ul> |
---|
1781 | <li><code>void</code></li> |
---|
1782 | </ul> |
---|
1783 | </div> |
---|
1784 | </div> |
---|
1785 | </div> |
---|
1786 | </td> |
---|
1787 | <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unreg" href="output/Ext.dd.DragDrop.html#unreg">DragDrop</a></td> |
---|
1788 | </tr> |
---|
1789 | </table> |
---|
1790 | <a id="Ext.dd.DragSource-events"></a> |
---|
1791 | <h2>Public Events</h2> |
---|
1792 | <div class="no-members">This class has no public events.</div> |
---|
1793 | </div> |
---|