Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.dd.DDProxy.js
1 Ext.data.JsonP.Ext_dd_DDProxy({
2   "tagname": "class",
3   "name": "Ext.dd.DDProxy",
4   "doc": "<p>A DragDrop implementation that inserts an empty, bordered div into\nthe document that follows the cursor during drag operations.  At the time of\nthe click, the frame div is resized to the dimensions of the linked html\nelement, and moved to the exact location of the linked element.</p>\n\n<p>References to the \"frame\" element refer to the single proxy element that\nwas created to be dragged in place of all DDProxy elements on the\npage.</p>\n",
5   "extends": "Ext.dd.DD",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18
19   ],
20   "method": [
21     {
22       "tagname": "method",
23       "name": "DDProxy",
24       "member": "Ext.dd.DDProxy",
25       "doc": "\n",
26       "params": [
27         {
28           "type": "String",
29           "name": "id",
30           "doc": "<p>the id of the linked html element</p>\n",
31           "optional": false
32         },
33         {
34           "type": "String",
35           "name": "sGroup",
36           "doc": "<p>the group of related DragDrop objects</p>\n",
37           "optional": false
38         },
39         {
40           "type": "object",
41           "name": "config",
42           "doc": "<p>an object containing configurable attributes</p>\n\n<pre><code>           Valid properties for DDProxy in addition to those in DragDrop:\n              resizeFrame, centerFrame, dragElId\n</code></pre>\n",
43           "optional": false
44         }
45       ],
46       "return": {
47         "type": "void",
48         "doc": "\n"
49       },
50       "private": false,
51       "static": false,
52       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DDProxy.js",
53       "linenr": 9,
54       "html_filename": "DDProxy.html",
55       "href": "DDProxy.html#Ext-dd-DDProxy-method-constructor",
56       "shortDoc": "\n"
57     },
58     {
59       "tagname": "method",
60       "name": "addInvalidHandleClass",
61       "member": "Ext.dd.DragDrop",
62       "doc": "<p>Lets you specify a css class of elements that will not initiate a drag</p>\n",
63       "params": [
64         {
65           "type": "string",
66           "name": "cssClass",
67           "doc": "<p>the class of the elements you wish to ignore</p>\n",
68           "optional": false
69         }
70       ],
71       "return": {
72         "type": "void",
73         "doc": "\n"
74       },
75       "private": false,
76       "static": false,
77       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
78       "linenr": 894,
79       "html_filename": "DragDrop.html",
80       "href": "DragDrop.html#Ext-dd-DragDrop-method-addInvalidHandleClass",
81       "shortDoc": "<p>Lets you specify a css class of elements that will not initiate a drag</p>\n"
82     },
83     {
84       "tagname": "method",
85       "name": "addInvalidHandleId",
86       "member": "Ext.dd.DragDrop",
87       "doc": "<p>Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag</p>\n",
88       "params": [
89         {
90           "type": "string",
91           "name": "id",
92           "doc": "<p>the element id of the element you wish to ignore</p>\n",
93           "optional": false
94         }
95       ],
96       "return": {
97         "type": "void",
98         "doc": "\n"
99       },
100       "private": false,
101       "static": false,
102       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
103       "linenr": 881,
104       "html_filename": "DragDrop.html",
105       "href": "DragDrop.html#Ext-dd-DragDrop-method-addInvalidHandleId",
106       "shortDoc": "<p>Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag</p>\n"
107     },
108     {
109       "tagname": "method",
110       "name": "addInvalidHandleType",
111       "member": "Ext.dd.DragDrop",
112       "doc": "<p>Allows you to specify a tag name that should not start a drag operation\nwhen clicked.  This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.</p>\n",
113       "params": [
114         {
115           "type": "string",
116           "name": "tagName",
117           "doc": "<p>the type of element to exclude</p>\n",
118           "optional": false
119         }
120       ],
121       "return": {
122         "type": "void",
123         "doc": "\n"
124       },
125       "private": false,
126       "static": false,
127       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
128       "linenr": 869,
129       "html_filename": "DragDrop.html",
130       "href": "DragDrop.html#Ext-dd-DragDrop-method-addInvalidHandleType",
131       "shortDoc": "Allows you to specify a tag name that should not start a drag operation\nwhen clicked.  This is designed to facilitate..."
132     },
133     {
134       "tagname": "method",
135       "name": "addToGroup",
136       "member": "Ext.dd.DragDrop",
137       "doc": "<p>Add this instance to a group of related drag/drop objects.  All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.</p>\n",
138       "params": [
139         {
140           "type": "Object",
141           "name": "sGroup",
142           "doc": "<p>{string} the name of the group</p>\n",
143           "optional": false
144         }
145       ],
146       "return": {
147         "type": "void",
148         "doc": "\n"
149       },
150       "private": false,
151       "static": false,
152       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
153       "linenr": 730,
154       "html_filename": "DragDrop.html",
155       "href": "DragDrop.html#Ext-dd-DragDrop-method-addToGroup",
156       "shortDoc": "Add this instance to a group of related drag/drop objects.  All\ninstances belong to at least one group, and can belon..."
157     },
158     {
159       "tagname": "method",
160       "name": "alignElWithMouse",
161       "member": "Ext.dd.DD",
162       "doc": "<p>Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked.  Override this if you want to place the element in a\nlocation other than where the cursor is.</p>\n",
163       "params": [
164         {
165           "type": "HTMLElement",
166           "name": "el",
167           "doc": "<p>the element to move</p>\n",
168           "optional": false
169         },
170         {
171           "type": "int",
172           "name": "iPageX",
173           "doc": "<p>the X coordinate of the mousedown or drag event</p>\n",
174           "optional": false
175         },
176         {
177           "type": "int",
178           "name": "iPageY",
179           "doc": "<p>the Y coordinate of the mousedown or drag event</p>\n",
180           "optional": false
181         }
182       ],
183       "return": {
184         "type": "void",
185         "doc": "\n"
186       },
187       "private": false,
188       "static": false,
189       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
190       "linenr": 84,
191       "html_filename": "DD.html",
192       "href": "DD.html#Ext-dd-DD-method-alignElWithMouse",
193       "shortDoc": "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the loc..."
194     },
195     {
196       "tagname": "method",
197       "name": "applyConfig",
198       "member": "Ext.dd.DD",
199       "doc": "<p>Sets up config options specific to this class. Overrides\nExt.dd.DragDrop, but all versions of this method through the\ninheritance chain are called</p>\n",
200       "params": [
201
202       ],
203       "return": {
204         "type": "void",
205         "doc": "\n"
206       },
207       "private": false,
208       "static": false,
209       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
210       "linenr": 258,
211       "html_filename": "DD.html",
212       "href": "DD.html#Ext-dd-DD-method-applyConfig",
213       "shortDoc": "Sets up config options specific to this class. Overrides\nExt.dd.DragDrop, but all versions of this method through the..."
214     },
215     {
216       "tagname": "method",
217       "name": "autoOffset",
218       "member": "Ext.dd.DD",
219       "doc": "<p>Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked</p>\n",
220       "params": [
221         {
222           "type": "int",
223           "name": "iPageX",
224           "doc": "<p>the X coordinate of the click</p>\n",
225           "optional": false
226         },
227         {
228           "type": "int",
229           "name": "iPageY",
230           "doc": "<p>the Y coordinate of the click</p>\n",
231           "optional": false
232         }
233       ],
234       "return": {
235         "type": "void",
236         "doc": "\n"
237       },
238       "private": false,
239       "static": false,
240       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
241       "linenr": 41,
242       "html_filename": "DD.html",
243       "href": "DD.html#Ext-dd-DD-method-autoOffset",
244       "shortDoc": "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was..."
245     },
246     {
247       "tagname": "method",
248       "name": "b4Drag",
249       "member": "Ext.dd.DD",
250       "doc": "<p>Event that fires prior to the onDrag event.  Overrides\nExt.dd.DragDrop.</p>\n",
251       "params": [
252         {
253           "type": "Object",
254           "name": "e",
255           "doc": "\n",
256           "optional": false
257         }
258       ],
259       "return": {
260         "type": "void",
261         "doc": "\n"
262       },
263       "private": false,
264       "static": false,
265       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
266       "linenr": 277,
267       "html_filename": "DD.html",
268       "href": "DD.html#Ext-dd-DD-method-b4Drag",
269       "shortDoc": "<p>Event that fires prior to the onDrag event.  Overrides\nExt.dd.DragDrop.</p>\n"
270     },
271     {
272       "tagname": "method",
273       "name": "b4MouseDown",
274       "member": "Ext.dd.DD",
275       "doc": "<p>Event that fires prior to the onMouseDown event.  Overrides\nExt.dd.DragDrop.</p>\n",
276       "params": [
277         {
278           "type": "Object",
279           "name": "e",
280           "doc": "\n",
281           "optional": false
282         }
283       ],
284       "return": {
285         "type": "void",
286         "doc": "\n"
287       },
288       "private": false,
289       "static": false,
290       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
291       "linenr": 268,
292       "html_filename": "DD.html",
293       "href": "DD.html#Ext-dd-DD-method-b4MouseDown",
294       "shortDoc": "<p>Event that fires prior to the onMouseDown event.  Overrides\nExt.dd.DragDrop.</p>\n"
295     },
296     {
297       "tagname": "method",
298       "name": "cachePosition",
299       "member": "Ext.dd.DD",
300       "doc": "<p>Saves the most recent position so that we can reset the constraints and\ntick marks on-demand.  We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.</p>\n",
301       "params": [
302         {
303           "type": "Object",
304           "name": "iPageX",
305           "doc": "<p>the current x position (optional, this just makes it so we\ndon't have to look it up again)</p>\n",
306           "optional": false
307         },
308         {
309           "type": "Object",
310           "name": "iPageY",
311           "doc": "<p>the current y position (optional, this just makes it so we\ndon't have to look it up again)</p>\n",
312           "optional": false
313         }
314       ],
315       "return": {
316         "type": "void",
317         "doc": "\n"
318       },
319       "private": false,
320       "static": false,
321       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
322       "linenr": 124,
323       "html_filename": "DD.html",
324       "href": "DD.html#Ext-dd-DD-method-cachePosition",
325       "shortDoc": "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand.  We need to know this s..."
326     },
327     {
328       "tagname": "method",
329       "name": "clearConstraints",
330       "member": "Ext.dd.DragDrop",
331       "doc": "<p>Clears any constraints applied to this instance.  Also clears ticks\nsince they can't exist independent of a constraint at this time.</p>\n",
332       "params": [
333
334       ],
335       "return": {
336         "type": "void",
337         "doc": "\n"
338       },
339       "private": false,
340       "static": false,
341       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
342       "linenr": 1049,
343       "html_filename": "DragDrop.html",
344       "href": "DragDrop.html#Ext-dd-DragDrop-method-clearConstraints",
345       "shortDoc": "Clears any constraints applied to this instance.  Also clears ticks\nsince they can't exist independent of a constrain..."
346     },
347     {
348       "tagname": "method",
349       "name": "clearTicks",
350       "member": "Ext.dd.DragDrop",
351       "doc": "<p>Clears any tick interval defined for this instance</p>\n",
352       "params": [
353
354       ],
355       "return": {
356         "type": "void",
357         "doc": "\n"
358       },
359       "private": false,
360       "static": false,
361       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
362       "linenr": 1060,
363       "html_filename": "DragDrop.html",
364       "href": "DragDrop.html#Ext-dd-DragDrop-method-clearTicks",
365       "shortDoc": "<p>Clears any tick interval defined for this instance</p>\n"
366     },
367     {
368       "tagname": "method",
369       "name": "constrainTo",
370       "member": "Ext.dd.DragDrop",
371       "doc": "<p>Initializes the drag drop object's constraints to restrict movement to a certain element.</p>\n\n<p>Usage:</p>\n\n<pre><code> var dd = new Ext.dd.DDProxy(\"dragDiv1\", \"proxytest\",\n                { dragElId: \"existingProxyDiv\" });\n dd.startDrag = function(){\n     this.constrainTo(\"parent-id\");\n };\n </code></pre>\n\n\n<p>Or you can initalize it using the <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a> object:</p>\n\n<pre><code> Ext.get(\"dragDiv1\").initDDProxy(\"proxytest\", {dragElId: \"existingProxyDiv\"}, {\n     startDrag : function(){\n         this.constrainTo(\"parent-id\");\n     }\n });\n </code></pre>\n\n",
372       "params": [
373         {
374           "type": "Mixed",
375           "name": "constrainTo",
376           "doc": "<p>The element to constrain to.</p>\n",
377           "optional": false
378         },
379         {
380           "type": "Object/Number",
381           "name": "pad",
382           "doc": "<p>(optional) Pad provides a way to specify \"padding\" of the constraints,\nand can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or\nan object containing the sides to pad. For example: {right:10, bottom:10}</p>\n",
383           "optional": true
384         },
385         {
386           "type": "Boolean",
387           "name": "inContent",
388           "doc": "<p>(optional) Constrain the draggable in the content box of the element (inside padding and borders)</p>\n",
389           "optional": true
390         }
391       ],
392       "return": {
393         "type": "void",
394         "doc": "\n"
395       },
396       "private": false,
397       "static": false,
398       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
399       "linenr": 493,
400       "html_filename": "DragDrop.html",
401       "href": "DragDrop.html#Ext-dd-DragDrop-method-constrainTo",
402       "shortDoc": "Initializes the drag drop object's constraints to restrict movement to a certain element.\n\nUsage:\n\n var dd = new Ext...."
403     },
404     {
405       "tagname": "method",
406       "name": "createFrame",
407       "member": "Ext.dd.DDProxy",
408       "doc": "<p>Creates the proxy element if it does not yet exist</p>\n",
409       "params": [
410
411       ],
412       "return": {
413         "type": "void",
414         "doc": "\n"
415       },
416       "private": false,
417       "static": false,
418       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DDProxy.js",
419       "linenr": 67,
420       "html_filename": "DDProxy.html",
421       "href": "DDProxy.html#Ext-dd-DDProxy-method-createFrame",
422       "shortDoc": "<p>Creates the proxy element if it does not yet exist</p>\n"
423     },
424     {
425       "tagname": "method",
426       "name": "endDrag",
427       "member": "Ext.dd.DragDrop",
428       "doc": "<p>Fired when we are done dragging the object</p>\n",
429       "params": [
430         {
431           "type": "Event",
432           "name": "e",
433           "doc": "<p>the mouseup event</p>\n",
434           "optional": false
435         }
436       ],
437       "return": {
438         "type": "void",
439         "doc": "\n"
440       },
441       "private": false,
442       "static": false,
443       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
444       "linenr": 445,
445       "html_filename": "DragDrop.html",
446       "href": "DragDrop.html#Ext-dd-DragDrop-method-endDrag",
447       "shortDoc": "<p>Fired when we are done dragging the object</p>\n"
448     },
449     {
450       "tagname": "method",
451       "name": "getDragEl",
452       "member": "Ext.dd.DragDrop",
453       "doc": "<p>Returns a reference to the actual element to drag.  By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Ext.dd.DDProxy</p>\n",
454       "params": [
455
456       ],
457       "return": {
458         "type": "HTMLElement",
459         "doc": "<p>the html element</p>\n"
460       },
461       "private": false,
462       "static": false,
463       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
464       "linenr": 563,
465       "html_filename": "DragDrop.html",
466       "href": "DragDrop.html#Ext-dd-DragDrop-method-getDragEl",
467       "shortDoc": "Returns a reference to the actual element to drag.  By default this is\nthe same as the html element, but it can be as..."
468     },
469     {
470       "tagname": "method",
471       "name": "getEl",
472       "member": "Ext.dd.DragDrop",
473       "doc": "<p>Returns a reference to the linked element</p>\n",
474       "params": [
475
476       ],
477       "return": {
478         "type": "HTMLElement",
479         "doc": "<p>the html element</p>\n"
480       },
481       "private": false,
482       "static": false,
483       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
484       "linenr": 550,
485       "html_filename": "DragDrop.html",
486       "href": "DragDrop.html#Ext-dd-DragDrop-method-getEl",
487       "shortDoc": "<p>Returns a reference to the linked element</p>\n"
488     },
489     {
490       "tagname": "method",
491       "name": "init",
492       "member": "Ext.dd.DragDrop",
493       "doc": "<p>Sets up the DragDrop object.  Must be called in the constructor of any\n<a href=\"#/api/Ext.dd.DragDrop\" rel=\"Ext.dd.DragDrop\" class=\"docClass\">Ext.dd.DragDrop</a> subclass</p>\n",
494       "params": [
495         {
496           "type": "Object",
497           "name": "id",
498           "doc": "<p>the id of the linked element</p>\n",
499           "optional": false
500         },
501         {
502           "type": "String",
503           "name": "sGroup",
504           "doc": "<p>the group of related items</p>\n",
505           "optional": false
506         },
507         {
508           "type": "object",
509           "name": "config",
510           "doc": "<p>configuration attributes</p>\n",
511           "optional": false
512         }
513       ],
514       "return": {
515         "type": "void",
516         "doc": "\n"
517       },
518       "private": false,
519       "static": false,
520       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
521       "linenr": 574,
522       "html_filename": "DragDrop.html",
523       "href": "DragDrop.html#Ext-dd-DragDrop-method-init",
524       "shortDoc": "<p>Sets up the DragDrop object.  Must be called in the constructor of any\n<a href=\"#/api/Ext.dd.DragDrop\" rel=\"Ext.dd.DragDrop\" class=\"docClass\">Ext.dd.DragDrop</a> subclass</p>\n"
525     },
526     {
527       "tagname": "method",
528       "name": "initFrame",
529       "member": "Ext.dd.DDProxy",
530       "doc": "<p>Initialization for the drag frame element.  Must be called in the\nconstructor of all subclasses</p>\n",
531       "params": [
532
533       ],
534       "return": {
535         "type": "void",
536         "doc": "\n"
537       },
538       "private": false,
539       "static": false,
540       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DDProxy.js",
541       "linenr": 100,
542       "html_filename": "DDProxy.html",
543       "href": "DDProxy.html#Ext-dd-DDProxy-method-initFrame",
544       "shortDoc": "<p>Initialization for the drag frame element.  Must be called in the\nconstructor of all subclasses</p>\n"
545     },
546     {
547       "tagname": "method",
548       "name": "initTarget",
549       "member": "Ext.dd.DragDrop",
550       "doc": "<p>Initializes Targeting functionality only... the object does not\nget a mousedown handler.</p>\n",
551       "params": [
552         {
553           "type": "Object",
554           "name": "id",
555           "doc": "<p>the id of the linked element</p>\n",
556           "optional": false
557         },
558         {
559           "type": "String",
560           "name": "sGroup",
561           "doc": "<p>the group of related items</p>\n",
562           "optional": false
563         },
564         {
565           "type": "object",
566           "name": "config",
567           "doc": "<p>configuration attributes</p>\n",
568           "optional": false
569         }
570       ],
571       "return": {
572         "type": "void",
573         "doc": "\n"
574       },
575       "private": false,
576       "static": false,
577       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
578       "linenr": 588,
579       "html_filename": "DragDrop.html",
580       "href": "DragDrop.html#Ext-dd-DragDrop-method-initTarget",
581       "shortDoc": "<p>Initializes Targeting functionality only... the object does not\nget a mousedown handler.</p>\n"
582     },
583     {
584       "tagname": "method",
585       "name": "isLocked",
586       "member": "Ext.dd.DragDrop",
587       "doc": "<p>Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)</p>\n",
588       "params": [
589
590       ],
591       "return": {
592         "type": "boolean",
593         "doc": "<p>true if this obj or all drag/drop is locked, else\nfalse</p>\n"
594       },
595       "private": false,
596       "static": false,
597       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
598       "linenr": 814,
599       "html_filename": "DragDrop.html",
600       "href": "DragDrop.html#Ext-dd-DragDrop-method-isLocked",
601       "shortDoc": "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on th..."
602     },
603     {
604       "tagname": "method",
605       "name": "isValidHandleChild",
606       "member": "Ext.dd.DragDrop",
607       "doc": "<p>Checks the tag exclusion list to see if this click should be ignored</p>\n",
608       "params": [
609         {
610           "type": "HTMLElement",
611           "name": "node",
612           "doc": "<p>the HTMLElement to evaluate</p>\n",
613           "optional": false
614         }
615       ],
616       "return": {
617         "type": "boolean",
618         "doc": "<p>true if this is a valid tag type, false if not</p>\n"
619       },
620       "private": false,
621       "static": false,
622       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
623       "linenr": 940,
624       "html_filename": "DragDrop.html",
625       "href": "DragDrop.html#Ext-dd-DragDrop-method-isValidHandleChild",
626       "shortDoc": "<p>Checks the tag exclusion list to see if this click should be ignored</p>\n"
627     },
628     {
629       "tagname": "method",
630       "name": "lock",
631       "member": "Ext.dd.DragDrop",
632       "doc": "<p>Lock this instance</p>\n",
633       "params": [
634
635       ],
636       "return": {
637         "type": "void",
638         "doc": "\n"
639       },
640       "private": false,
641       "static": false,
642       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
643       "linenr": 177,
644       "html_filename": "DragDrop.html",
645       "href": "DragDrop.html#Ext-dd-DragDrop-method-lock",
646       "shortDoc": "<p>Lock this instance</p>\n"
647     },
648     {
649       "tagname": "method",
650       "name": "onAvailable",
651       "member": "Ext.dd.DragDrop",
652       "doc": "<p>Override the onAvailable method to do what is needed after the initial\nposition was determined.</p>\n",
653       "params": [
654
655       ],
656       "return": {
657         "type": "void",
658         "doc": "\n"
659       },
660       "private": false,
661       "static": false,
662       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
663       "linenr": 474,
664       "html_filename": "DragDrop.html",
665       "href": "DragDrop.html#Ext-dd-DragDrop-method-onAvailable",
666       "shortDoc": "<p>Override the onAvailable method to do what is needed after the initial\nposition was determined.</p>\n"
667     },
668     {
669       "tagname": "method",
670       "name": "onDrag",
671       "member": "Ext.dd.DragDrop",
672       "doc": "<p>Abstract method called during the onMouseMove event while dragging an\nobject.</p>\n",
673       "params": [
674         {
675           "type": "Event",
676           "name": "e",
677           "doc": "<p>the mousemove event</p>\n",
678           "optional": false
679         }
680       ],
681       "return": {
682         "type": "void",
683         "doc": "\n"
684       },
685       "private": false,
686       "static": false,
687       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
688       "linenr": 358,
689       "html_filename": "DragDrop.html",
690       "href": "DragDrop.html#Ext-dd-DragDrop-method-onDrag",
691       "shortDoc": "<p>Abstract method called during the onMouseMove event while dragging an\nobject.</p>\n"
692     },
693     {
694       "tagname": "method",
695       "name": "onDragDrop",
696       "member": "Ext.dd.DragDrop",
697       "doc": "<p>Abstract method called when this item is dropped on another DragDrop\nobj</p>\n",
698       "params": [
699         {
700           "type": "Event",
701           "name": "e",
702           "doc": "<p>the mouseup event</p>\n",
703           "optional": false
704         },
705         {
706           "type": "String|DragDrop[]",
707           "name": "id",
708           "doc": "<p>In POINT mode, the element\nid this was dropped on.  In INTERSECT mode, an array of dd items this\nwas dropped on.</p>\n",
709           "optional": false
710         }
711       ],
712       "return": {
713         "type": "void",
714         "doc": "\n"
715       },
716       "private": false,
717       "static": false,
718       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
719       "linenr": 419,
720       "html_filename": "DragDrop.html",
721       "href": "DragDrop.html#Ext-dd-DragDrop-method-onDragDrop",
722       "shortDoc": "<p>Abstract method called when this item is dropped on another DragDrop\nobj</p>\n"
723     },
724     {
725       "tagname": "method",
726       "name": "onDragEnter",
727       "member": "Ext.dd.DragDrop",
728       "doc": "<p>Abstract method called when this element fist begins hovering over\nanother DragDrop obj</p>\n",
729       "params": [
730         {
731           "type": "Event",
732           "name": "e",
733           "doc": "<p>the mousemove event</p>\n",
734           "optional": false
735         },
736         {
737           "type": "String|DragDrop[]",
738           "name": "id",
739           "doc": "<p>In POINT mode, the element\nid this is hovering over.  In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.</p>\n",
740           "optional": false
741         }
742       ],
743       "return": {
744         "type": "void",
745         "doc": "\n"
746       },
747       "private": false,
748       "static": false,
749       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
750       "linenr": 366,
751       "html_filename": "DragDrop.html",
752       "href": "DragDrop.html#Ext-dd-DragDrop-method-onDragEnter",
753       "shortDoc": "<p>Abstract method called when this element fist begins hovering over\nanother DragDrop obj</p>\n"
754     },
755     {
756       "tagname": "method",
757       "name": "onDragOut",
758       "member": "Ext.dd.DragDrop",
759       "doc": "<p>Abstract method called when we are no longer hovering over an element</p>\n",
760       "params": [
761         {
762           "type": "Event",
763           "name": "e",
764           "doc": "<p>the mousemove event</p>\n",
765           "optional": false
766         },
767         {
768           "type": "String|DragDrop[]",
769           "name": "id",
770           "doc": "<p>In POINT mode, the element\nid this was hovering over.  In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.</p>\n",
771           "optional": false
772         }
773       ],
774       "return": {
775         "type": "void",
776         "doc": "\n"
777       },
778       "private": false,
779       "static": false,
780       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
781       "linenr": 402,
782       "html_filename": "DragDrop.html",
783       "href": "DragDrop.html#Ext-dd-DragDrop-method-onDragOut",
784       "shortDoc": "<p>Abstract method called when we are no longer hovering over an element</p>\n"
785     },
786     {
787       "tagname": "method",
788       "name": "onDragOver",
789       "member": "Ext.dd.DragDrop",
790       "doc": "<p>Abstract method called when this element is hovering over another\nDragDrop obj</p>\n",
791       "params": [
792         {
793           "type": "Event",
794           "name": "e",
795           "doc": "<p>the mousemove event</p>\n",
796           "optional": false
797         },
798         {
799           "type": "String|DragDrop[]",
800           "name": "id",
801           "doc": "<p>In POINT mode, the element\nid this is hovering over.  In INTERSECT mode, an array of dd items\nbeing hovered over.</p>\n",
802           "optional": false
803         }
804       ],
805       "return": {
806         "type": "void",
807         "doc": "\n"
808       },
809       "private": false,
810       "static": false,
811       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
812       "linenr": 384,
813       "html_filename": "DragDrop.html",
814       "href": "DragDrop.html#Ext-dd-DragDrop-method-onDragOver",
815       "shortDoc": "<p>Abstract method called when this element is hovering over another\nDragDrop obj</p>\n"
816     },
817     {
818       "tagname": "method",
819       "name": "onInvalidDrop",
820       "member": "Ext.dd.DragDrop",
821       "doc": "<p>Abstract method called when this item is dropped on an area with no\ndrop target</p>\n",
822       "params": [
823         {
824           "type": "Event",
825           "name": "e",
826           "doc": "<p>the mouseup event</p>\n",
827           "optional": false
828         }
829       ],
830       "return": {
831         "type": "void",
832         "doc": "\n"
833       },
834       "private": false,
835       "static": false,
836       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
837       "linenr": 430,
838       "html_filename": "DragDrop.html",
839       "href": "DragDrop.html#Ext-dd-DragDrop-method-onInvalidDrop",
840       "shortDoc": "<p>Abstract method called when this item is dropped on an area with no\ndrop target</p>\n"
841     },
842     {
843       "tagname": "method",
844       "name": "onMouseDown",
845       "member": "Ext.dd.DragDrop",
846       "doc": "<p>Event handler that fires when a drag/drop obj gets a mousedown</p>\n",
847       "params": [
848         {
849           "type": "Event",
850           "name": "e",
851           "doc": "<p>the mousedown event</p>\n",
852           "optional": false
853         }
854       ],
855       "return": {
856         "type": "void",
857         "doc": "\n"
858       },
859       "private": false,
860       "static": false,
861       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
862       "linenr": 460,
863       "html_filename": "DragDrop.html",
864       "href": "DragDrop.html#Ext-dd-DragDrop-method-onMouseDown",
865       "shortDoc": "<p>Event handler that fires when a drag/drop obj gets a mousedown</p>\n"
866     },
867     {
868       "tagname": "method",
869       "name": "onMouseUp",
870       "member": "Ext.dd.DragDrop",
871       "doc": "<p>Event handler that fires when a drag/drop obj gets a mouseup</p>\n",
872       "params": [
873         {
874           "type": "Event",
875           "name": "e",
876           "doc": "<p>the mouseup event</p>\n",
877           "optional": false
878         }
879       ],
880       "return": {
881         "type": "void",
882         "doc": "\n"
883       },
884       "private": false,
885       "static": false,
886       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
887       "linenr": 467,
888       "html_filename": "DragDrop.html",
889       "href": "DragDrop.html#Ext-dd-DragDrop-method-onMouseUp",
890       "shortDoc": "<p>Event handler that fires when a drag/drop obj gets a mouseup</p>\n"
891     },
892     {
893       "tagname": "method",
894       "name": "removeFromGroup",
895       "member": "Ext.dd.DragDrop",
896       "doc": "<p>Remove's this instance from the supplied interaction group</p>\n",
897       "params": [
898         {
899           "type": "string",
900           "name": "sGroup",
901           "doc": "<p>The group to drop</p>\n",
902           "optional": false
903         }
904       ],
905       "return": {
906         "type": "void",
907         "doc": "\n"
908       },
909       "private": false,
910       "static": false,
911       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
912       "linenr": 742,
913       "html_filename": "DragDrop.html",
914       "href": "DragDrop.html#Ext-dd-DragDrop-method-removeFromGroup",
915       "shortDoc": "<p>Remove's this instance from the supplied interaction group</p>\n"
916     },
917     {
918       "tagname": "method",
919       "name": "removeInvalidHandleClass",
920       "member": "Ext.dd.DragDrop",
921       "doc": "<p>Unsets an invalid css class</p>\n",
922       "params": [
923         {
924           "type": "string",
925           "name": "cssClass",
926           "doc": "<p>the class of the element(s) you wish to\nre-enable</p>\n",
927           "optional": false
928         }
929       ],
930       "return": {
931         "type": "void",
932         "doc": "\n"
933       },
934       "private": false,
935       "static": false,
936       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
937       "linenr": 926,
938       "html_filename": "DragDrop.html",
939       "href": "DragDrop.html#Ext-dd-DragDrop-method-removeInvalidHandleClass",
940       "shortDoc": "<p>Unsets an invalid css class</p>\n"
941     },
942     {
943       "tagname": "method",
944       "name": "removeInvalidHandleId",
945       "member": "Ext.dd.DragDrop",
946       "doc": "<p>Unsets an invalid handle id</p>\n",
947       "params": [
948         {
949           "type": "string",
950           "name": "id",
951           "doc": "<p>the id of the element to re-enable</p>\n",
952           "optional": false
953         }
954       ],
955       "return": {
956         "type": "void",
957         "doc": "\n"
958       },
959       "private": false,
960       "static": false,
961       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
962       "linenr": 914,
963       "html_filename": "DragDrop.html",
964       "href": "DragDrop.html#Ext-dd-DragDrop-method-removeInvalidHandleId",
965       "shortDoc": "<p>Unsets an invalid handle id</p>\n"
966     },
967     {
968       "tagname": "method",
969       "name": "removeInvalidHandleType",
970       "member": "Ext.dd.DragDrop",
971       "doc": "<p>Unsets an excluded tag name set by addInvalidHandleType</p>\n",
972       "params": [
973         {
974           "type": "string",
975           "name": "tagName",
976           "doc": "<p>the type of element to unexclude</p>\n",
977           "optional": false
978         }
979       ],
980       "return": {
981         "type": "void",
982         "doc": "\n"
983       },
984       "private": false,
985       "static": false,
986       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
987       "linenr": 903,
988       "html_filename": "DragDrop.html",
989       "href": "DragDrop.html#Ext-dd-DragDrop-method-removeInvalidHandleType",
990       "shortDoc": "<p>Unsets an excluded tag name set by addInvalidHandleType</p>\n"
991     },
992     {
993       "tagname": "method",
994       "name": "resetConstraints",
995       "member": "Ext.dd.DragDrop",
996       "doc": "<p>resetConstraints must be called if you manually reposition a dd element.</p>\n",
997       "params": [
998         {
999           "type": "boolean",
1000           "name": "maintainOffset",
1001           "doc": "\n",
1002           "optional": false
1003         }
1004       ],
1005       "return": {
1006         "type": "void",
1007         "doc": "\n"
1008       },
1009       "private": false,
1010       "static": false,
1011       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1012       "linenr": 1093,
1013       "html_filename": "DragDrop.html",
1014       "href": "DragDrop.html#Ext-dd-DragDrop-method-resetConstraints",
1015       "shortDoc": "<p>resetConstraints must be called if you manually reposition a dd element.</p>\n"
1016     },
1017     {
1018       "tagname": "method",
1019       "name": "setDelta",
1020       "member": "Ext.dd.DD",
1021       "doc": "<p>Sets the pointer offset.  You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)</p>\n",
1022       "params": [
1023         {
1024           "type": "int",
1025           "name": "iDeltaX",
1026           "doc": "<p>the distance from the left</p>\n",
1027           "optional": false
1028         },
1029         {
1030           "type": "int",
1031           "name": "iDeltaY",
1032           "doc": "<p>the distance from the top</p>\n",
1033           "optional": false
1034         }
1035       ],
1036       "return": {
1037         "type": "void",
1038         "doc": "\n"
1039       },
1040       "private": false,
1041       "static": false,
1042       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
1043       "linenr": 54,
1044       "html_filename": "DD.html",
1045       "href": "DD.html#Ext-dd-DD-method-setDelta",
1046       "shortDoc": "Sets the pointer offset.  You can call this directly to force the\noffset to be in a particular location (e.g., pass i..."
1047     },
1048     {
1049       "tagname": "method",
1050       "name": "setDragElId",
1051       "member": "Ext.dd.DragDrop",
1052       "doc": "<p>Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag</p>\n",
1053       "params": [
1054         {
1055           "type": "Object",
1056           "name": "id",
1057           "doc": "<p>{string} the id of the element that will be used to initiate the drag</p>\n",
1058           "optional": false
1059         }
1060       ],
1061       "return": {
1062         "type": "void",
1063         "doc": "\n"
1064       },
1065       "private": false,
1066       "static": false,
1067       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1068       "linenr": 755,
1069       "html_filename": "DragDrop.html",
1070       "href": "DragDrop.html#Ext-dd-DragDrop-method-setDragElId",
1071       "shortDoc": "<p>Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag</p>\n"
1072     },
1073     {
1074       "tagname": "method",
1075       "name": "setDragElPos",
1076       "member": "Ext.dd.DD",
1077       "doc": "<p>Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked.  Override this if you want to place the element in a\nlocation other than where the cursor is.</p>\n",
1078       "params": [
1079         {
1080           "type": "int",
1081           "name": "iPageX",
1082           "doc": "<p>the X coordinate of the mousedown or drag event</p>\n",
1083           "optional": false
1084         },
1085         {
1086           "type": "int",
1087           "name": "iPageY",
1088           "doc": "<p>the Y coordinate of the mousedown or drag event</p>\n",
1089           "optional": false
1090         }
1091       ],
1092       "return": {
1093         "type": "void",
1094         "doc": "\n"
1095       },
1096       "private": false,
1097       "static": false,
1098       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
1099       "linenr": 67,
1100       "html_filename": "DD.html",
1101       "href": "DD.html#Ext-dd-DD-method-setDragElPos",
1102       "shortDoc": "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to th..."
1103     },
1104     {
1105       "tagname": "method",
1106       "name": "setHandleElId",
1107       "member": "Ext.dd.DragDrop",
1108       "doc": "<p>Allows you to specify a child of the linked element that should be\nused to initiate the drag operation.  An example of this would be if\nyou have a content div with text and links.  Clicking anywhere in the\ncontent area would normally start the drag operation.  Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.</p>\n",
1109       "params": [
1110         {
1111           "type": "Object",
1112           "name": "id",
1113           "doc": "<p>{string} the id of the element that will be used to\ninitiate the drag.</p>\n",
1114           "optional": false
1115         }
1116       ],
1117       "return": {
1118         "type": "void",
1119         "doc": "\n"
1120       },
1121       "private": false,
1122       "static": false,
1123       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1124       "linenr": 765,
1125       "html_filename": "DragDrop.html",
1126       "href": "DragDrop.html#Ext-dd-DragDrop-method-setHandleElId",
1127       "shortDoc": "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation.  An example o..."
1128     },
1129     {
1130       "tagname": "method",
1131       "name": "setInitPosition",
1132       "member": "Ext.dd.DragDrop",
1133       "doc": "<p>Stores the initial placement of the linked element.</p>\n",
1134       "params": [
1135         {
1136           "type": "int",
1137           "name": "diffX",
1138           "doc": "<p>the X offset, default 0</p>\n",
1139           "optional": false
1140         },
1141         {
1142           "type": "int",
1143           "name": "diffY",
1144           "doc": "<p>the Y offset, default 0</p>\n",
1145           "optional": false
1146         }
1147       ],
1148       "return": {
1149         "type": "void",
1150         "doc": "\n"
1151       },
1152       "private": false,
1153       "static": false,
1154       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1155       "linenr": 688,
1156       "html_filename": "DragDrop.html",
1157       "href": "DragDrop.html#Ext-dd-DragDrop-method-setInitPosition",
1158       "shortDoc": "<p>Stores the initial placement of the linked element.</p>\n"
1159     },
1160     {
1161       "tagname": "method",
1162       "name": "setOuterHandleElId",
1163       "member": "Ext.dd.DragDrop",
1164       "doc": "<p>Allows you to set an element outside of the linked element as a drag\nhandle</p>\n",
1165       "params": [
1166         {
1167           "type": "Object",
1168           "name": "id",
1169           "doc": "<p>the id of the element that will be used to initiate the drag</p>\n",
1170           "optional": false
1171         }
1172       ],
1173       "return": {
1174         "type": "void",
1175         "doc": "\n"
1176       },
1177       "private": false,
1178       "static": false,
1179       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1180       "linenr": 784,
1181       "html_filename": "DragDrop.html",
1182       "href": "DragDrop.html#Ext-dd-DragDrop-method-setOuterHandleElId",
1183       "shortDoc": "<p>Allows you to set an element outside of the linked element as a drag\nhandle</p>\n"
1184     },
1185     {
1186       "tagname": "method",
1187       "name": "setPadding",
1188       "member": "Ext.dd.DragDrop",
1189       "doc": "<p>Configures the padding for the target zone in px.  Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.</p>\n",
1190       "params": [
1191         {
1192           "type": "int",
1193           "name": "iTop",
1194           "doc": "<p>Top pad</p>\n",
1195           "optional": false
1196         },
1197         {
1198           "type": "int",
1199           "name": "iRight",
1200           "doc": "<p>Right pad</p>\n",
1201           "optional": false
1202         },
1203         {
1204           "type": "int",
1205           "name": "iBot",
1206           "doc": "<p>Bot pad</p>\n",
1207           "optional": false
1208         },
1209         {
1210           "type": "int",
1211           "name": "iLeft",
1212           "doc": "<p>Left pad</p>\n",
1213           "optional": false
1214         }
1215       ],
1216       "return": {
1217         "type": "void",
1218         "doc": "\n"
1219       },
1220       "private": false,
1221       "static": false,
1222       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1223       "linenr": 665,
1224       "html_filename": "DragDrop.html",
1225       "href": "DragDrop.html#Ext-dd-DragDrop-method-setPadding",
1226       "shortDoc": "Configures the padding for the target zone in px.  Effectively expands\n(or reduces) the virtual object size for targe..."
1227     },
1228     {
1229       "tagname": "method",
1230       "name": "setXConstraint",
1231       "member": "Ext.dd.DragDrop",
1232       "doc": "<p>By default, the element can be dragged any place on the screen.  Use\nthis method to limit the horizontal travel of the element.  Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.</p>\n",
1233       "params": [
1234         {
1235           "type": "int",
1236           "name": "iLeft",
1237           "doc": "<p>the number of pixels the element can move to the left</p>\n",
1238           "optional": false
1239         },
1240         {
1241           "type": "int",
1242           "name": "iRight",
1243           "doc": "<p>the number of pixels the element can move to the\nright</p>\n",
1244           "optional": false
1245         },
1246         {
1247           "type": "int",
1248           "name": "iTickSize",
1249           "doc": "<p>optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.</p>\n",
1250           "optional": false
1251         }
1252       ],
1253       "return": {
1254         "type": "void",
1255         "doc": "\n"
1256       },
1257       "private": false,
1258       "static": false,
1259       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1260       "linenr": 1026,
1261       "html_filename": "DragDrop.html",
1262       "href": "DragDrop.html#Ext-dd-DragDrop-method-setXConstraint",
1263       "shortDoc": "By default, the element can be dragged any place on the screen.  Use\nthis method to limit the horizontal travel of th..."
1264     },
1265     {
1266       "tagname": "method",
1267       "name": "setYConstraint",
1268       "member": "Ext.dd.DragDrop",
1269       "doc": "<p>By default, the element can be dragged any place on the screen.  Set\nthis to limit the vertical travel of the element.  Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.</p>\n",
1270       "params": [
1271         {
1272           "type": "int",
1273           "name": "iUp",
1274           "doc": "<p>the number of pixels the element can move up</p>\n",
1275           "optional": false
1276         },
1277         {
1278           "type": "int",
1279           "name": "iDown",
1280           "doc": "<p>the number of pixels the element can move down</p>\n",
1281           "optional": false
1282         },
1283         {
1284           "type": "int",
1285           "name": "iTickSize",
1286           "doc": "<p>optional parameter for specifying that the\nelement should move iTickSize pixels at a time.</p>\n",
1287           "optional": false
1288         }
1289       ],
1290       "return": {
1291         "type": "void",
1292         "doc": "\n"
1293       },
1294       "private": false,
1295       "static": false,
1296       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1297       "linenr": 1071,
1298       "html_filename": "DragDrop.html",
1299       "href": "DragDrop.html#Ext-dd-DragDrop-method-setYConstraint",
1300       "shortDoc": "By default, the element can be dragged any place on the screen.  Set\nthis to limit the vertical travel of the element..."
1301     },
1302     {
1303       "tagname": "method",
1304       "name": "startDrag",
1305       "member": "Ext.dd.DragDrop",
1306       "doc": "<p>Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.</p>\n",
1307       "params": [
1308         {
1309           "type": "int",
1310           "name": "X",
1311           "doc": "<p>click location</p>\n",
1312           "optional": false
1313         },
1314         {
1315           "type": "int",
1316           "name": "Y",
1317           "doc": "<p>click location</p>\n",
1318           "optional": false
1319         }
1320       ],
1321       "return": {
1322         "type": "void",
1323         "doc": "\n"
1324       },
1325       "private": false,
1326       "static": false,
1327       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1328       "linenr": 342,
1329       "html_filename": "DragDrop.html",
1330       "href": "DragDrop.html#Ext-dd-DragDrop-method-startDrag",
1331       "shortDoc": "<p>Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.</p>\n"
1332     },
1333     {
1334       "tagname": "method",
1335       "name": "toString",
1336       "member": "Ext.dd.DragDrop",
1337       "doc": "<p>toString method</p>\n",
1338       "params": [
1339
1340       ],
1341       "return": {
1342         "type": "string",
1343         "doc": "<p>string representation of the dd obj</p>\n"
1344       },
1345       "private": false,
1346       "static": false,
1347       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1348       "linenr": 1160,
1349       "html_filename": "DragDrop.html",
1350       "href": "DragDrop.html#Ext-dd-DragDrop-method-toString",
1351       "shortDoc": "<p>toString method</p>\n"
1352     },
1353     {
1354       "tagname": "method",
1355       "name": "unlock",
1356       "member": "Ext.dd.DragDrop",
1357       "doc": "<p>Unlock this instace</p>\n",
1358       "params": [
1359
1360       ],
1361       "return": {
1362         "type": "void",
1363         "doc": "\n"
1364       },
1365       "private": false,
1366       "static": false,
1367       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1368       "linenr": 193,
1369       "html_filename": "DragDrop.html",
1370       "href": "DragDrop.html#Ext-dd-DragDrop-method-unlock",
1371       "shortDoc": "<p>Unlock this instace</p>\n"
1372     },
1373     {
1374       "tagname": "method",
1375       "name": "unreg",
1376       "member": "Ext.dd.DragDrop",
1377       "doc": "<p>Remove all drag and drop hooks for this element</p>\n",
1378       "params": [
1379
1380       ],
1381       "return": {
1382         "type": "void",
1383         "doc": "\n"
1384       },
1385       "private": false,
1386       "static": false,
1387       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1388       "linenr": 800,
1389       "html_filename": "DragDrop.html",
1390       "href": "DragDrop.html#Ext-dd-DragDrop-method-unreg",
1391       "shortDoc": "<p>Remove all drag and drop hooks for this element</p>\n"
1392     }
1393   ],
1394   "property": [
1395     {
1396       "tagname": "property",
1397       "name": "Ext",
1398       "member": "Ext.dd.DDProxy",
1399       "type": "String",
1400       "doc": "<p>The default drag frame div id .dd.DDProxy.dragElId</p>\n",
1401       "private": false,
1402       "static": true,
1403       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DDProxy.js",
1404       "linenr": 32,
1405       "html_filename": "DDProxy.html",
1406       "href": "DDProxy.html#Ext-dd-DDProxy-property-Ext"
1407     },
1408     {
1409       "tagname": "property",
1410       "name": "available",
1411       "member": "Ext.dd.DragDrop",
1412       "type": "boolean",
1413       "doc": "<p>The available property is false until the linked dom element is accessible.</p>\n",
1414       "private": false,
1415       "static": false,
1416       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1417       "linenr": 315,
1418       "html_filename": "DragDrop.html",
1419       "href": "DragDrop.html#Ext-dd-DragDrop-property-available"
1420     },
1421     {
1422       "tagname": "property",
1423       "name": "centerFrame",
1424       "member": "Ext.dd.DDProxy",
1425       "type": "boolean",
1426       "doc": "<p>By default the frame is positioned exactly where the drag element is, so\nwe use the cursor offset provided by <a href=\"#/api/Ext.dd.DD\" rel=\"Ext.dd.DD\" class=\"docClass\">Ext.dd.DD</a>.  Another option that works only if\nyou do not have constraints on the obj is to have the drag frame centered\naround the cursor.  Set centerFrame to true for this effect.</p>\n",
1427       "private": false,
1428       "static": false,
1429       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DDProxy.js",
1430       "linenr": 57,
1431       "html_filename": "DDProxy.html",
1432       "href": "DDProxy.html#Ext-dd-DDProxy-property-centerFrame",
1433       "shortDoc": "By default the frame is positioned exactly where the drag element is, so\nwe use the cursor offset provided by Ext.dd...."
1434     },
1435     {
1436       "tagname": "property",
1437       "name": "config",
1438       "member": "Ext.dd.DragDrop",
1439       "type": "object",
1440       "doc": "<p>Configuration attributes passed into the constructor</p>\n",
1441       "private": false,
1442       "static": false,
1443       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1444       "linenr": 81,
1445       "html_filename": "DragDrop.html",
1446       "href": "DragDrop.html#Ext-dd-DragDrop-property-config"
1447     },
1448     {
1449       "tagname": "property",
1450       "name": "defaultPadding",
1451       "member": "Ext.dd.DragDrop",
1452       "type": "Object",
1453       "doc": "<p>Provides default constraint padding to \"constrainTo\" elements (defaults to {left: 0, right:0, top:0, bottom:0}).</p>\n",
1454       "private": false,
1455       "static": false,
1456       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1457       "linenr": 482,
1458       "html_filename": "DragDrop.html",
1459       "href": "DragDrop.html#Ext-dd-DragDrop-property-defaultPadding"
1460     },
1461     {
1462       "tagname": "property",
1463       "name": "groups",
1464       "member": "Ext.dd.DragDrop",
1465       "type": "object",
1466       "doc": "<p>The group defines a logical collection of DragDrop objects that are\nrelated.  Instances only get events when interacting with other\nDragDrop object in the same group.  This lets us define multiple\ngroups using a single DragDrop subclass if we want. An object in the format {'group1':true, 'group2':true}</p>\n",
1467       "private": false,
1468       "static": false,
1469       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1470       "linenr": 158,
1471       "html_filename": "DragDrop.html",
1472       "href": "DragDrop.html#Ext-dd-DragDrop-property-groups",
1473       "shortDoc": "The group defines a logical collection of DragDrop objects that are\nrelated.  Instances only get events when interact..."
1474     },
1475     {
1476       "tagname": "property",
1477       "name": "hasOuterHandles",
1478       "member": "Ext.dd.DragDrop",
1479       "type": "boolean",
1480       "doc": "<p>By default, drags can only be initiated if the mousedown occurs in the\nregion the linked element is.  This is done in part to work around a\nbug in some browsers that mis-report the mousedown if the previous\nmouseup happened outside of the window.  This property is set to true\nif outer handles are defined. @default false</p>\n",
1481       "private": false,
1482       "static": false,
1483       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1484       "linenr": 322,
1485       "html_filename": "DragDrop.html",
1486       "href": "DragDrop.html#Ext-dd-DragDrop-property-hasOuterHandles",
1487       "shortDoc": "By default, drags can only be initiated if the mousedown occurs in the\nregion the linked element is.  This is done in..."
1488     },
1489     {
1490       "tagname": "property",
1491       "name": "id",
1492       "member": "Ext.dd.DragDrop",
1493       "type": "String",
1494       "doc": "<p>The id of the element associated with this object.  This is what we\nrefer to as the \"linked element\" because the size and position of\nthis element is used to determine when the drag and drop objects have\ninteracted.</p>\n",
1495       "private": false,
1496       "static": false,
1497       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1498       "linenr": 71,
1499       "html_filename": "DragDrop.html",
1500       "href": "DragDrop.html#Ext-dd-DragDrop-property-id",
1501       "shortDoc": "The id of the element associated with this object.  This is what we\nrefer to as the \"linked element\" because the size..."
1502     },
1503     {
1504       "tagname": "property",
1505       "name": "ignoreSelf",
1506       "member": "Ext.dd.DragDrop",
1507       "type": "Boolean",
1508       "doc": "<p>Set to false to enable a DragDrop object to fire drag events while dragging\nover its own Element. Defaults to true - DragDrop objects do not by default\nfire drag events to themselves.</p>\n",
1509       "private": false,
1510       "static": false,
1511       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1512       "linenr": 63,
1513       "html_filename": "DragDrop.html",
1514       "href": "DragDrop.html#Ext-dd-DragDrop-property-ignoreSelf",
1515       "shortDoc": "Set to false to enable a DragDrop object to fire drag events while dragging\nover its own Element. Defaults to true - ..."
1516     },
1517     {
1518       "tagname": "property",
1519       "name": "invalidHandleClasses",
1520       "member": "Ext.dd.DragDrop",
1521       "type": "Array",
1522       "doc": "<p>An Array of CSS class names for elements to be considered in valid as drag handles.</p>\n",
1523       "private": false,
1524       "static": false,
1525       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1526       "linenr": 133,
1527       "html_filename": "DragDrop.html",
1528       "href": "DragDrop.html#Ext-dd-DragDrop-property-invalidHandleClasses"
1529     },
1530     {
1531       "tagname": "property",
1532       "name": "invalidHandleIds",
1533       "member": "Ext.dd.DragDrop",
1534       "type": "Object",
1535       "doc": "<p>An object who's property names identify the IDs of elements to be considered invalid as drag handles.\nA non-null property value identifies the ID as invalid. For example, to prevent\ndragging from being initiated on element ID \"foo\", use:</p>\n\n<pre><code>{\n    foo: true\n}</code></pre>\n\n",
1536       "private": false,
1537       "static": false,
1538       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1539       "linenr": 121,
1540       "html_filename": "DragDrop.html",
1541       "href": "DragDrop.html#Ext-dd-DragDrop-property-invalidHandleIds",
1542       "shortDoc": "An object who's property names identify the IDs of elements to be considered invalid as drag handles.\nA non-null prop..."
1543     },
1544     {
1545       "tagname": "property",
1546       "name": "invalidHandleTypes",
1547       "member": "Ext.dd.DragDrop",
1548       "type": "Object",
1549       "doc": "<p>An object who's property names identify HTML tags to be considered invalid as drag handles.\nA non-null property value identifies the tag as invalid. Defaults to the\nfollowing value which prevents drag operations from being initiated by &lt;a> elements:</p>\n\n<pre><code>{\n    A: \"A\"\n}</code></pre>\n\n",
1550       "private": false,
1551       "static": false,
1552       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1553       "linenr": 109,
1554       "html_filename": "DragDrop.html",
1555       "href": "DragDrop.html#Ext-dd-DragDrop-property-invalidHandleTypes",
1556       "shortDoc": "An object who's property names identify HTML tags to be considered invalid as drag handles.\nA non-null property value..."
1557     },
1558     {
1559       "tagname": "property",
1560       "name": "isTarget",
1561       "member": "Ext.dd.DragDrop",
1562       "type": "boolean",
1563       "doc": "<p>By default, all instances can be a drop target.  This can be disabled by\nsetting isTarget to false.</p>\n",
1564       "private": false,
1565       "static": false,
1566       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1567       "linenr": 201,
1568       "html_filename": "DragDrop.html",
1569       "href": "DragDrop.html#Ext-dd-DragDrop-property-isTarget"
1570     },
1571     {
1572       "tagname": "property",
1573       "name": "maintainOffset",
1574       "member": "Ext.dd.DragDrop",
1575       "type": "boolean",
1576       "doc": "<p>Maintain offsets when we resetconstraints.  Set to true when you want\nthe position of the element relative to its parent to stay the same\nwhen the page changes</p>\n",
1577       "private": false,
1578       "static": false,
1579       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1580       "linenr": 279,
1581       "html_filename": "DragDrop.html",
1582       "href": "DragDrop.html#Ext-dd-DragDrop-property-maintainOffset",
1583       "shortDoc": "Maintain offsets when we resetconstraints.  Set to true when you want\nthe position of the element relative to its par..."
1584     },
1585     {
1586       "tagname": "property",
1587       "name": "moveOnly",
1588       "member": "Ext.dd.DragDrop",
1589       "type": "boolean",
1590       "doc": "<p>When set to true, other DD objects in cooperating DDGroups do not receive\nnotification events when this DD object is dragged over them. Defaults to false.</p>\n",
1591       "private": false,
1592       "static": false,
1593       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1594       "linenr": 185,
1595       "html_filename": "DragDrop.html",
1596       "href": "DragDrop.html#Ext-dd-DragDrop-property-moveOnly",
1597       "shortDoc": "When set to true, other DD objects in cooperating DDGroups do not receive\nnotification events when this DD object is ..."
1598     },
1599     {
1600       "tagname": "property",
1601       "name": "padding",
1602       "member": "Ext.dd.DragDrop",
1603       "type": "[int]",
1604       "doc": "<p>The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.\nAn array containing the 4 padding values: [top, right, bottom, left]</p>\n",
1605       "private": false,
1606       "static": false,
1607       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1608       "linenr": 209,
1609       "html_filename": "DragDrop.html",
1610       "href": "DragDrop.html#Ext-dd-DragDrop-property-padding",
1611       "shortDoc": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.\nAn ..."
1612     },
1613     {
1614       "tagname": "property",
1615       "name": "primaryButtonOnly",
1616       "member": "Ext.dd.DragDrop",
1617       "type": "boolean",
1618       "doc": "<p>By default the drag and drop instance will only respond to the primary\nbutton click (left button for a right-handed mouse).  Set to true to\nallow drag and drop to start with any mouse click that is propogated\nby the browser</p>\n",
1619       "private": false,
1620       "static": false,
1621       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1622       "linenr": 305,
1623       "html_filename": "DragDrop.html",
1624       "href": "DragDrop.html#Ext-dd-DragDrop-property-primaryButtonOnly",
1625       "shortDoc": "By default the drag and drop instance will only respond to the primary\nbutton click (left button for a right-handed m..."
1626     },
1627     {
1628       "tagname": "property",
1629       "name": "resizeFrame",
1630       "member": "Ext.dd.DDProxy",
1631       "type": "boolean",
1632       "doc": "<p>By default we resize the drag frame to be the same size as the element\nwe want to drag (this is to get the frame effect).  We can turn it off\nif we want a different behavior.</p>\n",
1633       "private": false,
1634       "static": false,
1635       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DDProxy.js",
1636       "linenr": 48,
1637       "html_filename": "DDProxy.html",
1638       "href": "DDProxy.html#Ext-dd-DDProxy-property-resizeFrame",
1639       "shortDoc": "By default we resize the drag frame to be the same size as the element\nwe want to drag (this is to get the frame effe..."
1640     },
1641     {
1642       "tagname": "property",
1643       "name": "scroll",
1644       "member": "Ext.dd.DD",
1645       "type": "boolean",
1646       "doc": "<p>When set to true, the utility automatically tries to scroll the browser\nwindow when a drag and drop element is dragged near the viewport boundary.\nDefaults to true.</p>\n",
1647       "private": false,
1648       "static": false,
1649       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DD.js",
1650       "linenr": 32,
1651       "html_filename": "DD.html",
1652       "href": "DD.html#Ext-dd-DD-property-scroll",
1653       "shortDoc": "When set to true, the utility automatically tries to scroll the browser\nwindow when a drag and drop element is dragge..."
1654     },
1655     {
1656       "tagname": "property",
1657       "name": "xTicks",
1658       "member": "Ext.dd.DragDrop",
1659       "type": "[int]",
1660       "doc": "<p>Array of pixel locations the element will snap to if we specified a\nhorizontal graduation/interval.  This array is generated automatically\nwhen you define a tick interval.</p>\n",
1661       "private": false,
1662       "static": false,
1663       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1664       "linenr": 289,
1665       "html_filename": "DragDrop.html",
1666       "href": "DragDrop.html#Ext-dd-DragDrop-property-xTicks",
1667       "shortDoc": "Array of pixel locations the element will snap to if we specified a\nhorizontal graduation/interval.  This array is ge..."
1668     },
1669     {
1670       "tagname": "property",
1671       "name": "yTicks",
1672       "member": "Ext.dd.DragDrop",
1673       "type": "[int]",
1674       "doc": "<p>Array of pixel locations the element will snap to if we specified a\nvertical graduation/interval.  This array is generated automatically\nwhen you define a tick interval.</p>\n",
1675       "private": false,
1676       "static": false,
1677       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragDrop.js",
1678       "linenr": 297,
1679       "html_filename": "DragDrop.html",
1680       "href": "DragDrop.html#Ext-dd-DragDrop-property-yTicks",
1681       "shortDoc": "Array of pixel locations the element will snap to if we specified a\nvertical graduation/interval.  This array is gene..."
1682     }
1683   ],
1684   "event": [
1685
1686   ],
1687   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DDProxy.js",
1688   "linenr": 9,
1689   "html_filename": "DDProxy.html",
1690   "href": "DDProxy.html#Ext-dd-DDProxy",
1691   "cssVar": [
1692
1693   ],
1694   "cssMixin": [
1695
1696   ],
1697   "component": false,
1698   "superclasses": [
1699     "Ext.dd.DragDrop",
1700     "Ext.dd.DD"
1701   ],
1702   "subclasses": [
1703     "Ext.dd.DragSource"
1704   ],
1705   "mixedInto": [
1706
1707   ],
1708   "allMixins": [
1709
1710   ]
1711 });