Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / pkgs / state-debug.js
diff --git a/pkgs/state-debug.js b/pkgs/state-debug.js
new file mode 100644 (file)
index 0000000..dcc5f71
--- /dev/null
@@ -0,0 +1,274 @@
+/*!
+ * Ext JS Library 3.0.0
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**
+ * @class Ext.state.Provider
+ * Abstract base class for state provider implementations. This class provides methods
+ * for encoding and decoding <b>typed</b> variables including dates and defines the
+ * Provider interface.
+ */
+Ext.state.Provider = function(){
+    /**
+     * @event statechange
+     * Fires when a state change occurs.
+     * @param {Provider} this This state provider
+     * @param {String} key The state key which was changed
+     * @param {String} value The encoded value for the state
+     */
+    this.addEvents("statechange");
+    this.state = {};
+    Ext.state.Provider.superclass.constructor.call(this);
+};
+Ext.extend(Ext.state.Provider, Ext.util.Observable, {
+    /**
+     * Returns the current value for a key
+     * @param {String} name The key name
+     * @param {Mixed} defaultValue A default value to return if the key's value is not found
+     * @return {Mixed} The state data
+     */
+    get : function(name, defaultValue){
+        return typeof this.state[name] == "undefined" ?
+            defaultValue : this.state[name];
+    },
+
+    /**
+     * Clears a value from the state
+     * @param {String} name The key name
+     */
+    clear : function(name){
+        delete this.state[name];
+        this.fireEvent("statechange", this, name, null);
+    },
+
+    /**
+     * Sets the value for a key
+     * @param {String} name The key name
+     * @param {Mixed} value The value to set
+     */
+    set : function(name, value){
+        this.state[name] = value;
+        this.fireEvent("statechange", this, name, value);
+    },
+
+    /**
+     * Decodes a string previously encoded with {@link #encodeValue}.
+     * @param {String} value The value to decode
+     * @return {Mixed} The decoded value
+     */
+    decodeValue : function(cookie){
+        var re = /^(a|n|d|b|s|o)\:(.*)$/;
+        var matches = re.exec(unescape(cookie));
+        if(!matches || !matches[1]) return; // non state cookie
+        var type = matches[1];
+        var v = matches[2];
+        switch(type){
+            case "n":
+                return parseFloat(v);
+            case "d":
+                return new Date(Date.parse(v));
+            case "b":
+                return (v == "1");
+            case "a":
+                var all = [];
+                var values = v.split("^");
+                for(var i = 0, len = values.length; i < len; i++){
+                    all.push(this.decodeValue(values[i]));
+                }
+                return all;
+           case "o":
+                var all = {};
+                var values = v.split("^");
+                for(var i = 0, len = values.length; i < len; i++){
+                    var kv = values[i].split("=");
+                    all[kv[0]] = this.decodeValue(kv[1]);
+                }
+                return all;
+           default:
+                return v;
+        }
+    },
+
+    /**
+     * Encodes a value including type information.  Decode with {@link #decodeValue}.
+     * @param {Mixed} value The value to encode
+     * @return {String} The encoded value
+     */
+    encodeValue : function(v){
+        var enc;
+        if(typeof v == "number"){
+            enc = "n:" + v;
+        }else if(typeof v == "boolean"){
+            enc = "b:" + (v ? "1" : "0");
+        }else if(Ext.isDate(v)){
+            enc = "d:" + v.toGMTString();
+        }else if(Ext.isArray(v)){
+            var flat = "";
+            for(var i = 0, len = v.length; i < len; i++){
+                flat += this.encodeValue(v[i]);
+                if(i != len-1) flat += "^";
+            }
+            enc = "a:" + flat;
+        }else if(typeof v == "object"){
+            var flat = "";
+            for(var key in v){
+                if(typeof v[key] != "function" && v[key] !== undefined){
+                    flat += key + "=" + this.encodeValue(v[key]) + "^";
+                }
+            }
+            enc = "o:" + flat.substring(0, flat.length-1);
+        }else{
+            enc = "s:" + v;
+        }
+        return escape(enc);
+    }
+});
+/**\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
+        /**\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
+        /**\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
+        /**\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
+        /**\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
+        /**\r
+         * Gets the currently configured state provider\r
+         * @return {Provider} The state provider\r
+         */\r
+        getProvider : function(){\r
+            return provider;\r
+        }\r
+    };\r
+}();\r
+/**\r
+ * @class Ext.state.CookieProvider\r
+ * @extends Ext.state.Provider\r
+ * The default Provider implementation which saves state via cookies.\r
+ * <br />Usage:\r
+ <pre><code>\r
+   var cp = new Ext.state.CookieProvider({\r
+       path: "/cgi-bin/",\r
+       expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days\r
+       domain: "extjs.com"\r
+   });\r
+   Ext.state.Manager.setProvider(cp);\r
+ </code></pre>\r
+ * @cfg {String} path The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)\r
+ * @cfg {Date} expires The cookie expiration date (defaults to 7 days from now)\r
+ * @cfg {String} domain The domain to save the cookie for.  Note that you cannot specify a different domain than\r
+ * your page is on, but you can specify a sub-domain, or simply the domain itself like 'extjs.com' to include\r
+ * all sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\r
+ * domain the page is running on including the 'www' like 'www.extjs.com')\r
+ * @cfg {Boolean} secure True if the site is using SSL (defaults to false)\r
+ * @constructor\r
+ * Create a new CookieProvider\r
+ * @param {Object} config The configuration object\r
+ */\r
+Ext.state.CookieProvider = function(config){\r
+    Ext.state.CookieProvider.superclass.constructor.call(this);\r
+    this.path = "/";\r
+    this.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days\r
+    this.domain = null;\r
+    this.secure = false;\r
+    Ext.apply(this, config);\r
+    this.state = this.readCookies();\r
+};\r
+\r
+Ext.extend(Ext.state.CookieProvider, Ext.state.Provider, {\r
+    // private\r
+    set : function(name, value){\r
+        if(typeof value == "undefined" || value === null){\r
+            this.clear(name);\r
+            return;\r
+        }\r
+        this.setCookie(name, value);\r
+        Ext.state.CookieProvider.superclass.set.call(this, name, value);\r
+    },\r
+\r
+    // private\r
+    clear : function(name){\r
+        this.clearCookie(name);\r
+        Ext.state.CookieProvider.superclass.clear.call(this, name);\r
+    },\r
+\r
+    // private\r
+    readCookies : function(){\r
+        var cookies = {};\r
+        var c = document.cookie + ";";\r
+        var re = /\s?(.*?)=(.*?);/g;\r
+       var matches;\r
+       while((matches = re.exec(c)) != null){\r
+            var name = matches[1];\r
+            var value = matches[2];\r
+            if(name && name.substring(0,3) == "ys-"){\r
+                cookies[name.substr(3)] = this.decodeValue(value);\r
+            }\r
+        }\r
+        return cookies;\r
+    },\r
+\r
+    // private\r
+    setCookie : function(name, value){\r
+        document.cookie = "ys-"+ name + "=" + this.encodeValue(value) +\r
+           ((this.expires == null) ? "" : ("; expires=" + this.expires.toGMTString())) +\r
+           ((this.path == null) ? "" : ("; path=" + this.path)) +\r
+           ((this.domain == null) ? "" : ("; domain=" + this.domain)) +\r
+           ((this.secure == true) ? "; secure" : "");\r
+    },\r
+\r
+    // private\r
+    clearCookie : function(name){\r
+        document.cookie = "ys-" + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" +\r
+           ((this.path == null) ? "" : ("; path=" + this.path)) +\r
+           ((this.domain == null) ? "" : ("; domain=" + this.domain)) +\r
+           ((this.secure == true) ? "; secure" : "");\r
+    }\r
+});
\ No newline at end of file