commit extjs-2.2.1
[extjs.git] / docs / output / Ext.dd.Registry.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.dd.Registry-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.dd.Registry-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.dd.Registry-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                         <a class="bookmark" href="../docs/?class=Ext.dd.Registry"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7         </div>
8                 <h1>Class Ext.dd.Registry</h1>
9         <table cellspacing="0">
10             <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Registry.js" target="_blank">Registry.js</a></td></tr>
12             <tr><td class="label">Class:</td><td class="hd-info">Registry</td></tr>
13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
14                     </table>
15         <div class="description">
16             *
17 Provides easy access to all drag drop components that are registered on a page.  Items can be retrieved either
18 directly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.<br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
19         
20         <div class="hr"></div>
21                 <a id="Ext.dd.Registry-props"></a>
22         <h2>Public Properties</h2>
23         <div class="no-members">This class has no public properties.</div>        <a id="Ext.dd.Registry-methods"></a>
24         <h2>Public Methods</h2>
25                 <table cellspacing="0" class="member-table">
26             <tr>
27                 <th class="sig-header" colspan="2">Method</th>
28                 <th class="msource-header">Defined By</th>
29             </tr>
30                 <tr class="method-row expandable">\r
31         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
32         <td class="sig">\r
33         <a id="Ext.dd.Registry-getHandle"></a>\r
34             <b>getHandle</b>(&nbsp;<code>String/HTMLElement id</code>&nbsp;) : Object            <div class="mdesc">\r
35                         <div class="short">Returns the handle registered for a DOM Node by id</div>\r
36             <div class="long">\r
37                 Returns the handle registered for a DOM Node by id    <div class="mdetail-params">\r
38         <strong>Parameters:</strong>\r
39         <ul><li><code>id</code> : String/HTMLElement<div class="sub-desc">The DOM node or id to look up</div></li>        </ul>\r
40         <strong>Returns:</strong>\r
41         <ul>\r
42             <li><code>Object</code><div class="sub-desc">handle The custom handle data</div></li>\r
43         </ul>\r
44     </div>\r
45                 </div>\r
46                         </div>\r
47         </td>\r
48         <td class="msource">Registry</td>\r
49     </tr>\r
50         <tr class="method-row alt expandable">\r
51         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
52         <td class="sig">\r
53         <a id="Ext.dd.Registry-getHandleFromEvent"></a>\r
54             <b>getHandleFromEvent</b>(&nbsp;<code>Event e</code>&nbsp;) : Object            <div class="mdesc">\r
55                         <div class="short">Returns the handle that is registered for the DOM node that is the target of the event</div>\r
56             <div class="long">\r
57                 Returns the handle that is registered for the DOM node that is the target of the event    <div class="mdetail-params">\r
58         <strong>Parameters:</strong>\r
59         <ul><li><code>e</code> : Event<div class="sub-desc">The event</div></li>        </ul>\r
60         <strong>Returns:</strong>\r
61         <ul>\r
62             <li><code>Object</code><div class="sub-desc">handle The custom handle data</div></li>\r
63         </ul>\r
64     </div>\r
65                 </div>\r
66                         </div>\r
67         </td>\r
68         <td class="msource">Registry</td>\r
69     </tr>\r
70         <tr class="method-row expandable">\r
71         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
72         <td class="sig">\r
73         <a id="Ext.dd.Registry-getTarget"></a>\r
74             <b>getTarget</b>(&nbsp;<code>String/HTMLElement id</code>&nbsp;) : Object            <div class="mdesc">\r
75                         <div class="short">Returns a custom data object that is registered for a DOM node by id</div>\r
76             <div class="long">\r
77                 Returns a custom data object that is registered for a DOM node by id    <div class="mdetail-params">\r
78         <strong>Parameters:</strong>\r
79         <ul><li><code>id</code> : String/HTMLElement<div class="sub-desc">The DOM node or id to look up</div></li>        </ul>\r
80         <strong>Returns:</strong>\r
81         <ul>\r
82             <li><code>Object</code><div class="sub-desc">data The custom data</div></li>\r
83         </ul>\r
84     </div>\r
85                 </div>\r
86                         </div>\r
87         </td>\r
88         <td class="msource">Registry</td>\r
89     </tr>\r
90         <tr class="method-row alt expandable">\r
91         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
92         <td class="sig">\r
93         <a id="Ext.dd.Registry-getTargetFromEvent"></a>\r
94             <b>getTargetFromEvent</b>(&nbsp;<code>Event e</code>&nbsp;) : Object            <div class="mdesc">\r
95                         <div class="short">Returns a custom data object that is registered for the DOM node that is the target of the event</div>\r
96             <div class="long">\r
97                 Returns a custom data object that is registered for the DOM node that is the target of the event    <div class="mdetail-params">\r
98         <strong>Parameters:</strong>\r
99         <ul><li><code>e</code> : Event<div class="sub-desc">The event</div></li>        </ul>\r
100         <strong>Returns:</strong>\r
101         <ul>\r
102             <li><code>Object</code><div class="sub-desc">data The custom data</div></li>\r
103         </ul>\r
104     </div>\r
105                 </div>\r
106                         </div>\r
107         </td>\r
108         <td class="msource">Registry</td>\r
109     </tr>\r
110         <tr class="method-row expandable">\r
111         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
112         <td class="sig">\r
113         <a id="Ext.dd.Registry-register"></a>\r
114             <b>register</b>(&nbsp;<code>String/HTMLElement) element</code>, <span class="optional" title="Optional">[<code>Object data</code>]</span>&nbsp;) : void            <div class="mdesc">\r
115                         <div class="short">Resgister a drag drop element</div>\r
116             <div class="long">\r
117                 Resgister a drag drop element    <div class="mdetail-params">\r
118         <strong>Parameters:</strong>\r
119         <ul><li><code>element</code> : String/HTMLElement)<div class="sub-desc">The id or DOM node to register</div></li><li><code>data</code> : Object<div class="sub-desc">(optional) An custom data object that will be passed between the elements that are involved
120 in drag drop operations. You can populate this object with any arbitrary properties that your own code
121 knows how to interpret, plus there are some specific properties known to the Registry that should be
122 populated in the data object (if applicable):
123 <pre>Value      Description<br />\r
124 ---------  ------------------------------------------<br />\r
125 handles    Array of DOM nodes that trigger dragging<br />\r
126            for the element being registered<br />\r
127 isHandle   True if the element passed in triggers<br />\r
128            dragging itself, else false</pre></div></li>        </ul>\r
129         <strong>Returns:</strong>\r
130         <ul>\r
131             <li><code>void</code></li>\r
132         </ul>\r
133     </div>\r
134                 </div>\r
135                         </div>\r
136         </td>\r
137         <td class="msource">Registry</td>\r
138     </tr>\r
139         <tr class="method-row alt expandable">\r
140         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
141         <td class="sig">\r
142         <a id="Ext.dd.Registry-unregister"></a>\r
143             <b>unregister</b>(&nbsp;<code>String/HTMLElement) element</code>&nbsp;) : void            <div class="mdesc">\r
144                         <div class="short">Unregister a drag drop element</div>\r
145             <div class="long">\r
146                 Unregister a drag drop element    <div class="mdetail-params">\r
147         <strong>Parameters:</strong>\r
148         <ul><li><code>element</code> : String/HTMLElement)<div class="sub-desc">The id or DOM node to unregister</div></li>        </ul>\r
149         <strong>Returns:</strong>\r
150         <ul>\r
151             <li><code>void</code></li>\r
152         </ul>\r
153     </div>\r
154                 </div>\r
155                         </div>\r
156         </td>\r
157         <td class="msource">Registry</td>\r
158     </tr>\r
159             </table>
160                 <a id="Ext.dd.Registry-events"></a>
161         <h2>Public Events</h2>
162         <div class="no-members">This class has no public events.</div>
163         </div>