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"> |
---|
31 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
32 | <td class="sig"> |
---|
33 | <a id="Ext.dd.Registry-getHandle"></a> |
---|
34 | <b>getHandle</b>( <code>String/HTMLElement id</code> ) : Object <div class="mdesc"> |
---|
35 | <div class="short">Returns the handle registered for a DOM Node by id</div> |
---|
36 | <div class="long"> |
---|
37 | Returns the handle registered for a DOM Node by id <div class="mdetail-params"> |
---|
38 | <strong>Parameters:</strong> |
---|
39 | <ul><li><code>id</code> : String/HTMLElement<div class="sub-desc">The DOM node or id to look up</div></li> </ul> |
---|
40 | <strong>Returns:</strong> |
---|
41 | <ul> |
---|
42 | <li><code>Object</code><div class="sub-desc">handle The custom handle data</div></li> |
---|
43 | </ul> |
---|
44 | </div> |
---|
45 | </div> |
---|
46 | </div> |
---|
47 | </td> |
---|
48 | <td class="msource">Registry</td> |
---|
49 | </tr> |
---|
50 | <tr class="method-row alt expandable"> |
---|
51 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
52 | <td class="sig"> |
---|
53 | <a id="Ext.dd.Registry-getHandleFromEvent"></a> |
---|
54 | <b>getHandleFromEvent</b>( <code>Event e</code> ) : Object <div class="mdesc"> |
---|
55 | <div class="short">Returns the handle that is registered for the DOM node that is the target of the event</div> |
---|
56 | <div class="long"> |
---|
57 | Returns the handle that is registered for the DOM node that is the target of the event <div class="mdetail-params"> |
---|
58 | <strong>Parameters:</strong> |
---|
59 | <ul><li><code>e</code> : Event<div class="sub-desc">The event</div></li> </ul> |
---|
60 | <strong>Returns:</strong> |
---|
61 | <ul> |
---|
62 | <li><code>Object</code><div class="sub-desc">handle The custom handle data</div></li> |
---|
63 | </ul> |
---|
64 | </div> |
---|
65 | </div> |
---|
66 | </div> |
---|
67 | </td> |
---|
68 | <td class="msource">Registry</td> |
---|
69 | </tr> |
---|
70 | <tr class="method-row expandable"> |
---|
71 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
72 | <td class="sig"> |
---|
73 | <a id="Ext.dd.Registry-getTarget"></a> |
---|
74 | <b>getTarget</b>( <code>String/HTMLElement id</code> ) : Object <div class="mdesc"> |
---|
75 | <div class="short">Returns a custom data object that is registered for a DOM node by id</div> |
---|
76 | <div class="long"> |
---|
77 | Returns a custom data object that is registered for a DOM node by id <div class="mdetail-params"> |
---|
78 | <strong>Parameters:</strong> |
---|
79 | <ul><li><code>id</code> : String/HTMLElement<div class="sub-desc">The DOM node or id to look up</div></li> </ul> |
---|
80 | <strong>Returns:</strong> |
---|
81 | <ul> |
---|
82 | <li><code>Object</code><div class="sub-desc">data The custom data</div></li> |
---|
83 | </ul> |
---|
84 | </div> |
---|
85 | </div> |
---|
86 | </div> |
---|
87 | </td> |
---|
88 | <td class="msource">Registry</td> |
---|
89 | </tr> |
---|
90 | <tr class="method-row alt expandable"> |
---|
91 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
92 | <td class="sig"> |
---|
93 | <a id="Ext.dd.Registry-getTargetFromEvent"></a> |
---|
94 | <b>getTargetFromEvent</b>( <code>Event e</code> ) : Object <div class="mdesc"> |
---|
95 | <div class="short">Returns a custom data object that is registered for the DOM node that is the target of the event</div> |
---|
96 | <div class="long"> |
---|
97 | Returns a custom data object that is registered for the DOM node that is the target of the event <div class="mdetail-params"> |
---|
98 | <strong>Parameters:</strong> |
---|
99 | <ul><li><code>e</code> : Event<div class="sub-desc">The event</div></li> </ul> |
---|
100 | <strong>Returns:</strong> |
---|
101 | <ul> |
---|
102 | <li><code>Object</code><div class="sub-desc">data The custom data</div></li> |
---|
103 | </ul> |
---|
104 | </div> |
---|
105 | </div> |
---|
106 | </div> |
---|
107 | </td> |
---|
108 | <td class="msource">Registry</td> |
---|
109 | </tr> |
---|
110 | <tr class="method-row expandable"> |
---|
111 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
112 | <td class="sig"> |
---|
113 | <a id="Ext.dd.Registry-register"></a> |
---|
114 | <b>register</b>( <code>String/HTMLElement) element</code>, <span class="optional" title="Optional">[<code>Object data</code>]</span> ) : void <div class="mdesc"> |
---|
115 | <div class="short">Resgister a drag drop element</div> |
---|
116 | <div class="long"> |
---|
117 | Resgister a drag drop element <div class="mdetail-params"> |
---|
118 | <strong>Parameters:</strong> |
---|
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 /> |
---|
124 | --------- ------------------------------------------<br /> |
---|
125 | handles Array of DOM nodes that trigger dragging<br /> |
---|
126 | for the element being registered<br /> |
---|
127 | isHandle True if the element passed in triggers<br /> |
---|
128 | dragging itself, else false</pre></div></li> </ul> |
---|
129 | <strong>Returns:</strong> |
---|
130 | <ul> |
---|
131 | <li><code>void</code></li> |
---|
132 | </ul> |
---|
133 | </div> |
---|
134 | </div> |
---|
135 | </div> |
---|
136 | </td> |
---|
137 | <td class="msource">Registry</td> |
---|
138 | </tr> |
---|
139 | <tr class="method-row alt expandable"> |
---|
140 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
141 | <td class="sig"> |
---|
142 | <a id="Ext.dd.Registry-unregister"></a> |
---|
143 | <b>unregister</b>( <code>String/HTMLElement) element</code> ) : void <div class="mdesc"> |
---|
144 | <div class="short">Unregister a drag drop element</div> |
---|
145 | <div class="long"> |
---|
146 | Unregister a drag drop element <div class="mdetail-params"> |
---|
147 | <strong>Parameters:</strong> |
---|
148 | <ul><li><code>element</code> : String/HTMLElement)<div class="sub-desc">The id or DOM node to unregister</div></li> </ul> |
---|
149 | <strong>Returns:</strong> |
---|
150 | <ul> |
---|
151 | <li><code>void</code></li> |
---|
152 | </ul> |
---|
153 | </div> |
---|
154 | </div> |
---|
155 | </div> |
---|
156 | </td> |
---|
157 | <td class="msource">Registry</td> |
---|
158 | </tr> |
---|
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> |
---|