Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.dd.DragSource.html
1 <!DOCTYPE html><html><head><title>Ext.dd.DragSource | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.dd.DragSource',
13         docClass: 'Ext.dd.DragSource',
14         docReq: 'Ext.dd.DragSource',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'DragSource.html#Ext-dd.DragSource';
33     clsInfo = {"methods":["DragSource","addInvalidHandleClass","addInvalidHandleId","addInvalidHandleType","addToGroup","afterDragDrop","afterDragEnter","afterDragOut","afterDragOver","afterInvalidDrop","alignElWithMouse","applyConfig","autoOffset","b4Drag","b4MouseDown","beforeDragDrop","beforeDragEnter","beforeDragOut","beforeDragOver","beforeInvalidDrop","cachePosition","clearConstraints","clearTicks","constrainTo","createFrame","endDrag","getDragData","getDragEl","getEl","getProxy","hideProxy","init","initFrame","initTarget","isLocked","isValidHandleChild","lock","onAvailable","onBeforeDrag","onDrag","onDragDrop","onDragEnter","onDragOut","onDragOver","onInvalidDrop","onMouseDown","onMouseUp","removeFromGroup","removeInvalidHandleClass","removeInvalidHandleId","removeInvalidHandleType","resetConstraints","setDelta","setDragElId","setDragElPos","setHandleElId","setInitPosition","setOuterHandleElId","setPadding","setXConstraint","setYConstraint","startDrag","toString","unlock","unreg"],"cfgs":["animRepair","ddGroup","dropAllowed","dropNotAllowed","repairHighlightColor"],"properties":["Ext","available","centerFrame","config","defaultPadding","groups","hasOuterHandles","id","ignoreSelf","invalidHandleClasses","invalidHandleIds","invalidHandleTypes","isTarget","maintainOffset","moveOnly","onStartDrag","padding","primaryButtonOnly","resizeFrame","scroll","xTicks","yTicks"],"events":[],"subclasses":["Ext.dd.DragZone"]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/DragSource.html#Ext-dd.DragSource" target="_blank">Ext.dd.DragSource</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.dd.DragDrop.html" rel="Ext.dd.DragDrop" class="cls docClass">Ext.dd.DragDrop</a><div class="subclass"><a href="Ext.dd.DD.html" rel="Ext.dd.DD" class="cls docClass">Ext.dd.DD</a><div class="subclass"><a href="Ext.dd.DDProxy.html" rel="Ext.dd.DDProxy" class="cls docClass">Ext.dd.DDProxy</a><div class="subclass"><strong>Ext.dd.DragSource</strong></div></div></div></div></pre><p>A simple class that provides the basic implementation needed to make any element draggable.</p>
38 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-animRepair" class="member f ni"><a href="Ext.dd.DragSource.html#config-animRepair" rel="config-animRepair" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-cfg-animRepair" class="viewSource">view source</a></div><a name="animRepair"></a><a name="config-animRepair"></a><a href="Ext.dd.DragSource.html#" rel="config-animRepair" class="cls expand">animRepair</a><span> : Boolean</span></div><div class="description"><div class="short">Defaults to true. If true, animates the proxy element back to the position of the handle element used to trigger the ...</div><div class="long"><p>Defaults to true. If true, animates the proxy element back to the position of the handle element used to trigger the drag.</p>
39 </div></div></div><div id="config-ddGroup" class="member ni"><a href="Ext.dd.DragSource.html#config-ddGroup" rel="config-ddGroup" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-cfg-ddGroup" class="viewSource">view source</a></div><a name="ddGroup"></a><a name="config-ddGroup"></a><a href="Ext.dd.DragSource.html#" rel="config-ddGroup" class="cls expand">ddGroup</a><span> : String</span></div><div class="description"><div class="short">A named drag drop group to which this object belongs.  If a group is specified, then this object will only
40 interact w...</div><div class="long"><p>A named drag drop group to which this object belongs.  If a group is specified, then this object will only
41 interact with other drag drop objects in the same group (defaults to undefined).</p>
42 </div></div></div><div id="config-dropAllowed" class="member ni"><a href="Ext.dd.DragSource.html#config-dropAllowed" rel="config-dropAllowed" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-cfg-dropAllowed" class="viewSource">view source</a></div><a name="dropAllowed"></a><a name="config-dropAllowed"></a><a href="Ext.dd.DragSource.html#" rel="config-dropAllowed" class="cls expand">dropAllowed</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</p>
43 </div><div class="long"><p>The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</p>
44 </div></div></div><div id="config-dropNotAllowed" class="member ni"><a href="Ext.dd.DragSource.html#config-dropNotAllowed" rel="config-dropNotAllowed" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-cfg-dropNotAllowed" class="viewSource">view source</a></div><a name="dropNotAllowed"></a><a name="config-dropNotAllowed"></a><a href="Ext.dd.DragSource.html#" rel="config-dropNotAllowed" class="cls expand">dropNotAllowed</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</p>
45 </div><div class="long"><p>The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</p>
46 </div></div></div><div id="config-repairHighlightColor" class="member ni"><a href="Ext.dd.DragSource.html#config-repairHighlightColor" rel="config-repairHighlightColor" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-cfg-repairHighlightColor" class="viewSource">view source</a></div><a name="repairHighlightColor"></a><a name="config-repairHighlightColor"></a><a href="Ext.dd.DragSource.html#" rel="config-repairHighlightColor" class="cls expand">repairHighlightColor</a><span> : String</span></div><div class="description"><div class="short">The color to use when visually highlighting the drag source in the afterRepair
47 method after a failed drop (defaults t...</div><div class="long"><p>The color to use when visually highlighting the drag source in the afterRepair
48 method after a failed drop (defaults to 'c3daf9' - light blue). The color must be a 6 digit hex value, without
49 a preceding '#'.</p>
50 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-Ext" class="member f inherited"><a href="Ext.dd.DragSource.html#property-Ext" rel="property-Ext" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DDProxy.html" class="definedIn docClass">Ext.dd.DDProxy</a><br/><a href="../source/DDProxy.html#Ext-dd.DDProxy-property-Ext" class="viewSource">view source</a></div><a name="Ext"></a><a name="property-Ext"></a><a href="Ext.dd.DragSource.html#" rel="property-Ext" class="cls expand">Ext</a><span> : String</span></div><div class="description"><div class="short"><p>The default drag frame div id .dd.DDProxy.dragElId</p>
51 </div><div class="long"><p>The default drag frame div id .dd.DDProxy.dragElId</p>
52 </div></div></div><div id="property-available" class="member inherited"><a href="Ext.dd.DragSource.html#property-available" rel="property-available" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-available" class="viewSource">view source</a></div><a name="available"></a><a name="property-available"></a><a href="Ext.dd.DragSource.html#" rel="property-available" class="cls expand">available</a><span> : boolean</span></div><div class="description"><div class="short"><p>The available property is false until the linked dom element is accessible.</p>
53 </div><div class="long"><p>The available property is false until the linked dom element is accessible.</p>
54 </div></div></div><div id="property-centerFrame" class="member inherited"><a href="Ext.dd.DragSource.html#property-centerFrame" rel="property-centerFrame" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DDProxy.html" class="definedIn docClass">Ext.dd.DDProxy</a><br/><a href="../source/DDProxy.html#Ext-dd.DDProxy-property-centerFrame" class="viewSource">view source</a></div><a name="centerFrame"></a><a name="property-centerFrame"></a><a href="Ext.dd.DragSource.html#" rel="property-centerFrame" class="cls expand">centerFrame</a><span> : boolean</span></div><div class="description"><div class="short">By default the frame is positioned exactly where the drag element is, so
55 we use the cursor offset provided by Ext.dd....</div><div class="long"><p>By default the frame is positioned exactly where the drag element is, so
56 we use the cursor offset provided by <a href="Ext.dd.DD.html" rel="Ext.dd.DD" class="docClass">Ext.dd.DD</a>.  Another option that works only if
57 you do not have constraints on the obj is to have the drag frame centered
58 around the cursor.  Set centerFrame to true for this effect.</p>
59 </div></div></div><div id="property-config" class="member inherited"><a href="Ext.dd.DragSource.html#property-config" rel="property-config" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-config" class="viewSource">view source</a></div><a name="config"></a><a name="property-config"></a><a href="Ext.dd.DragSource.html#" rel="property-config" class="cls expand">config</a><span> : object</span></div><div class="description"><div class="short"><p>Configuration attributes passed into the constructor</p>
60 </div><div class="long"><p>Configuration attributes passed into the constructor</p>
61 </div></div></div><div id="property-defaultPadding" class="member inherited"><a href="Ext.dd.DragSource.html#property-defaultPadding" rel="property-defaultPadding" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-defaultPadding" class="viewSource">view source</a></div><a name="defaultPadding"></a><a name="property-defaultPadding"></a><a href="Ext.dd.DragSource.html#" rel="property-defaultPadding" class="cls expand">defaultPadding</a><span> : Object</span></div><div class="description"><div class="short"><p>Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).</p>
62 </div><div class="long"><p>Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).</p>
63 </div></div></div><div id="property-groups" class="member inherited"><a href="Ext.dd.DragSource.html#property-groups" rel="property-groups" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-groups" class="viewSource">view source</a></div><a name="groups"></a><a name="property-groups"></a><a href="Ext.dd.DragSource.html#" rel="property-groups" class="cls expand">groups</a><span> : object</span></div><div class="description"><div class="short">The group defines a logical collection of DragDrop objects that are
64 related.  Instances only get events when interact...</div><div class="long"><p>The group defines a logical collection of DragDrop objects that are
65 related.  Instances only get events when interacting with other
66 DragDrop object in the same group.  This lets us define multiple
67 groups using a single DragDrop subclass if we want. An object in the format {'group1':true, 'group2':true}</p>
68 </div></div></div><div id="property-hasOuterHandles" class="member inherited"><a href="Ext.dd.DragSource.html#property-hasOuterHandles" rel="property-hasOuterHandles" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-hasOuterHandles" class="viewSource">view source</a></div><a name="hasOuterHandles"></a><a name="property-hasOuterHandles"></a><a href="Ext.dd.DragSource.html#" rel="property-hasOuterHandles" class="cls expand">hasOuterHandles</a><span> : boolean</span></div><div class="description"><div class="short">By default, drags can only be initiated if the mousedown occurs in the
69 region the linked element is.  This is done in...</div><div class="long"><p>By default, drags can only be initiated if the mousedown occurs in the
70 region the linked element is.  This is done in part to work around a
71 bug in some browsers that mis-report the mousedown if the previous
72 mouseup happened outside of the window.  This property is set to true
73 if outer handles are defined. @default false</p>
74 </div></div></div><div id="property-id" class="member inherited"><a href="Ext.dd.DragSource.html#property-id" rel="property-id" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-id" class="viewSource">view source</a></div><a name="id"></a><a name="property-id"></a><a href="Ext.dd.DragSource.html#" rel="property-id" class="cls expand">id</a><span> : String</span></div><div class="description"><div class="short">The id of the element associated with this object.  This is what we
75 refer to as the "linked element" because the size...</div><div class="long"><p>The id of the element associated with this object.  This is what we
76 refer to as the "linked element" because the size and position of
77 this element is used to determine when the drag and drop objects have
78 interacted.</p>
79 </div></div></div><div id="property-ignoreSelf" class="member inherited"><a href="Ext.dd.DragSource.html#property-ignoreSelf" rel="property-ignoreSelf" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-ignoreSelf" class="viewSource">view source</a></div><a name="ignoreSelf"></a><a name="property-ignoreSelf"></a><a href="Ext.dd.DragSource.html#" rel="property-ignoreSelf" class="cls expand">ignoreSelf</a><span> : Boolean</span></div><div class="description"><div class="short">Set to false to enable a DragDrop object to fire drag events while dragging
80 over its own Element. Defaults to true - ...</div><div class="long"><p>Set to false to enable a DragDrop object to fire drag events while dragging
81 over its own Element. Defaults to true - DragDrop objects do not by default
82 fire drag events to themselves.</p>
83 </div></div></div><div id="property-invalidHandleClasses" class="member inherited"><a href="Ext.dd.DragSource.html#property-invalidHandleClasses" rel="property-invalidHandleClasses" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-invalidHandleClasses" class="viewSource">view source</a></div><a name="invalidHandleClasses"></a><a name="property-invalidHandleClasses"></a><a href="Ext.dd.DragSource.html#" rel="property-invalidHandleClasses" class="cls expand">invalidHandleClasses</a><span> : Array</span></div><div class="description"><div class="short"><p>An Array of CSS class names for elements to be considered in valid as drag handles.</p>
84 </div><div class="long"><p>An Array of CSS class names for elements to be considered in valid as drag handles.</p>
85 </div></div></div><div id="property-invalidHandleIds" class="member inherited"><a href="Ext.dd.DragSource.html#property-invalidHandleIds" rel="property-invalidHandleIds" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-invalidHandleIds" class="viewSource">view source</a></div><a name="invalidHandleIds"></a><a name="property-invalidHandleIds"></a><a href="Ext.dd.DragSource.html#" rel="property-invalidHandleIds" class="cls expand">invalidHandleIds</a><span> : Object</span></div><div class="description"><div class="short">An object who's property names identify the IDs of elements to be considered invalid as drag handles.
86 A non-null prop...</div><div class="long"><p>An object who's property names identify the IDs of elements to be considered invalid as drag handles.
87 A non-null property value identifies the ID as invalid. For example, to prevent
88 dragging from being initiated on element ID "foo", use:</p>
89
90 <pre><code>{
91     foo: true
92 }</code></pre>
93
94 </div></div></div><div id="property-invalidHandleTypes" class="member inherited"><a href="Ext.dd.DragSource.html#property-invalidHandleTypes" rel="property-invalidHandleTypes" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-invalidHandleTypes" class="viewSource">view source</a></div><a name="invalidHandleTypes"></a><a name="property-invalidHandleTypes"></a><a href="Ext.dd.DragSource.html#" rel="property-invalidHandleTypes" class="cls expand">invalidHandleTypes</a><span> : Object</span></div><div class="description"><div class="short">An object who's property names identify HTML tags to be considered invalid as drag handles.
95 A non-null property value...</div><div class="long"><p>An object who's property names identify HTML tags to be considered invalid as drag handles.
96 A non-null property value identifies the tag as invalid. Defaults to the
97 following value which prevents drag operations from being initiated by &lt;a> elements:</p>
98
99 <pre><code>{
100     A: "A"
101 }</code></pre>
102
103 </div></div></div><div id="property-isTarget" class="member inherited"><a href="Ext.dd.DragSource.html#property-isTarget" rel="property-isTarget" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-isTarget" class="viewSource">view source</a></div><a name="isTarget"></a><a name="property-isTarget"></a><a href="Ext.dd.DragSource.html#" rel="property-isTarget" class="cls expand">isTarget</a><span> : boolean</span></div><div class="description"><div class="short"><p>By default, all instances can be a drop target.  This can be disabled by
104 setting isTarget to false.</p>
105 </div><div class="long"><p>By default, all instances can be a drop target.  This can be disabled by
106 setting isTarget to false.</p>
107 </div></div></div><div id="property-maintainOffset" class="member inherited"><a href="Ext.dd.DragSource.html#property-maintainOffset" rel="property-maintainOffset" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-maintainOffset" class="viewSource">view source</a></div><a name="maintainOffset"></a><a name="property-maintainOffset"></a><a href="Ext.dd.DragSource.html#" rel="property-maintainOffset" class="cls expand">maintainOffset</a><span> : boolean</span></div><div class="description"><div class="short">Maintain offsets when we resetconstraints.  Set to true when you want
108 the position of the element relative to its par...</div><div class="long"><p>Maintain offsets when we resetconstraints.  Set to true when you want
109 the position of the element relative to its parent to stay the same
110 when the page changes</p>
111 </div></div></div><div id="property-moveOnly" class="member inherited"><a href="Ext.dd.DragSource.html#property-moveOnly" rel="property-moveOnly" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-moveOnly" class="viewSource">view source</a></div><a name="moveOnly"></a><a name="property-moveOnly"></a><a href="Ext.dd.DragSource.html#" rel="property-moveOnly" class="cls expand">moveOnly</a><span> : boolean</span></div><div class="description"><div class="short">When set to true, other DD objects in cooperating DDGroups do not receive
112 notification events when this DD object is ...</div><div class="long"><p>When set to true, other DD objects in cooperating DDGroups do not receive
113 notification events when this DD object is dragged over them. Defaults to false.</p>
114 </div></div></div><div id="property-onStartDrag" class="member ni"><a href="Ext.dd.DragSource.html#property-onStartDrag" rel="property-onStartDrag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-property-onStartDrag" class="viewSource">view source</a></div><a name="onStartDrag"></a><a name="property-onStartDrag"></a><a href="Ext.dd.DragSource.html#" rel="property-onStartDrag" class="cls expand">onStartDrag</a><span> : Object</span></div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action once the initial
115 drag event has be...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action once the initial
116 drag event has begun.  The drag cannot be canceled from this function.</p>
117 </div></div></div><div id="property-padding" class="member inherited"><a href="Ext.dd.DragSource.html#property-padding" rel="property-padding" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-padding" class="viewSource">view source</a></div><a name="padding"></a><a name="property-padding"></a><a href="Ext.dd.DragSource.html#" rel="property-padding" class="cls expand">padding</a><span> : int[]</span></div><div class="description"><div class="short">The padding configured for this drag and drop object for calculating
118 the drop zone intersection with this object. An ...</div><div class="long"><p>The padding configured for this drag and drop object for calculating
119 the drop zone intersection with this object. An array containing the 4 padding values: [top, right, bottom, left]</p>
120 </div></div></div><div id="property-primaryButtonOnly" class="member inherited"><a href="Ext.dd.DragSource.html#property-primaryButtonOnly" rel="property-primaryButtonOnly" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-primaryButtonOnly" class="viewSource">view source</a></div><a name="primaryButtonOnly"></a><a name="property-primaryButtonOnly"></a><a href="Ext.dd.DragSource.html#" rel="property-primaryButtonOnly" class="cls expand">primaryButtonOnly</a><span> : boolean</span></div><div class="description"><div class="short">By default the drag and drop instance will only respond to the primary
121 button click (left button for a right-handed m...</div><div class="long"><p>By default the drag and drop instance will only respond to the primary
122 button click (left button for a right-handed mouse).  Set to true to
123 allow drag and drop to start with any mouse click that is propogated
124 by the browser</p>
125 </div></div></div><div id="property-resizeFrame" class="member inherited"><a href="Ext.dd.DragSource.html#property-resizeFrame" rel="property-resizeFrame" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DDProxy.html" class="definedIn docClass">Ext.dd.DDProxy</a><br/><a href="../source/DDProxy.html#Ext-dd.DDProxy-property-resizeFrame" class="viewSource">view source</a></div><a name="resizeFrame"></a><a name="property-resizeFrame"></a><a href="Ext.dd.DragSource.html#" rel="property-resizeFrame" class="cls expand">resizeFrame</a><span> : boolean</span></div><div class="description"><div class="short">By default we resize the drag frame to be the same size as the element
126 we want to drag (this is to get the frame effe...</div><div class="long"><p>By default we resize the drag frame to be the same size as the element
127 we want to drag (this is to get the frame effect).  We can turn it off
128 if we want a different behavior.</p>
129 </div></div></div><div id="property-scroll" class="member inherited"><a href="Ext.dd.DragSource.html#property-scroll" rel="property-scroll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-property-scroll" class="viewSource">view source</a></div><a name="scroll"></a><a name="property-scroll"></a><a href="Ext.dd.DragSource.html#" rel="property-scroll" class="cls expand">scroll</a><span> : boolean</span></div><div class="description"><div class="short">When set to true, the utility automatically tries to scroll the browser
130 window when a drag and drop element is dragge...</div><div class="long"><p>When set to true, the utility automatically tries to scroll the browser
131 window when a drag and drop element is dragged near the viewport boundary.
132 Defaults to true.</p>
133 </div></div></div><div id="property-xTicks" class="member inherited"><a href="Ext.dd.DragSource.html#property-xTicks" rel="property-xTicks" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-xTicks" class="viewSource">view source</a></div><a name="xTicks"></a><a name="property-xTicks"></a><a href="Ext.dd.DragSource.html#" rel="property-xTicks" class="cls expand">xTicks</a><span> : int[]</span></div><div class="description"><div class="short">Array of pixel locations the element will snap to if we specified a
134 horizontal graduation/interval.  This array is ge...</div><div class="long"><p>Array of pixel locations the element will snap to if we specified a
135 horizontal graduation/interval.  This array is generated automatically
136 when you define a tick interval.</p>
137 </div></div></div><div id="property-yTicks" class="member inherited"><a href="Ext.dd.DragSource.html#property-yTicks" rel="property-yTicks" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-property-yTicks" class="viewSource">view source</a></div><a name="yTicks"></a><a name="property-yTicks"></a><a href="Ext.dd.DragSource.html#" rel="property-yTicks" class="cls expand">yTicks</a><span> : int[]</span></div><div class="description"><div class="short">Array of pixel locations the element will snap to if we specified a
138 vertical graduation/interval.  This array is gene...</div><div class="long"><p>Array of pixel locations the element will snap to if we specified a
139 vertical graduation/interval.  This array is generated automatically
140 when you define a tick interval.</p>
141 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-DragSource" class="member f ni"><a href="Ext.dd.DragSource.html#method-DragSource" rel="method-DragSource" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-constructor" class="viewSource">view source</a></div><a name="DragSource"></a><a name="method-DragSource"></a><a href="Ext.dd.DragSource.html#" rel="method-DragSource" class="cls expand">DragSource</a>(
142 <span class="pre">Mixed el, Object config</span>)
143  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
144 <h3 class="pa">Parameters</h3><ul><li><span class="pre">el</span> : Mixed<div class="sub-desc"><p>The container element</p>
145 </div></li><li><span class="pre">config</span> : Object<div class="sub-desc">
146 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
147 </li></ul></div></div></div><div id="method-addInvalidHandleClass" class="member inherited"><a href="Ext.dd.DragSource.html#method-addInvalidHandleClass" rel="method-addInvalidHandleClass" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-addInvalidHandleClass" class="viewSource">view source</a></div><a name="addInvalidHandleClass"></a><a name="method-addInvalidHandleClass"></a><a href="Ext.dd.DragSource.html#" rel="method-addInvalidHandleClass" class="cls expand">addInvalidHandleClass</a>(
148 <span class="pre">string cssClass</span>)
149  : void</div><div class="description"><div class="short"><p>Lets you specify a css class of elements that will not initiate a drag</p>
150 </div><div class="long"><p>Lets you specify a css class of elements that will not initiate a drag</p>
151 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cssClass</span> : string<div class="sub-desc"><p>the class of the elements you wish to ignore</p>
152 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
153 </li></ul></div></div></div><div id="method-addInvalidHandleId" class="member inherited"><a href="Ext.dd.DragSource.html#method-addInvalidHandleId" rel="method-addInvalidHandleId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-addInvalidHandleId" class="viewSource">view source</a></div><a name="addInvalidHandleId"></a><a name="method-addInvalidHandleId"></a><a href="Ext.dd.DragSource.html#" rel="method-addInvalidHandleId" class="cls expand">addInvalidHandleId</a>(
154 <span class="pre">string id</span>)
155  : void</div><div class="description"><div class="short"><p>Lets you to specify an element id for a child of a drag handle
156 that should not initiate a drag</p>
157 </div><div class="long"><p>Lets you to specify an element id for a child of a drag handle
158 that should not initiate a drag</p>
159 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : string<div class="sub-desc"><p>the element id of the element you wish to ignore</p>
160 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
161 </li></ul></div></div></div><div id="method-addInvalidHandleType" class="member inherited"><a href="Ext.dd.DragSource.html#method-addInvalidHandleType" rel="method-addInvalidHandleType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-addInvalidHandleType" class="viewSource">view source</a></div><a name="addInvalidHandleType"></a><a name="method-addInvalidHandleType"></a><a href="Ext.dd.DragSource.html#" rel="method-addInvalidHandleType" class="cls expand">addInvalidHandleType</a>(
162 <span class="pre">string tagName</span>)
163  : void</div><div class="description"><div class="short">Allows you to specify a tag name that should not start a drag operation
164 when clicked.  This is designed to facilitate...</div><div class="long"><p>Allows you to specify a tag name that should not start a drag operation
165 when clicked.  This is designed to facilitate embedding links within a
166 drag handle that do something other than start the drag.</p>
167 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tagName</span> : string<div class="sub-desc"><p>the type of element to exclude</p>
168 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
169 </li></ul></div></div></div><div id="method-addToGroup" class="member inherited"><a href="Ext.dd.DragSource.html#method-addToGroup" rel="method-addToGroup" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-addToGroup" class="viewSource">view source</a></div><a name="addToGroup"></a><a name="method-addToGroup"></a><a href="Ext.dd.DragSource.html#" rel="method-addToGroup" class="cls expand">addToGroup</a>(
170 <span class="pre">Object sGroup</span>)
171  : void</div><div class="description"><div class="short">Add this instance to a group of related drag/drop objects.  All
172 instances belong to at least one group, and can belon...</div><div class="long"><p>Add this instance to a group of related drag/drop objects.  All
173 instances belong to at least one group, and can belong to as many
174 groups as needed.</p>
175 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sGroup</span> : Object<div class="sub-desc"><p>{string} the name of the group</p>
176 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
177 </li></ul></div></div></div><div id="method-afterDragDrop" class="member ni"><a href="Ext.dd.DragSource.html#method-afterDragDrop" rel="method-afterDragDrop" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-afterDragDrop" class="viewSource">view source</a></div><a name="afterDragDrop"></a><a name="method-afterDragDrop"></a><a href="Ext.dd.DragSource.html#" rel="method-afterDragDrop" class="cls expand">afterDragDrop</a>(
178 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
179  : void</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action
180 after a valid drag drop has occurr...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action
181 after a valid drag drop has occurred by providing an implementation.</p>
182 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
183 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
184 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dropped element</p>
185 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
186 </li></ul></div></div></div><div id="method-afterDragEnter" class="member ni"><a href="Ext.dd.DragSource.html#method-afterDragEnter" rel="method-afterDragEnter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-afterDragEnter" class="viewSource">view source</a></div><a name="afterDragEnter"></a><a name="method-afterDragEnter"></a><a href="Ext.dd.DragSource.html#" rel="method-afterDragEnter" class="cls expand">afterDragEnter</a>(
187 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
188  : void</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action
189 when the dragged item enters the d...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action
190 when the dragged item enters the drop target by providing an implementation.</p>
191 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
192 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
193 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dragged element</p>
194 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
195 </li></ul></div></div></div><div id="method-afterDragOut" class="member ni"><a href="Ext.dd.DragSource.html#method-afterDragOut" rel="method-afterDragOut" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-afterDragOut" class="viewSource">view source</a></div><a name="afterDragOut"></a><a name="method-afterDragOut"></a><a href="Ext.dd.DragSource.html#" rel="method-afterDragOut" class="cls expand">afterDragOut</a>(
196 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
197  : void</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action
198 after the dragged item is dragged ...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action
199 after the dragged item is dragged out of the target without dropping.</p>
200 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
201 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
202 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dragged element</p>
203 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
204 </li></ul></div></div></div><div id="method-afterDragOver" class="member ni"><a href="Ext.dd.DragSource.html#method-afterDragOver" rel="method-afterDragOver" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-afterDragOver" class="viewSource">view source</a></div><a name="afterDragOver"></a><a name="method-afterDragOver"></a><a href="Ext.dd.DragSource.html#" rel="method-afterDragOver" class="cls expand">afterDragOver</a>(
205 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
206  : void</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action
207 while the dragged item is over the...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action
208 while the dragged item is over the drop target by providing an implementation.</p>
209 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
210 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
211 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dragged element</p>
212 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
213 </li></ul></div></div></div><div id="method-afterInvalidDrop" class="member ni"><a href="Ext.dd.DragSource.html#method-afterInvalidDrop" rel="method-afterInvalidDrop" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-afterInvalidDrop" class="viewSource">view source</a></div><a name="afterInvalidDrop"></a><a name="method-afterInvalidDrop"></a><a href="Ext.dd.DragSource.html#" rel="method-afterInvalidDrop" class="cls expand">afterInvalidDrop</a>(
214 <span class="pre">Event e, String id</span>)
215  : void</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action
216 after an invalid drop has occurred...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action
217 after an invalid drop has occurred by providing an implementation.</p>
218 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
219 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dropped element</p>
220 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
221 </li></ul></div></div></div><div id="method-alignElWithMouse" class="member inherited"><a href="Ext.dd.DragSource.html#method-alignElWithMouse" rel="method-alignElWithMouse" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-method-alignElWithMouse" class="viewSource">view source</a></div><a name="alignElWithMouse"></a><a name="method-alignElWithMouse"></a><a href="Ext.dd.DragSource.html#" rel="method-alignElWithMouse" class="cls expand">alignElWithMouse</a>(
222 <span class="pre">HTMLElement el, int iPageX, int iPageY</span>)
223  : void</div><div class="description"><div class="short">Sets the element to the location of the mousedown or click event,
224 maintaining the cursor location relative to the loc...</div><div class="long"><p>Sets the element to the location of the mousedown or click event,
225 maintaining the cursor location relative to the location on the element
226 that was clicked.  Override this if you want to place the element in a
227 location other than where the cursor is.</p>
228 <h3 class="pa">Parameters</h3><ul><li><span class="pre">el</span> : HTMLElement<div class="sub-desc"><p>the element to move</p>
229 </div></li><li><span class="pre">iPageX</span> : int<div class="sub-desc"><p>the X coordinate of the mousedown or drag event</p>
230 </div></li><li><span class="pre">iPageY</span> : int<div class="sub-desc"><p>the Y coordinate of the mousedown or drag event</p>
231 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
232 </li></ul></div></div></div><div id="method-applyConfig" class="member inherited"><a href="Ext.dd.DragSource.html#method-applyConfig" rel="method-applyConfig" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-method-applyConfig" class="viewSource">view source</a></div><a name="applyConfig"></a><a name="method-applyConfig"></a><a href="Ext.dd.DragSource.html#" rel="method-applyConfig" class="cls expand">applyConfig</a> : void</div><div class="description"><div class="short">Sets up config options specific to this class. Overrides
233 Ext.dd.DragDrop, but all versions of this method through the...</div><div class="long"><p>Sets up config options specific to this class. Overrides
234 Ext.dd.DragDrop, but all versions of this method through the
235 inheritance chain are called</p>
236 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
237 </li></ul></div></div></div><div id="method-autoOffset" class="member inherited"><a href="Ext.dd.DragSource.html#method-autoOffset" rel="method-autoOffset" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-method-autoOffset" class="viewSource">view source</a></div><a name="autoOffset"></a><a name="method-autoOffset"></a><a href="Ext.dd.DragSource.html#" rel="method-autoOffset" class="cls expand">autoOffset</a>(
238 <span class="pre">int iPageX, int iPageY</span>)
239  : void</div><div class="description"><div class="short">Sets the pointer offset to the distance between the linked element's top
240 left corner and the location the element was...</div><div class="long"><p>Sets the pointer offset to the distance between the linked element's top
241 left corner and the location the element was clicked</p>
242 <h3 class="pa">Parameters</h3><ul><li><span class="pre">iPageX</span> : int<div class="sub-desc"><p>the X coordinate of the click</p>
243 </div></li><li><span class="pre">iPageY</span> : int<div class="sub-desc"><p>the Y coordinate of the click</p>
244 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
245 </li></ul></div></div></div><div id="method-b4Drag" class="member inherited"><a href="Ext.dd.DragSource.html#method-b4Drag" rel="method-b4Drag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-method-b4Drag" class="viewSource">view source</a></div><a name="b4Drag"></a><a name="method-b4Drag"></a><a href="Ext.dd.DragSource.html#" rel="method-b4Drag" class="cls expand">b4Drag</a>(
246 <span class="pre">Object e</span>)
247  : void</div><div class="description"><div class="short"><p>Event that fires prior to the onDrag event.  Overrides
248 Ext.dd.DragDrop.</p>
249 </div><div class="long"><p>Event that fires prior to the onDrag event.  Overrides
250 Ext.dd.DragDrop.</p>
251 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Object<div class="sub-desc">
252 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
253 </li></ul></div></div></div><div id="method-b4MouseDown" class="member inherited"><a href="Ext.dd.DragSource.html#method-b4MouseDown" rel="method-b4MouseDown" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-method-b4MouseDown" class="viewSource">view source</a></div><a name="b4MouseDown"></a><a name="method-b4MouseDown"></a><a href="Ext.dd.DragSource.html#" rel="method-b4MouseDown" class="cls expand">b4MouseDown</a>(
254 <span class="pre">Object e</span>)
255  : void</div><div class="description"><div class="short"><p>Event that fires prior to the onMouseDown event.  Overrides
256 Ext.dd.DragDrop.</p>
257 </div><div class="long"><p>Event that fires prior to the onMouseDown event.  Overrides
258 Ext.dd.DragDrop.</p>
259 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Object<div class="sub-desc">
260 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
261 </li></ul></div></div></div><div id="method-beforeDragDrop" class="member ni"><a href="Ext.dd.DragSource.html#method-beforeDragDrop" rel="method-beforeDragDrop" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-beforeDragDrop" class="viewSource">view source</a></div><a name="beforeDragDrop"></a><a name="method-beforeDragDrop"></a><a href="Ext.dd.DragSource.html#" rel="method-beforeDragDrop" class="cls expand">beforeDragDrop</a>(
262 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
263  : Boolean</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
264 item is dropped...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action before the dragged
265 item is dropped onto the target and optionally cancel the onDragDrop.</p>
266 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
267 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
268 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dragged element</p>
269 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isValid True if the drag drop event is valid, else false to cancel</p>
270 </li></ul></div></div></div><div id="method-beforeDragEnter" class="member ni"><a href="Ext.dd.DragSource.html#method-beforeDragEnter" rel="method-beforeDragEnter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-beforeDragEnter" class="viewSource">view source</a></div><a name="beforeDragEnter"></a><a name="method-beforeDragEnter"></a><a href="Ext.dd.DragSource.html#" rel="method-beforeDragEnter" class="cls expand">beforeDragEnter</a>(
271 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
272  : Boolean</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action
273 before the dragged item enters the...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action
274 before the dragged item enters the drop target and optionally cancel the onDragEnter.</p>
275 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
276 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
277 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dragged element</p>
278 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isValid True if the drag event is valid, else false to cancel</p>
279 </li></ul></div></div></div><div id="method-beforeDragOut" class="member ni"><a href="Ext.dd.DragSource.html#method-beforeDragOut" rel="method-beforeDragOut" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-beforeDragOut" class="viewSource">view source</a></div><a name="beforeDragOut"></a><a name="method-beforeDragOut"></a><a href="Ext.dd.DragSource.html#" rel="method-beforeDragOut" class="cls expand">beforeDragOut</a>(
280 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
281  : Boolean</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged
282 item is dragged...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action before the dragged
283 item is dragged out of the target without dropping, and optionally cancel the onDragOut.</p>
284 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
285 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
286 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dragged element</p>
287 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isValid True if the drag event is valid, else false to cancel</p>
288 </li></ul></div></div></div><div id="method-beforeDragOver" class="member ni"><a href="Ext.dd.DragSource.html#method-beforeDragOver" rel="method-beforeDragOver" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-beforeDragOver" class="viewSource">view source</a></div><a name="beforeDragOver"></a><a name="method-beforeDragOver"></a><a href="Ext.dd.DragSource.html#" rel="method-beforeDragOver" class="cls expand">beforeDragOver</a>(
289 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
290  : Boolean</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action
291 while the dragged item is over the...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action
292 while the dragged item is over the drop target and optionally cancel the onDragOver.</p>
293 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
294 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
295 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dragged element</p>
296 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isValid True if the drag event is valid, else false to cancel</p>
297 </li></ul></div></div></div><div id="method-beforeInvalidDrop" class="member ni"><a href="Ext.dd.DragSource.html#method-beforeInvalidDrop" rel="method-beforeInvalidDrop" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-beforeInvalidDrop" class="viewSource">view source</a></div><a name="beforeInvalidDrop"></a><a name="method-beforeInvalidDrop"></a><a href="Ext.dd.DragSource.html#" rel="method-beforeInvalidDrop" class="cls expand">beforeInvalidDrop</a>(
298 <span class="pre">Ext.dd.DragDrop target, Event e, String id</span>)
299  : Boolean</div><div class="description"><div class="short"><p>An empty function by default, but provided so that you can perform a custom action after an invalid
300 drop has occurred.</p>
301 </div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action after an invalid
302 drop has occurred.</p>
303 <h3 class="pa">Parameters</h3><ul><li><span class="pre">target</span> : Ext.dd.DragDrop<div class="sub-desc"><p>The drop target</p>
304 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
305 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the dragged element</p>
306 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isValid True if the invalid drop should proceed, else false to cancel</p>
307 </li></ul></div></div></div><div id="method-cachePosition" class="member inherited"><a href="Ext.dd.DragSource.html#method-cachePosition" rel="method-cachePosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-method-cachePosition" class="viewSource">view source</a></div><a name="cachePosition"></a><a name="method-cachePosition"></a><a href="Ext.dd.DragSource.html#" rel="method-cachePosition" class="cls expand">cachePosition</a>(
308 <span class="pre">Object iPageX, Object iPageY</span>)
309  : void</div><div class="description"><div class="short">Saves the most recent position so that we can reset the constraints and
310 tick marks on-demand.  We need to know this s...</div><div class="long"><p>Saves the most recent position so that we can reset the constraints and
311 tick marks on-demand.  We need to know this so that we can calculate the
312 number of pixels the element is offset from its original position.</p>
313 <h3 class="pa">Parameters</h3><ul><li><span class="pre">iPageX</span> : Object<div class="sub-desc"><p>the current x position (optional, this just makes it so we
314 don't have to look it up again)</p>
315 </div></li><li><span class="pre">iPageY</span> : Object<div class="sub-desc"><p>the current y position (optional, this just makes it so we
316 don't have to look it up again)</p>
317 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
318 </li></ul></div></div></div><div id="method-clearConstraints" class="member inherited"><a href="Ext.dd.DragSource.html#method-clearConstraints" rel="method-clearConstraints" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-clearConstraints" class="viewSource">view source</a></div><a name="clearConstraints"></a><a name="method-clearConstraints"></a><a href="Ext.dd.DragSource.html#" rel="method-clearConstraints" class="cls expand">clearConstraints</a> : void</div><div class="description"><div class="short">Clears any constraints applied to this instance.  Also clears ticks
319 since they can't exist independent of a constrain...</div><div class="long"><p>Clears any constraints applied to this instance.  Also clears ticks
320 since they can't exist independent of a constraint at this time.</p>
321 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
322 </li></ul></div></div></div><div id="method-clearTicks" class="member inherited"><a href="Ext.dd.DragSource.html#method-clearTicks" rel="method-clearTicks" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-clearTicks" class="viewSource">view source</a></div><a name="clearTicks"></a><a name="method-clearTicks"></a><a href="Ext.dd.DragSource.html#" rel="method-clearTicks" class="cls expand">clearTicks</a> : void</div><div class="description"><div class="short"><p>Clears any tick interval defined for this instance</p>
323 </div><div class="long"><p>Clears any tick interval defined for this instance</p>
324 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
325 </li></ul></div></div></div><div id="method-constrainTo" class="member inherited"><a href="Ext.dd.DragSource.html#method-constrainTo" rel="method-constrainTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-constrainTo" class="viewSource">view source</a></div><a name="constrainTo"></a><a name="method-constrainTo"></a><a href="Ext.dd.DragSource.html#" rel="method-constrainTo" class="cls expand">constrainTo</a>(
326 <span class="pre">Mixed constrainTo, [Object/Number pad], [Boolean inContent]</span>)
327  : void</div><div class="description"><div class="short">Initializes the drag drop object's constraints to restrict movement to a certain element.
328
329 Usage:
330
331  var dd = new Ext....</div><div class="long"><p>Initializes the drag drop object's constraints to restrict movement to a certain element.</p>
332
333 <p>Usage:</p>
334
335 <pre><code> var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest",
336                 { dragElId: "existingProxyDiv" });
337  dd.startDrag = function(){
338      this.constrainTo("parent-id");
339  };
340  </code></pre>
341
342
343 <p>Or you can initalize it using the <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Ext.core.Element</a> object:</p>
344
345 <pre><code> Ext.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, {
346      startDrag : function(){
347          this.constrainTo("parent-id");
348      }
349  });
350  </code></pre>
351
352 <h3 class="pa">Parameters</h3><ul><li><span class="pre">constrainTo</span> : Mixed<div class="sub-desc"><p>The element to constrain to.</p>
353 </div></li><li><span class="pre">pad</span> : Object/Number<div class="sub-desc"><p>(optional) Pad provides a way to specify "padding" of the constraints,
354 and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
355 an object containing the sides to pad. For example: {right:10, bottom:10}</p>
356 </div></li><li><span class="pre">inContent</span> : Boolean<div class="sub-desc"><p>(optional) Constrain the draggable in the content box of the element (inside padding and borders)</p>
357 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
358 </li></ul></div></div></div><div id="method-createFrame" class="member inherited"><a href="Ext.dd.DragSource.html#method-createFrame" rel="method-createFrame" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DDProxy.html" class="definedIn docClass">Ext.dd.DDProxy</a><br/><a href="../source/DDProxy.html#Ext-dd.DDProxy-method-createFrame" class="viewSource">view source</a></div><a name="createFrame"></a><a name="method-createFrame"></a><a href="Ext.dd.DragSource.html#" rel="method-createFrame" class="cls expand">createFrame</a> : void</div><div class="description"><div class="short"><p>Creates the proxy element if it does not yet exist</p>
359 </div><div class="long"><p>Creates the proxy element if it does not yet exist</p>
360 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
361 </li></ul></div></div></div><div id="method-endDrag" class="member inherited"><a href="Ext.dd.DragSource.html#method-endDrag" rel="method-endDrag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-endDrag" class="viewSource">view source</a></div><a name="endDrag"></a><a name="method-endDrag"></a><a href="Ext.dd.DragSource.html#" rel="method-endDrag" class="cls expand">endDrag</a>(
362 <span class="pre">Event e</span>)
363  : void</div><div class="description"><div class="short"><p>Fired when we are done dragging the object</p>
364 </div><div class="long"><p>Fired when we are done dragging the object</p>
365 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mouseup event</p>
366 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
367 </li></ul></div></div></div><div id="method-getDragData" class="member ni"><a href="Ext.dd.DragSource.html#method-getDragData" rel="method-getDragData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-getDragData" class="viewSource">view source</a></div><a name="getDragData"></a><a name="method-getDragData"></a><a href="Ext.dd.DragSource.html#" rel="method-getDragData" class="cls expand">getDragData</a>(
368 <span class="pre">Object e</span>)
369  : Object</div><div class="description"><div class="short"><p>Returns the data object associated with this drag source</p>
370 </div><div class="long"><p>Returns the data object associated with this drag source</p>
371 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Object<div class="sub-desc">
372 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>data An object containing arbitrary data</p>
373 </li></ul></div></div></div><div id="method-getDragEl" class="member inherited"><a href="Ext.dd.DragSource.html#method-getDragEl" rel="method-getDragEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-getDragEl" class="viewSource">view source</a></div><a name="getDragEl"></a><a name="method-getDragEl"></a><a href="Ext.dd.DragSource.html#" rel="method-getDragEl" class="cls expand">getDragEl</a> : HTMLElement</div><div class="description"><div class="short">Returns a reference to the actual element to drag.  By default this is
374 the same as the html element, but it can be as...</div><div class="long"><p>Returns a reference to the actual element to drag.  By default this is
375 the same as the html element, but it can be assigned to another
376 element. An example of this can be found in Ext.dd.DDProxy</p>
377 <h3 class="pa">Returns</h3><ul><li><span class="pre">HTMLElement</span>&nbsp; &nbsp;<p>the html element</p>
378 </li></ul></div></div></div><div id="method-getEl" class="member inherited"><a href="Ext.dd.DragSource.html#method-getEl" rel="method-getEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-getEl" class="viewSource">view source</a></div><a name="getEl"></a><a name="method-getEl"></a><a href="Ext.dd.DragSource.html#" rel="method-getEl" class="cls expand">getEl</a> : HTMLElement</div><div class="description"><div class="short"><p>Returns a reference to the linked element</p>
379 </div><div class="long"><p>Returns a reference to the linked element</p>
380 <h3 class="pa">Returns</h3><ul><li><span class="pre">HTMLElement</span>&nbsp; &nbsp;<p>the html element</p>
381 </li></ul></div></div></div><div id="method-getProxy" class="member ni"><a href="Ext.dd.DragSource.html#method-getProxy" rel="method-getProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-getProxy" class="viewSource">view source</a></div><a name="getProxy"></a><a name="method-getProxy"></a><a href="Ext.dd.DragSource.html#" rel="method-getProxy" class="cls expand">getProxy</a> : Ext.dd.StatusProxy</div><div class="description"><div class="short"><p>Returns the drag source's underlying <a href="Ext.dd.StatusProxy.html" rel="Ext.dd.StatusProxy" class="docClass">Ext.dd.StatusProxy</a></p>
382 </div><div class="long"><p>Returns the drag source's underlying <a href="Ext.dd.StatusProxy.html" rel="Ext.dd.StatusProxy" class="docClass">Ext.dd.StatusProxy</a></p>
383 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.dd.StatusProxy</span>&nbsp; &nbsp;<p>proxy The StatusProxy</p>
384 </li></ul></div></div></div><div id="method-hideProxy" class="member ni"><a href="Ext.dd.DragSource.html#method-hideProxy" rel="method-hideProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-hideProxy" class="viewSource">view source</a></div><a name="hideProxy"></a><a name="method-hideProxy"></a><a href="Ext.dd.DragSource.html#" rel="method-hideProxy" class="cls expand">hideProxy</a> : void</div><div class="description"><div class="short"><p>Hides the drag source's <a href="Ext.dd.StatusProxy.html" rel="Ext.dd.StatusProxy" class="docClass">Ext.dd.StatusProxy</a></p>
385 </div><div class="long"><p>Hides the drag source's <a href="Ext.dd.StatusProxy.html" rel="Ext.dd.StatusProxy" class="docClass">Ext.dd.StatusProxy</a></p>
386 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
387 </li></ul></div></div></div><div id="method-init" class="member inherited"><a href="Ext.dd.DragSource.html#method-init" rel="method-init" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-init" class="viewSource">view source</a></div><a name="init"></a><a name="method-init"></a><a href="Ext.dd.DragSource.html#" rel="method-init" class="cls expand">init</a>(
388 <span class="pre">Object id, String sGroup, object config</span>)
389  : void</div><div class="description"><div class="short"><p>Sets up the DragDrop object.  Must be called in the constructor of any
390 <a href="Ext.dd.DragDrop.html" rel="Ext.dd.DragDrop" class="docClass">Ext.dd.DragDrop</a> subclass</p>
391 </div><div class="long"><p>Sets up the DragDrop object.  Must be called in the constructor of any
392 <a href="Ext.dd.DragDrop.html" rel="Ext.dd.DragDrop" class="docClass">Ext.dd.DragDrop</a> subclass</p>
393 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : Object<div class="sub-desc"><p>the id of the linked element</p>
394 </div></li><li><span class="pre">sGroup</span> : String<div class="sub-desc"><p>the group of related items</p>
395 </div></li><li><span class="pre">config</span> : object<div class="sub-desc"><p>configuration attributes</p>
396 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
397 </li></ul></div></div></div><div id="method-initFrame" class="member inherited"><a href="Ext.dd.DragSource.html#method-initFrame" rel="method-initFrame" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DDProxy.html" class="definedIn docClass">Ext.dd.DDProxy</a><br/><a href="../source/DDProxy.html#Ext-dd.DDProxy-method-initFrame" class="viewSource">view source</a></div><a name="initFrame"></a><a name="method-initFrame"></a><a href="Ext.dd.DragSource.html#" rel="method-initFrame" class="cls expand">initFrame</a> : void</div><div class="description"><div class="short"><p>Initialization for the drag frame element.  Must be called in the
398 constructor of all subclasses</p>
399 </div><div class="long"><p>Initialization for the drag frame element.  Must be called in the
400 constructor of all subclasses</p>
401 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
402 </li></ul></div></div></div><div id="method-initTarget" class="member inherited"><a href="Ext.dd.DragSource.html#method-initTarget" rel="method-initTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-initTarget" class="viewSource">view source</a></div><a name="initTarget"></a><a name="method-initTarget"></a><a href="Ext.dd.DragSource.html#" rel="method-initTarget" class="cls expand">initTarget</a>(
403 <span class="pre">Object id, String sGroup, object config</span>)
404  : void</div><div class="description"><div class="short"><p>Initializes Targeting functionality only... the object does not
405 get a mousedown handler.</p>
406 </div><div class="long"><p>Initializes Targeting functionality only... the object does not
407 get a mousedown handler.</p>
408 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : Object<div class="sub-desc"><p>the id of the linked element</p>
409 </div></li><li><span class="pre">sGroup</span> : String<div class="sub-desc"><p>the group of related items</p>
410 </div></li><li><span class="pre">config</span> : object<div class="sub-desc"><p>configuration attributes</p>
411 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
412 </li></ul></div></div></div><div id="method-isLocked" class="member inherited"><a href="Ext.dd.DragSource.html#method-isLocked" rel="method-isLocked" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-isLocked" class="viewSource">view source</a></div><a name="isLocked"></a><a name="method-isLocked"></a><a href="Ext.dd.DragSource.html#" rel="method-isLocked" class="cls expand">isLocked</a> : boolean</div><div class="description"><div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
413 (meaning that all drag/drop is disabled on th...</div><div class="long"><p>Returns true if this instance is locked, or the drag drop mgr is locked
414 (meaning that all drag/drop is disabled on the page.)</p>
415 <h3 class="pa">Returns</h3><ul><li><span class="pre">boolean</span>&nbsp; &nbsp;<p>true if this obj or all drag/drop is locked, else
416 false</p>
417 </li></ul></div></div></div><div id="method-isValidHandleChild" class="member inherited"><a href="Ext.dd.DragSource.html#method-isValidHandleChild" rel="method-isValidHandleChild" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-isValidHandleChild" class="viewSource">view source</a></div><a name="isValidHandleChild"></a><a name="method-isValidHandleChild"></a><a href="Ext.dd.DragSource.html#" rel="method-isValidHandleChild" class="cls expand">isValidHandleChild</a>(
418 <span class="pre">HTMLElement node</span>)
419  : boolean</div><div class="description"><div class="short"><p>Checks the tag exclusion list to see if this click should be ignored</p>
420 </div><div class="long"><p>Checks the tag exclusion list to see if this click should be ignored</p>
421 <h3 class="pa">Parameters</h3><ul><li><span class="pre">node</span> : HTMLElement<div class="sub-desc"><p>the HTMLElement to evaluate</p>
422 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">boolean</span>&nbsp; &nbsp;<p>true if this is a valid tag type, false if not</p>
423 </li></ul></div></div></div><div id="method-lock" class="member inherited"><a href="Ext.dd.DragSource.html#method-lock" rel="method-lock" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-lock" class="viewSource">view source</a></div><a name="lock"></a><a name="method-lock"></a><a href="Ext.dd.DragSource.html#" rel="method-lock" class="cls expand">lock</a> : void</div><div class="description"><div class="short"><p>Lock this instance</p>
424 </div><div class="long"><p>Lock this instance</p>
425 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
426 </li></ul></div></div></div><div id="method-onAvailable" class="member inherited"><a href="Ext.dd.DragSource.html#method-onAvailable" rel="method-onAvailable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onAvailable" class="viewSource">view source</a></div><a name="onAvailable"></a><a name="method-onAvailable"></a><a href="Ext.dd.DragSource.html#" rel="method-onAvailable" class="cls expand">onAvailable</a> : void</div><div class="description"><div class="short"><p>Override the onAvailable method to do what is needed after the initial
427 position was determined.</p>
428 </div><div class="long"><p>Override the onAvailable method to do what is needed after the initial
429 position was determined.</p>
430 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
431 </li></ul></div></div></div><div id="method-onBeforeDrag" class="member ni"><a href="Ext.dd.DragSource.html#method-onBeforeDrag" rel="method-onBeforeDrag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragSource.html" class="definedIn docClass">Ext.dd.DragSource</a><br/><a href="../source/DragSource.html#Ext-dd.DragSource-method-onBeforeDrag" class="viewSource">view source</a></div><a name="onBeforeDrag"></a><a name="method-onBeforeDrag"></a><a href="Ext.dd.DragSource.html#" rel="method-onBeforeDrag" class="cls expand">onBeforeDrag</a>(
432 <span class="pre">Object data, Event e</span>)
433  : Boolean</div><div class="description"><div class="short">An empty function by default, but provided so that you can perform a custom action before the initial
434 drag event begi...</div><div class="long"><p>An empty function by default, but provided so that you can perform a custom action before the initial
435 drag event begins and optionally cancel it.</p>
436 <h3 class="pa">Parameters</h3><ul><li><span class="pre">data</span> : Object<div class="sub-desc"><p>An object containing arbitrary data to be shared with drop targets</p>
437 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
438 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isValid True if the drag event is valid, else false to cancel</p>
439 </li></ul></div></div></div><div id="method-onDrag" class="member inherited"><a href="Ext.dd.DragSource.html#method-onDrag" rel="method-onDrag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onDrag" class="viewSource">view source</a></div><a name="onDrag"></a><a name="method-onDrag"></a><a href="Ext.dd.DragSource.html#" rel="method-onDrag" class="cls expand">onDrag</a>(
440 <span class="pre">Event e</span>)
441  : void</div><div class="description"><div class="short"><p>Abstract method called during the onMouseMove event while dragging an
442 object.</p>
443 </div><div class="long"><p>Abstract method called during the onMouseMove event while dragging an
444 object.</p>
445 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mousemove event</p>
446 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
447 </li></ul></div></div></div><div id="method-onDragDrop" class="member inherited"><a href="Ext.dd.DragSource.html#method-onDragDrop" rel="method-onDragDrop" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onDragDrop" class="viewSource">view source</a></div><a name="onDragDrop"></a><a name="method-onDragDrop"></a><a href="Ext.dd.DragSource.html#" rel="method-onDragDrop" class="cls expand">onDragDrop</a>(
448 <span class="pre">Event e, String|DragDrop[] id</span>)
449  : void</div><div class="description"><div class="short"><p>Abstract method called when this item is dropped on another DragDrop
450 obj</p>
451 </div><div class="long"><p>Abstract method called when this item is dropped on another DragDrop
452 obj</p>
453 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mouseup event</p>
454 </div></li><li><span class="pre">id</span> : String|DragDrop[]<div class="sub-desc"><p>In POINT mode, the element
455 id this was dropped on.  In INTERSECT mode, an array of dd items this
456 was dropped on.</p>
457 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
458 </li></ul></div></div></div><div id="method-onDragEnter" class="member inherited"><a href="Ext.dd.DragSource.html#method-onDragEnter" rel="method-onDragEnter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onDragEnter" class="viewSource">view source</a></div><a name="onDragEnter"></a><a name="method-onDragEnter"></a><a href="Ext.dd.DragSource.html#" rel="method-onDragEnter" class="cls expand">onDragEnter</a>(
459 <span class="pre">Event e, String|DragDrop[] id</span>)
460  : void</div><div class="description"><div class="short"><p>Abstract method called when this element fist begins hovering over
461 another DragDrop obj</p>
462 </div><div class="long"><p>Abstract method called when this element fist begins hovering over
463 another DragDrop obj</p>
464 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mousemove event</p>
465 </div></li><li><span class="pre">id</span> : String|DragDrop[]<div class="sub-desc"><p>In POINT mode, the element
466 id this is hovering over.  In INTERSECT mode, an array of one or more
467 dragdrop items being hovered over.</p>
468 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
469 </li></ul></div></div></div><div id="method-onDragOut" class="member inherited"><a href="Ext.dd.DragSource.html#method-onDragOut" rel="method-onDragOut" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onDragOut" class="viewSource">view source</a></div><a name="onDragOut"></a><a name="method-onDragOut"></a><a href="Ext.dd.DragSource.html#" rel="method-onDragOut" class="cls expand">onDragOut</a>(
470 <span class="pre">Event e, String|DragDrop[] id</span>)
471  : void</div><div class="description"><div class="short"><p>Abstract method called when we are no longer hovering over an element</p>
472 </div><div class="long"><p>Abstract method called when we are no longer hovering over an element</p>
473 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mousemove event</p>
474 </div></li><li><span class="pre">id</span> : String|DragDrop[]<div class="sub-desc"><p>In POINT mode, the element
475 id this was hovering over.  In INTERSECT mode, an array of dd items
476 that the mouse is no longer over.</p>
477 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
478 </li></ul></div></div></div><div id="method-onDragOver" class="member inherited"><a href="Ext.dd.DragSource.html#method-onDragOver" rel="method-onDragOver" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onDragOver" class="viewSource">view source</a></div><a name="onDragOver"></a><a name="method-onDragOver"></a><a href="Ext.dd.DragSource.html#" rel="method-onDragOver" class="cls expand">onDragOver</a>(
479 <span class="pre">Event e, String|DragDrop[] id</span>)
480  : void</div><div class="description"><div class="short"><p>Abstract method called when this element is hovering over another
481 DragDrop obj</p>
482 </div><div class="long"><p>Abstract method called when this element is hovering over another
483 DragDrop obj</p>
484 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mousemove event</p>
485 </div></li><li><span class="pre">id</span> : String|DragDrop[]<div class="sub-desc"><p>In POINT mode, the element
486 id this is hovering over.  In INTERSECT mode, an array of dd items
487 being hovered over.</p>
488 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
489 </li></ul></div></div></div><div id="method-onInvalidDrop" class="member inherited"><a href="Ext.dd.DragSource.html#method-onInvalidDrop" rel="method-onInvalidDrop" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onInvalidDrop" class="viewSource">view source</a></div><a name="onInvalidDrop"></a><a name="method-onInvalidDrop"></a><a href="Ext.dd.DragSource.html#" rel="method-onInvalidDrop" class="cls expand">onInvalidDrop</a>(
490 <span class="pre">Event e</span>)
491  : void</div><div class="description"><div class="short"><p>Abstract method called when this item is dropped on an area with no
492 drop target</p>
493 </div><div class="long"><p>Abstract method called when this item is dropped on an area with no
494 drop target</p>
495 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mouseup event</p>
496 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
497 </li></ul></div></div></div><div id="method-onMouseDown" class="member inherited"><a href="Ext.dd.DragSource.html#method-onMouseDown" rel="method-onMouseDown" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onMouseDown" class="viewSource">view source</a></div><a name="onMouseDown"></a><a name="method-onMouseDown"></a><a href="Ext.dd.DragSource.html#" rel="method-onMouseDown" class="cls expand">onMouseDown</a>(
498 <span class="pre">Event e</span>)
499  : void</div><div class="description"><div class="short"><p>Event handler that fires when a drag/drop obj gets a mousedown</p>
500 </div><div class="long"><p>Event handler that fires when a drag/drop obj gets a mousedown</p>
501 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mousedown event</p>
502 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
503 </li></ul></div></div></div><div id="method-onMouseUp" class="member inherited"><a href="Ext.dd.DragSource.html#method-onMouseUp" rel="method-onMouseUp" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-onMouseUp" class="viewSource">view source</a></div><a name="onMouseUp"></a><a name="method-onMouseUp"></a><a href="Ext.dd.DragSource.html#" rel="method-onMouseUp" class="cls expand">onMouseUp</a>(
504 <span class="pre">Event e</span>)
505  : void</div><div class="description"><div class="short"><p>Event handler that fires when a drag/drop obj gets a mouseup</p>
506 </div><div class="long"><p>Event handler that fires when a drag/drop obj gets a mouseup</p>
507 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the mouseup event</p>
508 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
509 </li></ul></div></div></div><div id="method-removeFromGroup" class="member inherited"><a href="Ext.dd.DragSource.html#method-removeFromGroup" rel="method-removeFromGroup" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-removeFromGroup" class="viewSource">view source</a></div><a name="removeFromGroup"></a><a name="method-removeFromGroup"></a><a href="Ext.dd.DragSource.html#" rel="method-removeFromGroup" class="cls expand">removeFromGroup</a>(
510 <span class="pre">string sGroup</span>)
511  : void</div><div class="description"><div class="short"><p>Remove's this instance from the supplied interaction group</p>
512 </div><div class="long"><p>Remove's this instance from the supplied interaction group</p>
513 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sGroup</span> : string<div class="sub-desc"><p>The group to drop</p>
514 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
515 </li></ul></div></div></div><div id="method-removeInvalidHandleClass" class="member inherited"><a href="Ext.dd.DragSource.html#method-removeInvalidHandleClass" rel="method-removeInvalidHandleClass" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-removeInvalidHandleClass" class="viewSource">view source</a></div><a name="removeInvalidHandleClass"></a><a name="method-removeInvalidHandleClass"></a><a href="Ext.dd.DragSource.html#" rel="method-removeInvalidHandleClass" class="cls expand">removeInvalidHandleClass</a>(
516 <span class="pre">string cssClass</span>)
517  : void</div><div class="description"><div class="short"><p>Unsets an invalid css class</p>
518 </div><div class="long"><p>Unsets an invalid css class</p>
519 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cssClass</span> : string<div class="sub-desc"><p>the class of the element(s) you wish to
520 re-enable</p>
521 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
522 </li></ul></div></div></div><div id="method-removeInvalidHandleId" class="member inherited"><a href="Ext.dd.DragSource.html#method-removeInvalidHandleId" rel="method-removeInvalidHandleId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-removeInvalidHandleId" class="viewSource">view source</a></div><a name="removeInvalidHandleId"></a><a name="method-removeInvalidHandleId"></a><a href="Ext.dd.DragSource.html#" rel="method-removeInvalidHandleId" class="cls expand">removeInvalidHandleId</a>(
523 <span class="pre">string id</span>)
524  : void</div><div class="description"><div class="short"><p>Unsets an invalid handle id</p>
525 </div><div class="long"><p>Unsets an invalid handle id</p>
526 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : string<div class="sub-desc"><p>the id of the element to re-enable</p>
527 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
528 </li></ul></div></div></div><div id="method-removeInvalidHandleType" class="member inherited"><a href="Ext.dd.DragSource.html#method-removeInvalidHandleType" rel="method-removeInvalidHandleType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-removeInvalidHandleType" class="viewSource">view source</a></div><a name="removeInvalidHandleType"></a><a name="method-removeInvalidHandleType"></a><a href="Ext.dd.DragSource.html#" rel="method-removeInvalidHandleType" class="cls expand">removeInvalidHandleType</a>(
529 <span class="pre">string tagName</span>)
530  : void</div><div class="description"><div class="short"><p>Unsets an excluded tag name set by addInvalidHandleType</p>
531 </div><div class="long"><p>Unsets an excluded tag name set by addInvalidHandleType</p>
532 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tagName</span> : string<div class="sub-desc"><p>the type of element to unexclude</p>
533 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
534 </li></ul></div></div></div><div id="method-resetConstraints" class="member inherited"><a href="Ext.dd.DragSource.html#method-resetConstraints" rel="method-resetConstraints" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-resetConstraints" class="viewSource">view source</a></div><a name="resetConstraints"></a><a name="method-resetConstraints"></a><a href="Ext.dd.DragSource.html#" rel="method-resetConstraints" class="cls expand">resetConstraints</a>(
535 <span class="pre">boolean maintainOffset</span>)
536  : void</div><div class="description"><div class="short"><p>resetConstraints must be called if you manually reposition a dd element.</p>
537 </div><div class="long"><p>resetConstraints must be called if you manually reposition a dd element.</p>
538 <h3 class="pa">Parameters</h3><ul><li><span class="pre">maintainOffset</span> : boolean<div class="sub-desc">
539 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
540 </li></ul></div></div></div><div id="method-setDelta" class="member inherited"><a href="Ext.dd.DragSource.html#method-setDelta" rel="method-setDelta" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-method-setDelta" class="viewSource">view source</a></div><a name="setDelta"></a><a name="method-setDelta"></a><a href="Ext.dd.DragSource.html#" rel="method-setDelta" class="cls expand">setDelta</a>(
541 <span class="pre">int iDeltaX, int iDeltaY</span>)
542  : void</div><div class="description"><div class="short">Sets the pointer offset.  You can call this directly to force the
543 offset to be in a particular location (e.g., pass i...</div><div class="long"><p>Sets the pointer offset.  You can call this directly to force the
544 offset to be in a particular location (e.g., pass in 0,0 to set it
545 to the center of the object)</p>
546 <h3 class="pa">Parameters</h3><ul><li><span class="pre">iDeltaX</span> : int<div class="sub-desc"><p>the distance from the left</p>
547 </div></li><li><span class="pre">iDeltaY</span> : int<div class="sub-desc"><p>the distance from the top</p>
548 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
549 </li></ul></div></div></div><div id="method-setDragElId" class="member inherited"><a href="Ext.dd.DragSource.html#method-setDragElId" rel="method-setDragElId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-setDragElId" class="viewSource">view source</a></div><a name="setDragElId"></a><a name="method-setDragElId"></a><a href="Ext.dd.DragSource.html#" rel="method-setDragElId" class="cls expand">setDragElId</a>(
550 <span class="pre">Object id</span>)
551  : void</div><div class="description"><div class="short"><p>Allows you to specify that an element other than the linked element
552 will be moved with the cursor during a drag</p>
553 </div><div class="long"><p>Allows you to specify that an element other than the linked element
554 will be moved with the cursor during a drag</p>
555 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : Object<div class="sub-desc"><p>{string} the id of the element that will be used to initiate the drag</p>
556 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
557 </li></ul></div></div></div><div id="method-setDragElPos" class="member inherited"><a href="Ext.dd.DragSource.html#method-setDragElPos" rel="method-setDragElPos" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DD.html" class="definedIn docClass">Ext.dd.DD</a><br/><a href="../source/DD.html#Ext-dd.DD-method-setDragElPos" class="viewSource">view source</a></div><a name="setDragElPos"></a><a name="method-setDragElPos"></a><a href="Ext.dd.DragSource.html#" rel="method-setDragElPos" class="cls expand">setDragElPos</a>(
558 <span class="pre">int iPageX, int iPageY</span>)
559  : void</div><div class="description"><div class="short">Sets the drag element to the location of the mousedown or click event,
560 maintaining the cursor location relative to th...</div><div class="long"><p>Sets the drag element to the location of the mousedown or click event,
561 maintaining the cursor location relative to the location on the element
562 that was clicked.  Override this if you want to place the element in a
563 location other than where the cursor is.</p>
564 <h3 class="pa">Parameters</h3><ul><li><span class="pre">iPageX</span> : int<div class="sub-desc"><p>the X coordinate of the mousedown or drag event</p>
565 </div></li><li><span class="pre">iPageY</span> : int<div class="sub-desc"><p>the Y coordinate of the mousedown or drag event</p>
566 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
567 </li></ul></div></div></div><div id="method-setHandleElId" class="member inherited"><a href="Ext.dd.DragSource.html#method-setHandleElId" rel="method-setHandleElId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-setHandleElId" class="viewSource">view source</a></div><a name="setHandleElId"></a><a name="method-setHandleElId"></a><a href="Ext.dd.DragSource.html#" rel="method-setHandleElId" class="cls expand">setHandleElId</a>(
568 <span class="pre">Object id</span>)
569  : void</div><div class="description"><div class="short">Allows you to specify a child of the linked element that should be
570 used to initiate the drag operation.  An example o...</div><div class="long"><p>Allows you to specify a child of the linked element that should be
571 used to initiate the drag operation.  An example of this would be if
572 you have a content div with text and links.  Clicking anywhere in the
573 content area would normally start the drag operation.  Use this method
574 to specify that an element inside of the content div is the element
575 that starts the drag operation.</p>
576 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : Object<div class="sub-desc"><p>{string} the id of the element that will be used to
577 initiate the drag.</p>
578 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
579 </li></ul></div></div></div><div id="method-setInitPosition" class="member inherited"><a href="Ext.dd.DragSource.html#method-setInitPosition" rel="method-setInitPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-setInitPosition" class="viewSource">view source</a></div><a name="setInitPosition"></a><a name="method-setInitPosition"></a><a href="Ext.dd.DragSource.html#" rel="method-setInitPosition" class="cls expand">setInitPosition</a>(
580 <span class="pre">int diffX, int diffY</span>)
581  : void</div><div class="description"><div class="short"><p>Stores the initial placement of the linked element.</p>
582 </div><div class="long"><p>Stores the initial placement of the linked element.</p>
583 <h3 class="pa">Parameters</h3><ul><li><span class="pre">diffX</span> : int<div class="sub-desc"><p>the X offset, default 0</p>
584 </div></li><li><span class="pre">diffY</span> : int<div class="sub-desc"><p>the Y offset, default 0</p>
585 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
586 </li></ul></div></div></div><div id="method-setOuterHandleElId" class="member inherited"><a href="Ext.dd.DragSource.html#method-setOuterHandleElId" rel="method-setOuterHandleElId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-setOuterHandleElId" class="viewSource">view source</a></div><a name="setOuterHandleElId"></a><a name="method-setOuterHandleElId"></a><a href="Ext.dd.DragSource.html#" rel="method-setOuterHandleElId" class="cls expand">setOuterHandleElId</a>(
587 <span class="pre">Object id</span>)
588  : void</div><div class="description"><div class="short"><p>Allows you to set an element outside of the linked element as a drag
589 handle</p>
590 </div><div class="long"><p>Allows you to set an element outside of the linked element as a drag
591 handle</p>
592 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : Object<div class="sub-desc"><p>the id of the element that will be used to initiate the drag</p>
593 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
594 </li></ul></div></div></div><div id="method-setPadding" class="member inherited"><a href="Ext.dd.DragSource.html#method-setPadding" rel="method-setPadding" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-setPadding" class="viewSource">view source</a></div><a name="setPadding"></a><a name="method-setPadding"></a><a href="Ext.dd.DragSource.html#" rel="method-setPadding" class="cls expand">setPadding</a>(
595 <span class="pre">int iTop, int iRight, int iBot, int iLeft</span>)
596  : void</div><div class="description"><div class="short">Configures the padding for the target zone in px.  Effectively expands
597 (or reduces) the virtual object size for targe...</div><div class="long"><p>Configures the padding for the target zone in px.  Effectively expands
598 (or reduces) the virtual object size for targeting calculations.
599 Supports css-style shorthand; if only one parameter is passed, all sides
600 will have that padding, and if only two are passed, the top and bottom
601 will have the first param, the left and right the second.</p>
602 <h3 class="pa">Parameters</h3><ul><li><span class="pre">iTop</span> : int<div class="sub-desc"><p>Top pad</p>
603 </div></li><li><span class="pre">iRight</span> : int<div class="sub-desc"><p>Right pad</p>
604 </div></li><li><span class="pre">iBot</span> : int<div class="sub-desc"><p>Bot pad</p>
605 </div></li><li><span class="pre">iLeft</span> : int<div class="sub-desc"><p>Left pad</p>
606 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
607 </li></ul></div></div></div><div id="method-setXConstraint" class="member inherited"><a href="Ext.dd.DragSource.html#method-setXConstraint" rel="method-setXConstraint" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-setXConstraint" class="viewSource">view source</a></div><a name="setXConstraint"></a><a name="method-setXConstraint"></a><a href="Ext.dd.DragSource.html#" rel="method-setXConstraint" class="cls expand">setXConstraint</a>(
608 <span class="pre">int iLeft, int iRight, int iTickSize</span>)
609  : void</div><div class="description"><div class="short">By default, the element can be dragged any place on the screen.  Use
610 this method to limit the horizontal travel of th...</div><div class="long"><p>By default, the element can be dragged any place on the screen.  Use
611 this method to limit the horizontal travel of the element.  Pass in
612 0,0 for the parameters if you want to lock the drag to the y axis.</p>
613 <h3 class="pa">Parameters</h3><ul><li><span class="pre">iLeft</span> : int<div class="sub-desc"><p>the number of pixels the element can move to the left</p>
614 </div></li><li><span class="pre">iRight</span> : int<div class="sub-desc"><p>the number of pixels the element can move to the
615 right</p>
616 </div></li><li><span class="pre">iTickSize</span> : int<div class="sub-desc"><p>optional parameter for specifying that the
617 element
618 should move iTickSize pixels at a time.</p>
619 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
620 </li></ul></div></div></div><div id="method-setYConstraint" class="member inherited"><a href="Ext.dd.DragSource.html#method-setYConstraint" rel="method-setYConstraint" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-setYConstraint" class="viewSource">view source</a></div><a name="setYConstraint"></a><a name="method-setYConstraint"></a><a href="Ext.dd.DragSource.html#" rel="method-setYConstraint" class="cls expand">setYConstraint</a>(
621 <span class="pre">int iUp, int iDown, int iTickSize</span>)
622  : void</div><div class="description"><div class="short">By default, the element can be dragged any place on the screen.  Set
623 this to limit the vertical travel of the element...</div><div class="long"><p>By default, the element can be dragged any place on the screen.  Set
624 this to limit the vertical travel of the element.  Pass in 0,0 for the
625 parameters if you want to lock the drag to the x axis.</p>
626 <h3 class="pa">Parameters</h3><ul><li><span class="pre">iUp</span> : int<div class="sub-desc"><p>the number of pixels the element can move up</p>
627 </div></li><li><span class="pre">iDown</span> : int<div class="sub-desc"><p>the number of pixels the element can move down</p>
628 </div></li><li><span class="pre">iTickSize</span> : int<div class="sub-desc"><p>optional parameter for specifying that the
629 element should move iTickSize pixels at a time.</p>
630 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
631 </li></ul></div></div></div><div id="method-startDrag" class="member inherited"><a href="Ext.dd.DragSource.html#method-startDrag" rel="method-startDrag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-startDrag" class="viewSource">view source</a></div><a name="startDrag"></a><a name="method-startDrag"></a><a href="Ext.dd.DragSource.html#" rel="method-startDrag" class="cls expand">startDrag</a>(
632 <span class="pre">int X, int Y</span>)
633  : void</div><div class="description"><div class="short"><p>Abstract method called after a drag/drop object is clicked
634 and the drag or mousedown time thresholds have beeen met.</p>
635 </div><div class="long"><p>Abstract method called after a drag/drop object is clicked
636 and the drag or mousedown time thresholds have beeen met.</p>
637 <h3 class="pa">Parameters</h3><ul><li><span class="pre">X</span> : int<div class="sub-desc"><p>click location</p>
638 </div></li><li><span class="pre">Y</span> : int<div class="sub-desc"><p>click location</p>
639 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
640 </li></ul></div></div></div><div id="method-toString" class="member inherited"><a href="Ext.dd.DragSource.html#method-toString" rel="method-toString" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-toString" class="viewSource">view source</a></div><a name="toString"></a><a name="method-toString"></a><a href="Ext.dd.DragSource.html#" rel="method-toString" class="cls expand">toString</a> : string</div><div class="description"><div class="short"><p>toString method</p>
641 </div><div class="long"><p>toString method</p>
642 <h3 class="pa">Returns</h3><ul><li><span class="pre">string</span>&nbsp; &nbsp;<p>string representation of the dd obj</p>
643 </li></ul></div></div></div><div id="method-unlock" class="member inherited"><a href="Ext.dd.DragSource.html#method-unlock" rel="method-unlock" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-unlock" class="viewSource">view source</a></div><a name="unlock"></a><a name="method-unlock"></a><a href="Ext.dd.DragSource.html#" rel="method-unlock" class="cls expand">unlock</a> : void</div><div class="description"><div class="short"><p>Unlock this instace</p>
644 </div><div class="long"><p>Unlock this instace</p>
645 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
646 </li></ul></div></div></div><div id="method-unreg" class="member inherited"><a href="Ext.dd.DragSource.html#method-unreg" rel="method-unreg" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDrop.html" class="definedIn docClass">Ext.dd.DragDrop</a><br/><a href="../source/DragDrop.html#Ext-dd.DragDrop-method-unreg" class="viewSource">view source</a></div><a name="unreg"></a><a name="method-unreg"></a><a href="Ext.dd.DragSource.html#" rel="method-unreg" class="cls expand">unreg</a> : void</div><div class="description"><div class="short"><p>Remove all drag and drop hooks for this element</p>
647 </div><div class="long"><p>Remove all drag and drop hooks for this element</p>
648 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
649 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>