git.roojs.org Git - roojs1/blob - docs/symbols/Roo.dd.Registry.json

   1 {
   2   "name" : "Roo.dd.Registry",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "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.",
   8   "isSingleton" : true,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "Registry",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [],
  19   "returns" : [],
  20   "throws" : "",
  21   "requires" : "",
  22   "config" : [],
  23   "methods" : [
  24     {
  25       "name" : "getHandleFromEvent",
  26       "type" : "function",
  27       "desc" : "Returns the handle that is registered for the DOM node that is the target of the event",
  28       "sig" : "(e)",
  29       "static" : false,
  30       "memberOf" : "",
  31       "isStatic" : false,
  32       "isConstructor" : false,
  33       "isPrivate" : false,
  34       "example" : "",
  35       "deprecated" : "",
  36       "since" : "",
  37       "see" : "",
  38       "exceptions" : "",
  39       "requires" : "",
  40       "params" : [
  41         {
  42           "name" : "e",
  43           "type" : "Event",
  44           "desc" : "The event",
  45           "isOptional" : false
  46         }
  47       ],
  48       "returns" : [
  49         {
  50           "name" : "",
  51           "type" : "Object",
  52           "desc" : "handle The custom handle data"
  53         }
  54       ]
  55     },
  56     {
  57       "name" : "getTargetFromEvent",
  58       "type" : "function",
  59       "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event",
  60       "sig" : "(e)",
  61       "static" : false,
  62       "memberOf" : "",
  63       "isStatic" : false,
  64       "isConstructor" : false,
  65       "isPrivate" : false,
  66       "example" : "",
  67       "deprecated" : "",
  68       "since" : "",
  69       "see" : "",
  70       "exceptions" : "",
  71       "requires" : "",
  72       "params" : [
  73         {
  74           "name" : "e",
  75           "type" : "Event",
  76           "desc" : "The event",
  77           "isOptional" : false
  78         }
  79       ],
  80       "returns" : [
  81         {
  82           "name" : "",
  83           "type" : "Object",
  84           "desc" : "data The custom data"
  85         }
  86       ]
  87     },
  88     {
  89       "name" : "register",
  90       "type" : "function",
  91       "desc" : "Register a drag drop element",
  92       "sig" : "(element, data)",
  93       "static" : false,
  94       "memberOf" : "",
  95       "isStatic" : false,
  96       "isConstructor" : false,
  97       "isPrivate" : false,
  98       "example" : "",
  99       "deprecated" : "",
 100       "since" : "",
 101       "see" : "",
 102       "exceptions" : "",
 103       "requires" : "",
 104       "params" : [
 105         {
 106           "name" : "element",
 107           "type" : "String|HTMLElement",
 108           "desc" : "The id or DOM node to register",
 109           "isOptional" : false
 110         },
 111         {
 112           "name" : "data",
 113           "type" : "Object",
 114           "desc" : "(optional) A 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):\n<pre>\nValue      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>",
 115           "isOptional" : false
 116         }
 117       ],
 118       "returns" : []
 119     },
 120     {
 121       "name" : "unregister",
 122       "type" : "function",
 123       "desc" : "Unregister a drag drop element",
 124       "sig" : "(element)",
 125       "static" : false,
 126       "memberOf" : "",
 127       "isStatic" : false,
 128       "isConstructor" : false,
 129       "isPrivate" : false,
 130       "example" : "",
 131       "deprecated" : "",
 132       "since" : "",
 133       "see" : "",
 134       "exceptions" : "",
 135       "requires" : "",
 136       "params" : [
 137         {
 138           "name" : "element",
 139           "type" : "String|HTMLElement",
 140           "desc" : "The id or DOM node to unregister",
 141           "isOptional" : false
 142         }
 143       ],
 144       "returns" : []
 145     },
 146     {
 147       "name" : "getHandle",
 148       "type" : "function",
 149       "desc" : "Returns the handle registered for a DOM Node by id",
 150       "sig" : "(id)",
 151       "static" : false,
 152       "memberOf" : "",
 153       "isStatic" : false,
 154       "isConstructor" : false,
 155       "isPrivate" : false,
 156       "example" : "",
 157       "deprecated" : "",
 158       "since" : "",
 159       "see" : "",
 160       "exceptions" : "",
 161       "requires" : "",
 162       "params" : [
 163         {
 164           "name" : "id",
 165           "type" : "String|HTMLElement",
 166           "desc" : "The DOM node or id to look up",
 167           "isOptional" : false
 168         }
 169       ],
 170       "returns" : [
 171         {
 172           "name" : "",
 173           "type" : "Object",
 174           "desc" : "handle The custom handle data"
 175         }
 176       ]
 177     },
 178     {
 179       "name" : "getTarget",
 180       "type" : "function",
 181       "desc" : "Returns a custom data object that is registered for a DOM node by id",
 182       "sig" : "(id)",
 183       "static" : false,
 184       "memberOf" : "",
 185       "isStatic" : false,
 186       "isConstructor" : false,
 187       "isPrivate" : false,
 188       "example" : "",
 189       "deprecated" : "",
 190       "since" : "",
 191       "see" : "",
 192       "exceptions" : "",
 193       "requires" : "",
 194       "params" : [
 195         {
 196           "name" : "id",
 197           "type" : "String|HTMLElement",
 198           "desc" : "The DOM node or id to look up",
 199           "isOptional" : false
 200         }
 201       ],
 202       "returns" : [
 203         {
 204           "name" : "",
 205           "type" : "Object",
 206           "desc" : "data The custom data"
 207         }
 208       ]
 209     }
 210   ],
 211   "events" : []
 212 }