docs/source/Manager4.html

   1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-state.Manager'>/**
   2 </span> * @class Ext.state.Manager
   3  * This is the global state manager. By default all components that are &quot;state aware&quot; check this class
   4  * for state information if you don't pass them a custom state provider. In order for this class
   5  * to be useful, it must be initialized with a provider when your application initializes. Example usage:
   6  &lt;pre&gt;&lt;code&gt;
   7 // in your initialization function
   8 init : function(){
   9    Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
  10    var win = new Window(...);
  11    win.restoreState();
  12 }
  13  &lt;/code&gt;&lt;/pre&gt;
  14  * This class passes on calls from components to the underlying {@link Ext.state.Provider} so that
  15  * there is a common interface that can be used without needing to refer to a specific provider instance
  16  * in every component.
  17  * @singleton
  18  * @docauthor Evan Trimboli &lt;evan@sencha.com&gt;
  19  */
  20 Ext.define('Ext.state.Manager', {
  21     singleton: true,
  22     requires: ['Ext.state.Provider'],
  23     constructor: function() {
  24         this.provider = Ext.create('Ext.state.Provider');
  25     },
  26
  27
  28 <span id='Ext-state.Manager-method-setProvider'>    /**
  29 </span>     * Configures the default state provider for your application
  30      * @param {Provider} stateProvider The state provider to set
  31      */
  32     setProvider : function(stateProvider){
  33         this.provider = stateProvider;
  34     },
  35
  36 <span id='Ext-state.Manager-method-get'>    /**
  37 </span>     * Returns the current value for a key
  38      * @param {String} name The key name
  39      * @param {Mixed} defaultValue The default value to return if the key lookup does not match
  40      * @return {Mixed} The state data
  41      */
  42     get : function(key, defaultValue){
  43         return this.provider.get(key, defaultValue);
  44     },
  45
  46 <span id='Ext-state.Manager-method-set'>    /**
  47 </span>     * Sets the value for a key
  48      * @param {String} name The key name
  49      * @param {Mixed} value The state data
  50      */
  51      set : function(key, value){
  52         this.provider.set(key, value);
  53     },
  54
  55 <span id='Ext-state.Manager-method-clear'>    /**
  56 </span>     * Clears a value from the state
  57      * @param {String} name The key name
  58      */
  59     clear : function(key){
  60         this.provider.clear(key);
  61     },
  62
  63 <span id='Ext-state.Manager-method-getProvider'>    /**
  64 </span>     * Gets the currently configured state provider
  65      * @return {Provider} The state provider
  66      */
  67     getProvider : function(){
  68         return this.provider;
  69     }
  70 });</pre></pre></body></html>