Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / output / Ext.dd.DragSource.html
1 <div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.dd.DragDrop.html" ext:member="" ext:cls="Ext.dd.DragDrop">DragDrop</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.dd.DD.html" ext:member="" ext:cls="Ext.dd.DD">DD</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.dd.DDProxy.html" ext:member="" ext:cls="Ext.dd.DDProxy">DDProxy</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">DragSource</pre></div><h1>Class <a href="source/DragSource.html#cls-Ext.dd.DragSource">Ext.dd.DragSource</a></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">DragSource.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DragSource.html#cls-Ext.dd.DragSource">DragSource</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.dd.DragZone.html" ext:cls="Ext.dd.DragZone">DragZone</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.dd.DDProxy.html" ext:cls="Ext.dd.DDProxy" ext:member="">DDProxy</a></td></tr></table><div class="description">A simple class that provides the basic implementation needed to make any element draggable.</div><div class="hr"></div><a id="Ext.dd.DragSource-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-ddGroup"></a><b><a href="source/DragSource.html#cfg-Ext.dd.DragSource-ddGroup">ddGroup</a></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&#13;\r
2 interact ...</div><div class="long">A named drag drop group to which this object belongs.  If a group is specified, then this object will only\r
3 interact with other drag drop objects in the same group (defaults to undefined).</div></div></td><td class="msource">DragSource</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-dropAllowed"></a><b><a href="source/DragSource.html#cfg-Ext.dd.DragSource-dropAllowed">dropAllowed</a></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">DragSource</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-dropNotAllowed"></a><b><a href="source/DragSource.html#cfg-Ext.dd.DragSource-dropNotAllowed">dropNotAllowed</a></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">DragSource</td></tr></tbody></table><a id="Ext.dd.DragSource-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DDProxy-Ext.dd.DDProxy.dragElId"></a><b><a href="source/DDCore.html#prop-Ext.dd.DDProxy-Ext.dd.DDProxy.dragElId">Ext.dd.DDProxy.dragElId</a></b> : String<div class="mdesc">The default drag frame div id</div></td><td class="msource"><a href="output/Ext.dd.DDProxy.html#Ext.dd.DDProxy.dragElId" ext:member="#Ext.dd.DDProxy.dragElId" ext:cls="Ext.dd.DDProxy">DDProxy</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-Only"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-Only">Only</a></b> : Object<div class="mdesc"><div class="short">The drag and drop utility provides a framework for building drag and drop\r
4 applications.  In addition to enabling drag...</div><div class="long">The drag and drop utility provides a framework for building drag and drop
5 applications.  In addition to enabling drag and drop for specific elements,
6 the drag and drop elements are tracked by the manager class, and the
7 interactions between the various elements are tracked during the drag and
8 the implementing code is notified about these important moments.</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#Only" ext:member="#Only" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-available"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-available">available</a></b> : boolean<div class="mdesc">The availabe property is false until the linked dom element is accessible.</div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#available" ext:member="#available" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DDProxy-centerFrame"></a><b><a href="source/DDCore.html#prop-Ext.dd.DDProxy-centerFrame">centerFrame</a></b> : boolean<div class="mdesc"><div class="short">By default the frame is positioned exactly where the drag element is, so\r
9 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
10 we use the cursor offset provided by Ext.dd.DD.  Another option that works only if
11 you do not have constraints on the obj is to have the drag frame centered
12 around the cursor.  Set centerFrame to true for this effect.</div></div></td><td class="msource"><a href="output/Ext.dd.DDProxy.html#centerFrame" ext:member="#centerFrame" ext:cls="Ext.dd.DDProxy">DDProxy</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-config"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-config">config</a></b> : object<div class="mdesc">Configuration attributes passed into the constructor</div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#config" ext:member="#config" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-defaultPadding"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-defaultPadding">defaultPadding</a></b> : Object<div class="mdesc">Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).</div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#defaultPadding" ext:member="#defaultPadding" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-groups"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-groups">groups</a></b> : object An object in the format {'group1':true, 'group2':true<div class="mdesc"><div class="short">The group defines a logical collection of DragDrop objects that are\r
13 related.  Instances only get events when interact...</div><div class="long">The group defines a logical collection of DragDrop objects that are
14 related.  Instances only get events when interacting with other
15 DragDrop object in the same group.  This lets us define multiple
16 groups using a single DragDrop subclass if we want.</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#groups" ext:member="#groups" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-hasOuterHandles"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-hasOuterHandles">hasOuterHandles</a></b> : boolean<div class="mdesc"><div class="short">By default, drags can only be initiated if the mousedown occurs in the\r
17 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
18 region the linked element is.  This is done in part to work around a
19 bug in some browsers that mis-report the mousedown if the previous
20 mouseup happened outside of the window.  This property is set to true
21 if outer handles are defined.</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#hasOuterHandles" ext:member="#hasOuterHandles" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-id"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-id">id</a></b> : String<div class="mdesc"><div class="short">The id of the element associated with this object.  This is what we\r
22 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
23 refer to as the "linked element" because the size and position of
24 this element is used to determine when the drag and drop objects have
25 interacted.</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#id" ext:member="#id" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-ignoreSelf"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-ignoreSelf">ignoreSelf</a></b> : Boolean<div class="mdesc"><div class="short">Set to false to enable a DragDrop object to fire drag events while dragging\r
26 over its own Element. Defaults to true - ...</div><div class="long">Set to false to enable a DragDrop object to fire drag events while dragging
27 over its own Element. Defaults to true - DragDrop objects do not by default
28 fire drag events to themselves.</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#ignoreSelf" ext:member="#ignoreSelf" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-invalidHandleClasses"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-invalidHandleClasses">invalidHandleClasses</a></b> : Array<div class="mdesc">An Array of CSS class names for elements to be considered in valid as drag handles.</div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#invalidHandleClasses" ext:member="#invalidHandleClasses" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-invalidHandleIds"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-invalidHandleIds">invalidHandleIds</a></b> : Object<div class="mdesc"><div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles.\r
29 A non-null prop...</div><div class="long">An object who's property names identify the IDs of elements to be considered invalid as drag handles.
30 A non-null property value identifies the ID as invalid. For example, to prevent
31 dragging from being initiated on element ID "foo", use:<pre><code>{
32     foo: true
33 }</code></pre></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#invalidHandleIds" ext:member="#invalidHandleIds" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-invalidHandleTypes"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-invalidHandleTypes">invalidHandleTypes</a></b> : Object<div class="mdesc"><div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles.\r
34 A non-null property value...</div><div class="long">An object who's property names identify HTML tags to be considered invalid as drag handles.
35 A non-null property value identifies the tag as invalid. Defaults to the 
36 following value which prevents drag operations from being initiated by &lt;a> elements:<pre><code>{
37     A: <em>"A"</em>
38 }</code></pre></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#invalidHandleTypes" ext:member="#invalidHandleTypes" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-isTarget"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-isTarget">isTarget</a></b> : boolean<div class="mdesc">By default, all instances can be a drop target.  This can be disabled by
39 setting isTarget to false.</div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#isTarget" ext:member="#isTarget" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-maintainOffset"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-maintainOffset">maintainOffset</a></b> : boolean<div class="mdesc"><div class="short">Maintain offsets when we resetconstraints.  Set to true when you want\r
40 the position of the element relative to its par...</div><div class="long">Maintain offsets when we resetconstraints.  Set to true when you want
41 the position of the element relative to its parent to stay the same
42 when the page changes</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#maintainOffset" ext:member="#maintainOffset" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-moveOnly"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-moveOnly">moveOnly</a></b> : boolean<div class="mdesc"><div class="short">When set to true, other DD objects in cooperating DDGroups do not receive\r
43 notification events when this DD object is ...</div><div class="long">When set to true, other DD objects in cooperating DDGroups do not receive
44 notification events when this DD object is dragged over them. Defaults to false.</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#moveOnly" ext:member="#moveOnly" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-padding"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-padding">padding</a></b> : int[] An array containing the 4 padding values: [top, right, bottom, left]<div class="mdesc">The padding configured for this drag and drop object for calculating
45 the drop zone intersection with this object.</div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#padding" ext:member="#padding" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-primaryButtonOnly"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-primaryButtonOnly">primaryButtonOnly</a></b> : boolean<div class="mdesc"><div class="short">By default the drag and drop instance will only respond to the primary\r
46 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
47 button click (left button for a right-handed mouse).  Set to true to
48 allow drag and drop to start with any mouse click that is propogated
49 by the browser</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#primaryButtonOnly" ext:member="#primaryButtonOnly" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DDProxy-resizeFrame"></a><b><a href="source/DDCore.html#prop-Ext.dd.DDProxy-resizeFrame">resizeFrame</a></b> : boolean<div class="mdesc"><div class="short">By default we resize the drag frame to be the same size as the element\r
50 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
51 we want to drag (this is to get the frame effect).  We can turn it off
52 if we want a different behavior.</div></div></td><td class="msource"><a href="output/Ext.dd.DDProxy.html#resizeFrame" ext:member="#resizeFrame" ext:cls="Ext.dd.DDProxy">DDProxy</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-scroll"></a><b><a href="source/DDCore.html#prop-Ext.dd.DD-scroll">scroll</a></b> : boolean<div class="mdesc"><div class="short">When set to true, the utility automatically tries to scroll the browser\r
53 window when a drag and drop element is dragge...</div><div class="long">When set to true, the utility automatically tries to scroll the browser
54 window when a drag and drop element is dragged near the viewport boundary.
55 Defaults to true.</div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#scroll" ext:member="#scroll" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-xTicks"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-xTicks">xTicks</a></b> : int[]<div class="mdesc"><div class="short">Array of pixel locations the element will snap to if we specified a\r
56 horizontal graduation/interval.  This array is ge...</div><div class="long">Array of pixel locations the element will snap to if we specified a
57 horizontal graduation/interval.  This array is generated automatically
58 when you define a tick interval.</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#xTicks" ext:member="#xTicks" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-yTicks"></a><b><a href="source/DDCore.html#prop-Ext.dd.DragDrop-yTicks">yTicks</a></b> : int[]<div class="mdesc"><div class="short">Array of pixel locations the element will snap to if we specified a\r
59 vertical graduation/interval.  This array is gene...</div><div class="long">Array of pixel locations the element will snap to if we specified a
60 vertical graduation/interval.  This array is generated automatically
61 when you define a tick interval.</div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#yTicks" ext:member="#yTicks" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr></tbody></table><a id="Ext.dd.DragSource-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-DragSource"></a><b><a href="source/DragSource.html#cls-Ext.dd.DragSource">DragSource</a></b>(&nbsp;<code>Mixed&nbsp;el</code>,&nbsp;<code>Object&nbsp;config</code>&nbsp;)\r
62     <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>void</li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-addInvalidHandleClass"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-addInvalidHandleClass">addInvalidHandleClass</a></b>(&nbsp;<code>string&nbsp;cssClass</code>&nbsp;)\r
63     :\r
64                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#addInvalidHandleClass" ext:member="#addInvalidHandleClass" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-addInvalidHandleId"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-addInvalidHandleId">addInvalidHandleId</a></b>(&nbsp;<code>string&nbsp;id</code>&nbsp;)\r
65     :\r
66                                         void<div class="mdesc"><div class="short">Lets you to specify an element id for a child of a drag handle\r
67 that should not initiate a drag</div><div class="long">Lets you to specify an element id for a child of a drag handle
68 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#addInvalidHandleId" ext:member="#addInvalidHandleId" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-addInvalidHandleType"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-addInvalidHandleType">addInvalidHandleType</a></b>(&nbsp;<code>string&nbsp;tagName</code>&nbsp;)\r
69     :\r
70                                         void<div class="mdesc"><div class="short">Allows you to specify a tag name that should not start a drag operation\r
71 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
72 when clicked.  This is designed to facilitate embedding links within a
73 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#addInvalidHandleType" ext:member="#addInvalidHandleType" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-addToGroup"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-addToGroup">addToGroup</a></b>(&nbsp;<code>sGroup&nbsp;{string}</code>&nbsp;)\r
74     :\r
75                                         void<div class="mdesc"><div class="short">Add this instance to a group of related drag/drop objects.  All\r
76 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
77 instances belong to at least one group, and can belong to as many
78 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#addToGroup" ext:member="#addToGroup" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-afterDragDrop"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-afterDragDrop">afterDragDrop</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
79     :\r
80                                         void<div class="mdesc"><div class="short">An empty function by default, but provided so that you can perform a custom action&#13;\r
81 after a valid drag drop has occur...</div><div class="long">An empty function by default, but provided so that you can perform a custom action\r
82 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>void</li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-afterDragEnter"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-afterDragEnter">afterDragEnter</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
83     :\r
84                                         void<div class="mdesc"><div class="short">An empty function by default, but provided so that you can perform a custom action&#13;\r
85 when the dragged item enters the ...</div><div class="long">An empty function by default, but provided so that you can perform a custom action\r
86 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>void</li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-afterDragOut"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-afterDragOut">afterDragOut</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
87     :\r
88                                         void<div class="mdesc"><div class="short">An empty function by default, but provided so that you can perform a custom action&#13;\r
89 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\r
90 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>void</li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-afterDragOver"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-afterDragOver">afterDragOver</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
91     :\r
92                                         void<div class="mdesc"><div class="short">An empty function by default, but provided so that you can perform a custom action&#13;\r
93 while the dragged item is over th...</div><div class="long">An empty function by default, but provided so that you can perform a custom action\r
94 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>void</li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-afterInvalidDrop"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-afterInvalidDrop">afterInvalidDrop</a></b>(&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
95     :\r
96                                         void<div class="mdesc"><div class="short">An empty function by default, but provided so that you can perform a custom action&#13;\r
97 after an invalid drop has occurre...</div><div class="long">An empty function by default, but provided so that you can perform a custom action\r
98 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>void</li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-alignElWithMouse"></a><b><a href="source/DDCore.html#method-Ext.dd.DD-alignElWithMouse">alignElWithMouse</a></b>(&nbsp;<code>HTMLElement&nbsp;el</code>,&nbsp;<code>int&nbsp;iPageX</code>,&nbsp;<code>int&nbsp;iPageY</code>&nbsp;)\r
99     :\r
100                                         void<div class="mdesc"><div class="short">Sets the element to the location of the mousedown or click event,\r
101 maintaining the cursor location relative to the loc...</div><div class="long">Sets the element to the location of the mousedown or click event,
102 maintaining the cursor location relative to the location on the element
103 that was clicked.  Override this if you want to place the element in a
104 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#alignElWithMouse" ext:member="#alignElWithMouse" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-applyConfig"></a><b><a href="source/DDCore.html#method-Ext.dd.DD-applyConfig">applyConfig</a></b>()\r
105     :\r
106                                         void<div class="mdesc"><div class="short">Sets up config options specific to this class. Overrides\r
107 Ext.dd.DragDrop, but all versions of this method through the...</div><div class="long">Sets up config options specific to this class. Overrides
108 Ext.dd.DragDrop, but all versions of this method through the
109 inheritance chain are called<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#applyConfig" ext:member="#applyConfig" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-autoOffset"></a><b><a href="source/DDCore.html#method-Ext.dd.DD-autoOffset">autoOffset</a></b>(&nbsp;<code>int&nbsp;iPageX</code>,&nbsp;<code>int&nbsp;iPageY</code>&nbsp;)\r
110     :\r
111                                         void<div class="mdesc"><div class="short">Sets the pointer offset to the distance between the linked element's top\r
112 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
113 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#autoOffset" ext:member="#autoOffset" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-b4Drag"></a><b><a href="source/DDCore.html#method-Ext.dd.DD-b4Drag">b4Drag</a></b>()\r
114     :\r
115                                         void<div class="mdesc"><div class="short">Event that fires prior to the onDrag event.  Overrides\r
116 Ext.dd.DragDrop.</div><div class="long">Event that fires prior to the onDrag event.  Overrides
117 Ext.dd.DragDrop.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#b4Drag" ext:member="#b4Drag" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-b4MouseDown"></a><b><a href="source/DDCore.html#method-Ext.dd.DD-b4MouseDown">b4MouseDown</a></b>()\r
118     :\r
119                                         void<div class="mdesc"><div class="short">Event that fires prior to the onMouseDown event.  Overrides\r
120 Ext.dd.DragDrop.</div><div class="long">Event that fires prior to the onMouseDown event.  Overrides
121 Ext.dd.DragDrop.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#b4MouseDown" ext:member="#b4MouseDown" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-beforeDragDrop"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-beforeDragDrop">beforeDragDrop</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
122     :\r
123                                         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&#13;\r
124 item is droppe...</div><div class="long">An empty function by default, but provided so that you can perform a custom action before the dragged\r
125 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">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-beforeDragEnter"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-beforeDragEnter">beforeDragEnter</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
126     :\r
127                                         Boolean<div class="mdesc"><div class="short">An empty function by default, but provided so that you can perform a custom action&#13;\r
128 before the dragged item enters th...</div><div class="long">An empty function by default, but provided so that you can perform a custom action\r
129 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">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-beforeDragOut"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-beforeDragOut">beforeDragOut</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
130     :\r
131                                         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&#13;\r
132 item is dragge...</div><div class="long">An empty function by default, but provided so that you can perform a custom action before the dragged\r
133 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">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-beforeDragOver"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-beforeDragOver">beforeDragOver</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
134     :\r
135                                         Boolean<div class="mdesc"><div class="short">An empty function by default, but provided so that you can perform a custom action&#13;\r
136 while the dragged item is over th...</div><div class="long">An empty function by default, but provided so that you can perform a custom action\r
137 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">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-beforeInvalidDrop"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-beforeInvalidDrop">beforeInvalidDrop</a></b>(&nbsp;<code>Ext.dd.DragDrop&nbsp;target</code>,&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
138     :\r
139                                         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&#13;\r
140 drop has occurre...</div><div class="long">An empty function by default, but provided so that you can perform a custom action after an invalid\r
141 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">DragSource</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-cachePosition"></a><b><a href="source/DDCore.html#method-Ext.dd.DD-cachePosition">cachePosition</a></b>(&nbsp;<code>iPageX&nbsp;the</code>,&nbsp;<code>iPageY&nbsp;the</code>&nbsp;)\r
142     :\r
143                                         void<div class="mdesc"><div class="short">Saves the most recent position so that we can reset the constraints and\r
144 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
145 tick marks on-demand.  We need to know this so that we can calculate the
146 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
147 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
148 don't have to look it up again)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#cachePosition" ext:member="#cachePosition" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-clearConstraints"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-clearConstraints">clearConstraints</a></b>()\r
149     :\r
150                                         void<div class="mdesc"><div class="short">Clears any constraints applied to this instance.  Also clears ticks\r
151 since they can't exist independent of a constrain...</div><div class="long">Clears any constraints applied to this instance.  Also clears ticks
152 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#clearConstraints" ext:member="#clearConstraints" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-clearTicks"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-clearTicks">clearTicks</a></b>()\r
153     :\r
154                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#clearTicks" ext:member="#clearTicks" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-constrainTo"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-constrainTo">constrainTo</a></b>(&nbsp;<code>Mixed&nbsp;constrainTo</code>,&nbsp;<span title="Optional" class="optional">[<code>Object/Number&nbsp;pad</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;inContent</code>]</span>&nbsp;)\r
155     :\r
156                                         void<div class="mdesc"><div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element.\r
157 Usage:\r
158  var dd = new Ext.dd...</div><div class="long">Initializes the drag drop object's constraints to restrict movement to a certain element.
159 Usage:
160  <pre><code><b>var</b> dd = <b>new</b> Ext.dd.DDProxy(<em>"dragDiv1"</em>, <em>"proxytest"</em>,
161                 { dragElId: <em>"existingProxyDiv"</em> });
162  dd.startDrag = <b>function</b>(){
163      this.constrainTo(<em>"parent-id"</em>);
164  };</code></pre>
165 Or you can initalize it using the <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> object:
166  <pre><code>Ext.get(<em>"dragDiv1"</em>).initDDProxy(<em>"proxytest"</em>, {dragElId: <em>"existingProxyDiv"</em>}, {
167      startDrag : <b>function</b>(){
168          this.constrainTo(<em>"parent-id"</em>);
169      }
170  });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>constrainTo</code> : Mixed<div class="sub-desc">The element to constrain to.</div></li><li><code>pad</code> : Object/Number<div class="sub-desc">(optional) Pad provides a way to specify "padding" of the constraints,
171 and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
172 an object containing the sides to pad. For example: {right:10, bottom:10}</div></li><li><code>inContent</code> : Boolean<div class="sub-desc">(optional) Constrain the draggable in the content box of the element (inside padding and borders)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#constrainTo" ext:member="#constrainTo" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DDProxy-createFrame"></a><b><a href="source/DDCore.html#method-Ext.dd.DDProxy-createFrame">createFrame</a></b>()\r
173     :\r
174                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DDProxy.html#createFrame" ext:member="#createFrame" ext:cls="Ext.dd.DDProxy">DDProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-endDrag"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-endDrag">endDrag</a></b>(&nbsp;<code>Event&nbsp;e</code>&nbsp;)\r
175     :\r
176                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#endDrag" ext:member="#endDrag" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-getDragData"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-getDragData">getDragData</a></b>()\r
177     :\r
178                                         Object<div class="mdesc"><div class="short">Returns the data object associated with this drag source</div><div class="long">Returns the data object associated with this drag source<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">data An object containing arbitrary data</div></li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-getDragEl"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-getDragEl">getDragEl</a></b>()\r
179     :\r
180                                         HTMLElement<div class="mdesc"><div class="short">Returns a reference to the actual element to drag.  By default this is\r
181 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
182 the same as the html element, but it can be assigned to another
183 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 href="output/Ext.dd.DragDrop.html#getDragEl" ext:member="#getDragEl" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-getEl"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-getEl">getEl</a></b>()\r
184     :\r
185                                         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 href="output/Ext.dd.DragDrop.html#getEl" ext:member="#getEl" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-getProxy"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-getProxy">getProxy</a></b>()\r
186     :\r
187                                         Ext.dd.StatusProxy<div class="mdesc"><div class="short">Returns the drag source's underlying Ext.dd.StatusProxy</div><div class="long">Returns the drag source's underlying <a href="output/Ext.dd.StatusProxy.html" ext:cls="Ext.dd.StatusProxy">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">DragSource</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-hideProxy"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-hideProxy">hideProxy</a></b>()\r
188     :\r
189                                         void<div class="mdesc"><div class="short">Hides the drag source's Ext.dd.StatusProxy</div><div class="long">Hides the drag source's <a href="output/Ext.dd.StatusProxy.html" ext:cls="Ext.dd.StatusProxy">Ext.dd.StatusProxy</a><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-init"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-init">init</a></b>(&nbsp;<code>id&nbsp;the</code>,&nbsp;<code>String&nbsp;sGroup</code>,&nbsp;<code>object&nbsp;config</code>&nbsp;)\r
190     :\r
191                                         void<div class="mdesc"><div class="short">Sets up the DragDrop object.  Must be called in the constructor of any\r
192 Ext.dd.DragDrop subclass</div><div class="long">Sets up the DragDrop object.  Must be called in the constructor of any
193 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#init" ext:member="#init" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DDProxy-initFrame"></a><b><a href="source/DDCore.html#method-Ext.dd.DDProxy-initFrame">initFrame</a></b>()\r
194     :\r
195                                         void<div class="mdesc"><div class="short">Initialization for the drag frame element.  Must be called in the\r
196 constructor of all subclasses</div><div class="long">Initialization for the drag frame element.  Must be called in the
197 constructor of all subclasses<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DDProxy.html#initFrame" ext:member="#initFrame" ext:cls="Ext.dd.DDProxy">DDProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-initTarget"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-initTarget">initTarget</a></b>(&nbsp;<code>id&nbsp;the</code>,&nbsp;<code>String&nbsp;sGroup</code>,&nbsp;<code>object&nbsp;config</code>&nbsp;)\r
198     :\r
199                                         void<div class="mdesc"><div class="short">Initializes Targeting functionality only... the object does not\r
200 get a mousedown handler.</div><div class="long">Initializes Targeting functionality only... the object does not
201 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#initTarget" ext:member="#initTarget" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-isLocked"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-isLocked">isLocked</a></b>()\r
202     :\r
203                                         boolean<div class="mdesc"><div class="short">Returns true if this instance is locked, or the drag drop mgr is locked\r
204 (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
205 (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\r
206 false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#isLocked" ext:member="#isLocked" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-isValidHandleChild"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-isValidHandleChild">isValidHandleChild</a></b>(&nbsp;<code>HTMLElement&nbsp;node</code>&nbsp;)\r
207     :\r
208                                         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 href="output/Ext.dd.DragDrop.html#isValidHandleChild" ext:member="#isValidHandleChild" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-lock"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-lock">lock</a></b>()\r
209     :\r
210                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#lock" ext:member="#lock" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onAvailable"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onAvailable">onAvailable</a></b>()\r
211     :\r
212                                         void<div class="mdesc"><div class="short">Override the onAvailable method to do what is needed after the initial\r
213 position was determined.</div><div class="long">Override the onAvailable method to do what is needed after the initial
214 position was determined.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onAvailable" ext:member="#onAvailable" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-onBeforeDrag"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-onBeforeDrag">onBeforeDrag</a></b>(&nbsp;<code>Object&nbsp;data</code>,&nbsp;<code>Event&nbsp;e</code>&nbsp;)\r
215     :\r
216                                         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&#13;\r
217 drag event beg...</div><div class="long">An empty function by default, but provided so that you can perform a custom action before the initial\r
218 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">DragSource</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onDrag"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onDrag">onDrag</a></b>(&nbsp;<code>Event&nbsp;e</code>&nbsp;)\r
219     :\r
220                                         void<div class="mdesc"><div class="short">Abstract method called during the onMouseMove event while dragging an\r
221 object.</div><div class="long">Abstract method called during the onMouseMove event while dragging an
222 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onDrag" ext:member="#onDrag" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onDragDrop"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onDragDrop">onDragDrop</a></b>(&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String|DragDrop[]&nbsp;id</code>&nbsp;)\r
223     :\r
224                                         void<div class="mdesc"><div class="short">Abstract method called when this item is dropped on another DragDrop\r
225 obj</div><div class="long">Abstract method called when this item is dropped on another DragDrop
226 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
227 id this was dropped on.  In INTERSECT mode, an array of dd items this
228 was dropped on.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onDragDrop" ext:member="#onDragDrop" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onDragEnter"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onDragEnter">onDragEnter</a></b>(&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String|DragDrop[]&nbsp;id</code>&nbsp;)\r
229     :\r
230                                         void<div class="mdesc"><div class="short">Abstract method called when this element fist begins hovering over\r
231 another DragDrop obj</div><div class="long">Abstract method called when this element fist begins hovering over
232 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
233 id this is hovering over.  In INTERSECT mode, an array of one or more
234 dragdrop items being hovered over.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onDragEnter" ext:member="#onDragEnter" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onDragOut"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onDragOut">onDragOut</a></b>(&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String|DragDrop[]&nbsp;id</code>&nbsp;)\r
235     :\r
236                                         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
237 id this was hovering over.  In INTERSECT mode, an array of dd items
238 that the mouse is no longer over.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onDragOut" ext:member="#onDragOut" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onDragOver"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onDragOver">onDragOver</a></b>(&nbsp;<code>Event&nbsp;e</code>,&nbsp;<code>String|DragDrop[]&nbsp;id</code>&nbsp;)\r
239     :\r
240                                         void<div class="mdesc"><div class="short">Abstract method called when this element is hovering over another\r
241 DragDrop obj</div><div class="long">Abstract method called when this element is hovering over another
242 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
243 id this is hovering over.  In INTERSECT mode, an array of dd items
244 being hovered over.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onDragOver" ext:member="#onDragOver" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onInvalidDrop"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onInvalidDrop">onInvalidDrop</a></b>(&nbsp;<code>Event&nbsp;e</code>&nbsp;)\r
245     :\r
246                                         void<div class="mdesc"><div class="short">Abstract method called when this item is dropped on an area with no\r
247 drop target</div><div class="long">Abstract method called when this item is dropped on an area with no
248 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onInvalidDrop" ext:member="#onInvalidDrop" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onMouseDown"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onMouseDown">onMouseDown</a></b>(&nbsp;<code>Event&nbsp;e</code>&nbsp;)\r
249     :\r
250                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onMouseDown" ext:member="#onMouseDown" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-onMouseUp"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-onMouseUp">onMouseUp</a></b>(&nbsp;<code>Event&nbsp;e</code>&nbsp;)\r
251     :\r
252                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#onMouseUp" ext:member="#onMouseUp" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragSource-onStartDrag"></a><b><a href="source/DragSource.html#method-Ext.dd.DragSource-onStartDrag">onStartDrag</a></b>(&nbsp;<code>Number&nbsp;x</code>,&nbsp;<code>Number&nbsp;y</code>&nbsp;)\r
253     :\r
254                                         void<div class="mdesc"><div class="short">An empty function by default, but provided so that you can perform a custom action once the initial&#13;\r
255 drag event has b...</div><div class="long">An empty function by default, but provided so that you can perform a custom action once the initial\r
256 drag event has begun.  The drag cannot be canceled from this function.<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>void</li></ul></div></div></div></td><td class="msource">DragSource</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-removeFromGroup"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-removeFromGroup">removeFromGroup</a></b>(&nbsp;<code>string&nbsp;sGroup</code>&nbsp;)\r
257     :\r
258                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#removeFromGroup" ext:member="#removeFromGroup" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-removeInvalidHandleClass"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-removeInvalidHandleClass">removeInvalidHandleClass</a></b>(&nbsp;<code>string&nbsp;cssClass</code>&nbsp;)\r
259     :\r
260                                         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
261 re-enable</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass" ext:member="#removeInvalidHandleClass" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-removeInvalidHandleId"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-removeInvalidHandleId">removeInvalidHandleId</a></b>(&nbsp;<code>string&nbsp;id</code>&nbsp;)\r
262     :\r
263                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#removeInvalidHandleId" ext:member="#removeInvalidHandleId" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-removeInvalidHandleType"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-removeInvalidHandleType">removeInvalidHandleType</a></b>(&nbsp;<code>string&nbsp;tagName</code>&nbsp;)\r
264     :\r
265                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#removeInvalidHandleType" ext:member="#removeInvalidHandleType" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-resetConstraints"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-resetConstraints">resetConstraints</a></b>(&nbsp;<code>boolean&nbsp;maintainOffset</code>&nbsp;)\r
266     :\r
267                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#resetConstraints" ext:member="#resetConstraints" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-setDelta"></a><b><a href="source/DDCore.html#method-Ext.dd.DD-setDelta">setDelta</a></b>(&nbsp;<code>int&nbsp;iDeltaX</code>,&nbsp;<code>int&nbsp;iDeltaY</code>&nbsp;)\r
268     :\r
269                                         void<div class="mdesc"><div class="short">Sets the pointer offset.  You can call this directly to force the\r
270 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
271 offset to be in a particular location (e.g., pass in 0,0 to set it
272 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#setDelta" ext:member="#setDelta" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-setDragElId"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-setDragElId">setDragElId</a></b>(&nbsp;<code>id&nbsp;{string}</code>&nbsp;)\r
273     :\r
274                                         void<div class="mdesc"><div class="short">Allows you to specify that an element other than the linked element\r
275 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
276 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#setDragElId" ext:member="#setDragElId" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DD-setDragElPos"></a><b><a href="source/DDCore.html#method-Ext.dd.DD-setDragElPos">setDragElPos</a></b>(&nbsp;<code>int&nbsp;iPageX</code>,&nbsp;<code>int&nbsp;iPageY</code>&nbsp;)\r
277     :\r
278                                         void<div class="mdesc"><div class="short">Sets the drag element to the location of the mousedown or click event,\r
279 maintaining the cursor location relative to th...</div><div class="long">Sets the drag element to the location of the mousedown or click event,
280 maintaining the cursor location relative to the location on the element
281 that was clicked.  Override this if you want to place the element in a
282 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DD.html#setDragElPos" ext:member="#setDragElPos" ext:cls="Ext.dd.DD">DD</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-setHandleElId"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-setHandleElId">setHandleElId</a></b>(&nbsp;<code>id&nbsp;{string}</code>&nbsp;)\r
283     :\r
284                                         void<div class="mdesc"><div class="short">Allows you to specify a child of the linked element that should be\r
285 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
286 used to initiate the drag operation.  An example of this would be if
287 you have a content div with text and links.  Clicking anywhere in the
288 content area would normally start the drag operation.  Use this method
289 to specify that an element inside of the content div is the element
290 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
291 initiate the drag.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#setHandleElId" ext:member="#setHandleElId" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-setInitPosition"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-setInitPosition">setInitPosition</a></b>(&nbsp;<code>int&nbsp;diffX</code>,&nbsp;<code>int&nbsp;diffY</code>&nbsp;)\r
292     :\r
293                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#setInitPosition" ext:member="#setInitPosition" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-setOuterHandleElId"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-setOuterHandleElId">setOuterHandleElId</a></b>(&nbsp;<code>id&nbsp;the</code>&nbsp;)\r
294     :\r
295                                         void<div class="mdesc"><div class="short">Allows you to set an element outside of the linked element as a drag\r
296 handle</div><div class="long">Allows you to set an element outside of the linked element as a drag
297 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#setOuterHandleElId" ext:member="#setOuterHandleElId" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-setPadding"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-setPadding">setPadding</a></b>(&nbsp;<code>int&nbsp;iTop</code>,&nbsp;<code>int&nbsp;iRight</code>,&nbsp;<code>int&nbsp;iBot</code>,&nbsp;<code>int&nbsp;iLeft</code>&nbsp;)\r
298     :\r
299                                         void<div class="mdesc"><div class="short">Configures the padding for the target zone in px.  Effectively expands\r
300 (or reduces) the virtual object size for targe...</div><div class="long">Configures the padding for the target zone in px.  Effectively expands
301 (or reduces) the virtual object size for targeting calculations.
302 Supports css-style shorthand; if only one parameter is passed, all sides
303 will have that padding, and if only two are passed, the top and bottom
304 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#setPadding" ext:member="#setPadding" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-setXConstraint"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-setXConstraint">setXConstraint</a></b>(&nbsp;<code>int&nbsp;iLeft</code>,&nbsp;<code>int&nbsp;iRight</code>,&nbsp;<code>int&nbsp;iTickSize</code>&nbsp;)\r
305     :\r
306                                         void<div class="mdesc"><div class="short">By default, the element can be dragged any place on the screen.  Use\r
307 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
308 this method to limit the horizontal travel of the element.  Pass in
309 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
310 right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
311 element
312 should move iTickSize pixels at a time.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#setXConstraint" ext:member="#setXConstraint" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-setYConstraint"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-setYConstraint">setYConstraint</a></b>(&nbsp;<code>int&nbsp;iUp</code>,&nbsp;<code>int&nbsp;iDown</code>,&nbsp;<code>int&nbsp;iTickSize</code>&nbsp;)\r
313     :\r
314                                         void<div class="mdesc"><div class="short">By default, the element can be dragged any place on the screen.  Set\r
315 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
316 this to limit the vertical travel of the element.  Pass in 0,0 for the
317 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
318 element should move iTickSize pixels at a time.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#setYConstraint" ext:member="#setYConstraint" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-startDrag"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-startDrag">startDrag</a></b>(&nbsp;<code>int&nbsp;X</code>,&nbsp;<code>int&nbsp;Y</code>&nbsp;)\r
319     :\r
320                                         void<div class="mdesc"><div class="short">Abstract method called after a drag/drop object is clicked\r
321 and the drag or mousedown time thresholds have beeen met.</div><div class="long">Abstract method called after a drag/drop object is clicked
322 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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#startDrag" ext:member="#startDrag" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-toString"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-toString">toString</a></b>()\r
323     :\r
324                                         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 href="output/Ext.dd.DragDrop.html#toString" ext:member="#toString" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-unlock"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-unlock">unlock</a></b>()\r
325     :\r
326                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#unlock" ext:member="#unlock" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.dd.DragDrop-unreg"></a><b><a href="source/DDCore.html#method-Ext.dd.DragDrop-unreg">unreg</a></b>()\r
327     :\r
328                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.dd.DragDrop.html#unreg" ext:member="#unreg" ext:cls="Ext.dd.DragDrop">DragDrop</a></td></tr></tbody></table><a id="Ext.dd.DragSource-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>