docs/output/Ext.dd.Registry.js

   1 Ext.data.JsonP.Ext_dd_Registry({
   2   "tagname": "class",
   3   "name": "Ext.dd.Registry",
   4   "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",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "getHandle",
  24       "member": "Ext.dd.Registry",
  25       "doc": "<p>Returns the handle registered for a DOM Node by id</p>\n",
  26       "params": [
  27         {
  28           "type": "String/HTMLElement",
  29           "name": "id",
  30           "doc": "<p>The DOM node or id to look up</p>\n",
  31           "optional": false
  32         }
  33       ],
  34       "return": {
  35         "type": "Object",
  36         "doc": "<p>handle The custom handle data</p>\n"
  37       },
  38       "private": false,
  39       "static": false,
  40       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/Registry.js",
  41       "linenr": 79,
  42       "html_filename": "Registry.html",
  43       "href": "Registry.html#Ext-dd-Registry-method-getHandle",
  44       "shortDoc": "<p>Returns the handle registered for a DOM Node by id</p>\n"
  45     },
  46     {
  47       "tagname": "method",
  48       "name": "getHandleFromEvent",
  49       "member": "Ext.dd.Registry",
  50       "doc": "<p>Returns the handle that is registered for the DOM node that is the target of the event</p>\n",
  51       "params": [
  52         {
  53           "type": "Event",
  54           "name": "e",
  55           "doc": "<p>The event</p>\n",
  56           "optional": false
  57         }
  58       ],
  59       "return": {
  60         "type": "Object",
  61         "doc": "<p>handle The custom handle data</p>\n"
  62       },
  63       "private": false,
  64       "static": false,
  65       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/Registry.js",
  66       "linenr": 91,
  67       "html_filename": "Registry.html",
  68       "href": "Registry.html#Ext-dd-Registry-method-getHandleFromEvent",
  69       "shortDoc": "<p>Returns the handle that is registered for the DOM node that is the target of the event</p>\n"
  70     },
  71     {
  72       "tagname": "method",
  73       "name": "getTarget",
  74       "member": "Ext.dd.Registry",
  75       "doc": "<p>Returns a custom data object that is registered for a DOM node by id</p>\n",
  76       "params": [
  77         {
  78           "type": "String/HTMLElement",
  79           "name": "id",
  80           "doc": "<p>The DOM node or id to look up</p>\n",
  81           "optional": false
  82         }
  83       ],
  84       "return": {
  85         "type": "Object",
  86         "doc": "<p>data The custom data</p>\n"
  87       },
  88       "private": false,
  89       "static": false,
  90       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/Registry.js",
  91       "linenr": 101,
  92       "html_filename": "Registry.html",
  93       "href": "Registry.html#Ext-dd-Registry-method-getTarget",
  94       "shortDoc": "<p>Returns a custom data object that is registered for a DOM node by id</p>\n"
  95     },
  96     {
  97       "tagname": "method",
  98       "name": "getTargetFromEvent",
  99       "member": "Ext.dd.Registry",
 100       "doc": "<p>Returns a custom data object that is registered for the DOM node that is the target of the event</p>\n",
 101       "params": [
 102         {
 103           "type": "Event",
 104           "name": "e",
 105           "doc": "<p>The event</p>\n",
 106           "optional": false
 107         }
 108       ],
 109       "return": {
 110         "type": "Object",
 111         "doc": "<p>data The custom data</p>\n"
 112       },
 113       "private": false,
 114       "static": false,
 115       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/Registry.js",
 116       "linenr": 113,
 117       "html_filename": "Registry.html",
 118       "href": "Registry.html#Ext-dd-Registry-method-getTargetFromEvent",
 119       "shortDoc": "<p>Returns a custom data object that is registered for the DOM node that is the target of the event</p>\n"
 120     },
 121     {
 122       "tagname": "method",
 123       "name": "register",
 124       "member": "Ext.dd.Registry",
 125       "doc": "<p>Resgister a drag drop element</p>\n",
 126       "params": [
 127         {
 128           "type": "String/HTMLElement",
 129           "name": "element",
 130           "doc": "<p>The id or DOM node to register</p>\n",
 131           "optional": false
 132         },
 133         {
 134           "type": "Object",
 135           "name": "data",
 136           "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",
 137           "optional": true
 138         }
 139       ],
 140       "return": {
 141         "type": "void",
 142         "doc": "\n"
 143       },
 144       "private": false,
 145       "static": false,
 146       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/Registry.js",
 147       "linenr": 27,
 148       "html_filename": "Registry.html",
 149       "href": "Registry.html#Ext-dd-Registry-method-register",
 150       "shortDoc": "<p>Resgister a drag drop element</p>\n"
 151     },
 152     {
 153       "tagname": "method",
 154       "name": "unregister",
 155       "member": "Ext.dd.Registry",
 156       "doc": "<p>Unregister a drag drop element</p>\n",
 157       "params": [
 158         {
 159           "type": "String/HTMLElement",
 160           "name": "element",
 161           "doc": "<p>The id or DOM node to unregister</p>\n",
 162           "optional": false
 163         }
 164       ],
 165       "return": {
 166         "type": "void",
 167         "doc": "\n"
 168       },
 169       "private": false,
 170       "static": false,
 171       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/Registry.js",
 172       "linenr": 61,
 173       "html_filename": "Registry.html",
 174       "href": "Registry.html#Ext-dd-Registry-method-unregister",
 175       "shortDoc": "<p>Unregister a drag drop element</p>\n"
 176     }
 177   ],
 178   "property": [
 179
 180   ],
 181   "event": [
 182
 183   ],
 184   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/Registry.js",
 185   "linenr": 1,
 186   "html_filename": "Registry.html",
 187   "href": "Registry.html#Ext-dd-Registry",
 188   "cssVar": [
 189
 190   ],
 191   "cssMixin": [
 192
 193   ],
 194   "component": false,
 195   "superclasses": [
 196
 197   ],
 198   "subclasses": [
 199
 200   ],
 201   "mixedInto": [
 202
 203   ],
 204   "allMixins": [
 205
 206   ]
 207 });