New file |
0,0 → 1,1140 |
<div class="body-wrap"> |
<div class="top-tools"> |
<a class="inner-link" href="#Ext.dd.DragDrop-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
<a class="inner-link" href="#Ext.dd.DragDrop-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
<a class="inner-link" href="#Ext.dd.DragDrop-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
<a class="bookmark" href="../docs/?class=Ext.dd.DragDrop"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
</div> |
<h1>Class Ext.dd.DragDrop</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/DDCore.js" target="_blank">DDCore.js</a></td></tr> |
<tr><td class="label">Class:</td><td class="hd-info">DragDrop</td></tr> |
<tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.dd.DD" href="output/Ext.dd.DD.html">DD</a>, <a ext:cls="Ext.dd.DDTarget" href="output/Ext.dd.DDTarget.html">DDTarget</a></td></tr> |
<tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr> |
</table> |
<div class="description"> |
Defines the interface and base operation of items that that can be |
dragged or can be drop targets. It was designed to be extended, overriding |
the event handlers for startDrag, onDrag, onDragOver and onDragOut. |
Up to three html elements can be associated with a DragDrop instance: |
<ul> |
<li>linked element: the element that is passed into the constructor. |
This is the element which defines the boundaries for interaction with |
other DragDrop objects.</li> |
<li>handle element(s): The drag operation only occurs if the element that |
was clicked matches a handle element. By default this is the linked |
element, but there are times that you will want only a portion of the |
linked element to initiate the drag operation, and the setHandleElId() |
method provides a way to define this.</li> |
<li>drag element: this represents the element that would be moved along |
with the cursor during a drag operation. By default, this is the linked |
element itself as in <a ext:cls="Ext.dd.DD" href="output/Ext.dd.DD.html">Ext.dd.DD</a>. setDragElId() lets you define |
a separate element that would be moved, as in <a ext:cls="Ext.dd.DDProxy" href="output/Ext.dd.DDProxy.html">Ext.dd.DDProxy</a>. |
</li> |
</ul> |
This class should not be instantiated until the onload event to ensure that |
the associated elements are available. |
The following would define a DragDrop obj that would interact with any |
other DragDrop obj in the "group1" group: |
<pre>dd = new Ext.dd.DragDrop("div1", "group1");</pre> |
Since none of the event handlers have been implemented, nothing would |
actually happen if you were to run the code above. Normally you would |
override this class or one of the default implementations, but you can |
also override the methods you want on an instance of the class... |
<pre>dd.onDragDrop = function(e, id) { |
alert("dd was dropped on " + id); |
}</pre> </div> |
|
<div class="hr"></div> |
<a id="Ext.dd.DragDrop-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"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-config"></a> |
<b>config</b> : object <div class="mdesc"> |
Configuration attributes passed into the constructor </div> |
</td> |
<td class="msource">DragDrop</td> |
</tr> |
<tr class="property-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="property-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
</table> |
<a id="Ext.dd.DragDrop-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.DragDrop-DragDrop"></a> |
<b>DragDrop</b>( <code>String id</code>, <code>String sGroup</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>id</code> : String<div class="sub-desc">of the element that is linked to this instance</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related DragDrop objects</div></li><li><code>config</code> : object<div class="sub-desc">an object containing configurable attributes |
Valid properties for DragDrop: |
padding, isTarget, maintainOffset, primaryButtonOnly</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code></code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</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.DragDrop-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">DragDrop</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.dd.DragDrop-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">DragDrop</td> |
</tr> |
</table> |
<a id="Ext.dd.DragDrop-events"></a> |
<h2>Public Events</h2> |
<div class="no-members">This class has no public events.</div> |
</div> |