docs/source/Registry.html

   1 <html>
   2 <head>
   3   <title>The source code</title>
   4     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   5     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   6 </head>
   7 <body  onload="prettyPrint();">
   8     <pre class="prettyprint lang-js">/*!
   9  * Ext JS Library 3.0.3
  10  * Copyright(c) 2006-2009 Ext JS, LLC
  11  * licensing@extjs.com
  12  * http://www.extjs.com/license
  13  */
  14 <div id="cls-Ext.dd.Registry"></div>/**\r
  15  * @class Ext.dd.Registry\r
  16  * Provides easy access to all drag drop components that are registered on a page.  Items can be retrieved either\r
  17  * directly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.\r
  18  * @singleton\r
  19  */\r
  20 Ext.dd.Registry = function(){\r
  21     var elements = {}; \r
  22     var handles = {}; \r
  23     var autoIdSeed = 0;\r
  24 \r
  25     var getId = function(el, autogen){\r
  26         if(typeof el == "string"){\r
  27             return el;\r
  28         }\r
  29         var id = el.id;\r
  30         if(!id && autogen !== false){\r
  31             id = "extdd-" + (++autoIdSeed);\r
  32             el.id = id;\r
  33         }\r
  34         return id;\r
  35     };\r
  36     \r
  37     return {\r
  38     <div id="method-Ext.dd.Registry-register"></div>/**\r
  39      * Resgister a drag drop element\r
  40      * @param {String/HTMLElement) element The id or DOM node to register\r
  41      * @param {Object} data (optional) An custom data object that will be passed between the elements that are involved\r
  42      * in drag drop operations.  You can populate this object with any arbitrary properties that your own code\r
  43      * knows how to interpret, plus there are some specific properties known to the Registry that should be\r
  44      * populated in the data object (if applicable):\r
  45      * <pre>\r
  46 Value      Description<br />\r
  47 ---------  ------------------------------------------<br />\r
  48 handles    Array of DOM nodes that trigger dragging<br />\r
  49            for the element being registered<br />\r
  50 isHandle   True if the element passed in triggers<br />\r
  51            dragging itself, else false\r
  52 </pre>\r
  53      */\r
  54         register : function(el, data){\r
  55             data = data || {};\r
  56             if(typeof el == "string"){\r
  57                 el = document.getElementById(el);\r
  58             }\r
  59             data.ddel = el;\r
  60             elements[getId(el)] = data;\r
  61             if(data.isHandle !== false){\r
  62                 handles[data.ddel.id] = data;\r
  63             }\r
  64             if(data.handles){\r
  65                 var hs = data.handles;\r
  66                 for(var i = 0, len = hs.length; i < len; i++){\r
  67                         handles[getId(hs[i])] = data;\r
  68                 }\r
  69             }\r
  70         },\r
  71 \r
  72     <div id="method-Ext.dd.Registry-unregister"></div>/**\r
  73      * Unregister a drag drop element\r
  74      * @param {String/HTMLElement) element The id or DOM node to unregister\r
  75      */\r
  76         unregister : function(el){\r
  77             var id = getId(el, false);\r
  78             var data = elements[id];\r
  79             if(data){\r
  80                 delete elements[id];\r
  81                 if(data.handles){\r
  82                     var hs = data.handles;\r
  83                     for(var i = 0, len = hs.length; i < len; i++){\r
  84                         delete handles[getId(hs[i], false)];\r
  85                     }\r
  86                 }\r
  87             }\r
  88         },\r
  89 \r
  90     <div id="method-Ext.dd.Registry-getHandle"></div>/**\r
  91      * Returns the handle registered for a DOM Node by id\r
  92      * @param {String/HTMLElement} id The DOM node or id to look up\r
  93      * @return {Object} handle The custom handle data\r
  94      */\r
  95         getHandle : function(id){\r
  96             if(typeof id != "string"){ // must be element?\r
  97                 id = id.id;\r
  98             }\r
  99             return handles[id];\r
 100         },\r
 101 \r
 102     <div id="method-Ext.dd.Registry-getHandleFromEvent"></div>/**\r
 103      * Returns the handle that is registered for the DOM node that is the target of the event\r
 104      * @param {Event} e The event\r
 105      * @return {Object} handle The custom handle data\r
 106      */\r
 107         getHandleFromEvent : function(e){\r
 108             var t = Ext.lib.Event.getTarget(e);\r
 109             return t ? handles[t.id] : null;\r
 110         },\r
 111 \r
 112     <div id="method-Ext.dd.Registry-getTarget"></div>/**\r
 113      * Returns a custom data object that is registered for a DOM node by id\r
 114      * @param {String/HTMLElement} id The DOM node or id to look up\r
 115      * @return {Object} data The custom data\r
 116      */\r
 117         getTarget : function(id){\r
 118             if(typeof id != "string"){ // must be element?\r
 119                 id = id.id;\r
 120             }\r
 121             return elements[id];\r
 122         },\r
 123 \r
 124     <div id="method-Ext.dd.Registry-getTargetFromEvent"></div>/**\r
 125      * Returns a custom data object that is registered for the DOM node that is the target of the event\r
 126      * @param {Event} e The event\r
 127      * @return {Object} data The custom data\r
 128      */\r
 129         getTargetFromEvent : function(e){\r
 130             var t = Ext.lib.Event.getTarget(e);\r
 131             return t ? elements[t.id] || handles[t.id] : null;\r
 132         }\r
 133     };\r
 134 }();</pre>
 135 </body>
 136 </html>