src/state/Provider.js

   1 /*!
   2  * Ext JS Library 3.0.0
   3  * Copyright(c) 2006-2009 Ext JS, LLC
   4  * licensing@extjs.com
   5  * http://www.extjs.com/license
   6  */
   7 /**
   8  * @class Ext.state.Provider
   9  * Abstract base class for state provider implementations. This class provides methods
  10  * for encoding and decoding <b>typed</b> variables including dates and defines the
  11  * Provider interface.
  12  */
  13 Ext.state.Provider = function(){
  14     /**
  15      * @event statechange
  16      * Fires when a state change occurs.
  17      * @param {Provider} this This state provider
  18      * @param {String} key The state key which was changed
  19      * @param {String} value The encoded value for the state
  20      */
  21     this.addEvents("statechange");
  22     this.state = {};
  23     Ext.state.Provider.superclass.constructor.call(this);
  24 };
  25 Ext.extend(Ext.state.Provider, Ext.util.Observable, {
  26     /**
  27      * Returns the current value for a key
  28      * @param {String} name The key name
  29      * @param {Mixed} defaultValue A default value to return if the key's value is not found
  30      * @return {Mixed} The state data
  31      */
  32     get : function(name, defaultValue){
  33         return typeof this.state[name] == "undefined" ?
  34             defaultValue : this.state[name];
  35     },
  36
  37     /**
  38      * Clears a value from the state
  39      * @param {String} name The key name
  40      */
  41     clear : function(name){
  42         delete this.state[name];
  43         this.fireEvent("statechange", this, name, null);
  44     },
  45
  46     /**
  47      * Sets the value for a key
  48      * @param {String} name The key name
  49      * @param {Mixed} value The value to set
  50      */
  51     set : function(name, value){
  52         this.state[name] = value;
  53         this.fireEvent("statechange", this, name, value);
  54     },
  55
  56     /**
  57      * Decodes a string previously encoded with {@link #encodeValue}.
  58      * @param {String} value The value to decode
  59      * @return {Mixed} The decoded value
  60      */
  61     decodeValue : function(cookie){
  62         var re = /^(a|n|d|b|s|o)\:(.*)$/;
  63         var matches = re.exec(unescape(cookie));
  64         if(!matches || !matches[1]) return; // non state cookie
  65         var type = matches[1];
  66         var v = matches[2];
  67         switch(type){
  68             case "n":
  69                 return parseFloat(v);
  70             case "d":
  71                 return new Date(Date.parse(v));
  72             case "b":
  73                 return (v == "1");
  74             case "a":
  75                 var all = [];
  76                 var values = v.split("^");
  77                 for(var i = 0, len = values.length; i < len; i++){
  78                     all.push(this.decodeValue(values[i]));
  79                 }
  80                 return all;
  81            case "o":
  82                 var all = {};
  83                 var values = v.split("^");
  84                 for(var i = 0, len = values.length; i < len; i++){
  85                     var kv = values[i].split("=");
  86                     all[kv[0]] = this.decodeValue(kv[1]);
  87                 }
  88                 return all;
  89            default:
  90                 return v;
  91         }
  92     },
  93
  94     /**
  95      * Encodes a value including type information.  Decode with {@link #decodeValue}.
  96      * @param {Mixed} value The value to encode
  97      * @return {String} The encoded value
  98      */
  99     encodeValue : function(v){
 100         var enc;
 101         if(typeof v == "number"){
 102             enc = "n:" + v;
 103         }else if(typeof v == "boolean"){
 104             enc = "b:" + (v ? "1" : "0");
 105         }else if(Ext.isDate(v)){
 106             enc = "d:" + v.toGMTString();
 107         }else if(Ext.isArray(v)){
 108             var flat = "";
 109             for(var i = 0, len = v.length; i < len; i++){
 110                 flat += this.encodeValue(v[i]);
 111                 if(i != len-1) flat += "^";
 112             }
 113             enc = "a:" + flat;
 114         }else if(typeof v == "object"){
 115             var flat = "";
 116             for(var key in v){
 117                 if(typeof v[key] != "function" && v[key] !== undefined){
 118                     flat += key + "=" + this.encodeValue(v[key]) + "^";
 119                 }
 120             }
 121             enc = "o:" + flat.substring(0, flat.length-1);
 122         }else{
 123             enc = "s:" + v;
 124         }
 125         return escape(enc);
 126     }
 127 });