git.roojs.org Git - roojs1/blob - docs/src/Roo_state_Manager.js.html

   1 <html><head><title>Roo/state/Manager.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * &lt;script type=&quot;text/javascript&quot;&gt;
  10  */
  11 /**
  12  * @class Roo.state.Manager
  13  * This is the global state manager. By default all components that are &quot;state aware&quot; check this class
  14  * for state information if you don't pass them a custom state provider. In order for this class
  15  * to be useful, it must be initialized with a provider when your application initializes.
  16  &lt;pre&gt;&lt;code&gt;
  17 // in your initialization function
  18 init : function(){
  19    Roo.state.Manager.setProvider(new Roo.state.CookieProvider());
  20    ...
  21    // supposed you have a {@link Roo.BorderLayout}
  22    var layout = new Roo.BorderLayout(...);
  23    layout.restoreState();
  24    // or a {Roo.BasicDialog}
  25    var dialog = new Roo.BasicDialog(...);
  26    dialog.restoreState();
  27  &lt;/code&gt;&lt;/pre&gt;
  28  * @singleton
  29  */
  30 </span><span class="jsdoc-var">Roo.state.Manager </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  31     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">provider </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">new </span><span class="jsdoc-var">Roo.state.Provider</span><span class="jsdoc-syntax">();
  32
  33     </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
  34         </span><span class="jsdoc-comment">/**
  35          * Configures the default state provider for your application
  36          * @param {Provider} stateProvider The state provider to set
  37          */
  38         </span><span class="jsdoc-var">setProvider </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">stateProvider</span><span class="jsdoc-syntax">){
  39             </span><span class="jsdoc-var">provider </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">stateProvider</span><span class="jsdoc-syntax">;
  40         },
  41
  42         </span><span class="jsdoc-comment">/**
  43          * Returns the current value for a key
  44          * @param {String} name The key name
  45          * @param {Mixed} defaultValue The default value to return if the key lookup does not match
  46          * @return {Mixed} The state data
  47          */
  48         </span><span class="jsdoc-var">get </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">key</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">defaultValue</span><span class="jsdoc-syntax">){
  49             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">provider.get</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">key</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">defaultValue</span><span class="jsdoc-syntax">);
  50         },
  51
  52         </span><span class="jsdoc-comment">/**
  53          * Sets the value for a key
  54          * @param {String} name The key name
  55          * @param {Mixed} value The state data
  56          */
  57          </span><span class="jsdoc-var">set </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">key</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">value</span><span class="jsdoc-syntax">){
  58             </span><span class="jsdoc-var">provider.set</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">key</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">value</span><span class="jsdoc-syntax">);
  59         },
  60
  61         </span><span class="jsdoc-comment">/**
  62          * Clears a value from the state
  63          * @param {String} name The key name
  64          */
  65         </span><span class="jsdoc-var">clear </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">key</span><span class="jsdoc-syntax">){
  66             </span><span class="jsdoc-var">provider.clear</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">key</span><span class="jsdoc-syntax">);
  67         },
  68
  69         </span><span class="jsdoc-comment">/**
  70          * Gets the currently configured state provider
  71          * @return {Provider} The state provider
  72          */
  73         </span><span class="jsdoc-var">getProvider </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  74             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">provider</span><span class="jsdoc-syntax">;
  75         }
  76     };
  77 }();
  78 </span></code></body></html>