docs/output/Ext.state.Manager.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.state.Manager-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.state.Manager-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.state.Manager-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                         <a class="bookmark" href="../docs/?class=Ext.state.Manager"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   7         </div>
   8                 <h1>Class Ext.state.Manager</h1>
   9         <table cellspacing="0">
  10             <tr><td class="label">Package:</td><td class="hd-info">Ext.state</td></tr>
  11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/StateManager.js" target="_blank">StateManager.js</a></td></tr>
  12             <tr><td class="label">Class:</td><td class="hd-info">Manager</td></tr>
  13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  14                     </table>
  15         <div class="description">
  16             *
  17 This is the global state manager. By default all components that are "state aware" check this class
  18 for state information if you don't pass them a custom state provider. In order for this class
  19 to be useful, it must be initialized with a provider when your application initializes. Example usage:\r
  20  <pre><code><i>// <b>in</b> your initialization <b>function</b></i>
  21 init : <b>function</b>(){
  22    Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());
  23    <b>var</b> win = <b>new</b> Window(...);
  24    win.restoreState();
  25 }</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
  26
  27         <div class="hr"></div>
  28                 <a id="Ext.state.Manager-props"></a>
  29         <h2>Public Properties</h2>
  30         <div class="no-members">This class has no public properties.</div>        <a id="Ext.state.Manager-methods"></a>
  31         <h2>Public Methods</h2>
  32                 <table cellspacing="0" class="member-table">
  33             <tr>
  34                 <th class="sig-header" colspan="2">Method</th>
  35                 <th class="msource-header">Defined By</th>
  36             </tr>
  37                 <tr class="method-row expandable">\r
  38         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  39         <td class="sig">\r
  40         <a id="Ext.state.Manager-clear"></a>\r
  41             <b>clear</b>(&nbsp;<code>String name</code>&nbsp;) : void            <div class="mdesc">\r
  42                         <div class="short">Clears a value from the state</div>\r
  43             <div class="long">\r
  44                 Clears a value from the state    <div class="mdetail-params">\r
  45         <strong>Parameters:</strong>\r
  46         <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li>        </ul>\r
  47         <strong>Returns:</strong>\r
  48         <ul>\r
  49             <li><code>void</code></li>\r
  50         </ul>\r
  51     </div>\r
  52                 </div>\r
  53                         </div>\r
  54         </td>\r
  55         <td class="msource">Manager</td>\r
  56     </tr>\r
  57         <tr class="method-row alt expandable">\r
  58         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  59         <td class="sig">\r
  60         <a id="Ext.state.Manager-get"></a>\r
  61             <b>get</b>(&nbsp;<code>String name</code>, <code>Mixed defaultValue</code>&nbsp;) : Mixed            <div class="mdesc">\r
  62                         <div class="short">Returns the current value for a key</div>\r
  63             <div class="long">\r
  64                 Returns the current value for a key    <div class="mdetail-params">\r
  65         <strong>Parameters:</strong>\r
  66         <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li><li><code>defaultValue</code> : Mixed<div class="sub-desc">The default value to return if the key lookup does not match</div></li>        </ul>\r
  67         <strong>Returns:</strong>\r
  68         <ul>\r
  69             <li><code>Mixed</code><div class="sub-desc">The state data</div></li>\r
  70         </ul>\r
  71     </div>\r
  72                 </div>\r
  73                         </div>\r
  74         </td>\r
  75         <td class="msource">Manager</td>\r
  76     </tr>\r
  77         <tr class="method-row expandable">\r
  78         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  79         <td class="sig">\r
  80         <a id="Ext.state.Manager-getProvider"></a>\r
  81             <b>getProvider</b>() : Provider            <div class="mdesc">\r
  82                         <div class="short">Gets the currently configured state provider</div>\r
  83             <div class="long">\r
  84                 Gets the currently configured state provider    <div class="mdetail-params">\r
  85         <strong>Parameters:</strong>\r
  86         <ul><li>None.</li>        </ul>\r
  87         <strong>Returns:</strong>\r
  88         <ul>\r
  89             <li><code>Provider</code><div class="sub-desc">The state provider</div></li>\r
  90         </ul>\r
  91     </div>\r
  92                 </div>\r
  93                         </div>\r
  94         </td>\r
  95         <td class="msource">Manager</td>\r
  96     </tr>\r
  97         <tr class="method-row alt expandable">\r
  98         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  99         <td class="sig">\r
 100         <a id="Ext.state.Manager-set"></a>\r
 101             <b>set</b>(&nbsp;<code>String name</code>, <code>Mixed value</code>&nbsp;) : void            <div class="mdesc">\r
 102                         <div class="short">Sets the value for a key</div>\r
 103             <div class="long">\r
 104                 Sets the value for a key    <div class="mdetail-params">\r
 105         <strong>Parameters:</strong>\r
 106         <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li><li><code>value</code> : Mixed<div class="sub-desc">The state data</div></li>        </ul>\r
 107         <strong>Returns:</strong>\r
 108         <ul>\r
 109             <li><code>void</code></li>\r
 110         </ul>\r
 111     </div>\r
 112                 </div>\r
 113                         </div>\r
 114         </td>\r
 115         <td class="msource">Manager</td>\r
 116     </tr>\r
 117         <tr class="method-row expandable">\r
 118         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 119         <td class="sig">\r
 120         <a id="Ext.state.Manager-setProvider"></a>\r
 121             <b>setProvider</b>(&nbsp;<code>Provider stateProvider</code>&nbsp;) : void            <div class="mdesc">\r
 122                         <div class="short">Configures the default state provider for your application</div>\r
 123             <div class="long">\r
 124                 Configures the default state provider for your application    <div class="mdetail-params">\r
 125         <strong>Parameters:</strong>\r
 126         <ul><li><code>stateProvider</code> : Provider<div class="sub-desc">The state provider to set</div></li>        </ul>\r
 127         <strong>Returns:</strong>\r
 128         <ul>\r
 129             <li><code>void</code></li>\r
 130         </ul>\r
 131     </div>\r
 132                 </div>\r
 133                         </div>\r
 134         </td>\r
 135         <td class="msource">Manager</td>\r
 136     </tr>\r
 137             </table>
 138                 <a id="Ext.state.Manager-events"></a>
 139         <h2>Public Events</h2>
 140         <div class="no-members">This class has no public events.</div>
 141         </div>