Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.dd.DragDropManager.html
1 <!DOCTYPE html><html><head><title>Ext.dd.DragDropManager | 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.DragDropManager',
13         docClass: 'Ext.dd.DragDropManager',
14         docReq: 'Ext.dd.DragDropManager',
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 = 'DragDropManager.html#Ext-dd.DragDropManager';
33     clsInfo = {"methods":["getBestMatch","getCss","getDDById","getElement","getLocation","getRelated","isDragDrop","isHandle","isLegalTarget","isLocked","isTypeOfDD","lock","refreshCache","regDragDrop","regHandle","startDrag","stopEvent","unlock","verifyEl"],"cfgs":[],"properties":["INTERSECT","POINT","clickPixelThresh","clickTimeThresh","mode","preventDefault","stopPropagation","useCache"],"events":[],"subclasses":[]};
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/DragDropManager.html#Ext-dd.DragDropManager" target="_blank">Ext.dd.DragDropManager</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><p>DragDropManager is a singleton that tracks the element interaction for
38 all DragDrop items in the window.  Generally, you will not call
39 this class directly, but it does have helper methods that could
40 be useful in your DragDrop implementations.</p>
41 <div class="members"><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-INTERSECT" class="member f ni"><a href="Ext.dd.DragDropManager.html#property-INTERSECT" rel="property-INTERSECT" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-property-INTERSECT" class="viewSource">view source</a></div><a name="INTERSECT"></a><a name="property-INTERSECT"></a><a href="Ext.dd.DragDropManager.html#" rel="property-INTERSECT" class="cls expand">INTERSECT</a><span> : int</span></div><div class="description"><div class="short"><p>In intersect mode, drag and drop interaction is defined by the
42 overlap of two or more drag and drop objects.</p>
43 </div><div class="long"><p>In intersect mode, drag and drop interaction is defined by the
44 overlap of two or more drag and drop objects.</p>
45 </div></div></div><div id="property-POINT" class="member ni"><a href="Ext.dd.DragDropManager.html#property-POINT" rel="property-POINT" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-property-POINT" class="viewSource">view source</a></div><a name="POINT"></a><a name="property-POINT"></a><a href="Ext.dd.DragDropManager.html#" rel="property-POINT" class="cls expand">POINT</a><span> : int</span></div><div class="description"><div class="short"><p>In point mode, drag and drop interaction is defined by the
46 location of the cursor during the drag/drop</p>
47 </div><div class="long"><p>In point mode, drag and drop interaction is defined by the
48 location of the cursor during the drag/drop</p>
49 </div></div></div><div id="property-clickPixelThresh" class="member ni"><a href="Ext.dd.DragDropManager.html#property-clickPixelThresh" rel="property-clickPixelThresh" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-property-clickPixelThresh" class="viewSource">view source</a></div><a name="clickPixelThresh"></a><a name="property-clickPixelThresh"></a><a href="Ext.dd.DragDropManager.html#" rel="property-clickPixelThresh" class="cls expand">clickPixelThresh</a><span> : int</span></div><div class="description"><div class="short"><p>The number of pixels that the mouse needs to move after the
50 mousedown before the drag is initiated.  Default=3;</p>
51 </div><div class="long"><p>The number of pixels that the mouse needs to move after the
52 mousedown before the drag is initiated.  Default=3;</p>
53 </div></div></div><div id="property-clickTimeThresh" class="member ni"><a href="Ext.dd.DragDropManager.html#property-clickTimeThresh" rel="property-clickTimeThresh" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-property-clickTimeThresh" class="viewSource">view source</a></div><a name="clickTimeThresh"></a><a name="property-clickTimeThresh"></a><a href="Ext.dd.DragDropManager.html#" rel="property-clickTimeThresh" class="cls expand">clickTimeThresh</a><span> : int</span></div><div class="description"><div class="short"><p>The number of milliseconds after the mousedown event to initiate the
54 drag if we don't get a mouseup event. Default=350</p>
55 </div><div class="long"><p>The number of milliseconds after the mousedown event to initiate the
56 drag if we don't get a mouseup event. Default=350</p>
57 </div></div></div><div id="property-mode" class="member ni"><a href="Ext.dd.DragDropManager.html#property-mode" rel="property-mode" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-property-mode" class="viewSource">view source</a></div><a name="mode"></a><a name="property-mode"></a><a href="Ext.dd.DragDropManager.html#" rel="property-mode" class="cls expand">mode</a><span> : int</span></div><div class="description"><div class="short"><p>The current drag and drop mode.  Default: POINT</p>
58 </div><div class="long"><p>The current drag and drop mode.  Default: POINT</p>
59 </div></div></div><div id="property-preventDefault" class="member ni"><a href="Ext.dd.DragDropManager.html#property-preventDefault" rel="property-preventDefault" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-property-preventDefault" class="viewSource">view source</a></div><a name="preventDefault"></a><a name="property-preventDefault"></a><a href="Ext.dd.DragDropManager.html#" rel="property-preventDefault" class="cls expand">preventDefault</a><span> : boolean</span></div><div class="description"><div class="short">Flag to determine if we should prevent the default behavior of the
60 events we define. By default this is true, but thi...</div><div class="long"><p>Flag to determine if we should prevent the default behavior of the
61 events we define. By default this is true, but this can be set to
62 false if you need the default behavior (not recommended)</p>
63 </div></div></div><div id="property-stopPropagation" class="member ni"><a href="Ext.dd.DragDropManager.html#property-stopPropagation" rel="property-stopPropagation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-property-stopPropagation" class="viewSource">view source</a></div><a name="stopPropagation"></a><a name="property-stopPropagation"></a><a href="Ext.dd.DragDropManager.html#" rel="property-stopPropagation" class="cls expand">stopPropagation</a><span> : boolean</span></div><div class="description"><div class="short">Flag to determine if we should stop the propagation of the events
64 we generate. This is true by default but you may wa...</div><div class="long"><p>Flag to determine if we should stop the propagation of the events
65 we generate. This is true by default but you may want to set it to
66 false if the html element contains other features that require the
67 mouse click.</p>
68 </div></div></div><div id="property-useCache" class="member ni"><a href="Ext.dd.DragDropManager.html#property-useCache" rel="property-useCache" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-property-useCache" class="viewSource">view source</a></div><a name="useCache"></a><a name="property-useCache"></a><a href="Ext.dd.DragDropManager.html#" rel="property-useCache" class="cls expand">useCache</a><span> : boolean</span></div><div class="description"><div class="short">Set useCache to false if you want to force object the lookup of each
69 drag and drop linked element constantly during a...</div><div class="long"><p>Set useCache to false if you want to force object the lookup of each
70 drag and drop linked element constantly during a drag.</p>
71 </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-getBestMatch" class="member f ni"><a href="Ext.dd.DragDropManager.html#method-getBestMatch" rel="method-getBestMatch" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-getBestMatch" class="viewSource">view source</a></div><a name="getBestMatch"></a><a name="method-getBestMatch"></a><a href="Ext.dd.DragDropManager.html#" rel="method-getBestMatch" class="cls expand">getBestMatch</a>(
72 <span class="pre">DragDrop[] dds</span>)
73  : DragDrop</div><div class="description"><div class="short">Helper function for getting the best match from the list of drag
74 and drop objects returned by the drag and drop event...</div><div class="long"><p>Helper function for getting the best match from the list of drag
75 and drop objects returned by the drag and drop events when we are
76 in INTERSECT mode.  It returns either the first object that the
77 cursor is over, or the object that has the greatest overlap with
78 the dragged element.</p>
79 <h3 class="pa">Parameters</h3><ul><li><span class="pre">dds</span> : DragDrop[]<div class="sub-desc"><p>The array of drag and drop objects
80 targeted</p>
81 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">DragDrop</span>&nbsp; &nbsp;<p>The best single match</p>
82 </li></ul></div></div></div><div id="method-getCss" class="member ni"><a href="Ext.dd.DragDropManager.html#method-getCss" rel="method-getCss" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-getCss" class="viewSource">view source</a></div><a name="getCss"></a><a name="method-getCss"></a><a href="Ext.dd.DragDropManager.html#" rel="method-getCss" class="cls expand">getCss</a>(
83 <span class="pre">String id</span>)
84  : Object</div><div class="description"><div class="short"><p>Returns the style property for the DOM element (i.e.,
85 document.getElById(id).style)</p>
86 </div><div class="long"><p>Returns the style property for the DOM element (i.e.,
87 document.getElById(id).style)</p>
88 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>the id of the elment to get</p>
89 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The style property of the element</p>
90 </li></ul></div></div></div><div id="method-getDDById" class="member ni"><a href="Ext.dd.DragDropManager.html#method-getDDById" rel="method-getDDById" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-getDDById" class="viewSource">view source</a></div><a name="getDDById"></a><a name="method-getDDById"></a><a href="Ext.dd.DragDropManager.html#" rel="method-getDDById" class="cls expand">getDDById</a>(
91 <span class="pre">String id</span>)
92  : DragDrop</div><div class="description"><div class="short"><p>Returns the DragDrop instance for a given id</p>
93 </div><div class="long"><p>Returns the DragDrop instance for a given id</p>
94 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>the id of the DragDrop object</p>
95 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">DragDrop</span>&nbsp; &nbsp;<p>the drag drop object, null if it is not found</p>
96 </li></ul></div></div></div><div id="method-getElement" class="member ni"><a href="Ext.dd.DragDropManager.html#method-getElement" rel="method-getElement" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-getElement" class="viewSource">view source</a></div><a name="getElement"></a><a name="method-getElement"></a><a href="Ext.dd.DragDropManager.html#" rel="method-getElement" class="cls expand">getElement</a>(
97 <span class="pre">String id</span>)
98  : Object</div><div class="description"><div class="short"><p>Returns the actual DOM element</p>
99 </div><div class="long"><p>Returns the actual DOM element</p>
100 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>the id of the elment to get</p>
101 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The element
102 @deprecated use Ext.lib.Ext.getDom instead</p>
103 </li></ul></div></div></div><div id="method-getLocation" class="member ni"><a href="Ext.dd.DragDropManager.html#method-getLocation" rel="method-getLocation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-getLocation" class="viewSource">view source</a></div><a name="getLocation"></a><a name="method-getLocation"></a><a href="Ext.dd.DragDropManager.html#" rel="method-getLocation" class="cls expand">getLocation</a>(
104 <span class="pre">DragDrop oDD</span>)
105  : Ext.util.Region</div><div class="description"><div class="short">Returns a Region object containing the drag and drop element's position
106 and size, including the padding configured fo...</div><div class="long"><p>Returns a Region object containing the drag and drop element's position
107 and size, including the padding configured for it</p>
108 <h3 class="pa">Parameters</h3><ul><li><span class="pre">oDD</span> : DragDrop<div class="sub-desc"><p>the drag and drop object to get the</p>
109
110 <pre><code>                  location for
111 </code></pre>
112 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Region</span>&nbsp; &nbsp;<p>a Region object representing the total area</p>
113
114 <pre><code>                        the element occupies, including any padding
115                         the instance is configured for.
116 </code></pre>
117 </li></ul></div></div></div><div id="method-getRelated" class="member ni"><a href="Ext.dd.DragDropManager.html#method-getRelated" rel="method-getRelated" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-getRelated" class="viewSource">view source</a></div><a name="getRelated"></a><a name="method-getRelated"></a><a href="Ext.dd.DragDropManager.html#" rel="method-getRelated" class="cls expand">getRelated</a>(
118 <span class="pre">DragDrop p_oDD, boolean bTargetsOnly</span>)
119  : DragDrop[]</div><div class="description"><div class="short"><p>Returns the drag and drop instances that are in all groups the
120 passed in instance belongs to.</p>
121 </div><div class="long"><p>Returns the drag and drop instances that are in all groups the
122 passed in instance belongs to.</p>
123 <h3 class="pa">Parameters</h3><ul><li><span class="pre">p_oDD</span> : DragDrop<div class="sub-desc"><p>the obj to get related data for</p>
124 </div></li><li><span class="pre">bTargetsOnly</span> : boolean<div class="sub-desc"><p>if true, only return targetable objs</p>
125 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">DragDrop[]</span>&nbsp; &nbsp;<p>the related instances</p>
126 </li></ul></div></div></div><div id="method-isDragDrop" class="member ni"><a href="Ext.dd.DragDropManager.html#method-isDragDrop" rel="method-isDragDrop" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-isDragDrop" class="viewSource">view source</a></div><a name="isDragDrop"></a><a name="method-isDragDrop"></a><a href="Ext.dd.DragDropManager.html#" rel="method-isDragDrop" class="cls expand">isDragDrop</a>(
127 <span class="pre">String id</span>)
128  : boolean</div><div class="description"><div class="short"><p>Utility function to determine if a given element has been
129 registered as a drag drop item.</p>
130 </div><div class="long"><p>Utility function to determine if a given element has been
131 registered as a drag drop item.</p>
132 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>the element id to check</p>
133 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">boolean</span>&nbsp; &nbsp;<p>true if this element is a DragDrop item,
134 false otherwise</p>
135 </li></ul></div></div></div><div id="method-isHandle" class="member ni"><a href="Ext.dd.DragDropManager.html#method-isHandle" rel="method-isHandle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-isHandle" class="viewSource">view source</a></div><a name="isHandle"></a><a name="method-isHandle"></a><a href="Ext.dd.DragDropManager.html#" rel="method-isHandle" class="cls expand">isHandle</a>(
136 <span class="pre">String id, Object sHandleId</span>)
137  : boolean</div><div class="description"><div class="short">Utility function to determine if a given element has been
138 registered as a drag drop handle for the given Drag Drop ob...</div><div class="long"><p>Utility function to determine if a given element has been
139 registered as a drag drop handle for the given Drag Drop object.</p>
140 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>the element id to check</p>
141 </div></li><li><span class="pre">sHandleId</span> : Object<div class="sub-desc">
142 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">boolean</span>&nbsp; &nbsp;<p>true if this element is a DragDrop handle, false
143 otherwise</p>
144 </li></ul></div></div></div><div id="method-isLegalTarget" class="member ni"><a href="Ext.dd.DragDropManager.html#method-isLegalTarget" rel="method-isLegalTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-isLegalTarget" class="viewSource">view source</a></div><a name="isLegalTarget"></a><a name="method-isLegalTarget"></a><a href="Ext.dd.DragDropManager.html#" rel="method-isLegalTarget" class="cls expand">isLegalTarget</a>(
145 <span class="pre">DragDrop oDD, DragDrop oTargetDD</span>)
146  : boolean</div><div class="description"><div class="short"><p>Returns true if the specified dd target is a legal target for
147 the specifice drag obj</p>
148 </div><div class="long"><p>Returns true if the specified dd target is a legal target for
149 the specifice drag obj</p>
150 <h3 class="pa">Parameters</h3><ul><li><span class="pre">oDD</span> : DragDrop<div class="sub-desc"><p>the drag obj</p>
151 </div></li><li><span class="pre">oTargetDD</span> : DragDrop<div class="sub-desc"><p>the target</p>
152 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">boolean</span>&nbsp; &nbsp;<p>true if the target is a legal target for the
153 dd obj</p>
154 </li></ul></div></div></div><div id="method-isLocked" class="member ni"><a href="Ext.dd.DragDropManager.html#method-isLocked" rel="method-isLocked" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-isLocked" class="viewSource">view source</a></div><a name="isLocked"></a><a name="method-isLocked"></a><a href="Ext.dd.DragDropManager.html#" rel="method-isLocked" class="cls expand">isLocked</a> : boolean</div><div class="description"><div class="short"><p>Is drag and drop locked?</p>
155 </div><div class="long"><p>Is drag and drop locked?</p>
156 <h3 class="pa">Returns</h3><ul><li><span class="pre">boolean</span>&nbsp; &nbsp;<p>True if drag and drop is locked, false otherwise.</p>
157 </li></ul></div></div></div><div id="method-isTypeOfDD" class="member ni"><a href="Ext.dd.DragDropManager.html#method-isTypeOfDD" rel="method-isTypeOfDD" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-isTypeOfDD" class="viewSource">view source</a></div><a name="isTypeOfDD"></a><a name="method-isTypeOfDD"></a><a href="Ext.dd.DragDropManager.html#" rel="method-isTypeOfDD" class="cls expand">isTypeOfDD</a>(
158 <span class="pre">Object the</span>)
159  : boolean</div><div class="description"><div class="short">My goal is to be able to transparently determine if an object is
160 typeof DragDrop, and the exact subclass of DragDrop....</div><div class="long"><p>My goal is to be able to transparently determine if an object is
161 typeof DragDrop, and the exact subclass of DragDrop.  typeof
162 returns "object", oDD.constructor.toString() always returns
163 "DragDrop" and not the name of the subclass.  So for now it just
164 evaluates a well-known variable in DragDrop.</p>
165 <h3 class="pa">Parameters</h3><ul><li><span class="pre">the</span> : Object<div class="sub-desc"><p>object to evaluate</p>
166 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">boolean</span>&nbsp; &nbsp;<p>true if typeof oDD = DragDrop</p>
167 </li></ul></div></div></div><div id="method-lock" class="member ni"><a href="Ext.dd.DragDropManager.html#method-lock" rel="method-lock" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-lock" class="viewSource">view source</a></div><a name="lock"></a><a name="method-lock"></a><a href="Ext.dd.DragDropManager.html#" rel="method-lock" class="cls expand">lock</a> : void</div><div class="description"><div class="short"><p>Lock all drag and drop functionality</p>
168 </div><div class="long"><p>Lock all drag and drop functionality</p>
169 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
170 </li></ul></div></div></div><div id="method-refreshCache" class="member ni"><a href="Ext.dd.DragDropManager.html#method-refreshCache" rel="method-refreshCache" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-refreshCache" class="viewSource">view source</a></div><a name="refreshCache"></a><a name="method-refreshCache"></a><a href="Ext.dd.DragDropManager.html#" rel="method-refreshCache" class="cls expand">refreshCache</a>(
171 <span class="pre">Object groups</span>)
172  : void</div><div class="description"><div class="short">Refreshes the cache of the top-left and bottom-right points of the
173 drag and drop objects in the specified group(s).  ...</div><div class="long"><p>Refreshes the cache of the top-left and bottom-right points of the
174 drag and drop objects in the specified group(s).  This is in the
175 format that is stored in the drag and drop instance, so typical
176 usage is:
177 <code>
178 Ext.dd.DragDropManager.refreshCache(ddinstance.groups);
179 </code>
180 Alternatively:
181 <code>
182 Ext.dd.DragDropManager.refreshCache({group1:true, group2:true});
183 </code>
184 @TODO this really should be an indexed array.  Alternatively this
185 method could accept both.</p>
186 <h3 class="pa">Parameters</h3><ul><li><span class="pre">groups</span> : Object<div class="sub-desc"><p>an associative array of groups to refresh</p>
187 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
188 </li></ul></div></div></div><div id="method-regDragDrop" class="member ni"><a href="Ext.dd.DragDropManager.html#method-regDragDrop" rel="method-regDragDrop" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-regDragDrop" class="viewSource">view source</a></div><a name="regDragDrop"></a><a name="method-regDragDrop"></a><a href="Ext.dd.DragDropManager.html#" rel="method-regDragDrop" class="cls expand">regDragDrop</a>(
189 <span class="pre">DragDrop oDD, String sGroup</span>)
190  : void</div><div class="description"><div class="short"><p>Each DragDrop instance must be registered with the DragDropManager.
191 This is executed in DragDrop.init()</p>
192 </div><div class="long"><p>Each DragDrop instance must be registered with the DragDropManager.
193 This is executed in DragDrop.init()</p>
194 <h3 class="pa">Parameters</h3><ul><li><span class="pre">oDD</span> : DragDrop<div class="sub-desc"><p>the DragDrop object to register</p>
195 </div></li><li><span class="pre">sGroup</span> : String<div class="sub-desc"><p>the name of the group this element belongs to</p>
196 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
197 </li></ul></div></div></div><div id="method-regHandle" class="member ni"><a href="Ext.dd.DragDropManager.html#method-regHandle" rel="method-regHandle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-regHandle" class="viewSource">view source</a></div><a name="regHandle"></a><a name="method-regHandle"></a><a href="Ext.dd.DragDropManager.html#" rel="method-regHandle" class="cls expand">regHandle</a>(
198 <span class="pre">String sDDId, String sHandleId</span>)
199  : void</div><div class="description"><div class="short"><p>Each DragDrop handle element must be registered.  This is done
200 automatically when executing DragDrop.setHandleElId()</p>
201 </div><div class="long"><p>Each DragDrop handle element must be registered.  This is done
202 automatically when executing DragDrop.setHandleElId()</p>
203 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sDDId</span> : String<div class="sub-desc"><p>the DragDrop id this element is a handle for</p>
204 </div></li><li><span class="pre">sHandleId</span> : String<div class="sub-desc"><p>the id of the element that is the drag
205 handle</p>
206 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
207 </li></ul></div></div></div><div id="method-startDrag" class="member ni"><a href="Ext.dd.DragDropManager.html#method-startDrag" rel="method-startDrag" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-startDrag" class="viewSource">view source</a></div><a name="startDrag"></a><a name="method-startDrag"></a><a href="Ext.dd.DragDropManager.html#" rel="method-startDrag" class="cls expand">startDrag</a>(
208 <span class="pre">Object x, Object y</span>)
209  : void</div><div class="description"><div class="short"><p>Fired when either the drag pixel threshol or the mousedown hold
210 time threshold has been met.</p>
211 </div><div class="long"><p>Fired when either the drag pixel threshol or the mousedown hold
212 time threshold has been met.</p>
213 <h3 class="pa">Parameters</h3><ul><li><span class="pre">x</span> : Object<div class="sub-desc"><p>{int} the X position of the original mousedown</p>
214 </div></li><li><span class="pre">y</span> : Object<div class="sub-desc"><p>{int} the Y position of the original mousedown</p>
215 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
216 </li></ul></div></div></div><div id="method-stopEvent" class="member ni"><a href="Ext.dd.DragDropManager.html#method-stopEvent" rel="method-stopEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-stopEvent" class="viewSource">view source</a></div><a name="stopEvent"></a><a name="method-stopEvent"></a><a href="Ext.dd.DragDropManager.html#" rel="method-stopEvent" class="cls expand">stopEvent</a>(
217 <span class="pre">Event e</span>)
218  : void</div><div class="description"><div class="short"><p>Utility to stop event propagation and event default, if these
219 features are turned on.</p>
220 </div><div class="long"><p>Utility to stop event propagation and event default, if these
221 features are turned on.</p>
222 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>the event as returned by this.getEvent()</p>
223 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
224 </li></ul></div></div></div><div id="method-unlock" class="member ni"><a href="Ext.dd.DragDropManager.html#method-unlock" rel="method-unlock" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-unlock" class="viewSource">view source</a></div><a name="unlock"></a><a name="method-unlock"></a><a href="Ext.dd.DragDropManager.html#" rel="method-unlock" class="cls expand">unlock</a> : void</div><div class="description"><div class="short"><p>Unlock all drag and drop functionality</p>
225 </div><div class="long"><p>Unlock all drag and drop functionality</p>
226 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
227 </li></ul></div></div></div><div id="method-verifyEl" class="member ni"><a href="Ext.dd.DragDropManager.html#method-verifyEl" rel="method-verifyEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.DragDropManager.html" class="definedIn docClass">Ext.dd.DragDropManager</a><br/><a href="../source/DragDropManager.html#Ext-dd.DragDropManager-method-verifyEl" class="viewSource">view source</a></div><a name="verifyEl"></a><a name="method-verifyEl"></a><a href="Ext.dd.DragDropManager.html#" rel="method-verifyEl" class="cls expand">verifyEl</a>(
228 <span class="pre">HTMLElement el</span>)
229  : boolean</div><div class="description"><div class="short">This checks to make sure an element exists and is in the DOM.  The
230 main purpose is to handle cases where innerHTML is...</div><div class="long"><p>This checks to make sure an element exists and is in the DOM.  The
231 main purpose is to handle cases where innerHTML is used to remove
232 drag and drop objects from the DOM.  IE provides an 'unspecified
233 error' when trying to access the offsetParent of such an element</p>
234 <h3 class="pa">Parameters</h3><ul><li><span class="pre">el</span> : HTMLElement<div class="sub-desc"><p>the element to check</p>
235 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">boolean</span>&nbsp; &nbsp;<p>true if the element looks usable</p>
236 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>