Upgrade to ExtJS 3.1.1 - Released 02/08/2010

[extjs.git] / docs / output / Ext.state.Manager.html

diff --git a/docs/output/Ext.state.Manager.html b/docs/output/Ext.state.Manager.html
index 953e2cf..7856878 100644 (file)
--- a/docs/output/Ext.state.Manager.html
+++ b/docs/output/Ext.state.Manager.html
@@ -1,141 +1,19 @@
-        <div class="body-wrap">
-        <div class="top-tools">
-            <a class="inner-link" href="#Ext.state.Manager-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
-            <a class="inner-link" href="#Ext.state.Manager-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
-            <a class="inner-link" href="#Ext.state.Manager-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
-                        <a class="bookmark" href="../docs/?class=Ext.state.Manager"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
-        </div>
-                <h1>Class Ext.state.Manager</h1>
-        <table cellspacing="0">
-            <tr><td class="label">Package:</td><td class="hd-info">Ext.state</td></tr>
-            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/StateManager.js" target="_blank">StateManager.js</a></td></tr>
-            <tr><td class="label">Class:</td><td class="hd-info">Manager</td></tr>
-                                    <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
-                    </table>
-        <div class="description">
-            *
-This is the global state manager. By default all components that are "state aware" check this class
-for state information if you don't pass them a custom state provider. In order for this class
+<div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/StateManager.html#cls-Ext.state.Manager">Ext.state.Manager</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.state</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">StateManager.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/StateManager.html#cls-Ext.state.Manager">Manager</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">This is the global state manager. By default all components that are "state aware" check this class\r
+for state information if you don't pass them a custom state provider. In order for this class\r

 to be useful, it must be initialized with a provider when your application initializes. Example usage:\r
 to be useful, it must be initialized with a provider when your application initializes. Example usage:\r

- <pre><code><i>// <b>in</b> your initialization <b>function</b></i>
-init : <b>function</b>(){
-   Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());
-   <b>var</b> win = <b>new</b> Window(...);
-   win.restoreState();
-}</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
-        
-        <div class="hr"></div>
-                <a id="Ext.state.Manager-props"></a>
-        <h2>Public Properties</h2>
-        <div class="no-members">This class has no public properties.</div>        <a id="Ext.state.Manager-methods"></a>
-        <h2>Public Methods</h2>
-                <table cellspacing="0" class="member-table">
-            <tr>
-                <th class="sig-header" colspan="2">Method</th>
-                <th class="msource-header">Defined By</th>
-            </tr>
-                <tr class="method-row expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.state.Manager-clear"></a>\r
-            <b>clear</b>(&nbsp;<code>String name</code>&nbsp;) : void            <div class="mdesc">\r
-                        <div class="short">Clears a value from the state</div>\r
-            <div class="long">\r
-                Clears a value from the state    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">Manager</td>\r
-    </tr>\r
-        <tr class="method-row alt expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.state.Manager-get"></a>\r
-            <b>get</b>(&nbsp;<code>String name</code>, <code>Mixed defaultValue</code>&nbsp;) : Mixed            <div class="mdesc">\r
-                        <div class="short">Returns the current value for a key</div>\r
-            <div class="long">\r
-                Returns the current value for a key    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <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
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>Mixed</code><div class="sub-desc">The state data</div></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">Manager</td>\r
-    </tr>\r
-        <tr class="method-row expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.state.Manager-getProvider"></a>\r
-            <b>getProvider</b>() : Provider            <div class="mdesc">\r
-                        <div class="short">Gets the currently configured state provider</div>\r
-            <div class="long">\r
-                Gets the currently configured state provider    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li>None.</li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>Provider</code><div class="sub-desc">The state provider</div></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">Manager</td>\r
-    </tr>\r
-        <tr class="method-row alt expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.state.Manager-set"></a>\r
-            <b>set</b>(&nbsp;<code>String name</code>, <code>Mixed value</code>&nbsp;) : void            <div class="mdesc">\r
-                        <div class="short">Sets the value for a key</div>\r
-            <div class="long">\r
-                Sets the value for a key    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <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
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">Manager</td>\r
-    </tr>\r
-        <tr class="method-row expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.state.Manager-setProvider"></a>\r
-            <b>setProvider</b>(&nbsp;<code>Provider stateProvider</code>&nbsp;) : void            <div class="mdesc">\r
-                        <div class="short">Configures the default state provider for your application</div>\r
-            <div class="long">\r
-                Configures the default state provider for your application    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li><code>stateProvider</code> : Provider<div class="sub-desc">The state provider to set</div></li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">Manager</td>\r
-    </tr>\r
-            </table>
-                <a id="Ext.state.Manager-events"></a>
-        <h2>Public Events</h2>
-        <div class="no-members">This class has no public events.</div>
-        </div>
\ No newline at end of file
+ <pre><code><i>// <b>in</b> your initialization <b>function</b>\r</i>
+init : <b>function</b>(){\r
+   Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());\r
+   <b>var</b> win = <b>new</b> Window(...);\r
+   win.restoreState();\r
+}</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.state.Manager-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.state.Manager-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Manager-clear"></a><b><a href="source/StateManager.html#method-Ext.state.Manager-clear">clear</a></b>(&nbsp;<code>String&nbsp;name</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Clears a value from the state</div><div class="long">Clears a value from the state<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>name</code> : String<div class="sub-desc">The key name</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Manager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Manager-get"></a><b><a href="source/StateManager.html#method-Ext.state.Manager-get">get</a></b>(&nbsp;<code>String&nbsp;name</code>,&nbsp;<code>Mixed&nbsp;defaultValue</code>&nbsp;)
+    :
+                                        Mixed<div class="mdesc"><div class="short">Returns the current value for a key</div><div class="long">Returns the current value for a key<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Mixed</code><div class="sub-desc">The state data</div></li></ul></div></div></div></td><td class="msource">Manager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Manager-getProvider"></a><b><a href="source/StateManager.html#method-Ext.state.Manager-getProvider">getProvider</a></b>()
+    :
+                                        Provider<div class="mdesc"><div class="short">Gets the currently configured state provider</div><div class="long">Gets the currently configured state provider<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Provider</code><div class="sub-desc">The state provider</div></li></ul></div></div></div></td><td class="msource">Manager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Manager-set"></a><b><a href="source/StateManager.html#method-Ext.state.Manager-set">set</a></b>(&nbsp;<code>String&nbsp;name</code>,&nbsp;<code>Mixed&nbsp;value</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Sets the value for a key</div><div class="long">Sets the value for a key<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Manager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.state.Manager-setProvider"></a><b><a href="source/StateManager.html#method-Ext.state.Manager-setProvider">setProvider</a></b>(&nbsp;<code>Provider&nbsp;stateProvider</code>&nbsp;)
+    :
+                                        void<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<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>stateProvider</code> : Provider<div class="sub-desc">The state provider to set</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Manager</td></tr></tbody></table><a id="Ext.state.Manager-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file