Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs.old / symbols / Roo.state.Manager.html
diff --git a/docs.old/symbols/Roo.state.Manager.html b/docs.old/symbols/Roo.state.Manager.html
new file mode 100644 (file)
index 0000000..dbe15d3
--- /dev/null
@@ -0,0 +1,535 @@
+<!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.state.Manager</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.state.Manager-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+        <a class="inner-link" href="#Roo.state.Manager-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+        <a class="inner-link" href="#Roo.state.Manager-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+        <a class="inner-link" href="#Roo.state.Manager-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.state.Manager
+                       </h1>
+                       
+    <table cellspacing="0" class="class-summary-table">
+       
+               <tr><td class="label">Package:</td><td class="hd-info">Roo.state</td></tr>
+       
+        <tr><td class="label">Defined In:</td><td class="hd-info">
+                       
+                                       <a href="./src/Roo_state_Manager.js.html">Roo/state/Manager.js</a>.
+                       
+       </td></tr>
+        <tr><td class="label">Class:</td><td class="hd-info">Manager</td></tr>
+       
+       
+       
+       
+    </table>
+
+    
+<!-- ============================== class summary ========================== -->                       
+    <div class="description">
+       This is the global state manager. By default all components that are "state aware" check this class<br/>for state information if you don't pass them a custom state provider. In order for this class<br/>to be useful, it must be initialized with a provider when your application initializes.<br/> <pre><code><br/>// in your initialization function<br/>init : function(){<br/>   Roo.state.Manager.setProvider(new Roo.state.CookieProvider());<br/>   ...<br/>   // supposed you have a {<b>link</b> Roo.BorderLayout}<br/>   var layout = new Roo.BorderLayout(...);<br/>   layout.restoreState();<br/>   // or a {Roo.BasicDialog}<br/>   var dialog = new Roo.BasicDialog(...);<br/>   dialog.restoreState();<br/> </code></pre>
+    </div>
+
+       
+<!-- ============================== Class comment block... ========================== -->                                      
+
+<div class="comments">
+       <b>Class Comments / Notes</B> =>  
+       <u onclick="parent.CommentDialog.showCommentId = 'Roo.state.Manager';">[Add Your comment/notes about this class]</u>
+       <br/>
+       <iframe frameborder="0"  id="comments-Roo.state" style="border: none;width:100%;" 
+               src="/blog.php/GtkDjsComments/Roo.state.Manager.html"></iframe>
+</div>
+       
+
+               
+<!-- ============================== config options ========================== -->                                              
+                
+    
+    
+               
+    <div class="hr"></div>
+    <a id="Roo.state.Manager-configs"></a>
+               
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Config Options - Has None</caption>
+     </table>
+    
+    
+     
+               
+  
+  
+  
+  
+  
+  
+  
+  
+  <!-- ============================== public properties ==================== -->       
+  
+  
+  
+    <a id="Roo.state.Manager-props"></a>      
+    
+    
+
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Public Properties - Has None</caption>
+     </table>
+    
+    
+     
+    
+  <!-- ============================== methods summary / details ======================== -->
+  
+  
+  <a id="Roo.state.Manager-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.state.Manager-method-clear"   name=".clear"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.state.Manager.</span><b class="itemname">clear</b>
+                               
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Clears a value from the state</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Clears a value from the state
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
+                                               
+                                       </dt>
+                                       <dd>The key name</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.state.Manager
+               &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.state.Manager-method-get"   name=".get"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.state.Manager.</span><b class="itemname">get</b>
+                               
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>defaultValue</i></B>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               Mixed
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns the current value for a key</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns the current value for a key
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
+                                               
+                                       </dt>
+                                       <dd>The key name</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont">Mixed</span>  <b>defaultValue</b>
+                                               
+                                       </dt>
+                                       <dd>The default value to return if the key lookup does not match</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont">Mixed</span>  The state data</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.state.Manager
+               &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.state.Manager-method-getProvider"   name=".getProvider"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.state.Manager.</span><b class="itemname">getProvider</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               Provider
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Gets the currently configured state provider</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Gets the currently configured state provider
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont">Provider</span>  The state provider</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.state.Manager
+               &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.state.Manager-method-set"   name=".set"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.state.Manager.</span><b class="itemname">set</b>
+                               
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, Mixed <B><i>value</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Sets the value for a key</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Sets the value for a key
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>name</b>
+                                               
+                                       </dt>
+                                       <dd>The key name</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont">Mixed</span>  <b>value</b>
+                                               
+                                       </dt>
+                                       <dd>The state data</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.state.Manager
+               &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.state.Manager-method-setProvider"   name=".setProvider"></a>
+               <div class="fixedFont">
+                       <span class="attributes">Roo.state.Manager.</span><b class="itemname">setProvider</b>
+                               
+                                (Provider <B><i>stateProvider</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Configures the default state provider for your application</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Configures the default state provider for your application
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">Provider</span>  <b>stateProvider</b>
+                                               
+                                       </dt>
+                                       <dd>The state provider to set</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.state.Manager
+               &nbsp;
+            </td>
+        </tr>
+       
+                                                      
+    </table>
+
+  
+  <!-- ============================== events summary / details ======================== -->
+  
+  
+  <a id="Roo.state.Manager-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:55 GMT+0800 (HKT)
+                       Based on 
+                       <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
+               </div>
+       </body>
+</html>