3 * Copyright(c) 2006-2010 Sencha Inc.
5 * http://www.sencha.com/license
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
13 Ext.state.Provider = Ext.extend(Ext.util.Observable, {
15 constructor : function(){
18 * Fires when a state change occurs.
19 * @param {Provider} this This state provider
20 * @param {String} key The state key which was changed
21 * @param {String} value The encoded value for the state
23 this.addEvents("statechange");
25 Ext.state.Provider.superclass.constructor.call(this);
29 * Returns the current value for a key
30 * @param {String} name The key name
31 * @param {Mixed} defaultValue A default value to return if the key's value is not found
32 * @return {Mixed} The state data
34 get : function(name, defaultValue){
35 return typeof this.state[name] == "undefined" ?
36 defaultValue : this.state[name];
40 * Clears a value from the state
41 * @param {String} name The key name
43 clear : function(name){
44 delete this.state[name];
45 this.fireEvent("statechange", this, name, null);
49 * Sets the value for a key
50 * @param {String} name The key name
51 * @param {Mixed} value The value to set
53 set : function(name, value){
54 this.state[name] = value;
55 this.fireEvent("statechange", this, name, value);
59 * Decodes a string previously encoded with {@link #encodeValue}.
60 * @param {String} value The value to decode
61 * @return {Mixed} The decoded value
63 decodeValue : function(cookie){
73 var re = /^(a|n|d|b|s|o|e)\:(.*)$/,
74 matches = re.exec(unescape(cookie)),
79 if(!matches || !matches[1]){
80 return; // non state cookie
90 return new Date(Date.parse(v));
96 Ext.each(v.split('^'), function(val){
97 all.push(this.decodeValue(val));
104 Ext.each(v.split('^'), function(val){
106 all[kv[0]] = this.decodeValue(kv[1]);
116 * Encodes a value including type information. Decode with {@link #decodeValue}.
117 * @param {Mixed} value The value to encode
118 * @return {String} The encoded value
120 encodeValue : function(v){
128 }else if(typeof v == 'number'){
130 }else if(typeof v == 'boolean'){
131 enc = 'b:' + (v ? '1' : '0');
132 }else if(Ext.isDate(v)){
133 enc = 'd:' + v.toGMTString();
134 }else if(Ext.isArray(v)){
135 for(len = v.length; i < len; i++){
136 flat += this.encodeValue(v[i]);
142 }else if(typeof v == 'object'){
144 if(typeof v[key] != 'function' && v[key] !== undefined){
145 flat += key + '=' + this.encodeValue(v[key]) + '^';
148 enc = 'o:' + flat.substring(0, flat.length-1);
156 * @class Ext.state.Manager
157 * This is the global state manager. By default all components that are "state aware" check this class
158 * for state information if you don't pass them a custom state provider. In order for this class
159 * to be useful, it must be initialized with a provider when your application initializes. Example usage:
161 // in your initialization function
163 Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
164 var win = new Window(...);
170 Ext.state.Manager = function(){
171 var provider = new Ext.state.Provider();
175 * Configures the default state provider for your application
176 * @param {Provider} stateProvider The state provider to set
178 setProvider : function(stateProvider){
179 provider = stateProvider;
183 * Returns the current value for a key
184 * @param {String} name The key name
185 * @param {Mixed} defaultValue The default value to return if the key lookup does not match
186 * @return {Mixed} The state data
188 get : function(key, defaultValue){
189 return provider.get(key, defaultValue);
193 * Sets the value for a key
194 * @param {String} name The key name
195 * @param {Mixed} value The state data
197 set : function(key, value){
198 provider.set(key, value);
202 * Clears a value from the state
203 * @param {String} name The key name
205 clear : function(key){
210 * Gets the currently configured state provider
211 * @return {Provider} The state provider
213 getProvider : function(){
219 * @class Ext.state.CookieProvider
220 * @extends Ext.state.Provider
221 * The default Provider implementation which saves state via cookies.
224 var cp = new Ext.state.CookieProvider({
226 expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days
229 Ext.state.Manager.setProvider(cp);
231 * @cfg {String} path The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)
232 * @cfg {Date} expires The cookie expiration date (defaults to 7 days from now)
233 * @cfg {String} domain The domain to save the cookie for. Note that you cannot specify a different domain than
234 * your page is on, but you can specify a sub-domain, or simply the domain itself like 'extjs.com' to include
235 * all sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same
236 * domain the page is running on including the 'www' like 'www.extjs.com')
237 * @cfg {Boolean} secure True if the site is using SSL (defaults to false)
239 * Create a new CookieProvider
240 * @param {Object} config The configuration object
242 Ext.state.CookieProvider = Ext.extend(Ext.state.Provider, {
244 constructor : function(config){
245 Ext.state.CookieProvider.superclass.constructor.call(this);
247 this.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days
250 Ext.apply(this, config);
251 this.state = this.readCookies();
255 set : function(name, value){
256 if(typeof value == "undefined" || value === null){
260 this.setCookie(name, value);
261 Ext.state.CookieProvider.superclass.set.call(this, name, value);
265 clear : function(name){
266 this.clearCookie(name);
267 Ext.state.CookieProvider.superclass.clear.call(this, name);
271 readCookies : function(){
273 c = document.cookie + ";",
274 re = /\s?(.*?)=(.*?);/g,
278 while((matches = re.exec(c)) != null){
281 if(name && name.substring(0,3) == "ys-"){
282 cookies[name.substr(3)] = this.decodeValue(value);
289 setCookie : function(name, value){
290 document.cookie = "ys-"+ name + "=" + this.encodeValue(value) +
291 ((this.expires == null) ? "" : ("; expires=" + this.expires.toGMTString())) +
292 ((this.path == null) ? "" : ("; path=" + this.path)) +
293 ((this.domain == null) ? "" : ("; domain=" + this.domain)) +
294 ((this.secure == true) ? "; secure" : "");
298 clearCookie : function(name){
299 document.cookie = "ys-" + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" +
300 ((this.path == null) ? "" : ("; path=" + this.path)) +
301 ((this.domain == null) ? "" : ("; domain=" + this.domain)) +
302 ((this.secure == true) ? "; secure" : "");