Upgrade to ExtJS 3.3.1 - Released 11/30/2010
[extjs.git] / docs / source / StateManager.html
index 17ea962..13e6fb1 100644 (file)
@@ -1,73 +1,79 @@
-<html>\r
-<head>\r
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.state.Manager"></div>/**\r
- * @class Ext.state.Manager\r
- * 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
- <pre><code>\r
-// in your initialization function\r
-init : function(){\r
-   Ext.state.Manager.setProvider(new Ext.state.CookieProvider());\r
-   var win = new Window(...);\r
-   win.restoreState();\r
-}\r
- </code></pre>\r
- * @singleton\r
- */\r
-Ext.state.Manager = function(){\r
-    var provider = new Ext.state.Provider();\r
-\r
-    return {\r
-        <div id="method-Ext.state.Manager-setProvider"></div>/**\r
-         * Configures the default state provider for your application\r
-         * @param {Provider} stateProvider The state provider to set\r
-         */\r
-        setProvider : function(stateProvider){\r
-            provider = stateProvider;\r
-        },\r
-\r
-        <div id="method-Ext.state.Manager-get"></div>/**\r
-         * Returns the current value for a key\r
-         * @param {String} name The key name\r
-         * @param {Mixed} defaultValue The default value to return if the key lookup does not match\r
-         * @return {Mixed} The state data\r
-         */\r
-        get : function(key, defaultValue){\r
-            return provider.get(key, defaultValue);\r
-        },\r
-\r
-        <div id="method-Ext.state.Manager-set"></div>/**\r
-         * Sets the value for a key\r
-         * @param {String} name The key name\r
-         * @param {Mixed} value The state data\r
-         */\r
-         set : function(key, value){\r
-            provider.set(key, value);\r
-        },\r
-\r
-        <div id="method-Ext.state.Manager-clear"></div>/**\r
-         * Clears a value from the state\r
-         * @param {String} name The key name\r
-         */\r
-        clear : function(key){\r
-            provider.clear(key);\r
-        },\r
-\r
-        <div id="method-Ext.state.Manager-getProvider"></div>/**\r
-         * Gets the currently configured state provider\r
-         * @return {Provider} The state provider\r
-         */\r
-        getProvider : function(){\r
-            return provider;\r
-        }\r
-    };\r
-}();</pre>    \r
-</body>\r
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.3.1
+ * Copyright(c) 2006-2010 Sencha Inc.
+ * licensing@sencha.com
+ * http://www.sencha.com/license
+ */
+<div id="cls-Ext.state.Manager"></div>/**
+ * @class Ext.state.Manager
+ * 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
+ * to be useful, it must be initialized with a provider when your application initializes. Example usage:
+ <pre><code>
+// in your initialization function
+init : function(){
+   Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
+   var win = new Window(...);
+   win.restoreState();
+}
+ </code></pre>
+ * @singleton
+ */
+Ext.state.Manager = function(){
+    var provider = new Ext.state.Provider();
+
+    return {
+        <div id="method-Ext.state.Manager-setProvider"></div>/**
+         * Configures the default state provider for your application
+         * @param {Provider} stateProvider The state provider to set
+         */
+        setProvider : function(stateProvider){
+            provider = stateProvider;
+        },
+
+        <div id="method-Ext.state.Manager-get"></div>/**
+         * Returns the current value for a key
+         * @param {String} name The key name
+         * @param {Mixed} defaultValue The default value to return if the key lookup does not match
+         * @return {Mixed} The state data
+         */
+        get : function(key, defaultValue){
+            return provider.get(key, defaultValue);
+        },
+
+        <div id="method-Ext.state.Manager-set"></div>/**
+         * Sets the value for a key
+         * @param {String} name The key name
+         * @param {Mixed} value The state data
+         */
+         set : function(key, value){
+            provider.set(key, value);
+        },
+
+        <div id="method-Ext.state.Manager-clear"></div>/**
+         * Clears a value from the state
+         * @param {String} name The key name
+         */
+        clear : function(key){
+            provider.clear(key);
+        },
+
+        <div id="method-Ext.state.Manager-getProvider"></div>/**
+         * Gets the currently configured state provider
+         * @return {Provider} The state provider
+         */
+        getProvider : function(){
+            return provider;
+        }
+    };
+}();</pre>    
+</body>
 </html>
\ No newline at end of file