Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs / symbols / Roo.KeyNav.html
diff --git a/docs/symbols/Roo.KeyNav.html b/docs/symbols/Roo.KeyNav.html
deleted file mode 100644 (file)
index 43f5892..0000000
+++ /dev/null
@@ -1,470 +0,0 @@
-<!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.KeyNav</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.KeyNav-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
-        <a class="inner-link" href="#Roo.KeyNav-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
-        <a class="inner-link" href="#Roo.KeyNav-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
-        <a class="inner-link" href="#Roo.KeyNav-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.KeyNav
-                       </h1>
-                       
-    <table cellspacing="0" class="class-summary-table">
-       
-               <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
-       
-        <tr><td class="label">Defined In:</td><td class="hd-info">
-                       
-                                       <a href="./src/Roo_KeyNav.js.html">Roo/KeyNav.js</a>.
-                       
-       </td></tr>
-        <tr><td class="label">Class:</td><td class="hd-info">KeyNav</td></tr>
-       
-       
-       
-       
-    </table>
-
-    
-<!-- ============================== class summary ========================== -->                       
-    <div class="description">
-       <p>Provides a convenient wrapper for normalized keyboard navigation.  KeyNav allows you to bind<br/>navigation keys to function calls that will get called when the keys are pressed, providing an easy<br/>way to implement custom navigation schemes for any UI component.</p><br/><p>The following are all of the possible keys that can be implemented: enter, left, right, up, down, tab, esc,<br/>pageUp, pageDown, del, home, end.  Usage:</p><br/> <pre><code><br/>var nav = new Roo.KeyNav("my-element", {<br/>    "left" : function(e){<br/>        this.moveLeft(e.ctrlKey);<br/>    },<br/>    "right" : function(e){<br/>        this.moveRight(e.ctrlKey);<br/>    },<br/>    "enter" : function(e){<br/>        this.save();<br/>    },<br/>    scope : this<br/>});<br/></code></pre>
-    </div>
-
-       
-<!-- ============================== Class comment block... ========================== -->                                      
-
-<div class="comments">
-       <b>Class Comments / Notes</B> =>  
-       <u onclick="parent.CommentDialog.showCommentId = 'Roo.KeyNav';">[Add Your comment/notes about this class]</u>
-       <br/>
-       <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;" 
-               src="/blog.php/GtkDjsComments/Roo.KeyNav.html"></iframe>
-</div>
-       
-
-               
-<!-- ============================== config options ========================== -->                                              
-                
-    
-    
-               
-    <div class="hr"></div>
-    <a id="Roo.KeyNav-configs"></a>
-               
-    
-     
-    
-       
-      <table cellspacing="0" class="member-table">   
-      <caption>Config Options (Usually are also Properties)</caption>
-    
-       
-        <tr>
-            <th class="sig-header" colspan="2">Options</th>
-           
-            <th class="msource-header">Defined By</th>
-        </tr>
-       
-       
-       
-       
-       
-               <tr class="config-row expandable config-row-alt0 notInherited">
-                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
-                   <td class="sig">
-
-                       <a id="Roo.KeyNav-cfg-defaultEventAction" name=".defaultEventAction"></a>
-                       <div class="fixedFont">
-                               <b  class="itemname">defaultEventAction</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-                               
-                               
-                       </div>
-                 
-                       <div class="mdesc">
-                           <div class="short">The method to call on the {<b>link</b> Roo.EventObject} after this KeyNav intercepts a key.</div> 
-                       </div>
-                       
-                       <div class="mdesc">
-                           <div class="long">
-                    The method to call on the {<b>link</b> Roo.EventObject} after this KeyNav intercepts a key.  Valid values are<br/>{<b>link</b> Roo.EventObject<b>stopEvent</b>}, {<b>link</b> Roo.EventObject<b>preventDefault</b>} and<br/>{<b>link</b> Roo.EventObject<b>stopPropagation</b>} (defaults to 'stopEvent')
-                    
-                </div> 
-                       </div>
-                       
-                       
-
-                   </td>
-                   <td class="msource">
-                       
-                       Roo.KeyNav
-                               
-                   </td>
-               </tr>
-        
-       
-               <tr class="config-row expandable config-row-alt1 notInherited">
-                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
-                   <td class="sig">
-
-                       <a id="Roo.KeyNav-cfg-disabled" name=".disabled"></a>
-                       <div class="fixedFont">
-                               <b  class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-                               
-                               
-                       </div>
-                 
-                       <div class="mdesc">
-                           <div class="short">True to disable this KeyNav instance (defaults to false)</div> 
-                       </div>
-                       
-                       <div class="mdesc">
-                           <div class="long">
-                    True to disable this KeyNav instance (defaults to false)
-                    
-                </div> 
-                       </div>
-                       
-                       
-
-                   </td>
-                   <td class="msource">
-                       
-                       Roo.KeyNav
-                               
-                   </td>
-               </tr>
-        
-       
-               <tr class="config-row expandable config-row-alt0 notInherited">
-                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
-                   <td class="sig">
-
-                       <a id="Roo.KeyNav-cfg-forceKeyDown" name=".forceKeyDown"></a>
-                       <div class="fixedFont">
-                               <b  class="itemname">forceKeyDown</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-                               
-                               
-                       </div>
-                 
-                       <div class="mdesc">
-                           <div class="short">Handle the keydown event instead of keypress (defaults to false).</div> 
-                       </div>
-                       
-                       <div class="mdesc">
-                           <div class="long">
-                    Handle the keydown event instead of keypress (defaults to false).  KeyNav automatically does this for IE since<br/>IE does not propagate special keys on keypress, but setting this to true will force other browsers to also<br/>handle keydown instead of keypress.
-                    
-                </div> 
-                       </div>
-                       
-                       
-
-                   </td>
-                   <td class="msource">
-                       
-                       Roo.KeyNav
-                               
-                   </td>
-               </tr>
-        
-        
-    </table>
-               
-  
-  
-  
-  
-  
-  
-  
-  
-  <!-- ============================== public properties ==================== -->       
-  
-  
-  
-    <a id="Roo.KeyNav-props"></a>      
-    
-    
-
-    
-    
-     <table cellspacing="0" class="member-table">
-      <caption class="Empty">Public Properties - Has None</caption>
-     </table>
-    
-    
-     
-    
-  <!-- ============================== methods summary / details ======================== -->
-  
-  
-  <a id="Roo.KeyNav-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-method-KeyNav"   name=".KeyNav"></a>
-               <div class="fixedFont">
-                       <span class="attributes">new <B>Roo.</B></span><b class="itemname">KeyNav</b>
-                               
-                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>) 
-                       
-                               
-                       
-               </div>
-                <div class="mdesc">
-               
-                
-                       <div class="short">Create a new Roo.KeyNav</div> 
-                
-                
-                    <div class="long">
-                       
-                       
-                       
-                               Create a new Roo.KeyNav
-                       
-                       
-                               <dl class="detailList">
-                               <dt class="heading">Parameters:</dt>
-                               
-                                       <dt>
-                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
-                                               
-                                       </dt>
-                                       <dd>The element to bind to</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>config</b>
-                                               
-                                       </dt>
-                                       <dd>The config</dd>
-                               
-                               </dl>
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-
-                   
-                   
-                    
-                    </div>                    
-                </div>
-
-            </td>
-            <td class="msource">
-               &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.KeyNav-method-disable"   name=".disable"></a>
-               <div class="fixedFont">
-                       <span class="attributes"></span><b class="itemname">disable</b>
-                               
-                                () 
-                       
-                               
-                       
-               </div>
-                <div class="mdesc">
-               
-                   <div class="short">Disable this KeyNav</div> 
-                
-                
-                
-                    <div class="long">
-                       
-                               Disable this KeyNav
-                   
-                               
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-
-                   
-                   
-                    
-                    </div>                    
-                </div>
-
-            </td>
-            <td class="msource">
-               
-                       Roo.KeyNav
-               &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.KeyNav-method-enable"   name=".enable"></a>
-               <div class="fixedFont">
-                       <span class="attributes"></span><b class="itemname">enable</b>
-                               
-                                () 
-                       
-                               
-                       
-               </div>
-                <div class="mdesc">
-               
-                   <div class="short">Enable this KeyNav</div> 
-                
-                
-                
-                    <div class="long">
-                       
-                               Enable this KeyNav
-                   
-                               
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-                       
-
-                   
-                   
-                    
-                    </div>                    
-                </div>
-
-            </td>
-            <td class="msource">
-               
-                       Roo.KeyNav
-               &nbsp;
-            </td>
-        </tr>
-       
-                                                      
-    </table>
-
-  
-  <!-- ============================== events summary / details ======================== -->
-  
-  
-  <a id="Roo.KeyNav-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:53 GMT+0800 (HKT)
-                       Based on 
-                       <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
-               </div>
-       </body>
-</html>