Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / StateManager.html
1 <html>\r
2 <head>\r
3   <title>The source code</title>\r
4     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
5     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
6 </head>\r
7 <body  onload="prettyPrint();">\r
8     <pre class="prettyprint lang-js"><div id="cls-Ext.state.Manager"></div>/**\r
9  * @class Ext.state.Manager\r
10  * This is the global state manager. By default all components that are "state aware" check this class\r
11  * for state information if you don't pass them a custom state provider. In order for this class\r
12  * to be useful, it must be initialized with a provider when your application initializes. Example usage:\r
13  <pre><code>\r
14 // in your initialization function\r
15 init : function(){\r
16    Ext.state.Manager.setProvider(new Ext.state.CookieProvider());\r
17    var win = new Window(...);\r
18    win.restoreState();\r
19 }\r
20  </code></pre>\r
21  * @singleton\r
22  */\r
23 Ext.state.Manager = function(){\r
24     var provider = new Ext.state.Provider();\r
25 \r
26     return {\r
27         <div id="method-Ext.state.Manager-setProvider"></div>/**\r
28          * Configures the default state provider for your application\r
29          * @param {Provider} stateProvider The state provider to set\r
30          */\r
31         setProvider : function(stateProvider){\r
32             provider = stateProvider;\r
33         },\r
34 \r
35         <div id="method-Ext.state.Manager-get"></div>/**\r
36          * Returns the current value for a key\r
37          * @param {String} name The key name\r
38          * @param {Mixed} defaultValue The default value to return if the key lookup does not match\r
39          * @return {Mixed} The state data\r
40          */\r
41         get : function(key, defaultValue){\r
42             return provider.get(key, defaultValue);\r
43         },\r
44 \r
45         <div id="method-Ext.state.Manager-set"></div>/**\r
46          * Sets the value for a key\r
47          * @param {String} name The key name\r
48          * @param {Mixed} value The state data\r
49          */\r
50          set : function(key, value){\r
51             provider.set(key, value);\r
52         },\r
53 \r
54         <div id="method-Ext.state.Manager-clear"></div>/**\r
55          * Clears a value from the state\r
56          * @param {String} name The key name\r
57          */\r
58         clear : function(key){\r
59             provider.clear(key);\r
60         },\r
61 \r
62         <div id="method-Ext.state.Manager-getProvider"></div>/**\r
63          * Gets the currently configured state provider\r
64          * @return {Provider} The state provider\r
65          */\r
66         getProvider : function(){\r
67             return provider;\r
68         }\r
69     };\r
70 }();</pre>    \r
71 </body>\r
72 </html>