/*
|
This file is part of Ext JS 4.2
|
|
Copyright (c) 2011-2013 Sencha Inc
|
|
Contact: http://www.sencha.com/contact
|
|
GNU General Public License Usage
|
This file may be used under the terms of the GNU General Public License version 3.0 as
|
published by the Free Software Foundation and appearing in the file LICENSE included in the
|
packaging of this file.
|
|
Please review the following information to ensure the GNU General Public License version 3.0
|
requirements will be met: http://www.gnu.org/copyleft/gpl.html.
|
|
If you are unsure which license is appropriate for your use, please contact the sales department
|
at http://www.sencha.com/contact.
|
|
Build date: 2013-05-16 14:36:50 (f9be68accb407158ba2b1be2c226a6ce1f649314)
|
*/
|
/**
|
* @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());
|
}
|
</code></pre>
|
* This class passes on calls from components to the underlying {@link Ext.state.Provider} so that
|
* there is a common interface that can be used without needing to refer to a specific provider instance
|
* in every component.
|
* @singleton
|
* @docauthor Evan Trimboli <evan@sencha.com>
|
*/
|
Ext.define('Ext.state.Manager', {
|
singleton: true,
|
requires: ['Ext.state.Provider'],
|
constructor: function() {
|
this.provider = new Ext.state.Provider();
|
},
|
|
|
/**
|
* Configures the default state provider for your application
|
* @param {Ext.state.Provider} stateProvider The state provider to set
|
*/
|
setProvider : function(stateProvider){
|
this.provider = stateProvider;
|
},
|
|
/**
|
* Returns the current value for a key
|
* @param {String} name The key name
|
* @param {Object} defaultValue The default value to return if the key lookup does not match
|
* @return {Object} The state data
|
*/
|
get : function(key, defaultValue){
|
return this.provider.get(key, defaultValue);
|
},
|
|
/**
|
* Sets the value for a key
|
* @param {String} name The key name
|
* @param {Object} value The state data
|
*/
|
set : function(key, value){
|
this.provider.set(key, value);
|
},
|
|
/**
|
* Clears a value from the state
|
* @param {String} name The key name
|
*/
|
clear : function(key){
|
this.provider.clear(key);
|
},
|
|
/**
|
* Gets the currently configured state provider
|
* @return {Ext.state.Provider} The state provider
|
*/
|
getProvider : function(){
|
return this.provider;
|
}
|
});
|
