Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs.old / symbols / Roo.dd.Registry.html
diff --git a/docs.old/symbols/Roo.dd.Registry.html b/docs.old/symbols/Roo.dd.Registry.html
new file mode 100644 (file)
index 0000000..714eab0
--- /dev/null
@@ -0,0 +1,632 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+       <head>
+               <meta http-equiv="content-type" content="text/html; charset=undefined" />
+               <meta name="generator" content="JsDoc Toolkit" />
+               
+               
+               <title>JsDoc Reference - Roo.dd.Registry</title>
+               
+               
+       <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
+       <link rel="stylesheet" type="text/css" href="../default.css" />
+       
+       
+       <script type="text/javascript" src="../page.js">
+       
+       </script>
+        
+               
+       </head>
+
+       <body onload="RooDocsPage.onload();">
+        
+       
+<div class="body-wrap">
+
+    <!-- ============================== links to methods. ================================= -->        
+
+    <div class="top-tools">
+    <!--
+        <a class="inner-link" href="#Roo.dd.Registry-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+        <a class="inner-link" href="#Roo.dd.Registry-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+        <a class="inner-link" href="#Roo.dd.Registry-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+        <a class="inner-link" href="#Roo.dd.Registry-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+        <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+       -->
+    </div>
+
+    
+<!-- ============================== inheritance Block. ================================= -->   
+       
+<!-- ============================== class title / details ============================ -->
+    
+    
+    <h1 class="classTitle">
+                               
+                               Class Roo.dd.Registry
+                       </h1>
+                       
+    <table cellspacing="0" class="class-summary-table">
+       
+               <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
+       
+        <tr><td class="label">Defined In:</td><td class="hd-info">
+                       
+                                       <a href="./src/Roo_dd_Registry.js.html">Roo/dd/Registry.js</a>.
+                       
+       </td></tr>
+        <tr><td class="label">Class:</td><td class="hd-info">Registry</td></tr>
+       
+       
+       
+       
+    </table>
+
+    
+<!-- ============================== class summary ========================== -->                       
+    <div class="description">
+       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.
+    </div>
+
+       
+<!-- ============================== Class comment block... ========================== -->                                      
+
+<div class="comments">
+       <b>Class Comments / Notes</B> =>  
+       <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.Registry';">[Add Your comment/notes about this class]</u>
+       <br/>
+       <iframe frameborder="0"  id="comments-Roo.dd" style="border: none;width:100%;" 
+               src="/blog.php/GtkDjsComments/Roo.dd.Registry.html"></iframe>
+</div>
+       
+
+               
+<!-- ============================== config options ========================== -->                                              
+                
+    
+    
+               
+    <div class="hr"></div>
+    <a id="Roo.dd.Registry-configs"></a>
+               
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Config Options - Has None</caption>
+     </table>
+    
+    
+     
+               
+  
+  
+  
+  
+  
+  
+  
+  
+  <!-- ============================== public properties ==================== -->       
+  
+  
+  
+    <a id="Roo.dd.Registry-props"></a>      
+    
+    
+
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Public Properties - Has None</caption>
+     </table>
+    
+    
+     
+    
+  <!-- ============================== methods summary / details ======================== -->
+  
+  
+  <a id="Roo.dd.Registry-methods"></a>
+       <!-- constructor?? -->
+       
+       <!-- static's first 
+       
+       
+       -->
+       
+       <!-- then dynamics first -->
+       
+  
+  
+    
+    
+    
+      <table cellspacing="0" class="member-table">
+      <caption>Public Methods</caption>
+        <tr>
+            <th class="sig-header" colspan="2">Method</th>            
+            <th class="msource-header">Defined By</th>
+
+        </tr>
+        
+       
+       
+        
+       
+        
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.dd.Registry-method-getHandle"   name=".getHandle"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getHandle</b>
+                               
+                                (<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>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns the handle registered for a DOM Node by id</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns the handle registered for a DOM Node by id
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <dd>The DOM node or id to look up</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <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>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.dd.Registry
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.dd.Registry-method-getHandleFromEvent"   name=".getHandleFromEvent"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getHandleFromEvent</b>
+                               
+                                (Event <B><i>e</i></B>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns the handle that is registered for the DOM node that is the target of the event</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns the handle that is registered for the DOM node that is the target of the event
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">Event</span>  <b>e</b>
+                                               
+                                       </dt>
+                                       <dd>The event</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <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>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.dd.Registry
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.dd.Registry-method-getTarget"   name=".getTarget"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getTarget</b>
+                               
+                                (<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>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns a custom data object that is registered for a DOM node by id</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns a custom data object that is registered for a DOM node by id
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <dd>The DOM node or id to look up</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <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>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.dd.Registry
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.dd.Registry-method-getTargetFromEvent"   name=".getTargetFromEvent"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getTargetFromEvent</b>
+                               
+                                (Event <B><i>e</i></B>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns a custom data object that is registered for the DOM node that is the target of the event</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns a custom data object that is registered for the DOM node that is the target of the event
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">Event</span>  <b>e</b>
+                                               
+                                       </dt>
+                                       <dd>The event</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <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>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.dd.Registry
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.dd.Registry-method-register"   name=".register"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.dd.Registry.</span><b class="itemname">register</b>
+                               
+                                (<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>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Register a drag drop element</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Register a drag drop element
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <dd>The id or DOM node to register</dd>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <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>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.dd.Registry
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.dd.Registry-method-unregister"   name=".unregister"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.dd.Registry.</span><b class="itemname">unregister</b>
+                               
+                                (<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>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Unregister a drag drop element</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Unregister a drag drop element
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <dd>The id or DOM node to unregister</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.dd.Registry
+               &nbsp;
+            </td>
+        </tr>
+       
+                                                      
+    </table>
+
+  
+  <!-- ============================== events summary / details ======================== -->
+  
+  
+  <a id="Roo.dd.Registry-events"></a>
+    
+  
+       
+   
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Events - Has None</caption>
+     </table>
+    
+    
+  
+    
+    
+  
+  
+  
+<!-- ============================== footer ================================= -->
+               <div class="fineprint" style="clear:both">
+                       
+                       Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
+                       Based on 
+                       <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
+               </div>
+       </body>
+</html>