docs/symbols/Roo.state.CookieProvider.html
authorAlan Knowles <alan@akbkhome.com>
Mon, 19 Jul 2010 03:51:47 +0000 (11:51 +0800)
committerAlan Knowles <alan@akbkhome.com>
Mon, 19 Jul 2010 03:51:47 +0000 (11:51 +0800)
docs/symbols/Roo.state.CookieProvider.html

index f363788..62dd4cc 100644 (file)
             </td>
         </tr>
        
+         
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.state.Provider-method-clear"   name=".clear"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></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">
+               
+                       <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.state.Provider-method-decodeValue"   name=".decodeValue"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">decodeValue</b>
+                               
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               Mixed
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Decodes a string previously encoded with {<b>link</b> <b>encodeValue</b>}.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <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>value</b>
+                                               
+                                       </dt>
+                                       <dd>The value to decode</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont">Mixed</span>  The decoded value</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.state.Provider-method-encodeValue"   name=".encodeValue"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">encodeValue</b>
+                               
+                                (Mixed <B><i>value</i></B>) 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Encodes a value including type information.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Encodes a value including type information.  Decode with {<b>link</b> <b>decodeValue</b>}.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">Mixed</span>  <b>value</b>
+                                               
+                                       </dt>
+                                       <dd>The value to encode</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The encoded value</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.state.Provider-method-get"   name=".get"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></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>A default value to return if the key's value is not found</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">
+               
+                       <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.state.Provider-method-set"   name=".set"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></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 value to set</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+               &nbsp;
+            </td>
+        </tr>
+       
                                                       
     </table>
 
   
        
    
-    
-     <table cellspacing="0" class="member-table">
-      <caption class="Empty">Events - Has None</caption>
-     </table>
-    
-    
   
     
     
+    
+      <table cellspacing="0" class="member-table">
+               <caption>Events</caption>
+             <thead>
+               <tr>
+                   <th class="sig-header" colspan="2">Event</th>            
+                   <th class="msource-header">Defined By</th>
+
+               </tr>
+             </thead>  
+       
+       
+        
+       
+        
+          <tr class="method-row expandable config-row-alt0">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+           
+            <td class="sig">
+                <a id="Roo.state.Provider-event-*statechange"></a>
+                
+              <div class="fixedFont">
+               <b class="itemname">statechange</b> (Provider <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>key</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>) 
+               
+               </div>
+
+                <div class="mdesc">
+
+                   <div class="short">Fires when a state change occurs.
+                  
+               </div> 
+                   
+                    <div class="long">
+                   
+                       Fires when a state change occurs.
+                   
+                       
+                       
+               
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">Provider</span> <b>this</b>
+                                               
+                                       </dt>
+                                       <dd>This state provider</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>key</b>
+                                               
+                                       </dt>
+                                       <dd>The state key which was changed</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+                                               
+                                       </dt>
+                                       <dd>The encoded value for the state</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+                <a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a>
+            </td>
+        </tr>
+       
+                                                      
+    </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 16 2010 19:32:57 GMT+0800 (HKT)
+                       Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Mon Jul 19 2010 11:50:48 GMT+0800 (HKT)
                        Based on 
                        <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
                </div>