1
<div class="body-wrap">
2
<div class="top-tools">
3
<a class="inner-link" href="#Ext.grid.GridDragZone-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4
<a class="inner-link" href="#Ext.grid.GridDragZone-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5
<a class="inner-link" href="#Ext.grid.GridDragZone-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6
<a class="inner-link" href="#Ext.grid.GridDragZone-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7
<a class="bookmark" href="../docs/?class=Ext.grid.GridDragZone"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
9
<div class="inheritance res-block">
10
<pre class="res-block-inner"><a ext:cls="Ext.dd.DragDrop" ext:member="" href="output/Ext.dd.DragDrop.html">DragDrop</a>
11
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DD" ext:member="" href="output/Ext.dd.DD.html">DD</a>
12
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DDProxy" ext:member="" href="output/Ext.dd.DDProxy.html">DDProxy</a>
13
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DragSource" ext:member="" href="output/Ext.dd.DragSource.html">DragSource</a>
14
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DragZone" ext:member="" href="output/Ext.dd.DragZone.html">DragZone</a>
15
<img src="resources/elbow-end.gif"/>GridDragZone</pre></div>
16
<h1>Class Ext.grid.GridDragZone</h1>
17
<table cellspacing="0">
18
<tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
19
<tr><td class="label">Defined In:</td><td class="hd-info">GridDD.js</td></tr>
20
<tr><td class="label">Class:</td><td class="hd-info">GridDragZone</td></tr>
21
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.dd.DragZone" ext:member="" href="output/Ext.dd.DragZone.html">DragZone</a></td></tr>
23
<div class="description">
24
<p>A customized implementation of a <a ext:cls="Ext.dd.DragZone" href="output/Ext.dd.DragZone.html">DragZone</a> which provides default implementations of two of the
25
template methods of DragZone to enable dragging of the selected rows of a GridPanel.</p>
26
<p>A cooperating <a ext:cls="Ext.dd.DropZone" href="output/Ext.dd.DropZone.html">DropZone</a> must be created who's template method implementations of
27
<a ext:cls="Ext.dd.DropZone" ext:member="onNodeEnter" href="output/Ext.dd.DropZone.html#onNodeEnter">onNodeEnter</a>, <a ext:cls="Ext.dd.DropZone" ext:member="onNodeOver" href="output/Ext.dd.DropZone.html#onNodeOver">onNodeOver</a>,
28
<a ext:cls="Ext.dd.DropZone" ext:member="onNodeOut" href="output/Ext.dd.DropZone.html#onNodeOut">onNodeOut</a> and <a ext:cls="Ext.dd.DropZone" ext:member="onNodeDrop" href="output/Ext.dd.DropZone.html#onNodeDrop">onNodeDrop</a></p> are able
29
to process the <a ext:cls="Ext.grid.GridDragZone" ext:member="getDragData" href="output/Ext.grid.GridDragZone.html#getDragData">data</a> which is provided. </div>
31
<div class="hr"></div>
32
<a id="Ext.grid.GridDragZone-configs"></a>
33
<h2>Config Options</h2>
34
<table cellspacing="0" class="member-table">
36
<th class="sig-header" colspan="2">Config Options</th>
37
<th class="msource-header">Defined By</th>
39
<tr class="config-row inherited">
40
<td class="micon"><a class="exi" href="#expand"> </a></td>
42
<a id="Ext.grid.GridDragZone-containerScroll"></a>
43
<b>containerScroll</b> : Boolean <div class="mdesc">
44
True to register this container with the Scrollmanager for auto scrolling during drag operations. </div>
46
<td class="msource"><a ext:cls="Ext.dd.DragZone" ext:member="#containerScroll" href="output/Ext.dd.DragZone.html#containerScroll">DragZone</a></td>
48
<tr class="config-row inherited alt expandable">
49
<td class="micon"><a class="exi" href="#expand"> </a></td>
51
<a id="Ext.grid.GridDragZone-ddGroup"></a>
52
<b>ddGroup</b> : String <div class="mdesc">
53
<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>
55
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>
58
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#ddGroup" href="output/Ext.dd.DragSource.html#ddGroup">DragSource</a></td>
60
<tr class="config-row inherited">
61
<td class="micon"><a class="exi" href="#expand"> </a></td>
63
<a id="Ext.grid.GridDragZone-dropAllowed"></a>
64
<b>dropAllowed</b> : String <div class="mdesc">
65
The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). </div>
67
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#dropAllowed" href="output/Ext.dd.DragSource.html#dropAllowed">DragSource</a></td>
69
<tr class="config-row inherited alt">
70
<td class="micon"><a class="exi" href="#expand"> </a></td>
72
<a id="Ext.grid.GridDragZone-dropNotAllowed"></a>
73
<b>dropNotAllowed</b> : String <div class="mdesc">
74
The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div>
76
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#dropNotAllowed" href="output/Ext.dd.DragSource.html#dropNotAllowed">DragSource</a></td>
78
<tr class="config-row inherited expandable">
79
<td class="micon"><a class="exi" href="#expand"> </a></td>
81
<a id="Ext.grid.GridDragZone-hlColor"></a>
82
<b>hlColor</b> : String <div class="mdesc">
83
<div class="short">The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults t...</div>
85
The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults to "c3daf9" - light blue) </div>
88
<td class="msource"><a ext:cls="Ext.dd.DragZone" ext:member="#hlColor" href="output/Ext.dd.DragZone.html#hlColor">DragZone</a></td>
91
<a id="Ext.grid.GridDragZone-props"></a>
92
<h2>Public Properties</h2>
93
<table cellspacing="0" class="member-table">
95
<th class="sig-header" colspan="2">Property</th>
96
<th class="msource-header">Defined By</th>
98
<tr class="property-row inherited">
99
<td class="micon"><a class="exi" href="#expand"> </a></td>
101
<a id="Ext.grid.GridDragZone-available"></a>
102
<b>available</b> : boolean <div class="mdesc">
103
The availabe property is false until the linked dom element is accessible. </div>
105
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#available" href="output/Ext.dd.DragDrop.html#available">DragDrop</a></td>
107
<tr class="property-row inherited alt expandable">
108
<td class="micon"><a class="exi" href="#expand"> </a></td>
110
<a id="Ext.grid.GridDragZone-centerFrame"></a>
111
<b>centerFrame</b> : boolean <div class="mdesc">
112
<div class="short">By default the frame is positioned exactly where the drag element is, so
113
we use the cursor offset provided by Ext.dd....</div>
115
By default the frame is positioned exactly where the drag element is, so
116
we use the cursor offset provided by Ext.dd.DD. Another option that works only if
117
you do not have constraints on the obj is to have the drag frame centered
118
around the cursor. Set centerFrame to true for this effect. </div>
121
<td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#centerFrame" href="output/Ext.dd.DDProxy.html#centerFrame">DDProxy</a></td>
123
<tr class="property-row inherited">
124
<td class="micon"><a class="exi" href="#expand"> </a></td>
126
<a id="Ext.grid.GridDragZone-config"></a>
127
<b>config</b> : object <div class="mdesc">
128
Configuration attributes passed into the constructor </div>
130
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#config" href="output/Ext.dd.DragDrop.html#config">DragDrop</a></td>
132
<tr class="property-row inherited alt">
133
<td class="micon"><a class="exi" href="#expand"> </a></td>
135
<a id="Ext.grid.GridDragZone-defaultPadding"></a>
136
<b>defaultPadding</b> : Object <div class="mdesc">
137
Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). </div>
139
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#defaultPadding" href="output/Ext.dd.DragDrop.html#defaultPadding">DragDrop</a></td>
141
<tr class="property-row inherited expandable">
142
<td class="micon"><a class="exi" href="#expand"> </a></td>
144
<a id="Ext.grid.GridDragZone-groups"></a>
145
<b>groups</b> : object <div class="mdesc">
146
<div class="short">The group defines a logical collection of DragDrop objects that are
147
related. Instances only get events when interact...</div>
149
The group defines a logical collection of DragDrop objects that are
150
related. Instances only get events when interacting with other
151
DragDrop object in the same group. This lets us define multiple
152
groups using a single DragDrop subclass if we want. </div>
155
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#groups" href="output/Ext.dd.DragDrop.html#groups">DragDrop</a></td>
157
<tr class="property-row inherited alt expandable">
158
<td class="micon"><a class="exi" href="#expand"> </a></td>
160
<a id="Ext.grid.GridDragZone-hasOuterHandles"></a>
161
<b>hasOuterHandles</b> : boolean <div class="mdesc">
162
<div class="short">By default, drags can only be initiated if the mousedown occurs in the
163
region the linked element is. This is done in...</div>
165
By default, drags can only be initiated if the mousedown occurs in the
166
region the linked element is. This is done in part to work around a
167
bug in some browsers that mis-report the mousedown if the previous
168
mouseup happened outside of the window. This property is set to true
169
if outer handles are defined. </div>
172
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#hasOuterHandles" href="output/Ext.dd.DragDrop.html#hasOuterHandles">DragDrop</a></td>
174
<tr class="property-row inherited expandable">
175
<td class="micon"><a class="exi" href="#expand"> </a></td>
177
<a id="Ext.grid.GridDragZone-id"></a>
178
<b>id</b> : String <div class="mdesc">
179
<div class="short">The id of the element associated with this object. This is what we
180
refer to as the "linked element" because the size...</div>
182
The id of the element associated with this object. This is what we
183
refer to as the "linked element" because the size and position of
184
this element is used to determine when the drag and drop objects have
188
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#id" href="output/Ext.dd.DragDrop.html#id">DragDrop</a></td>
190
<tr class="property-row inherited alt">
191
<td class="micon"><a class="exi" href="#expand"> </a></td>
193
<a id="Ext.grid.GridDragZone-invalidHandleClasses"></a>
194
<b>invalidHandleClasses</b> : Array <div class="mdesc">
195
An Array of CSS class names for elements to be considered in valid as drag handles. </div>
197
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleClasses" href="output/Ext.dd.DragDrop.html#invalidHandleClasses">DragDrop</a></td>
199
<tr class="property-row inherited expandable">
200
<td class="micon"><a class="exi" href="#expand"> </a></td>
202
<a id="Ext.grid.GridDragZone-invalidHandleIds"></a>
203
<b>invalidHandleIds</b> : Object <div class="mdesc">
204
<div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles.
205
A non-null prop...</div>
207
An object who's property names identify the IDs of elements to be considered invalid as drag handles.
208
A non-null property value identifies the ID as invalid. For example, to prevent
209
dragging from being initiated on element ID "foo", use:<pre><code>{
211
}</code></pre> </div>
214
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleIds" href="output/Ext.dd.DragDrop.html#invalidHandleIds">DragDrop</a></td>
216
<tr class="property-row inherited alt expandable">
217
<td class="micon"><a class="exi" href="#expand"> </a></td>
219
<a id="Ext.grid.GridDragZone-invalidHandleTypes"></a>
220
<b>invalidHandleTypes</b> : Object <div class="mdesc">
221
<div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles.
222
A non-null property value...</div>
224
An object who's property names identify HTML tags to be considered invalid as drag handles.
225
A non-null property value identifies the tag as invalid. Defaults to the
226
following value which prevents drag operations from being initiated by <a> elements:<pre><code>{
228
}</code></pre> </div>
231
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleTypes" href="output/Ext.dd.DragDrop.html#invalidHandleTypes">DragDrop</a></td>
233
<tr class="property-row inherited">
234
<td class="micon"><a class="exi" href="#expand"> </a></td>
236
<a id="Ext.grid.GridDragZone-isTarget"></a>
237
<b>isTarget</b> : boolean <div class="mdesc">
238
By default, all instances can be a drop target. This can be disabled by
239
setting isTarget to false. </div>
241
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isTarget" href="output/Ext.dd.DragDrop.html#isTarget">DragDrop</a></td>
243
<tr class="property-row inherited alt expandable">
244
<td class="micon"><a class="exi" href="#expand"> </a></td>
246
<a id="Ext.grid.GridDragZone-maintainOffset"></a>
247
<b>maintainOffset</b> : boolean <div class="mdesc">
248
<div class="short">Maintain offsets when we resetconstraints. Set to true when you want
249
the position of the element relative to its par...</div>
251
Maintain offsets when we resetconstraints. Set to true when you want
252
the position of the element relative to its parent to stay the same
253
when the page changes </div>
256
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#maintainOffset" href="output/Ext.dd.DragDrop.html#maintainOffset">DragDrop</a></td>
258
<tr class="property-row inherited expandable">
259
<td class="micon"><a class="exi" href="#expand"> </a></td>
261
<a id="Ext.grid.GridDragZone-moveOnly"></a>
262
<b>moveOnly</b> : boolean <div class="mdesc">
263
<div class="short">When set to true, other DD objects in cooperating DDGroups do not receive
264
notification events when this DD object is ...</div>
266
When set to true, other DD objects in cooperating DDGroups do not receive
267
notification events when this DD object is dragged over them. Defaults to false. </div>
270
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#moveOnly" href="output/Ext.dd.DragDrop.html#moveOnly">DragDrop</a></td>
272
<tr class="property-row inherited alt expandable">
273
<td class="micon"><a class="exi" href="#expand"> </a></td>
275
<a id="Ext.grid.GridDragZone-onStartDrag"></a>
276
<b>onStartDrag</b> : Object <div class="mdesc">
277
<div class="short">An empty function by default, but provided so that you can perform a custom action once the initial
278
drag event has be...</div>
280
An empty function by default, but provided so that you can perform a custom action once the initial
281
drag event has begun. The drag cannot be canceled from this function. </div>
284
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#onStartDrag" href="output/Ext.dd.DragSource.html#onStartDrag">DragSource</a></td>
286
<tr class="property-row inherited">
287
<td class="micon"><a class="exi" href="#expand"> </a></td>
289
<a id="Ext.grid.GridDragZone-padding"></a>
290
<b>padding</b> : int[] <div class="mdesc">
291
The padding configured for this drag and drop object for calculating
292
the drop zone intersection with this object. </div>
294
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#padding" href="output/Ext.dd.DragDrop.html#padding">DragDrop</a></td>
296
<tr class="property-row inherited alt expandable">
297
<td class="micon"><a class="exi" href="#expand"> </a></td>
299
<a id="Ext.grid.GridDragZone-primaryButtonOnly"></a>
300
<b>primaryButtonOnly</b> : boolean <div class="mdesc">
301
<div class="short">By default the drag and drop instance will only respond to the primary
302
button click (left button for a right-handed m...</div>
304
By default the drag and drop instance will only respond to the primary
305
button click (left button for a right-handed mouse). Set to true to
306
allow drag and drop to start with any mouse click that is propogated
307
by the browser </div>
310
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#primaryButtonOnly" href="output/Ext.dd.DragDrop.html#primaryButtonOnly">DragDrop</a></td>
312
<tr class="property-row inherited expandable">
313
<td class="micon"><a class="exi" href="#expand"> </a></td>
315
<a id="Ext.grid.GridDragZone-resizeFrame"></a>
316
<b>resizeFrame</b> : boolean <div class="mdesc">
317
<div class="short">By default we resize the drag frame to be the same size as the element
318
we want to drag (this is to get the frame effe...</div>
320
By default we resize the drag frame to be the same size as the element
321
we want to drag (this is to get the frame effect). We can turn it off
322
if we want a different behavior. </div>
325
<td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#resizeFrame" href="output/Ext.dd.DDProxy.html#resizeFrame">DDProxy</a></td>
327
<tr class="property-row inherited alt expandable">
328
<td class="micon"><a class="exi" href="#expand"> </a></td>
330
<a id="Ext.grid.GridDragZone-scroll"></a>
331
<b>scroll</b> : boolean <div class="mdesc">
332
<div class="short">When set to true, the utility automatically tries to scroll the browser
333
window when a drag and drop element is dragge...</div>
335
When set to true, the utility automatically tries to scroll the browser
336
window when a drag and drop element is dragged near the viewport boundary.
337
Defaults to true. </div>
340
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#scroll" href="output/Ext.dd.DD.html#scroll">DD</a></td>
342
<tr class="property-row inherited expandable">
343
<td class="micon"><a class="exi" href="#expand"> </a></td>
345
<a id="Ext.grid.GridDragZone-xTicks"></a>
346
<b>xTicks</b> : int[] <div class="mdesc">
347
<div class="short">Array of pixel locations the element will snap to if we specified a
348
horizontal graduation/interval. This array is ge...</div>
350
Array of pixel locations the element will snap to if we specified a
351
horizontal graduation/interval. This array is generated automatically
352
when you define a tick interval. </div>
355
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#xTicks" href="output/Ext.dd.DragDrop.html#xTicks">DragDrop</a></td>
357
<tr class="property-row inherited alt expandable">
358
<td class="micon"><a class="exi" href="#expand"> </a></td>
360
<a id="Ext.grid.GridDragZone-yTicks"></a>
361
<b>yTicks</b> : int[] <div class="mdesc">
362
<div class="short">Array of pixel locations the element will snap to if we specified a
363
vertical graduation/interval. This array is gene...</div>
365
Array of pixel locations the element will snap to if we specified a
366
vertical graduation/interval. This array is generated automatically
367
when you define a tick interval. </div>
370
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#yTicks" href="output/Ext.dd.DragDrop.html#yTicks">DragDrop</a></td>
373
<a id="Ext.grid.GridDragZone-methods"></a>
374
<h2>Public Methods</h2>
375
<table cellspacing="0" class="member-table">
377
<th class="sig-header" colspan="2">Method</th>
378
<th class="msource-header">Defined By</th>
380
<tr class="method-row inherited expandable">
381
<td class="micon"><a class="exi" href="#expand"> </a></td>
383
<a id="Ext.grid.GridDragZone-addInvalidHandleClass"></a>
384
<b>addInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">
385
<div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
387
Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params">
388
<strong>Parameters:</strong>
389
<ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul>
390
<strong>Returns:</strong>
392
<li><code>void</code></li>
398
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleClass" href="output/Ext.dd.DragDrop.html#addInvalidHandleClass">DragDrop</a></td>
400
<tr class="method-row inherited alt expandable">
401
<td class="micon"><a class="exi" href="#expand"> </a></td>
403
<a id="Ext.grid.GridDragZone-addInvalidHandleId"></a>
404
<b>addInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">
405
<div class="short">Lets you to specify an element id for a child of a drag handle
406
that should not initiate a drag</div>
408
Lets you to specify an element id for a child of a drag handle
409
that should not initiate a drag <div class="mdetail-params">
410
<strong>Parameters:</strong>
411
<ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li> </ul>
412
<strong>Returns:</strong>
414
<li><code>void</code></li>
420
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleId" href="output/Ext.dd.DragDrop.html#addInvalidHandleId">DragDrop</a></td>
422
<tr class="method-row inherited expandable">
423
<td class="micon"><a class="exi" href="#expand"> </a></td>
425
<a id="Ext.grid.GridDragZone-addInvalidHandleType"></a>
426
<b>addInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">
427
<div class="short">Allows you to specify a tag name that should not start a drag operation
428
when clicked. This is designed to facilitate...</div>
430
Allows you to specify a tag name that should not start a drag operation
431
when clicked. This is designed to facilitate embedding links within a
432
drag handle that do something other than start the drag. <div class="mdetail-params">
433
<strong>Parameters:</strong>
434
<ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul>
435
<strong>Returns:</strong>
437
<li><code>void</code></li>
443
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleType" href="output/Ext.dd.DragDrop.html#addInvalidHandleType">DragDrop</a></td>
445
<tr class="method-row inherited alt expandable">
446
<td class="micon"><a class="exi" href="#expand"> </a></td>
448
<a id="Ext.grid.GridDragZone-addToGroup"></a>
449
<b>addToGroup</b>( <code>sGroup {string}</code> ) : void <div class="mdesc">
450
<div class="short">Add this instance to a group of related drag/drop objects. All
451
instances belong to at least one group, and can belon...</div>
453
Add this instance to a group of related drag/drop objects. All
454
instances belong to at least one group, and can belong to as many
455
groups as needed. <div class="mdetail-params">
456
<strong>Parameters:</strong>
457
<ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul>
458
<strong>Returns:</strong>
460
<li><code>void</code></li>
466
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addToGroup" href="output/Ext.dd.DragDrop.html#addToGroup">DragDrop</a></td>
468
<tr class="method-row inherited expandable">
469
<td class="micon"><a class="exi" href="#expand"> </a></td>
471
<a id="Ext.grid.GridDragZone-afterDragDrop"></a>
472
<b>afterDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
473
<div class="short">An empty function by default, but provided so that you can perform a custom action
474
after a valid drag drop has occurr...</div>
476
An empty function by default, but provided so that you can perform a custom action
477
after a valid drag drop has occurred by providing an implementation. <div class="mdetail-params">
478
<strong>Parameters:</strong>
479
<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>
480
<strong>Returns:</strong>
482
<li><code>void</code></li>
488
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragDrop" href="output/Ext.dd.DragSource.html#afterDragDrop">DragSource</a></td>
490
<tr class="method-row inherited alt expandable">
491
<td class="micon"><a class="exi" href="#expand"> </a></td>
493
<a id="Ext.grid.GridDragZone-afterDragEnter"></a>
494
<b>afterDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
495
<div class="short">An empty function by default, but provided so that you can perform a custom action
496
when the dragged item enters the d...</div>
498
An empty function by default, but provided so that you can perform a custom action
499
when the dragged item enters the drop target by providing an implementation. <div class="mdetail-params">
500
<strong>Parameters:</strong>
501
<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>
502
<strong>Returns:</strong>
504
<li><code>void</code></li>
510
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragEnter" href="output/Ext.dd.DragSource.html#afterDragEnter">DragSource</a></td>
512
<tr class="method-row inherited expandable">
513
<td class="micon"><a class="exi" href="#expand"> </a></td>
515
<a id="Ext.grid.GridDragZone-afterDragOut"></a>
516
<b>afterDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
517
<div class="short">An empty function by default, but provided so that you can perform a custom action
518
after the dragged item is dragged ...</div>
520
An empty function by default, but provided so that you can perform a custom action
521
after the dragged item is dragged out of the target without dropping. <div class="mdetail-params">
522
<strong>Parameters:</strong>
523
<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>
524
<strong>Returns:</strong>
526
<li><code>void</code></li>
532
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragOut" href="output/Ext.dd.DragSource.html#afterDragOut">DragSource</a></td>
534
<tr class="method-row inherited alt expandable">
535
<td class="micon"><a class="exi" href="#expand"> </a></td>
537
<a id="Ext.grid.GridDragZone-afterDragOver"></a>
538
<b>afterDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
539
<div class="short">An empty function by default, but provided so that you can perform a custom action
540
while the dragged item is over the...</div>
542
An empty function by default, but provided so that you can perform a custom action
543
while the dragged item is over the drop target by providing an implementation. <div class="mdetail-params">
544
<strong>Parameters:</strong>
545
<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>
546
<strong>Returns:</strong>
548
<li><code>void</code></li>
554
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragOver" href="output/Ext.dd.DragSource.html#afterDragOver">DragSource</a></td>
556
<tr class="method-row inherited expandable">
557
<td class="micon"><a class="exi" href="#expand"> </a></td>
559
<a id="Ext.grid.GridDragZone-afterInvalidDrop"></a>
560
<b>afterInvalidDrop</b>( <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc">
561
<div class="short">An empty function by default, but provided so that you can perform a custom action
562
after an invalid drop has occurred...</div>
564
An empty function by default, but provided so that you can perform a custom action
565
after an invalid drop has occurred by providing an implementation. <div class="mdetail-params">
566
<strong>Parameters:</strong>
567
<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>
568
<strong>Returns:</strong>
570
<li><code>void</code></li>
576
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterInvalidDrop" href="output/Ext.dd.DragSource.html#afterInvalidDrop">DragSource</a></td>
578
<tr class="method-row alt expandable">
579
<td class="micon"><a class="exi" href="#expand"> </a></td>
581
<a id="Ext.grid.GridDragZone-afterRepair"></a>
582
<b>afterRepair</b>() : void <div class="mdesc">
583
<div class="short">An empty immplementation. Implement this to provide behaviour after a repair of an invalid drop. An implementation mi...</div>
585
An empty immplementation. Implement this to provide behaviour after a repair of an invalid drop. An implementation might highlight
586
the selected rows to show that they have not been dragged. <div class="mdetail-params">
587
<strong>Parameters:</strong>
588
<ul><li>None.</li> </ul>
589
<strong>Returns:</strong>
591
<li><code>void</code></li>
597
<td class="msource">GridDragZone</td>
599
<tr class="method-row inherited expandable">
600
<td class="micon"><a class="exi" href="#expand"> </a></td>
602
<a id="Ext.grid.GridDragZone-alignElWithMouse"></a>
603
<b>alignElWithMouse</b>( <code>HTMLElement el</code>, <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
604
<div class="short">Sets the element to the location of the mousedown or click event,
605
maintaining the cursor location relative to the loc...</div>
607
Sets the element to the location of the mousedown or click event,
608
maintaining the cursor location relative to the location on the element
609
that was clicked. Override this if you want to place the element in a
610
location other than where the cursor is. <div class="mdetail-params">
611
<strong>Parameters:</strong>
612
<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>
613
<strong>Returns:</strong>
615
<li><code>void</code></li>
621
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#alignElWithMouse" href="output/Ext.dd.DD.html#alignElWithMouse">DD</a></td>
623
<tr class="method-row inherited alt expandable">
624
<td class="micon"><a class="exi" href="#expand"> </a></td>
626
<a id="Ext.grid.GridDragZone-applyConfig"></a>
627
<b>applyConfig</b>() : void <div class="mdesc">
628
<div class="short">Applies the configuration parameters that were passed into the constructor.
629
This is supposed to happen at each level ...</div>
631
Applies the configuration parameters that were passed into the constructor.
632
This is supposed to happen at each level through the inheritance chain. So
633
a DDProxy implentation will execute apply config on DDProxy, DD, and
634
DragDrop in order to get all of the parameters that are available in
635
each object. <div class="mdetail-params">
636
<strong>Parameters:</strong>
637
<ul><li>None.</li> </ul>
638
<strong>Returns:</strong>
640
<li><code>void</code></li>
646
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#applyConfig" href="output/Ext.dd.DragDrop.html#applyConfig">DragDrop</a></td>
648
<tr class="method-row inherited expandable">
649
<td class="micon"><a class="exi" href="#expand"> </a></td>
651
<a id="Ext.grid.GridDragZone-autoOffset"></a>
652
<b>autoOffset</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
653
<div class="short">Sets the pointer offset to the distance between the linked element's top
654
left corner and the location the element was...</div>
656
Sets the pointer offset to the distance between the linked element's top
657
left corner and the location the element was clicked <div class="mdetail-params">
658
<strong>Parameters:</strong>
659
<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>
660
<strong>Returns:</strong>
662
<li><code>void</code></li>
668
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#autoOffset" href="output/Ext.dd.DD.html#autoOffset">DD</a></td>
670
<tr class="method-row inherited alt expandable">
671
<td class="micon"><a class="exi" href="#expand"> </a></td>
673
<a id="Ext.grid.GridDragZone-b4Drag"></a>
674
<b>b4Drag</b>() : void <div class="mdesc">
675
<div class="short">Event that fires prior to the onDrag event. Overrides
676
Ext.dd.DragDrop.</div>
678
Event that fires prior to the onDrag event. Overrides
679
Ext.dd.DragDrop. <div class="mdetail-params">
680
<strong>Parameters:</strong>
681
<ul><li>None.</li> </ul>
682
<strong>Returns:</strong>
684
<li><code>void</code></li>
690
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4Drag" href="output/Ext.dd.DD.html#b4Drag">DD</a></td>
692
<tr class="method-row inherited expandable">
693
<td class="micon"><a class="exi" href="#expand"> </a></td>
695
<a id="Ext.grid.GridDragZone-b4MouseDown"></a>
696
<b>b4MouseDown</b>() : void <div class="mdesc">
697
<div class="short">Event that fires prior to the onMouseDown event. Overrides
698
Ext.dd.DragDrop.</div>
700
Event that fires prior to the onMouseDown event. Overrides
701
Ext.dd.DragDrop. <div class="mdetail-params">
702
<strong>Parameters:</strong>
703
<ul><li>None.</li> </ul>
704
<strong>Returns:</strong>
706
<li><code>void</code></li>
712
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#b4MouseDown" href="output/Ext.dd.DD.html#b4MouseDown">DD</a></td>
714
<tr class="method-row inherited alt expandable">
715
<td class="micon"><a class="exi" href="#expand"> </a></td>
717
<a id="Ext.grid.GridDragZone-beforeDragDrop"></a>
718
<b>beforeDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
719
<div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
720
item is dropped...</div>
722
An empty function by default, but provided so that you can perform a custom action before the dragged
723
item is dropped onto the target and optionally cancel the onDragDrop. <div class="mdetail-params">
724
<strong>Parameters:</strong>
725
<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>
726
<strong>Returns:</strong>
728
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag drop event is valid, else false to cancel</div></li>
734
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragDrop" href="output/Ext.dd.DragSource.html#beforeDragDrop">DragSource</a></td>
736
<tr class="method-row inherited expandable">
737
<td class="micon"><a class="exi" href="#expand"> </a></td>
739
<a id="Ext.grid.GridDragZone-beforeDragEnter"></a>
740
<b>beforeDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
741
<div class="short">An empty function by default, but provided so that you can perform a custom action
742
before the dragged item enters the...</div>
744
An empty function by default, but provided so that you can perform a custom action
745
before the dragged item enters the drop target and optionally cancel the onDragEnter. <div class="mdetail-params">
746
<strong>Parameters:</strong>
747
<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>
748
<strong>Returns:</strong>
750
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
756
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragEnter" href="output/Ext.dd.DragSource.html#beforeDragEnter">DragSource</a></td>
758
<tr class="method-row inherited alt expandable">
759
<td class="micon"><a class="exi" href="#expand"> </a></td>
761
<a id="Ext.grid.GridDragZone-beforeDragOut"></a>
762
<b>beforeDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
763
<div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
764
item is dragged...</div>
766
An empty function by default, but provided so that you can perform a custom action before the dragged
767
item is dragged out of the target without dropping, and optionally cancel the onDragOut. <div class="mdetail-params">
768
<strong>Parameters:</strong>
769
<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>
770
<strong>Returns:</strong>
772
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
778
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragOut" href="output/Ext.dd.DragSource.html#beforeDragOut">DragSource</a></td>
780
<tr class="method-row inherited expandable">
781
<td class="micon"><a class="exi" href="#expand"> </a></td>
783
<a id="Ext.grid.GridDragZone-beforeDragOver"></a>
784
<b>beforeDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
785
<div class="short">An empty function by default, but provided so that you can perform a custom action
786
while the dragged item is over the...</div>
788
An empty function by default, but provided so that you can perform a custom action
789
while the dragged item is over the drop target and optionally cancel the onDragOver. <div class="mdetail-params">
790
<strong>Parameters:</strong>
791
<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>
792
<strong>Returns:</strong>
794
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
800
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragOver" href="output/Ext.dd.DragSource.html#beforeDragOver">DragSource</a></td>
802
<tr class="method-row inherited alt expandable">
803
<td class="micon"><a class="exi" href="#expand"> </a></td>
805
<a id="Ext.grid.GridDragZone-beforeInvalidDrop"></a>
806
<b>beforeInvalidDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc">
807
<div class="short">An empty function by default, but provided so that you can perform a custom action after an invalid
808
drop has occurred.</div>
810
An empty function by default, but provided so that you can perform a custom action after an invalid
811
drop has occurred. <div class="mdetail-params">
812
<strong>Parameters:</strong>
813
<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>
814
<strong>Returns:</strong>
816
<li><code>Boolean</code><div class="sub-desc">isValid True if the invalid drop should proceed, else false to cancel</div></li>
822
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeInvalidDrop" href="output/Ext.dd.DragSource.html#beforeInvalidDrop">DragSource</a></td>
824
<tr class="method-row inherited expandable">
825
<td class="micon"><a class="exi" href="#expand"> </a></td>
827
<a id="Ext.grid.GridDragZone-cachePosition"></a>
828
<b>cachePosition</b>( <code>iPageX the</code>, <code>iPageY the</code> ) : void <div class="mdesc">
829
<div class="short">Saves the most recent position so that we can reset the constraints and
830
tick marks on-demand. We need to know this s...</div>
832
Saves the most recent position so that we can reset the constraints and
833
tick marks on-demand. We need to know this so that we can calculate the
834
number of pixels the element is offset from its original position. <div class="mdetail-params">
835
<strong>Parameters:</strong>
836
<ul><li><code>the</code> : iPageX<div class="sub-desc">current x position (optional, this just makes it so we
837
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
838
don't have to look it up again)</div></li> </ul>
839
<strong>Returns:</strong>
841
<li><code>void</code></li>
847
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#cachePosition" href="output/Ext.dd.DD.html#cachePosition">DD</a></td>
849
<tr class="method-row inherited alt expandable">
850
<td class="micon"><a class="exi" href="#expand"> </a></td>
852
<a id="Ext.grid.GridDragZone-clearConstraints"></a>
853
<b>clearConstraints</b>() : void <div class="mdesc">
854
<div class="short">Clears any constraints applied to this instance. Also clears ticks
855
since they can't exist independent of a constrain...</div>
857
Clears any constraints applied to this instance. Also clears ticks
858
since they can't exist independent of a constraint at this time. <div class="mdetail-params">
859
<strong>Parameters:</strong>
860
<ul><li>None.</li> </ul>
861
<strong>Returns:</strong>
863
<li><code>void</code></li>
869
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearConstraints" href="output/Ext.dd.DragDrop.html#clearConstraints">DragDrop</a></td>
871
<tr class="method-row inherited expandable">
872
<td class="micon"><a class="exi" href="#expand"> </a></td>
874
<a id="Ext.grid.GridDragZone-clearTicks"></a>
875
<b>clearTicks</b>() : void <div class="mdesc">
876
<div class="short">Clears any tick interval defined for this instance</div>
878
Clears any tick interval defined for this instance <div class="mdetail-params">
879
<strong>Parameters:</strong>
880
<ul><li>None.</li> </ul>
881
<strong>Returns:</strong>
883
<li><code>void</code></li>
889
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearTicks" href="output/Ext.dd.DragDrop.html#clearTicks">DragDrop</a></td>
891
<tr class="method-row inherited alt expandable">
892
<td class="micon"><a class="exi" href="#expand"> </a></td>
894
<a id="Ext.grid.GridDragZone-constrainTo"></a>
895
<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">
896
<div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element.
898
var dd = new Ext.d...</div>
900
Initializes the drag drop object's constraints to restrict movement to a certain element.
902
<pre><code>var dd = <b>new</b> Ext.dd.DDProxy(<em>"dragDiv1"</em>, <em>"proxytest"</em>,
903
{ dragElId: <em>"existingProxyDiv"</em> });
904
dd.startDrag = <b>function</b>(){
905
<b>this</b>.constrainTo(<em>"parent-id"</em>);
907
Or you can initalize it using the <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object:
908
<pre><code>Ext.get(<em>"dragDiv1"</em>).initDDProxy(<em>"proxytest"</em>, {dragElId: <em>"existingProxyDiv"</em>}, {
909
startDrag : <b>function</b>(){
910
<b>this</b>.constrainTo(<em>"parent-id"</em>);
912
});</code></pre> <div class="mdetail-params">
913
<strong>Parameters:</strong>
914
<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,
915
and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
916
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>
917
<strong>Returns:</strong>
919
<li><code>void</code></li>
925
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#constrainTo" href="output/Ext.dd.DragDrop.html#constrainTo">DragDrop</a></td>
927
<tr class="method-row inherited expandable">
928
<td class="micon"><a class="exi" href="#expand"> </a></td>
930
<a id="Ext.grid.GridDragZone-createFrame"></a>
931
<b>createFrame</b>() : void <div class="mdesc">
932
<div class="short">Creates the proxy element if it does not yet exist</div>
934
Creates the proxy element if it does not yet exist <div class="mdetail-params">
935
<strong>Parameters:</strong>
936
<ul><li>None.</li> </ul>
937
<strong>Returns:</strong>
939
<li><code>void</code></li>
945
<td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#createFrame" href="output/Ext.dd.DDProxy.html#createFrame">DDProxy</a></td>
947
<tr class="method-row inherited alt expandable">
948
<td class="micon"><a class="exi" href="#expand"> </a></td>
950
<a id="Ext.grid.GridDragZone-endDrag"></a>
951
<b>endDrag</b>( <code>Event e</code> ) : void <div class="mdesc">
952
<div class="short">Fired when we are done dragging the object</div>
954
Fired when we are done dragging the object <div class="mdetail-params">
955
<strong>Parameters:</strong>
956
<ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
957
<strong>Returns:</strong>
959
<li><code>void</code></li>
965
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#endDrag" href="output/Ext.dd.DragDrop.html#endDrag">DragDrop</a></td>
967
<tr class="method-row expandable">
968
<td class="micon"><a class="exi" href="#expand"> </a></td>
970
<a id="Ext.grid.GridDragZone-getDragData"></a>
971
<b>getDragData</b>() : void <div class="mdesc">
972
<div class="short">The provided implementation of the getDragData method which collects the data to be dragged from the GridPanel on mou...</div>
974
<p>The provided implementation of the getDragData method which collects the data to be dragged from the GridPanel on mousedown.</p>
975
<p>This data is available for processing in the <a ext:cls="Ext.dd.DropZone" ext:member="onNodeEnter" href="output/Ext.dd.DropZone.html#onNodeEnter">onNodeEnter</a>, <a ext:cls="Ext.dd.DropZone" ext:member="onNodeOver" href="output/Ext.dd.DropZone.html#onNodeOver">onNodeOver</a>,
976
<a ext:cls="Ext.dd.DropZone" ext:member="onNodeOut" href="output/Ext.dd.DropZone.html#onNodeOut">onNodeOut</a> and <a ext:cls="Ext.dd.DropZone" ext:member="onNodeDrop" href="output/Ext.dd.DropZone.html#onNodeDrop">onNodeDrop</a> methods of a cooperating <a ext:cls="Ext.dd.DropZone" href="output/Ext.dd.DropZone.html">DropZone</a>.</p>
977
<p>The data object contains the following properties:<ul>
978
<li><b>grid</b> : Ext.Grid.GridPanel<div class="sub-desc">The GridPanel from which the data is being dragged.</div></li>
979
<li><b>ddel</b> : htmlElement<div class="sub-desc">An htmlElement which provides the "picture" of the data being dragged.</div></li>
980
<li><b>rowIndex</b> : Number<div class="sub-desc">The index of the row which receieved the mousedown gesture which triggered the drag.</div></li>
981
<li><b>selections</b> : Array<div class="sub-desc">An Array of the selected Records which are being dragged from the GridPanel.</div></li>
982
</ul></p> <div class="mdetail-params">
983
<strong>Parameters:</strong>
984
<ul><li>None.</li> </ul>
985
<strong>Returns:</strong>
987
<li><code>void</code></li>
993
<td class="msource">GridDragZone</td>
995
<tr class="method-row inherited alt expandable">
996
<td class="micon"><a class="exi" href="#expand"> </a></td>
998
<a id="Ext.grid.GridDragZone-getDragEl"></a>
999
<b>getDragEl</b>() : HTMLElement <div class="mdesc">
1000
<div class="short">Returns a reference to the actual element to drag. By default this is
1001
the same as the html element, but it can be as...</div>
1003
Returns a reference to the actual element to drag. By default this is
1004
the same as the html element, but it can be assigned to another
1005
element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params">
1006
<strong>Parameters:</strong>
1007
<ul><li>None.</li> </ul>
1008
<strong>Returns:</strong>
1010
<li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
1016
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getDragEl" href="output/Ext.dd.DragDrop.html#getDragEl">DragDrop</a></td>
1018
<tr class="method-row inherited expandable">
1019
<td class="micon"><a class="exi" href="#expand"> </a></td>
1021
<a id="Ext.grid.GridDragZone-getEl"></a>
1022
<b>getEl</b>() : HTMLElement <div class="mdesc">
1023
<div class="short">Returns a reference to the linked element</div>
1025
Returns a reference to the linked element <div class="mdetail-params">
1026
<strong>Parameters:</strong>
1027
<ul><li>None.</li> </ul>
1028
<strong>Returns:</strong>
1030
<li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
1036
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getEl" href="output/Ext.dd.DragDrop.html#getEl">DragDrop</a></td>
1038
<tr class="method-row inherited alt expandable">
1039
<td class="micon"><a class="exi" href="#expand"> </a></td>
1041
<a id="Ext.grid.GridDragZone-getProxy"></a>
1042
<b>getProxy</b>() : Ext.dd.StatusProxy <div class="mdesc">
1043
<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>
1045
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">
1046
<strong>Parameters:</strong>
1047
<ul><li>None.</li> </ul>
1048
<strong>Returns:</strong>
1050
<li><code>Ext.dd.StatusProxy</code><div class="sub-desc">proxy The StatusProxy</div></li>
1056
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#getProxy" href="output/Ext.dd.DragSource.html#getProxy">DragSource</a></td>
1058
<tr class="method-row expandable">
1059
<td class="micon"><a class="exi" href="#expand"> </a></td>
1061
<a id="Ext.grid.GridDragZone-getRepairXY"></a>
1062
<b>getRepairXY</b>( <code>EventObject e</code> ) : Array <div class="mdesc">
1063
<div class="short">An empty implementation. Implement this to provide coordinates for the drag proxy to slide back to after an invalid d...</div>
1065
<p>An empty implementation. Implement this to provide coordinates for the drag proxy to slide back to after an invalid drop.</p>
1066
<p>Called before a repair of an invalid drop to get the XY to animate to.</p> <div class="mdetail-params">
1067
<strong>Parameters:</strong>
1068
<ul><li><code>e</code> : EventObject<div class="sub-desc">The mouse up event</div></li> </ul>
1069
<strong>Returns:</strong>
1071
<li><code>Array</code><div class="sub-desc">The xy location (e.g. [100, 200])</div></li>
1077
<td class="msource">GridDragZone</td>
1079
<tr class="method-row inherited alt expandable">
1080
<td class="micon"><a class="exi" href="#expand"> </a></td>
1082
<a id="Ext.grid.GridDragZone-hideProxy"></a>
1083
<b>hideProxy</b>() : void <div class="mdesc">
1084
<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>
1086
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">
1087
<strong>Parameters:</strong>
1088
<ul><li>None.</li> </ul>
1089
<strong>Returns:</strong>
1091
<li><code>void</code></li>
1097
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#hideProxy" href="output/Ext.dd.DragSource.html#hideProxy">DragSource</a></td>
1099
<tr class="method-row inherited expandable">
1100
<td class="micon"><a class="exi" href="#expand"> </a></td>
1102
<a id="Ext.grid.GridDragZone-init"></a>
1103
<b>init</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">
1104
<div class="short">Sets up the DragDrop object. Must be called in the constructor of any
1105
Ext.dd.DragDrop subclass</div>
1107
Sets up the DragDrop object. Must be called in the constructor of any
1108
Ext.dd.DragDrop subclass <div class="mdetail-params">
1109
<strong>Parameters:</strong>
1110
<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>
1111
<strong>Returns:</strong>
1113
<li><code>void</code></li>
1119
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#init" href="output/Ext.dd.DragDrop.html#init">DragDrop</a></td>
1121
<tr class="method-row inherited alt expandable">
1122
<td class="micon"><a class="exi" href="#expand"> </a></td>
1124
<a id="Ext.grid.GridDragZone-initFrame"></a>
1125
<b>initFrame</b>() : void <div class="mdesc">
1126
<div class="short">Initialization for the drag frame element. Must be called in the
1127
constructor of all subclasses</div>
1129
Initialization for the drag frame element. Must be called in the
1130
constructor of all subclasses <div class="mdetail-params">
1131
<strong>Parameters:</strong>
1132
<ul><li>None.</li> </ul>
1133
<strong>Returns:</strong>
1135
<li><code>void</code></li>
1141
<td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#initFrame" href="output/Ext.dd.DDProxy.html#initFrame">DDProxy</a></td>
1143
<tr class="method-row inherited expandable">
1144
<td class="micon"><a class="exi" href="#expand"> </a></td>
1146
<a id="Ext.grid.GridDragZone-initTarget"></a>
1147
<b>initTarget</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc">
1148
<div class="short">Initializes Targeting functionality only... the object does not
1149
get a mousedown handler.</div>
1151
Initializes Targeting functionality only... the object does not
1152
get a mousedown handler. <div class="mdetail-params">
1153
<strong>Parameters:</strong>
1154
<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>
1155
<strong>Returns:</strong>
1157
<li><code>void</code></li>
1163
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#initTarget" href="output/Ext.dd.DragDrop.html#initTarget">DragDrop</a></td>
1165
<tr class="method-row inherited alt expandable">
1166
<td class="micon"><a class="exi" href="#expand"> </a></td>
1168
<a id="Ext.grid.GridDragZone-isLocked"></a>
1169
<b>isLocked</b>() : boolean <div class="mdesc">
1170
<div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
1171
(meaning that all drag/drop is disabled on th...</div>
1173
Returns true if this instance is locked, or the drag drop mgr is locked
1174
(meaning that all drag/drop is disabled on the page.) <div class="mdetail-params">
1175
<strong>Parameters:</strong>
1176
<ul><li>None.</li> </ul>
1177
<strong>Returns:</strong>
1179
<li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li>
1185
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isLocked" href="output/Ext.dd.DragDrop.html#isLocked">DragDrop</a></td>
1187
<tr class="method-row inherited expandable">
1188
<td class="micon"><a class="exi" href="#expand"> </a></td>
1190
<a id="Ext.grid.GridDragZone-isValidHandleChild"></a>
1191
<b>isValidHandleChild</b>( <code>HTMLElement node</code> ) : boolean <div class="mdesc">
1192
<div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1194
Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params">
1195
<strong>Parameters:</strong>
1196
<ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul>
1197
<strong>Returns:</strong>
1199
<li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li>
1205
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isValidHandleChild" href="output/Ext.dd.DragDrop.html#isValidHandleChild">DragDrop</a></td>
1207
<tr class="method-row inherited alt expandable">
1208
<td class="micon"><a class="exi" href="#expand"> </a></td>
1210
<a id="Ext.grid.GridDragZone-lock"></a>
1211
<b>lock</b>() : void <div class="mdesc">
1212
<div class="short">Lock this instance</div>
1214
Lock this instance <div class="mdetail-params">
1215
<strong>Parameters:</strong>
1216
<ul><li>None.</li> </ul>
1217
<strong>Returns:</strong>
1219
<li><code>void</code></li>
1225
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#lock" href="output/Ext.dd.DragDrop.html#lock">DragDrop</a></td>
1227
<tr class="method-row inherited expandable">
1228
<td class="micon"><a class="exi" href="#expand"> </a></td>
1230
<a id="Ext.grid.GridDragZone-onAvailable"></a>
1231
<b>onAvailable</b>() : void <div class="mdesc">
1232
<div class="short">Override the onAvailable method to do what is needed after the initial
1233
position was determined.</div>
1235
Override the onAvailable method to do what is needed after the initial
1236
position was determined. <div class="mdetail-params">
1237
<strong>Parameters:</strong>
1238
<ul><li>None.</li> </ul>
1239
<strong>Returns:</strong>
1241
<li><code>void</code></li>
1247
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onAvailable" href="output/Ext.dd.DragDrop.html#onAvailable">DragDrop</a></td>
1249
<tr class="method-row inherited alt expandable">
1250
<td class="micon"><a class="exi" href="#expand"> </a></td>
1252
<a id="Ext.grid.GridDragZone-onBeforeDrag"></a>
1253
<b>onBeforeDrag</b>( <code>Object data</code>, <code>Event e</code> ) : Boolean <div class="mdesc">
1254
<div class="short">An empty function by default, but provided so that you can perform a custom action before the initial
1255
drag event begi...</div>
1257
An empty function by default, but provided so that you can perform a custom action before the initial
1258
drag event begins and optionally cancel it. <div class="mdetail-params">
1259
<strong>Parameters:</strong>
1260
<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>
1261
<strong>Returns:</strong>
1263
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li>
1269
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#onBeforeDrag" href="output/Ext.dd.DragSource.html#onBeforeDrag">DragSource</a></td>
1271
<tr class="method-row inherited expandable">
1272
<td class="micon"><a class="exi" href="#expand"> </a></td>
1274
<a id="Ext.grid.GridDragZone-onDrag"></a>
1275
<b>onDrag</b>( <code>Event e</code> ) : void <div class="mdesc">
1276
<div class="short">Abstract method called during the onMouseMove event while dragging an
1279
Abstract method called during the onMouseMove event while dragging an
1280
object. <div class="mdetail-params">
1281
<strong>Parameters:</strong>
1282
<ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul>
1283
<strong>Returns:</strong>
1285
<li><code>void</code></li>
1291
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDrag" href="output/Ext.dd.DragDrop.html#onDrag">DragDrop</a></td>
1293
<tr class="method-row inherited alt expandable">
1294
<td class="micon"><a class="exi" href="#expand"> </a></td>
1296
<a id="Ext.grid.GridDragZone-onDragDrop"></a>
1297
<b>onDragDrop</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
1298
<div class="short">Abstract method called when this item is dropped on another DragDrop
1301
Abstract method called when this item is dropped on another DragDrop
1302
obj <div class="mdetail-params">
1303
<strong>Parameters:</strong>
1304
<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
1305
id this was dropped on. In INTERSECT mode, an array of dd items this
1306
was dropped on.</div></li> </ul>
1307
<strong>Returns:</strong>
1309
<li><code>void</code></li>
1315
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragDrop" href="output/Ext.dd.DragDrop.html#onDragDrop">DragDrop</a></td>
1317
<tr class="method-row inherited expandable">
1318
<td class="micon"><a class="exi" href="#expand"> </a></td>
1320
<a id="Ext.grid.GridDragZone-onDragEnter"></a>
1321
<b>onDragEnter</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
1322
<div class="short">Abstract method called when this element fist begins hovering over
1323
another DragDrop obj</div>
1325
Abstract method called when this element fist begins hovering over
1326
another DragDrop obj <div class="mdetail-params">
1327
<strong>Parameters:</strong>
1328
<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
1329
id this is hovering over. In INTERSECT mode, an array of one or more
1330
dragdrop items being hovered over.</div></li> </ul>
1331
<strong>Returns:</strong>
1333
<li><code>void</code></li>
1339
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragEnter" href="output/Ext.dd.DragDrop.html#onDragEnter">DragDrop</a></td>
1341
<tr class="method-row inherited alt expandable">
1342
<td class="micon"><a class="exi" href="#expand"> </a></td>
1344
<a id="Ext.grid.GridDragZone-onDragOut"></a>
1345
<b>onDragOut</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
1346
<div class="short">Abstract method called when we are no longer hovering over an element</div>
1348
Abstract method called when we are no longer hovering over an element <div class="mdetail-params">
1349
<strong>Parameters:</strong>
1350
<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
1351
id this was hovering over. In INTERSECT mode, an array of dd items
1352
that the mouse is no longer over.</div></li> </ul>
1353
<strong>Returns:</strong>
1355
<li><code>void</code></li>
1361
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOut" href="output/Ext.dd.DragDrop.html#onDragOut">DragDrop</a></td>
1363
<tr class="method-row inherited expandable">
1364
<td class="micon"><a class="exi" href="#expand"> </a></td>
1366
<a id="Ext.grid.GridDragZone-onDragOver"></a>
1367
<b>onDragOver</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc">
1368
<div class="short">Abstract method called when this element is hovering over another
1371
Abstract method called when this element is hovering over another
1372
DragDrop obj <div class="mdetail-params">
1373
<strong>Parameters:</strong>
1374
<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
1375
id this is hovering over. In INTERSECT mode, an array of dd items
1376
being hovered over.</div></li> </ul>
1377
<strong>Returns:</strong>
1379
<li><code>void</code></li>
1385
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOver" href="output/Ext.dd.DragDrop.html#onDragOver">DragDrop</a></td>
1387
<tr class="method-row alt expandable">
1388
<td class="micon"><a class="exi" href="#expand"> </a></td>
1390
<a id="Ext.grid.GridDragZone-onInitDrag"></a>
1391
<b>onInitDrag</b>() : void <div class="mdesc">
1392
<div class="short">The provided implementation of the onInitDrag method. Sets the innerHTML of the drag proxy which provides the "pictur...</div>
1394
<p>The provided implementation of the onInitDrag method. Sets the <tt>innerHTML</tt> of the drag proxy which provides the "picture"
1395
of the data being dragged.</p>
1396
<p>The <tt>innerHTML</tt> data is found by calling the owning GridPanel's <a ext:cls="Ext.grid.GridPanel" ext:member="getDragDropText" href="output/Ext.grid.GridPanel.html#getDragDropText">getDragDropText</a>.</p> <div class="mdetail-params">
1397
<strong>Parameters:</strong>
1398
<ul><li>None.</li> </ul>
1399
<strong>Returns:</strong>
1401
<li><code>void</code></li>
1407
<td class="msource">GridDragZone</td>
1409
<tr class="method-row inherited expandable">
1410
<td class="micon"><a class="exi" href="#expand"> </a></td>
1412
<a id="Ext.grid.GridDragZone-onInvalidDrop"></a>
1413
<b>onInvalidDrop</b>( <code>Event e</code> ) : void <div class="mdesc">
1414
<div class="short">Abstract method called when this item is dropped on an area with no
1417
Abstract method called when this item is dropped on an area with no
1418
drop target <div class="mdetail-params">
1419
<strong>Parameters:</strong>
1420
<ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
1421
<strong>Returns:</strong>
1423
<li><code>void</code></li>
1429
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onInvalidDrop" href="output/Ext.dd.DragDrop.html#onInvalidDrop">DragDrop</a></td>
1431
<tr class="method-row inherited alt expandable">
1432
<td class="micon"><a class="exi" href="#expand"> </a></td>
1434
<a id="Ext.grid.GridDragZone-onMouseDown"></a>
1435
<b>onMouseDown</b>( <code>Event e</code> ) : void <div class="mdesc">
1436
<div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
1438
Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params">
1439
<strong>Parameters:</strong>
1440
<ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul>
1441
<strong>Returns:</strong>
1443
<li><code>void</code></li>
1449
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseDown" href="output/Ext.dd.DragDrop.html#onMouseDown">DragDrop</a></td>
1451
<tr class="method-row inherited expandable">
1452
<td class="micon"><a class="exi" href="#expand"> </a></td>
1454
<a id="Ext.grid.GridDragZone-onMouseUp"></a>
1455
<b>onMouseUp</b>( <code>Event e</code> ) : void <div class="mdesc">
1456
<div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
1458
Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params">
1459
<strong>Parameters:</strong>
1460
<ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
1461
<strong>Returns:</strong>
1463
<li><code>void</code></li>
1469
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseUp" href="output/Ext.dd.DragDrop.html#onMouseUp">DragDrop</a></td>
1471
<tr class="method-row inherited alt expandable">
1472
<td class="micon"><a class="exi" href="#expand"> </a></td>
1474
<a id="Ext.grid.GridDragZone-removeFromGroup"></a>
1475
<b>removeFromGroup</b>( <code>string sGroup</code> ) : void <div class="mdesc">
1476
<div class="short">Remove's this instance from the supplied interaction group</div>
1478
Remove's this instance from the supplied interaction group <div class="mdetail-params">
1479
<strong>Parameters:</strong>
1480
<ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul>
1481
<strong>Returns:</strong>
1483
<li><code>void</code></li>
1489
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeFromGroup" href="output/Ext.dd.DragDrop.html#removeFromGroup">DragDrop</a></td>
1491
<tr class="method-row inherited expandable">
1492
<td class="micon"><a class="exi" href="#expand"> </a></td>
1494
<a id="Ext.grid.GridDragZone-removeInvalidHandleClass"></a>
1495
<b>removeInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc">
1496
<div class="short">Unsets an invalid css class</div>
1498
Unsets an invalid css class <div class="mdetail-params">
1499
<strong>Parameters:</strong>
1500
<ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to
1501
re-enable</div></li> </ul>
1502
<strong>Returns:</strong>
1504
<li><code>void</code></li>
1510
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleClass" href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass">DragDrop</a></td>
1512
<tr class="method-row inherited alt expandable">
1513
<td class="micon"><a class="exi" href="#expand"> </a></td>
1515
<a id="Ext.grid.GridDragZone-removeInvalidHandleId"></a>
1516
<b>removeInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc">
1517
<div class="short">Unsets an invalid handle id</div>
1519
Unsets an invalid handle id <div class="mdetail-params">
1520
<strong>Parameters:</strong>
1521
<ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul>
1522
<strong>Returns:</strong>
1524
<li><code>void</code></li>
1530
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleId" href="output/Ext.dd.DragDrop.html#removeInvalidHandleId">DragDrop</a></td>
1532
<tr class="method-row inherited expandable">
1533
<td class="micon"><a class="exi" href="#expand"> </a></td>
1535
<a id="Ext.grid.GridDragZone-removeInvalidHandleType"></a>
1536
<b>removeInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc">
1537
<div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
1539
Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params">
1540
<strong>Parameters:</strong>
1541
<ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li> </ul>
1542
<strong>Returns:</strong>
1544
<li><code>void</code></li>
1550
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleType" href="output/Ext.dd.DragDrop.html#removeInvalidHandleType">DragDrop</a></td>
1552
<tr class="method-row inherited alt expandable">
1553
<td class="micon"><a class="exi" href="#expand"> </a></td>
1555
<a id="Ext.grid.GridDragZone-resetConstraints"></a>
1556
<b>resetConstraints</b>( <code>boolean maintainOffset</code> ) : void <div class="mdesc">
1557
<div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
1559
resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params">
1560
<strong>Parameters:</strong>
1561
<ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul>
1562
<strong>Returns:</strong>
1564
<li><code>void</code></li>
1570
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#resetConstraints" href="output/Ext.dd.DragDrop.html#resetConstraints">DragDrop</a></td>
1572
<tr class="method-row inherited expandable">
1573
<td class="micon"><a class="exi" href="#expand"> </a></td>
1575
<a id="Ext.grid.GridDragZone-setDelta"></a>
1576
<b>setDelta</b>( <code>int iDeltaX</code>, <code>int iDeltaY</code> ) : void <div class="mdesc">
1577
<div class="short">Sets the pointer offset. You can call this directly to force the
1578
offset to be in a particular location (e.g., pass i...</div>
1580
Sets the pointer offset. You can call this directly to force the
1581
offset to be in a particular location (e.g., pass in 0,0 to set it
1582
to the center of the object) <div class="mdetail-params">
1583
<strong>Parameters:</strong>
1584
<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>
1585
<strong>Returns:</strong>
1587
<li><code>void</code></li>
1593
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDelta" href="output/Ext.dd.DD.html#setDelta">DD</a></td>
1595
<tr class="method-row inherited alt expandable">
1596
<td class="micon"><a class="exi" href="#expand"> </a></td>
1598
<a id="Ext.grid.GridDragZone-setDragElId"></a>
1599
<b>setDragElId</b>( <code>id {string}</code> ) : void <div class="mdesc">
1600
<div class="short">Allows you to specify that an element other than the linked element
1601
will be moved with the cursor during a drag</div>
1603
Allows you to specify that an element other than the linked element
1604
will be moved with the cursor during a drag <div class="mdetail-params">
1605
<strong>Parameters:</strong>
1606
<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>
1607
<strong>Returns:</strong>
1609
<li><code>void</code></li>
1615
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setDragElId" href="output/Ext.dd.DragDrop.html#setDragElId">DragDrop</a></td>
1617
<tr class="method-row inherited expandable">
1618
<td class="micon"><a class="exi" href="#expand"> </a></td>
1620
<a id="Ext.grid.GridDragZone-setDragElPos"></a>
1621
<b>setDragElPos</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc">
1622
<div class="short">Sets the drag element to the location of the mousedown or click event,
1623
maintaining the cursor location relative to th...</div>
1625
Sets the drag element to the location of the mousedown or click event,
1626
maintaining the cursor location relative to the location on the element
1627
that was clicked. Override this if you want to place the element in a
1628
location other than where the cursor is. <div class="mdetail-params">
1629
<strong>Parameters:</strong>
1630
<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>
1631
<strong>Returns:</strong>
1633
<li><code>void</code></li>
1639
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDragElPos" href="output/Ext.dd.DD.html#setDragElPos">DD</a></td>
1641
<tr class="method-row inherited alt expandable">
1642
<td class="micon"><a class="exi" href="#expand"> </a></td>
1644
<a id="Ext.grid.GridDragZone-setHandleElId"></a>
1645
<b>setHandleElId</b>( <code>id {string}</code> ) : void <div class="mdesc">
1646
<div class="short">Allows you to specify a child of the linked element that should be
1647
used to initiate the drag operation. An example o...</div>
1649
Allows you to specify a child of the linked element that should be
1650
used to initiate the drag operation. An example of this would be if
1651
you have a content div with text and links. Clicking anywhere in the
1652
content area would normally start the drag operation. Use this method
1653
to specify that an element inside of the content div is the element
1654
that starts the drag operation. <div class="mdetail-params">
1655
<strong>Parameters:</strong>
1656
<ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to
1657
initiate the drag.</div></li> </ul>
1658
<strong>Returns:</strong>
1660
<li><code>void</code></li>
1666
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setHandleElId" href="output/Ext.dd.DragDrop.html#setHandleElId">DragDrop</a></td>
1668
<tr class="method-row inherited expandable">
1669
<td class="micon"><a class="exi" href="#expand"> </a></td>
1671
<a id="Ext.grid.GridDragZone-setInitPosition"></a>
1672
<b>setInitPosition</b>( <code>int diffX</code>, <code>int diffY</code> ) : void <div class="mdesc">
1673
<div class="short">Stores the initial placement of the linked element.</div>
1675
Stores the initial placement of the linked element. <div class="mdetail-params">
1676
<strong>Parameters:</strong>
1677
<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>
1678
<strong>Returns:</strong>
1680
<li><code>void</code></li>
1686
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setInitPosition" href="output/Ext.dd.DragDrop.html#setInitPosition">DragDrop</a></td>
1688
<tr class="method-row inherited alt expandable">
1689
<td class="micon"><a class="exi" href="#expand"> </a></td>
1691
<a id="Ext.grid.GridDragZone-setOuterHandleElId"></a>
1692
<b>setOuterHandleElId</b>( <code>id the</code> ) : void <div class="mdesc">
1693
<div class="short">Allows you to set an element outside of the linked element as a drag
1696
Allows you to set an element outside of the linked element as a drag
1697
handle <div class="mdetail-params">
1698
<strong>Parameters:</strong>
1699
<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>
1700
<strong>Returns:</strong>
1702
<li><code>void</code></li>
1708
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setOuterHandleElId" href="output/Ext.dd.DragDrop.html#setOuterHandleElId">DragDrop</a></td>
1710
<tr class="method-row inherited expandable">
1711
<td class="micon"><a class="exi" href="#expand"> </a></td>
1713
<a id="Ext.grid.GridDragZone-setPadding"></a>
1714
<b>setPadding</b>( <code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code> ) : void <div class="mdesc">
1715
<div class="short">Configures the padding for the target zone in px. Effectively expands
1716
(or reduces) the virtual object size for targe...</div>
1718
Configures the padding for the target zone in px. Effectively expands
1719
(or reduces) the virtual object size for targeting calculations.
1720
Supports css-style shorthand; if only one parameter is passed, all sides
1721
will have that padding, and if only two are passed, the top and bottom
1722
will have the first param, the left and right the second. <div class="mdetail-params">
1723
<strong>Parameters:</strong>
1724
<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>
1725
<strong>Returns:</strong>
1727
<li><code>void</code></li>
1733
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setPadding" href="output/Ext.dd.DragDrop.html#setPadding">DragDrop</a></td>
1735
<tr class="method-row inherited alt expandable">
1736
<td class="micon"><a class="exi" href="#expand"> </a></td>
1738
<a id="Ext.grid.GridDragZone-setXConstraint"></a>
1739
<b>setXConstraint</b>( <code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code> ) : void <div class="mdesc">
1740
<div class="short">By default, the element can be dragged any place on the screen. Use
1741
this method to limit the horizontal travel of th...</div>
1743
By default, the element can be dragged any place on the screen. Use
1744
this method to limit the horizontal travel of the element. Pass in
1745
0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params">
1746
<strong>Parameters:</strong>
1747
<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
1748
right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
1750
should move iTickSize pixels at a time.</div></li> </ul>
1751
<strong>Returns:</strong>
1753
<li><code>void</code></li>
1759
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setXConstraint" href="output/Ext.dd.DragDrop.html#setXConstraint">DragDrop</a></td>
1761
<tr class="method-row inherited expandable">
1762
<td class="micon"><a class="exi" href="#expand"> </a></td>
1764
<a id="Ext.grid.GridDragZone-setYConstraint"></a>
1765
<b>setYConstraint</b>( <code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code> ) : void <div class="mdesc">
1766
<div class="short">By default, the element can be dragged any place on the screen. Set
1767
this to limit the vertical travel of the element...</div>
1769
By default, the element can be dragged any place on the screen. Set
1770
this to limit the vertical travel of the element. Pass in 0,0 for the
1771
parameters if you want to lock the drag to the x axis. <div class="mdetail-params">
1772
<strong>Parameters:</strong>
1773
<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
1774
element should move iTickSize pixels at a time.</div></li> </ul>
1775
<strong>Returns:</strong>
1777
<li><code>void</code></li>
1783
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setYConstraint" href="output/Ext.dd.DragDrop.html#setYConstraint">DragDrop</a></td>
1785
<tr class="method-row inherited alt expandable">
1786
<td class="micon"><a class="exi" href="#expand"> </a></td>
1788
<a id="Ext.grid.GridDragZone-startDrag"></a>
1789
<b>startDrag</b>( <code>int X</code>, <code>int Y</code> ) : void <div class="mdesc">
1790
<div class="short">Abstract method called after a drag/drop object is clicked
1791
and the drag or mousedown time thresholds have beeen met.</div>
1793
Abstract method called after a drag/drop object is clicked
1794
and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params">
1795
<strong>Parameters:</strong>
1796
<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>
1797
<strong>Returns:</strong>
1799
<li><code>void</code></li>
1805
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#startDrag" href="output/Ext.dd.DragDrop.html#startDrag">DragDrop</a></td>
1807
<tr class="method-row inherited expandable">
1808
<td class="micon"><a class="exi" href="#expand"> </a></td>
1810
<a id="Ext.grid.GridDragZone-toString"></a>
1811
<b>toString</b>() : string <div class="mdesc">
1812
<div class="short">toString method</div>
1814
toString method <div class="mdetail-params">
1815
<strong>Parameters:</strong>
1816
<ul><li>None.</li> </ul>
1817
<strong>Returns:</strong>
1819
<li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li>
1825
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#toString" href="output/Ext.dd.DragDrop.html#toString">DragDrop</a></td>
1827
<tr class="method-row inherited alt expandable">
1828
<td class="micon"><a class="exi" href="#expand"> </a></td>
1830
<a id="Ext.grid.GridDragZone-unlock"></a>
1831
<b>unlock</b>() : void <div class="mdesc">
1832
<div class="short">Unlock this instace</div>
1834
Unlock this instace <div class="mdetail-params">
1835
<strong>Parameters:</strong>
1836
<ul><li>None.</li> </ul>
1837
<strong>Returns:</strong>
1839
<li><code>void</code></li>
1845
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unlock" href="output/Ext.dd.DragDrop.html#unlock">DragDrop</a></td>
1847
<tr class="method-row inherited expandable">
1848
<td class="micon"><a class="exi" href="#expand"> </a></td>
1850
<a id="Ext.grid.GridDragZone-unreg"></a>
1851
<b>unreg</b>() : void <div class="mdesc">
1852
<div class="short">Remove all drag and drop hooks for this element</div>
1854
Remove all drag and drop hooks for this element <div class="mdetail-params">
1855
<strong>Parameters:</strong>
1856
<ul><li>None.</li> </ul>
1857
<strong>Returns:</strong>
1859
<li><code>void</code></li>
1865
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unreg" href="output/Ext.dd.DragDrop.html#unreg">DragDrop</a></td>
1868
<a id="Ext.grid.GridDragZone-events"></a>
1869
<h2>Public Events</h2>
1870
<div class="no-members">This class has no public events.</div>