New file |
0,0 → 1,1767 |
<div class="body-wrap"> |
<div class="top-tools"> |
<a class="inner-link" href="#Ext.dd.DragZone-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
<a class="inner-link" href="#Ext.dd.DragZone-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
<a class="inner-link" href="#Ext.dd.DragZone-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
<a class="inner-link" href="#Ext.dd.DragZone-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> |
<a class="bookmark" href="../docs/?class=Ext.dd.DragZone"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
</div> |
<div class="inheritance res-block"> |
<pre class="res-block-inner"><a ext:cls="Ext.dd.DragDrop" ext:member="" href="output/Ext.dd.DragDrop.html">DragDrop</a> |
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DD" ext:member="" href="output/Ext.dd.DD.html">DD</a> |
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DDProxy" ext:member="" href="output/Ext.dd.DDProxy.html">DDProxy</a> |
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DragSource" ext:member="" href="output/Ext.dd.DragSource.html">DragSource</a> |
<img src="resources/elbow-end.gif"/>DragZone</pre></div> |
<h1>Class Ext.dd.DragZone</h1> |
<table cellspacing="0"> |
<tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr> |
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/dd/DragZone.js" target="_blank">DragZone.js</a></td></tr> |
<tr><td class="label">Class:</td><td class="hd-info">DragZone</td></tr> |
<tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.tree.TreeDragZone" href="output/Ext.tree.TreeDragZone.html">TreeDragZone</a></td></tr> |
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.dd.DragSource" ext:member="" href="output/Ext.dd.DragSource.html">DragSource</a></td></tr> |
</table> |
<div class="description"> |
This class provides a container DD instance that proxies for multiple child node sources.<br /> |
By default, this class requires that draggable child nodes are registered with <a ext:cls="Ext.dd.Registry" href="output/Ext.dd.Registry.html">Ext.dd.Registry</a>. </div> |
|
<div class="hr"></div> |
<a id="Ext.dd.DragZone-configs"></a> |
<h2>Config Options</h2> |
<table cellspacing="0" class="member-table"> |
<tr> |
<th class="sig-header" colspan="2">Config Options</th> |
<th class="msource-header">Defined By</th> |
</tr> |
<tr class="config-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-containerScroll"></a> |
<b>containerScroll</b> : Boolean <div class="mdesc"> |
True to register this container with the Scrollmanager for auto scrolling during drag operations. </div> |
</td> |
<td class="msource">DragZone</td> |
</tr> |
<tr class="config-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-ddGroup"></a> |
<b>ddGroup</b> : String <div class="mdesc"> |
<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> |
<div class="long"> |
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> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#ddGroup" href="output/Ext.dd.DragSource.html#ddGroup">DragSource</a></td> |
</tr> |
<tr class="config-row inherited"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-dropAllowed"></a> |
<b>dropAllowed</b> : String <div class="mdesc"> |
The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#dropAllowed" href="output/Ext.dd.DragSource.html#dropAllowed">DragSource</a></td> |
</tr> |
<tr class="config-row inherited alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-dropNotAllowed"></a> |
<b>dropNotAllowed</b> : String <div class="mdesc"> |
The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#dropNotAllowed" href="output/Ext.dd.DragSource.html#dropNotAllowed">DragSource</a></td> |
</tr> |
<tr class="config-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-hlColor"></a> |
<b>hlColor</b> : String <div class="mdesc"> |
<div class="short">The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults t...</div> |
<div class="long"> |
The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults to "c3daf9" - light blue) </div> |
</div> |
</td> |
<td class="msource">DragZone</td> |
</tr> |
</table> |
<a id="Ext.dd.DragZone-props"></a> |
<h2>Public Properties</h2> |
<table cellspacing="0" class="member-table"> |
<tr> |
<th class="sig-header" colspan="2">Property</th> |
<th class="msource-header">Defined By</th> |
</tr> |
<tr class="property-row inherited"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-available"></a> |
<b>available</b> : boolean <div class="mdesc"> |
The availabe property is false until the linked dom element is accessible. </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#available" href="output/Ext.dd.DragDrop.html#available">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-centerFrame"></a> |
<b>centerFrame</b> : boolean <div class="mdesc"> |
<div class="short">By default the frame is positioned exactly where the drag element is, so |
we use the cursor offset provided by Ext.dd....</div> |
<div class="long"> |
By default the frame is positioned exactly where the drag element is, so |
we use the cursor offset provided by Ext.dd.DD. Another option that works only if |
you do not have constraints on the obj is to have the drag frame centered |
around the cursor. Set centerFrame to true for this effect. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#centerFrame" href="output/Ext.dd.DDProxy.html#centerFrame">DDProxy</a></td> |
</tr> |
<tr class="property-row inherited"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-config"></a> |
<b>config</b> : object <div class="mdesc"> |
Configuration attributes passed into the constructor </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#config" href="output/Ext.dd.DragDrop.html#config">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-groups"></a> |
<b>groups</b> : object <div class="mdesc"> |
<div class="short">The group defines a logical collection of DragDrop objects that are |
related. Instances only get events when interact...</div> |
<div class="long"> |
The group defines a logical collection of DragDrop objects that are |
related. Instances only get events when interacting with other |
DragDrop object in the same group. This lets us define multiple |
groups using a single DragDrop subclass if we want. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#groups" href="output/Ext.dd.DragDrop.html#groups">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-hasOuterHandles"></a> |
<b>hasOuterHandles</b> : boolean <div class="mdesc"> |
<div class="short">By default, drags can only be initiated if the mousedown occurs in the |
region the linked element is. This is done in...</div> |
<div class="long"> |
By default, drags can only be initiated if the mousedown occurs in the |
region the linked element is. This is done in part to work around a |
bug in some browsers that mis-report the mousedown if the previous |
mouseup happened outside of the window. This property is set to true |
if outer handles are defined. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#hasOuterHandles" href="output/Ext.dd.DragDrop.html#hasOuterHandles">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-id"></a> |
<b>id</b> : String <div class="mdesc"> |
<div class="short">The id of the element associated with this object. This is what we |
refer to as the "linked element" because the size...</div> |
<div class="long"> |
The id of the element associated with this object. This is what we |
refer to as the "linked element" because the size and position of |
this element is used to determine when the drag and drop objects have |
interacted. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#id" href="output/Ext.dd.DragDrop.html#id">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-invalidHandleClasses"></a> |
<b>invalidHandleClasses</b> : string[] <div class="mdesc"> |
An indexted array of css class names for elements that will be ignored |
if clicked. </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleClasses" href="output/Ext.dd.DragDrop.html#invalidHandleClasses">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-invalidHandleIds"></a> |
<b>invalidHandleIds</b> : string: <div class="mdesc"> |
An associative array of ids for elements that will be ignored if clicked </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleIds" href="output/Ext.dd.DragDrop.html#invalidHandleIds">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-invalidHandleTypes"></a> |
<b>invalidHandleTypes</b> : string: <div class="mdesc"> |
An associative array of HTML tags that will be ignored if clicked. </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleTypes" href="output/Ext.dd.DragDrop.html#invalidHandleTypes">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-isTarget"></a> |
<b>isTarget</b> : boolean <div class="mdesc"> |
By default, all insances can be a drop target. This can be disabled by |
setting isTarget to false. </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isTarget" href="output/Ext.dd.DragDrop.html#isTarget">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-maintainOffset"></a> |
<b>maintainOffset</b> : boolean <div class="mdesc"> |
<div class="short">Maintain offsets when we resetconstraints. Set to true when you want |
the position of the element relative to its par...</div> |
<div class="long"> |
Maintain offsets when we resetconstraints. Set to true when you want |
the position of the element relative to its parent to stay the same |
when the page changes </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#maintainOffset" href="output/Ext.dd.DragDrop.html#maintainOffset">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onStartDrag"></a> |
<b>onStartDrag</b> : Object <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action once the initial |
drag event has be...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action once the initial |
drag event has begun. The drag cannot be canceled from this function. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#onStartDrag" href="output/Ext.dd.DragSource.html#onStartDrag">DragSource</a></td> |
</tr> |
<tr class="property-row inherited"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-padding"></a> |
<b>padding</b> : int[] <div class="mdesc"> |
The padding configured for this drag and drop object for calculating |
the drop zone intersection with this object. </div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#padding" href="output/Ext.dd.DragDrop.html#padding">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-primaryButtonOnly"></a> |
<b>primaryButtonOnly</b> : boolean <div class="mdesc"> |
<div class="short">By default the drag and drop instance will only respond to the primary |
button click (left button for a right-handed m...</div> |
<div class="long"> |
By default the drag and drop instance will only respond to the primary |
button click (left button for a right-handed mouse). Set to true to |
allow drag and drop to start with any mouse click that is propogated |
by the browser </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#primaryButtonOnly" href="output/Ext.dd.DragDrop.html#primaryButtonOnly">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-resizeFrame"></a> |
<b>resizeFrame</b> : boolean <div class="mdesc"> |
<div class="short">By default we resize the drag frame to be the same size as the element |
we want to drag (this is to get the frame effe...</div> |
<div class="long"> |
By default we resize the drag frame to be the same size as the element |
we want to drag (this is to get the frame effect). We can turn it off |
if we want a different behavior. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#resizeFrame" href="output/Ext.dd.DDProxy.html#resizeFrame">DDProxy</a></td> |
</tr> |
<tr class="property-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-scroll"></a> |
<b>scroll</b> : boolean <div class="mdesc"> |
<div class="short">When set to true, the utility automatically tries to scroll the browser |
window wehn a drag and drop element is dragge...</div> |
<div class="long"> |
When set to true, the utility automatically tries to scroll the browser |
window wehn a drag and drop element is dragged near the viewport boundary. |
Defaults to true. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#scroll" href="output/Ext.dd.DD.html#scroll">DD</a></td> |
</tr> |
<tr class="property-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-xTicks"></a> |
<b>xTicks</b> : int[] <div class="mdesc"> |
<div class="short">Array of pixel locations the element will snap to if we specified a |
horizontal graduation/interval. This array is ge...</div> |
<div class="long"> |
Array of pixel locations the element will snap to if we specified a |
horizontal graduation/interval. This array is generated automatically |
when you define a tick interval. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#xTicks" href="output/Ext.dd.DragDrop.html#xTicks">DragDrop</a></td> |
</tr> |
<tr class="property-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-yTicks"></a> |
<b>yTicks</b> : int[] <div class="mdesc"> |
<div class="short">Array of pixel locations the element will snap to if we specified a |
vertical graduation/interval. This array is gene...</div> |
<div class="long"> |
Array of pixel locations the element will snap to if we specified a |
vertical graduation/interval. This array is generated automatically |
when you define a tick interval. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#yTicks" href="output/Ext.dd.DragDrop.html#yTicks">DragDrop</a></td> |
</tr> |
</table> |
<a id="Ext.dd.DragZone-methods"></a> |
<h2>Public Methods</h2> |
<table cellspacing="0" class="member-table"> |
<tr> |
<th class="sig-header" colspan="2">Method</th> |
<th class="msource-header">Defined By</th> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-DragZone"></a> |
<b>DragZone</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc"> |
<div class="short"></div> |
<div class="long"> |
<div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code></code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">DragZone</td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-addInvalidHandleClass"></a> |
<b>addInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc"> |
<div class="short">Lets you specify a css class of elements that will not initiate a drag</div> |
<div class="long"> |
Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleClass" href="output/Ext.dd.DragDrop.html#addInvalidHandleClass">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-addInvalidHandleId"></a> |
<b>addInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc"> |
<div class="short">Lets you to specify an element id for a child of a drag handle |
that should not initiate a drag</div> |
<div class="long"> |
Lets you to specify an element id for a child of a drag handle |
that should not initiate a drag <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleId" href="output/Ext.dd.DragDrop.html#addInvalidHandleId">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-addInvalidHandleType"></a> |
<b>addInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc"> |
<div class="short">Allows you to specify a tag name that should not start a drag operation |
when clicked. This is designed to facilitate...</div> |
<div class="long"> |
Allows you to specify a tag name that should not start a drag operation |
when clicked. This is designed to facilitate embedding links within a |
drag handle that do something other than start the drag. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleType" href="output/Ext.dd.DragDrop.html#addInvalidHandleType">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-addToGroup"></a> |
<b>addToGroup</b>( <code>sGroup {string}</code> ) : void <div class="mdesc"> |
<div class="short">Add this instance to a group of related drag/drop objects. All |
instances belong to at least one group, and can belon...</div> |
<div class="long"> |
Add this instance to a group of related drag/drop objects. All |
instances belong to at least one group, and can belong to as many |
groups as needed. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addToGroup" href="output/Ext.dd.DragDrop.html#addToGroup">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-afterDragDrop"></a> |
<b>afterDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action |
after a valid drag drop has occurr...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action |
after a valid drag drop has occurred by providing an implementation. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragDrop" href="output/Ext.dd.DragSource.html#afterDragDrop">DragSource</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-afterDragEnter"></a> |
<b>afterDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action |
when the dragged item enters the d...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action |
when the dragged item enters the drop target by providing an implementation. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragEnter" href="output/Ext.dd.DragSource.html#afterDragEnter">DragSource</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-afterDragOut"></a> |
<b>afterDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action |
after the dragged item is dragged ...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action |
after the dragged item is dragged out of the target without dropping. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragOut" href="output/Ext.dd.DragSource.html#afterDragOut">DragSource</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-afterDragOver"></a> |
<b>afterDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action |
while the dragged item is over the...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action |
while the dragged item is over the drop target by providing an implementation. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterDragOver" href="output/Ext.dd.DragSource.html#afterDragOver">DragSource</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-afterInvalidDrop"></a> |
<b>afterInvalidDrop</b>( <code>Event e</code>, <code>String id</code> ) : void <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action |
after an invalid drop has occurred...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action |
after an invalid drop has occurred by providing an implementation. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#afterInvalidDrop" href="output/Ext.dd.DragSource.html#afterInvalidDrop">DragSource</a></td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-afterRepair"></a> |
<b>afterRepair</b>() : void <div class="mdesc"> |
<div class="short">Called after a repair of an invalid drop. By default, highlights this.dragData.ddel</div> |
<div class="long"> |
Called after a repair of an invalid drop. By default, highlights this.dragData.ddel <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">DragZone</td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-alignElWithMouse"></a> |
<b>alignElWithMouse</b>( <code>HTMLElement el</code>, <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc"> |
<div class="short">Sets the element to the location of the mousedown or click event, |
maintaining the cursor location relative to the loc...</div> |
<div class="long"> |
Sets the element to the location of the mousedown or click event, |
maintaining the cursor location relative to the location on the element |
that was clicked. Override this if you want to place the element in a |
location other than where the cursor is. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#alignElWithMouse" href="output/Ext.dd.DD.html#alignElWithMouse">DD</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-applyConfig"></a> |
<b>applyConfig</b>() : void <div class="mdesc"> |
<div class="short">Applies the configuration parameters that were passed into the constructor. |
This is supposed to happen at each level ...</div> |
<div class="long"> |
Applies the configuration parameters that were passed into the constructor. |
This is supposed to happen at each level through the inheritance chain. So |
a DDProxy implentation will execute apply config on DDProxy, DD, and |
DragDrop in order to get all of the parameters that are available in |
each object. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#applyConfig" href="output/Ext.dd.DragDrop.html#applyConfig">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-autoOffset"></a> |
<b>autoOffset</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc"> |
<div class="short">Sets the pointer offset to the distance between the linked element's top |
left corner and the location the element was...</div> |
<div class="long"> |
Sets the pointer offset to the distance between the linked element's top |
left corner and the location the element was clicked <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#autoOffset" href="output/Ext.dd.DD.html#autoOffset">DD</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-beforeDragDrop"></a> |
<b>beforeDragDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged |
item is dropped...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action before the dragged |
item is dropped onto the target and optionally cancel the onDragDrop. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag drop event is valid, else false to cancel</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragDrop" href="output/Ext.dd.DragSource.html#beforeDragDrop">DragSource</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-beforeDragEnter"></a> |
<b>beforeDragEnter</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action |
before the dragged item enters the...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action |
before the dragged item enters the drop target and optionally cancel the onDragEnter. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragEnter" href="output/Ext.dd.DragSource.html#beforeDragEnter">DragSource</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-beforeDragOut"></a> |
<b>beforeDragOut</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged |
item is dragged...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action before the dragged |
item is dragged out of the target without dropping, and optionally cancel the onDragOut. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragOut" href="output/Ext.dd.DragSource.html#beforeDragOut">DragSource</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-beforeDragOver"></a> |
<b>beforeDragOver</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action |
while the dragged item is over the...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action |
while the dragged item is over the drop target and optionally cancel the onDragOver. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeDragOver" href="output/Ext.dd.DragSource.html#beforeDragOver">DragSource</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-beforeInvalidDrop"></a> |
<b>beforeInvalidDrop</b>( <code>Ext.dd.DragDrop target</code>, <code>Event e</code>, <code>String id</code> ) : Boolean <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action after an invalid |
drop has occurred.</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action after an invalid |
drop has occurred. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">isValid True if the invalid drop should proceed, else false to cancel</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#beforeInvalidDrop" href="output/Ext.dd.DragSource.html#beforeInvalidDrop">DragSource</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-cachePosition"></a> |
<b>cachePosition</b>( <code>iPageX the</code>, <code>iPageY the</code> ) : void <div class="mdesc"> |
<div class="short">Saves the most recent position so that we can reset the constraints and |
tick marks on-demand. We need to know this s...</div> |
<div class="long"> |
Saves the most recent position so that we can reset the constraints and |
tick marks on-demand. We need to know this so that we can calculate the |
number of pixels the element is offset from its original position. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>the</code> : iPageX<div class="sub-desc">current x position (optional, this just makes it so we |
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 |
don't have to look it up again)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#cachePosition" href="output/Ext.dd.DD.html#cachePosition">DD</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-clearConstraints"></a> |
<b>clearConstraints</b>() : void <div class="mdesc"> |
<div class="short">Clears any constraints applied to this instance. Also clears ticks |
since they can't exist independent of a constrain...</div> |
<div class="long"> |
Clears any constraints applied to this instance. Also clears ticks |
since they can't exist independent of a constraint at this time. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearConstraints" href="output/Ext.dd.DragDrop.html#clearConstraints">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-clearTicks"></a> |
<b>clearTicks</b>() : void <div class="mdesc"> |
<div class="short">Clears any tick interval defined for this instance</div> |
<div class="long"> |
Clears any tick interval defined for this instance <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearTicks" href="output/Ext.dd.DragDrop.html#clearTicks">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-createFrame"></a> |
<b>createFrame</b>() : void <div class="mdesc"> |
<div class="short">Creates the proxy element if it does not yet exist</div> |
<div class="long"> |
Creates the proxy element if it does not yet exist <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#createFrame" href="output/Ext.dd.DDProxy.html#createFrame">DDProxy</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-endDrag"></a> |
<b>endDrag</b>( <code>Event e</code> ) : void <div class="mdesc"> |
<div class="short">Fired when we are done dragging the object</div> |
<div class="long"> |
Fired when we are done dragging the object <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#endDrag" href="output/Ext.dd.DragDrop.html#endDrag">DragDrop</a></td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-getDragData"></a> |
<b>getDragData</b>( <code>EventObject e</code> ) : Object <div class="mdesc"> |
<div class="short"> |
Called when a mousedown occurs in this container. Looks in Ext.dd.Registry |
for a valid target to drag based on the m...</div> |
<div class="long"> |
|
Called when a mousedown occurs in this container. Looks in <a ext:cls="Ext.dd.Registry" href="output/Ext.dd.Registry.html">Ext.dd.Registry</a> |
for a valid target to drag based on the mouse down. Override this method |
to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned |
object has a "ddel" attribute (with an HTML Element) for other functions to work. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>e</code> : EventObject<div class="sub-desc">The mouse down event</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Object</code><div class="sub-desc">The dragData</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">DragZone</td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-getDragEl"></a> |
<b>getDragEl</b>() : HTMLElement <div class="mdesc"> |
<div class="short">Returns a reference to the actual element to drag. By default this is |
the same as the html element, but it can be as...</div> |
<div class="long"> |
Returns a reference to the actual element to drag. By default this is |
the same as the html element, but it can be assigned to another |
element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>HTMLElement</code><div class="sub-desc">the html element</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getDragEl" href="output/Ext.dd.DragDrop.html#getDragEl">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-getEl"></a> |
<b>getEl</b>() : HTMLElement <div class="mdesc"> |
<div class="short">Returns a reference to the linked element</div> |
<div class="long"> |
Returns a reference to the linked element <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>HTMLElement</code><div class="sub-desc">the html element</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getEl" href="output/Ext.dd.DragDrop.html#getEl">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-getProxy"></a> |
<b>getProxy</b>() : Ext.dd.StatusProxy <div class="mdesc"> |
<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> |
<div class="long"> |
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"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Ext.dd.StatusProxy</code><div class="sub-desc">proxy The StatusProxy</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#getProxy" href="output/Ext.dd.DragSource.html#getProxy">DragSource</a></td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-getRepairXY"></a> |
<b>getRepairXY</b>( <code>EventObject e</code> ) : Array <div class="mdesc"> |
<div class="short">Called before a repair of an invalid drop to get the XY to animate to. By default returns |
the XY of this.dragData.ddel</div> |
<div class="long"> |
Called before a repair of an invalid drop to get the XY to animate to. By default returns |
the XY of this.dragData.ddel <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>e</code> : EventObject<div class="sub-desc">The mouse up event</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Array</code><div class="sub-desc">The xy location (e.g. [100, 200])</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">DragZone</td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-hideProxy"></a> |
<b>hideProxy</b>() : void <div class="mdesc"> |
<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> |
<div class="long"> |
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"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#hideProxy" href="output/Ext.dd.DragSource.html#hideProxy">DragSource</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-init"></a> |
<b>init</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc"> |
<div class="short">Sets up the DragDrop object. Must be called in the constructor of any |
Ext.dd.DragDrop subclass</div> |
<div class="long"> |
Sets up the DragDrop object. Must be called in the constructor of any |
Ext.dd.DragDrop subclass <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#init" href="output/Ext.dd.DragDrop.html#init">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-initFrame"></a> |
<b>initFrame</b>() : void <div class="mdesc"> |
<div class="short">Initialization for the drag frame element. Must be called in the |
constructor of all subclasses</div> |
<div class="long"> |
Initialization for the drag frame element. Must be called in the |
constructor of all subclasses <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DDProxy" ext:member="#initFrame" href="output/Ext.dd.DDProxy.html#initFrame">DDProxy</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-initTarget"></a> |
<b>initTarget</b>( <code>id the</code>, <code>String sGroup</code>, <code>object config</code> ) : void <div class="mdesc"> |
<div class="short">Initializes Targeting functionality only... the object does not |
get a mousedown handler.</div> |
<div class="long"> |
Initializes Targeting functionality only... the object does not |
get a mousedown handler. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#initTarget" href="output/Ext.dd.DragDrop.html#initTarget">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-isLocked"></a> |
<b>isLocked</b>() : boolean <div class="mdesc"> |
<div class="short">Returns true if this instance is locked, or the drag drop mgr is locked |
(meaning that all drag/drop is disabled on th...</div> |
<div class="long"> |
Returns true if this instance is locked, or the drag drop mgr is locked |
(meaning that all drag/drop is disabled on the page.) <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isLocked" href="output/Ext.dd.DragDrop.html#isLocked">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-isValidHandleChild"></a> |
<b>isValidHandleChild</b>( <code>HTMLElement node</code> ) : boolean <div class="mdesc"> |
<div class="short">Checks the tag exclusion list to see if this click should be ignored</div> |
<div class="long"> |
Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isValidHandleChild" href="output/Ext.dd.DragDrop.html#isValidHandleChild">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-lock"></a> |
<b>lock</b>() : void <div class="mdesc"> |
<div class="short">Lock this instance</div> |
<div class="long"> |
Lock this instance <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#lock" href="output/Ext.dd.DragDrop.html#lock">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onAvailable"></a> |
<b>onAvailable</b>() : void <div class="mdesc"> |
<div class="short">Override the onAvailable method to do what is needed after the initial |
position was determined.</div> |
<div class="long"> |
Override the onAvailable method to do what is needed after the initial |
position was determined. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onAvailable" href="output/Ext.dd.DragDrop.html#onAvailable">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onBeforeDrag"></a> |
<b>onBeforeDrag</b>( <code>Object data</code>, <code>Event e</code> ) : Boolean <div class="mdesc"> |
<div class="short">An empty function by default, but provided so that you can perform a custom action before the initial |
drag event begi...</div> |
<div class="long"> |
An empty function by default, but provided so that you can perform a custom action before the initial |
drag event begins and optionally cancel it. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">isValid True if the drag event is valid, else false to cancel</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragSource" ext:member="#onBeforeDrag" href="output/Ext.dd.DragSource.html#onBeforeDrag">DragSource</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onDrag"></a> |
<b>onDrag</b>( <code>Event e</code> ) : void <div class="mdesc"> |
<div class="short">Abstract method called during the onMouseMove event while dragging an |
object.</div> |
<div class="long"> |
Abstract method called during the onMouseMove event while dragging an |
object. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDrag" href="output/Ext.dd.DragDrop.html#onDrag">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onDragDrop"></a> |
<b>onDragDrop</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc"> |
<div class="short">Abstract method called when this item is dropped on another DragDrop |
obj</div> |
<div class="long"> |
Abstract method called when this item is dropped on another DragDrop |
obj <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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 |
id this was dropped on. In INTERSECT mode, an array of dd items this |
was dropped on.</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragDrop" href="output/Ext.dd.DragDrop.html#onDragDrop">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onDragEnter"></a> |
<b>onDragEnter</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc"> |
<div class="short">Abstract method called when this element fist begins hovering over |
another DragDrop obj</div> |
<div class="long"> |
Abstract method called when this element fist begins hovering over |
another DragDrop obj <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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 |
id this is hovering over. In INTERSECT mode, an array of one or more |
dragdrop items being hovered over.</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragEnter" href="output/Ext.dd.DragDrop.html#onDragEnter">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onDragOut"></a> |
<b>onDragOut</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc"> |
<div class="short">Abstract method called when we are no longer hovering over an element</div> |
<div class="long"> |
Abstract method called when we are no longer hovering over an element <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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 |
id this was hovering over. In INTERSECT mode, an array of dd items |
that the mouse is no longer over.</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOut" href="output/Ext.dd.DragDrop.html#onDragOut">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onDragOver"></a> |
<b>onDragOver</b>( <code>Event e</code>, <code>String|DragDrop[] id</code> ) : void <div class="mdesc"> |
<div class="short">Abstract method called when this element is hovering over another |
DragDrop obj</div> |
<div class="long"> |
Abstract method called when this element is hovering over another |
DragDrop obj <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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 |
id this is hovering over. In INTERSECT mode, an array of dd items |
being hovered over.</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOver" href="output/Ext.dd.DragDrop.html#onDragOver">DragDrop</a></td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onInitDrag"></a> |
<b>onInitDrag</b>( <code>Number x</code>, <code>Number y</code> ) : Boolean <div class="mdesc"> |
<div class="short">Called once drag threshold has been reached to initialize the proxy element. By default, it clones the |
this.dragData....</div> |
<div class="long"> |
Called once drag threshold has been reached to initialize the proxy element. By default, it clones the |
this.dragData.ddel <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>x</code> : Number<div class="sub-desc">The x position of the click on the dragged object</div></li><li><code>y</code> : Number<div class="sub-desc">The y position of the click on the dragged object</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">true to continue the drag, false to cancel</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">DragZone</td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onInvalidDrop"></a> |
<b>onInvalidDrop</b>( <code>Event e</code> ) : void <div class="mdesc"> |
<div class="short">Abstract method called when this item is dropped on an area with no |
drop target</div> |
<div class="long"> |
Abstract method called when this item is dropped on an area with no |
drop target <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onInvalidDrop" href="output/Ext.dd.DragDrop.html#onInvalidDrop">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onMouseDown"></a> |
<b>onMouseDown</b>( <code>Event e</code> ) : void <div class="mdesc"> |
<div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div> |
<div class="long"> |
Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseDown" href="output/Ext.dd.DragDrop.html#onMouseDown">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-onMouseUp"></a> |
<b>onMouseUp</b>( <code>Event e</code> ) : void <div class="mdesc"> |
<div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div> |
<div class="long"> |
Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseUp" href="output/Ext.dd.DragDrop.html#onMouseUp">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-removeFromGroup"></a> |
<b>removeFromGroup</b>( <code>string sGroup</code> ) : void <div class="mdesc"> |
<div class="short">Remove's this instance from the supplied interaction group</div> |
<div class="long"> |
Remove's this instance from the supplied interaction group <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeFromGroup" href="output/Ext.dd.DragDrop.html#removeFromGroup">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-removeInvalidHandleClass"></a> |
<b>removeInvalidHandleClass</b>( <code>string cssClass</code> ) : void <div class="mdesc"> |
<div class="short">Unsets an invalid css class</div> |
<div class="long"> |
Unsets an invalid css class <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to |
re-enable</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleClass" href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-removeInvalidHandleId"></a> |
<b>removeInvalidHandleId</b>( <code>string id</code> ) : void <div class="mdesc"> |
<div class="short">Unsets an invalid handle id</div> |
<div class="long"> |
Unsets an invalid handle id <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleId" href="output/Ext.dd.DragDrop.html#removeInvalidHandleId">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-removeInvalidHandleType"></a> |
<b>removeInvalidHandleType</b>( <code>string tagName</code> ) : void <div class="mdesc"> |
<div class="short">Unsets an excluded tag name set by addInvalidHandleType</div> |
<div class="long"> |
Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleType" href="output/Ext.dd.DragDrop.html#removeInvalidHandleType">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-resetConstraints"></a> |
<b>resetConstraints</b>( <code>boolean maintainOffset</code> ) : void <div class="mdesc"> |
<div class="short">resetConstraints must be called if you manually reposition a dd element.</div> |
<div class="long"> |
resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#resetConstraints" href="output/Ext.dd.DragDrop.html#resetConstraints">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setDelta"></a> |
<b>setDelta</b>( <code>int iDeltaX</code>, <code>int iDeltaY</code> ) : void <div class="mdesc"> |
<div class="short">Sets the pointer offset. You can call this directly to force the |
offset to be in a particular location (e.g., pass i...</div> |
<div class="long"> |
Sets the pointer offset. You can call this directly to force the |
offset to be in a particular location (e.g., pass in 0,0 to set it |
to the center of the object) <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDelta" href="output/Ext.dd.DD.html#setDelta">DD</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setDragElId"></a> |
<b>setDragElId</b>( <code>id {string}</code> ) : void <div class="mdesc"> |
<div class="short">Allows you to specify that an element other than the linked element |
will be moved with the cursor during a drag</div> |
<div class="long"> |
Allows you to specify that an element other than the linked element |
will be moved with the cursor during a drag <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setDragElId" href="output/Ext.dd.DragDrop.html#setDragElId">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setDragElPos"></a> |
<b>setDragElPos</b>( <code>int iPageX</code>, <code>int iPageY</code> ) : void <div class="mdesc"> |
<div class="short">Sets the drag element to the location of the mousedown or click event, |
maintaining the cursor location relative to th...</div> |
<div class="long"> |
Sets the drag element to the location of the mousedown or click event, |
maintaining the cursor location relative to the location on the element |
that was clicked. Override this if you want to place the element in a |
location other than where the cursor is. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DD" ext:member="#setDragElPos" href="output/Ext.dd.DD.html#setDragElPos">DD</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setHandleElId"></a> |
<b>setHandleElId</b>( <code>id {string}</code> ) : void <div class="mdesc"> |
<div class="short">Allows you to specify a child of the linked element that should be |
used to initiate the drag operation. An example o...</div> |
<div class="long"> |
Allows you to specify a child of the linked element that should be |
used to initiate the drag operation. An example of this would be if |
you have a content div with text and links. Clicking anywhere in the |
content area would normally start the drag operation. Use this method |
to specify that an element inside of the content div is the element |
that starts the drag operation. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setHandleElId" href="output/Ext.dd.DragDrop.html#setHandleElId">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setInitialPosition"></a> |
<b>setInitialPosition</b>( <code>int diffX</code>, <code>int diffY</code> ) : void <div class="mdesc"> |
<div class="short">Stores the initial placement of the linked element.</div> |
<div class="long"> |
Stores the initial placement of the linked element. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setInitialPosition" href="output/Ext.dd.DragDrop.html#setInitialPosition">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setOuterHandleElId"></a> |
<b>setOuterHandleElId</b>( <code>id the</code> ) : void <div class="mdesc"> |
<div class="short">Allows you to set an element outside of the linked element as a drag |
handle</div> |
<div class="long"> |
Allows you to set an element outside of the linked element as a drag |
handle <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setOuterHandleElId" href="output/Ext.dd.DragDrop.html#setOuterHandleElId">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setPadding"></a> |
<b>setPadding</b>( <code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code> ) : void <div class="mdesc"> |
<div class="short">Configures the padding for the target zone in px. Effectively expands |
(or reduces) the virtual object size for targe...</div> |
<div class="long"> |
Configures the padding for the target zone in px. Effectively expands |
(or reduces) the virtual object size for targeting calculations. |
Supports css-style shorthand; if only one parameter is passed, all sides |
will have that padding, and if only two are passed, the top and bottom |
will have the first param, the left and right the second. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setPadding" href="output/Ext.dd.DragDrop.html#setPadding">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setXConstraint"></a> |
<b>setXConstraint</b>( <code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code> ) : void <div class="mdesc"> |
<div class="short">By default, the element can be dragged any place on the screen. Use |
this method to limit the horizontal travel of th...</div> |
<div class="long"> |
By default, the element can be dragged any place on the screen. Use |
this method to limit the horizontal travel of the element. Pass in |
0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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 |
right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the |
element |
should move iTickSize pixels at a time.</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setXConstraint" href="output/Ext.dd.DragDrop.html#setXConstraint">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-setYConstraint"></a> |
<b>setYConstraint</b>( <code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code> ) : void <div class="mdesc"> |
<div class="short">By default, the element can be dragged any place on the screen. Set |
this to limit the vertical travel of the element...</div> |
<div class="long"> |
By default, the element can be dragged any place on the screen. Set |
this to limit the vertical travel of the element. Pass in 0,0 for the |
parameters if you want to lock the drag to the x axis. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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 |
element should move iTickSize pixels at a time.</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setYConstraint" href="output/Ext.dd.DragDrop.html#setYConstraint">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-startDrag"></a> |
<b>startDrag</b>( <code>int X</code>, <code>int Y</code> ) : void <div class="mdesc"> |
<div class="short">Abstract method called after a drag/drop object is clicked |
and the drag or mousedown time thresholds have beeen met.</div> |
<div class="long"> |
Abstract method called after a drag/drop object is clicked |
and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<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> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#startDrag" href="output/Ext.dd.DragDrop.html#startDrag">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-toString"></a> |
<b>toString</b>() : string <div class="mdesc"> |
<div class="short">toString method</div> |
<div class="long"> |
toString method <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#toString" href="output/Ext.dd.DragDrop.html#toString">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-unlock"></a> |
<b>unlock</b>() : void <div class="mdesc"> |
<div class="short">Unlock this instace</div> |
<div class="long"> |
Unlock this instace <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unlock" href="output/Ext.dd.DragDrop.html#unlock">DragDrop</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragZone-unreg"></a> |
<b>unreg</b>() : void <div class="mdesc"> |
<div class="short">Remove all drag and drop hooks for this element</div> |
<div class="long"> |
Remove all drag and drop hooks for this element <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unreg" href="output/Ext.dd.DragDrop.html#unreg">DragDrop</a></td> |
</tr> |
</table> |
<a id="Ext.dd.DragZone-events"></a> |
<h2>Public Events</h2> |
<div class="no-members">This class has no public events.</div> |
</div> |