1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.dd.Registry</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.dd.Registry-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.dd.Registry-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.dd.Registry-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.dd.Registry-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_dd_Registry.js.html">Roo/dd/Registry.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">Registry</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 Provides easy access to all drag drop components that are registered on a page. Items can be retrieved either<br/>directly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.Registry';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo.dd" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.dd.Registry.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.dd.Registry-configs"></a>
98 <table cellspacing="0" class="member-table">
99 <caption class="Empty">Config Options - Has None</caption>
113 <!-- ============================== public properties ==================== -->
117 <a id="Roo.dd.Registry-props"></a>
123 <table cellspacing="0" class="member-table">
124 <caption class="Empty">Public Properties - Has None</caption>
130 <!-- ============================== methods summary / details ======================== -->
133 <a id="Roo.dd.Registry-methods"></a>
134 <!-- constructor?? -->
141 <!-- then dynamics first -->
148 <table cellspacing="0" class="member-table">
149 <caption>Public Methods</caption>
151 <th class="sig-header" colspan="2">Method</th>
152 <th class="msource-header">Defined By</th>
162 <tr class="method-row config-row-alt0 expandable notInherited">
163 <td class="micon"><a class="exi" href="#expand"> </a></td>
167 <a id="Roo.dd.Registry-method-getHandle" name=".getHandle"></a>
168 <div class="fixedFont">
169 <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getHandle</b>
171 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>id</i></B>)
177 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
186 <div class="short">Returns the handle registered for a DOM Node by id</div>
192 Returns the handle registered for a DOM Node by id
199 <dl class="detailList">
200 <dt class="heading">Parameters:</dt>
203 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>id</b>
206 <dd>The DOM node or id to look up</dd>
214 <dl class="detailList">
215 <dt class="heading">Returns:</dt>
217 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> handle The custom handle data</dd>
239 <tr class="method-row config-row-alt1 expandable notInherited">
240 <td class="micon"><a class="exi" href="#expand"> </a></td>
244 <a id="Roo.dd.Registry-method-getHandleFromEvent" name=".getHandleFromEvent"></a>
245 <div class="fixedFont">
246 <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getHandleFromEvent</b>
248 (Event <B><i>e</i></B>)
254 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
263 <div class="short">Returns the handle that is registered for the DOM node that is the target of the event</div>
269 Returns the handle that is registered for the DOM node that is the target of the event
276 <dl class="detailList">
277 <dt class="heading">Parameters:</dt>
280 <span class="fixedFont">Event</span> <b>e</b>
291 <dl class="detailList">
292 <dt class="heading">Returns:</dt>
294 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> handle The custom handle data</dd>
316 <tr class="method-row config-row-alt0 expandable notInherited">
317 <td class="micon"><a class="exi" href="#expand"> </a></td>
321 <a id="Roo.dd.Registry-method-getTarget" name=".getTarget"></a>
322 <div class="fixedFont">
323 <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getTarget</b>
325 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>id</i></B>)
331 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
340 <div class="short">Returns a custom data object that is registered for a DOM node by id</div>
346 Returns a custom data object that is registered for a DOM node by id
353 <dl class="detailList">
354 <dt class="heading">Parameters:</dt>
357 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>id</b>
360 <dd>The DOM node or id to look up</dd>
368 <dl class="detailList">
369 <dt class="heading">Returns:</dt>
371 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> data The custom data</dd>
393 <tr class="method-row config-row-alt1 expandable notInherited">
394 <td class="micon"><a class="exi" href="#expand"> </a></td>
398 <a id="Roo.dd.Registry-method-getTargetFromEvent" name=".getTargetFromEvent"></a>
399 <div class="fixedFont">
400 <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getTargetFromEvent</b>
402 (Event <B><i>e</i></B>)
408 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
417 <div class="short">Returns a custom data object that is registered for the DOM node that is the target of the event</div>
423 Returns a custom data object that is registered for the DOM node that is the target of the event
430 <dl class="detailList">
431 <dt class="heading">Parameters:</dt>
434 <span class="fixedFont">Event</span> <b>e</b>
445 <dl class="detailList">
446 <dt class="heading">Returns:</dt>
448 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> data The custom data</dd>
470 <tr class="method-row config-row-alt0 expandable notInherited">
471 <td class="micon"><a class="exi" href="#expand"> </a></td>
475 <a id="Roo.dd.Registry-method-register" name=".register"></a>
476 <div class="fixedFont">
477 <span class="attributes">Roo.dd.Registry.</span><b class="itemname">register</b>
479 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>element</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
486 <div class="short">Register a drag drop element</div>
492 Register a drag drop element
499 <dl class="detailList">
500 <dt class="heading">Parameters:</dt>
503 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>element</b>
506 <dd>The id or DOM node to register</dd>
509 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
512 <dd>(optional) A custom data object that will be passed between the elements that are involved<br/>in drag drop operations. You can populate this object with any arbitrary properties that your own code<br/>knows how to interpret, plus there are some specific properties known to the Registry that should be<br/>populated in the data object (if applicable):<br/><pre><br/>Value Description<br /><br/>--------- ------------------------------------------<br /><br/>handles Array of DOM nodes that trigger dragging<br /><br/> for the element being registered<br /><br/>isHandle True if the element passed in triggers<br /><br/> dragging itself, else false<br/></pre></dd>
538 <tr class="method-row config-row-alt1 expandable notInherited">
539 <td class="micon"><a class="exi" href="#expand"> </a></td>
543 <a id="Roo.dd.Registry-method-unregister" name=".unregister"></a>
544 <div class="fixedFont">
545 <span class="attributes">Roo.dd.Registry.</span><b class="itemname">unregister</b>
547 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>element</i></B>)
554 <div class="short">Unregister a drag drop element</div>
560 Unregister a drag drop element
567 <dl class="detailList">
568 <dt class="heading">Parameters:</dt>
571 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>element</b>
574 <dd>The id or DOM node to unregister</dd>
603 <!-- ============================== events summary / details ======================== -->
606 <a id="Roo.dd.Registry-events"></a>
612 <table cellspacing="0" class="member-table">
613 <caption class="Empty">Events - Has None</caption>
624 <!-- ============================== footer ================================= -->
625 <div class="fineprint" style="clear:both">
627 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed Aug 04 2010 10:58:36 GMT+0800 (HKT)
629 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>