Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.dd.Registry.js
1 Ext.data.JsonP.Ext_dd_Registry({
2   "allMixins": [
3
4   ],
5   "deprecated": null,
6   "docauthor": null,
7   "members": {
8     "cfg": [
9
10     ],
11     "method": [
12       {
13         "deprecated": null,
14         "alias": null,
15         "protected": false,
16         "tagname": "method",
17         "href": "Base3.html#Ext-Base-method-addStatics",
18         "shortDoc": "Add / override static properties of this class. ...",
19         "static": true,
20         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
21         "private": false,
22         "params": [
23           {
24             "type": "Object",
25             "optional": false,
26             "doc": "\n",
27             "name": "members"
28           }
29         ],
30         "name": "addStatics",
31         "owner": "Ext.Base",
32         "doc": "<p>Add / override static properties of this class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n</code></pre>\n",
33         "linenr": 388,
34         "return": {
35           "type": "Ext.Base",
36           "doc": "<p>this</p>\n"
37         },
38         "html_filename": "Base3.html"
39       },
40       {
41         "deprecated": null,
42         "alias": null,
43         "protected": false,
44         "tagname": "method",
45         "href": "Base3.html#Ext-Base-method-callOverridden",
46         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
47         "static": false,
48         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
49         "private": false,
50         "params": [
51           {
52             "type": "Array/Arguments",
53             "optional": false,
54             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
55             "name": "args"
56           }
57         ],
58         "name": "callOverridden",
59         "owner": "Ext.Base",
60         "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">Ext.Base.override</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
61         "linenr": 269,
62         "return": {
63           "type": "Mixed",
64           "doc": "<p>Returns the result after calling the overridden method</p>\n"
65         },
66         "html_filename": "Base3.html"
67       },
68       {
69         "deprecated": null,
70         "alias": null,
71         "protected": true,
72         "tagname": "method",
73         "href": "Base3.html#Ext-Base-method-callParent",
74         "shortDoc": "Call the parent's overridden method. ...",
75         "static": false,
76         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
77         "private": false,
78         "params": [
79           {
80             "type": "Array/Arguments",
81             "optional": false,
82             "doc": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
83             "name": "args"
84           }
85         ],
86         "name": "callParent",
87         "owner": "Ext.Base",
88         "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n</code></pre>\n",
89         "linenr": 124,
90         "return": {
91           "type": "Mixed",
92           "doc": "<p>Returns the result from the superclass' method</p>\n"
93         },
94         "html_filename": "Base3.html"
95       },
96       {
97         "deprecated": null,
98         "alias": null,
99         "protected": false,
100         "tagname": "method",
101         "href": "Base3.html#Ext-Base-method-create",
102         "shortDoc": "Create a new instance of this Class. ...",
103         "static": true,
104         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
105         "private": false,
106         "params": [
107
108         ],
109         "name": "create",
110         "owner": "Ext.Base",
111         "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
112         "linenr": 329,
113         "return": {
114           "type": "Object",
115           "doc": "<p>the created instance.</p>\n"
116         },
117         "html_filename": "Base3.html"
118       },
119       {
120         "deprecated": null,
121         "alias": null,
122         "protected": false,
123         "tagname": "method",
124         "href": "Base3.html#Ext-Base-method-createAlias",
125         "shortDoc": "Create aliases for existing prototype methods. ...",
126         "static": true,
127         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
128         "private": false,
129         "params": [
130           {
131             "type": "String/Object",
132             "optional": false,
133             "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
134             "name": "alias"
135           },
136           {
137             "type": "String/Object",
138             "optional": false,
139             "doc": "<p>The original method name</p>\n",
140             "name": "origin"
141           }
142         ],
143         "name": "createAlias",
144         "owner": "Ext.Base",
145         "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -&gt; test.method1()\n</code></pre>\n",
146         "linenr": 648,
147         "return": {
148           "type": "void",
149           "doc": "\n"
150         },
151         "html_filename": "Base3.html"
152       },
153       {
154         "deprecated": null,
155         "alias": null,
156         "protected": false,
157         "tagname": "method",
158         "href": "Registry.html#Ext-dd-Registry-method-getHandle",
159         "shortDoc": "Returns the handle registered for a DOM Node by id ...",
160         "static": false,
161         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/Registry.js",
162         "private": false,
163         "params": [
164           {
165             "type": "String/HTMLElement",
166             "optional": false,
167             "doc": "<p>The DOM node or id to look up</p>\n",
168             "name": "id"
169           }
170         ],
171         "name": "getHandle",
172         "owner": "Ext.dd.Registry",
173         "doc": "<p>Returns the handle registered for a DOM Node by id</p>\n",
174         "linenr": 79,
175         "return": {
176           "type": "Object",
177           "doc": "<p>handle The custom handle data</p>\n"
178         },
179         "html_filename": "Registry.html"
180       },
181       {
182         "deprecated": null,
183         "alias": null,
184         "protected": false,
185         "tagname": "method",
186         "href": "Registry.html#Ext-dd-Registry-method-getHandleFromEvent",
187         "shortDoc": "Returns the handle that is registered for the DOM node that is the target of the event ...",
188         "static": false,
189         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/Registry.js",
190         "private": false,
191         "params": [
192           {
193             "type": "Event",
194             "optional": false,
195             "doc": "<p>The event</p>\n",
196             "name": "e"
197           }
198         ],
199         "name": "getHandleFromEvent",
200         "owner": "Ext.dd.Registry",
201         "doc": "<p>Returns the handle that is registered for the DOM node that is the target of the event</p>\n",
202         "linenr": 91,
203         "return": {
204           "type": "Object",
205           "doc": "<p>handle The custom handle data</p>\n"
206         },
207         "html_filename": "Registry.html"
208       },
209       {
210         "deprecated": null,
211         "alias": null,
212         "protected": false,
213         "tagname": "method",
214         "href": "Base3.html#Ext-Base-method-getName",
215         "shortDoc": "Get the current class' name in string format. ...",
216         "static": false,
217         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
218         "private": false,
219         "params": [
220
221         ],
222         "name": "getName",
223         "owner": "Ext.Base",
224         "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n</code></pre>\n",
225         "linenr": 631,
226         "return": {
227           "type": "String",
228           "doc": "<p>className</p>\n"
229         },
230         "html_filename": "Base3.html"
231       },
232       {
233         "deprecated": null,
234         "alias": null,
235         "protected": false,
236         "tagname": "method",
237         "href": "Registry.html#Ext-dd-Registry-method-getTarget",
238         "shortDoc": "Returns a custom data object that is registered for a DOM node by id ...",
239         "static": false,
240         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/Registry.js",
241         "private": false,
242         "params": [
243           {
244             "type": "String/HTMLElement",
245             "optional": false,
246             "doc": "<p>The DOM node or id to look up</p>\n",
247             "name": "id"
248           }
249         ],
250         "name": "getTarget",
251         "owner": "Ext.dd.Registry",
252         "doc": "<p>Returns a custom data object that is registered for a DOM node by id</p>\n",
253         "linenr": 101,
254         "return": {
255           "type": "Object",
256           "doc": "<p>data The custom data</p>\n"
257         },
258         "html_filename": "Registry.html"
259       },
260       {
261         "deprecated": null,
262         "alias": null,
263         "protected": false,
264         "tagname": "method",
265         "href": "Registry.html#Ext-dd-Registry-method-getTargetFromEvent",
266         "shortDoc": "Returns a custom data object that is registered for the DOM node that is the target of the event ...",
267         "static": false,
268         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/Registry.js",
269         "private": false,
270         "params": [
271           {
272             "type": "Event",
273             "optional": false,
274             "doc": "<p>The event</p>\n",
275             "name": "e"
276           }
277         ],
278         "name": "getTargetFromEvent",
279         "owner": "Ext.dd.Registry",
280         "doc": "<p>Returns a custom data object that is registered for the DOM node that is the target of the event</p>\n",
281         "linenr": 113,
282         "return": {
283           "type": "Object",
284           "doc": "<p>data The custom data</p>\n"
285         },
286         "html_filename": "Registry.html"
287       },
288       {
289         "deprecated": null,
290         "alias": null,
291         "protected": false,
292         "tagname": "method",
293         "href": "Base3.html#Ext-Base-method-implement",
294         "shortDoc": "Add methods / properties to the prototype of this class. ...",
295         "static": true,
296         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
297         "private": false,
298         "params": [
299           {
300             "type": "Object",
301             "optional": false,
302             "doc": "\n",
303             "name": "members"
304           }
305         ],
306         "name": "implement",
307         "owner": "Ext.Base",
308         "doc": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n</code></pre>\n",
309         "linenr": 415,
310         "return": {
311           "type": "void",
312           "doc": "\n"
313         },
314         "html_filename": "Base3.html"
315       },
316       {
317         "deprecated": null,
318         "alias": null,
319         "protected": true,
320         "tagname": "method",
321         "href": "Base3.html#Ext-Base-method-initConfig",
322         "shortDoc": "Initialize configuration for this class. ...",
323         "static": false,
324         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
325         "private": false,
326         "params": [
327           {
328             "type": "Object",
329             "optional": false,
330             "doc": "\n",
331             "name": "config"
332           }
333         ],
334         "name": "initConfig",
335         "owner": "Ext.Base",
336         "doc": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n\n        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n</code></pre>\n",
337         "linenr": 63,
338         "return": {
339           "type": "Object",
340           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
341         },
342         "html_filename": "Base3.html"
343       },
344       {
345         "deprecated": null,
346         "alias": null,
347         "protected": false,
348         "tagname": "method",
349         "href": "Base3.html#Ext-Base-method-override",
350         "shortDoc": "Override prototype members of this class. ...",
351         "static": true,
352         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
353         "private": false,
354         "params": [
355           {
356             "type": "Object",
357             "optional": false,
358             "doc": "\n",
359             "name": "members"
360           }
361         ],
362         "name": "override",
363         "owner": "Ext.Base",
364         "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">Ext.Base.callOverridden</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
365         "linenr": 518,
366         "return": {
367           "type": "Ext.Base",
368           "doc": "<p>this</p>\n"
369         },
370         "html_filename": "Base3.html"
371       },
372       {
373         "deprecated": null,
374         "alias": null,
375         "protected": false,
376         "tagname": "method",
377         "href": "Registry.html#Ext-dd-Registry-method-register",
378         "shortDoc": "Resgister a drag drop element ...",
379         "static": false,
380         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/Registry.js",
381         "private": false,
382         "params": [
383           {
384             "type": "String/HTMLElement",
385             "optional": false,
386             "doc": "<p>The id or DOM node to register</p>\n",
387             "name": "element"
388           },
389           {
390             "type": "Object",
391             "optional": true,
392             "doc": "<p>(optional) An custom data object that will be passed between the elements that are involved\nin drag drop operations.  You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):</p>\n\n<pre>Value      Description<br />\n---------  ------------------------------------------<br />\nhandles    Array of DOM nodes that trigger dragging<br />\n           for the element being registered<br />\nisHandle   True if the element passed in triggers<br />\n           dragging itself, else false\n</pre>\n\n",
393             "name": "data"
394           }
395         ],
396         "name": "register",
397         "owner": "Ext.dd.Registry",
398         "doc": "<p>Resgister a drag drop element</p>\n",
399         "linenr": 27,
400         "return": {
401           "type": "void",
402           "doc": "\n"
403         },
404         "html_filename": "Registry.html"
405       },
406       {
407         "deprecated": null,
408         "alias": null,
409         "protected": true,
410         "tagname": "method",
411         "href": "Base3.html#Ext-Base-method-statics",
412         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
413         "static": false,
414         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
415         "private": false,
416         "params": [
417
418         ],
419         "name": "statics",
420         "owner": "Ext.Base",
421         "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">Ext.Base.self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n\n        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n</code></pre>\n",
422         "linenr": 199,
423         "return": {
424           "type": "Class",
425           "doc": "\n"
426         },
427         "html_filename": "Base3.html"
428       },
429       {
430         "deprecated": null,
431         "alias": null,
432         "protected": false,
433         "tagname": "method",
434         "href": "Registry.html#Ext-dd-Registry-method-unregister",
435         "shortDoc": "Unregister a drag drop element ...",
436         "static": false,
437         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/Registry.js",
438         "private": false,
439         "params": [
440           {
441             "type": "String/HTMLElement",
442             "optional": false,
443             "doc": "<p>The id or DOM node to unregister</p>\n",
444             "name": "element"
445           }
446         ],
447         "name": "unregister",
448         "owner": "Ext.dd.Registry",
449         "doc": "<p>Unregister a drag drop element</p>\n",
450         "linenr": 61,
451         "return": {
452           "type": "void",
453           "doc": "\n"
454         },
455         "html_filename": "Registry.html"
456       }
457     ],
458     "property": [
459       {
460         "type": "Class",
461         "deprecated": null,
462         "alias": null,
463         "protected": true,
464         "tagname": "property",
465         "href": "Base3.html#Ext-Base-property-self",
466         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
467         "static": false,
468         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
469         "private": false,
470         "name": "self",
471         "owner": "Ext.Base",
472         "doc": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>\nfor a detailed comparison</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); / dependent on 'this'\n\n        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n</code></pre>\n",
473         "linenr": 18,
474         "html_filename": "Base3.html"
475       }
476     ],
477     "cssVar": [
478
479     ],
480     "cssMixin": [
481
482     ],
483     "event": [
484
485     ]
486   },
487   "singleton": true,
488   "alias": null,
489   "superclasses": [
490     "Ext.Base"
491   ],
492   "protected": false,
493   "tagname": "class",
494   "mixins": [
495
496   ],
497   "href": "Registry.html#Ext-dd-Registry",
498   "subclasses": [
499
500   ],
501   "static": false,
502   "author": null,
503   "component": false,
504   "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/Registry.js",
505   "private": false,
506   "alternateClassNames": [
507
508   ],
509   "name": "Ext.dd.Registry",
510   "doc": "<p>Provides easy access to all drag drop components that are registered on a page.  Items can be retrieved either\ndirectly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.</p>\n",
511   "mixedInto": [
512
513   ],
514   "linenr": 1,
515   "xtypes": [
516
517   ],
518   "html_filename": "Registry.html",
519   "extends": "Ext.Base"
520 });