Upgrade to ExtJS 4.0.7 - Released 10/19/2011

[extjs.git] / docs / source / Provider2.html
diff --git a/docs/source/Provider2.html b/docs/source/Provider2.html

index feb1bcf..48605b3 100644 (file)
--- a/docs/source/Provider2.html
+++ b/docs/source/Provider2.html
@@ -1,4 +1,21 @@
-<!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.Provider'>/**
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-state-Provider'>/**
  </span> * @class Ext.state.Provider
   * &lt;p&gt;Abstract base class for state provider implementations. The provider is responsible
   * for setting values  and extracting values to/from the underlying storage source. The 
@@ -15,7 +32,7 @@ Ext.define('Ext.state.Provider', {
          observable: 'Ext.util.Observable'
      },
      
-<span id='Ext-state.Provider-cfg-prefix'>    /**
+<span id='Ext-state-Provider-cfg-prefix'>    /**
  </span>     * @cfg {String} prefix A string to prefix to items stored in the underlying state store. 
       * Defaults to &lt;tt&gt;'ext-'&lt;/tt&gt;
       */
@@ -25,10 +42,10 @@ Ext.define('Ext.state.Provider', {
          config = config || {};
          var me = this;
          Ext.apply(me, config);
-<span id='Ext-state.Provider-event-statechange'>        /**
+<span id='Ext-state-Provider-event-statechange'>        /**
  </span>         * @event statechange
           * Fires when a state change occurs.
-         * @param {Provider} this This state provider
+         * @param {Ext.state.Provider} this This state provider
           * @param {String} key The state key which was changed
           * @param {String} value The encoded value for the state
           */
@@ -37,18 +54,18 @@ Ext.define('Ext.state.Provider', {
          me.mixins.observable.constructor.call(me);
      },
      
-<span id='Ext-state.Provider-method-get'>    /**
+<span id='Ext-state-Provider-method-get'>    /**
  </span>     * Returns the current value for a key
       * @param {String} name The key name
-     * @param {Mixed} defaultValue A default value to return if the key's value is not found
-     * @return {Mixed} The state data
+     * @param {Object} defaultValue A default value to return if the key's value is not found
+     * @return {Object} The state data
       */
      get : function(name, defaultValue){
          return typeof this.state[name] == &quot;undefined&quot; ?
              defaultValue : this.state[name];
      },
  
-<span id='Ext-state.Provider-method-clear'>    /**
+<span id='Ext-state-Provider-method-clear'>    /**
  </span>     * Clears a value from the state
       * @param {String} name The key name
       */
@@ -58,10 +75,10 @@ Ext.define('Ext.state.Provider', {
          me.fireEvent(&quot;statechange&quot;, me, name, null);
      },
  
-<span id='Ext-state.Provider-method-set'>    /**
+<span id='Ext-state-Provider-method-set'>    /**
  </span>     * Sets the value for a key
       * @param {String} name The key name
-     * @param {Mixed} value The value to set
+     * @param {Object} value The value to set
       */
      set : function(name, value){
          var me = this;
@@ -69,10 +86,10 @@ Ext.define('Ext.state.Provider', {
          me.fireEvent(&quot;statechange&quot;, me, name, value);
      },
  
-<span id='Ext-state.Provider-method-decodeValue'>    /**
+<span id='Ext-state-Provider-method-decodeValue'>    /**
  </span>     * Decodes a string previously encoded with {@link #encodeValue}.
       * @param {String} value The value to decode
-     * @return {Mixed} The decoded value
+     * @return {Object} The decoded value
       */
      decodeValue : function(value){
  
@@ -129,9 +146,9 @@ Ext.define('Ext.state.Provider', {
          }
      },
  
-<span id='Ext-state.Provider-method-encodeValue'>    /**
+<span id='Ext-state-Provider-method-encodeValue'>    /**
  </span>     * Encodes a value including type information.  Decode with {@link #decodeValue}.
-     * @param {Mixed} value The value to encode
+     * @param {Object} value The value to encode
       * @return {String} The encoded value
       */
      encodeValue : function(value){
@@ -169,4 +186,6 @@ Ext.define('Ext.state.Provider', {
          }
          return escape(enc);
      }
-});</pre></pre></body></html>
-\ No newline at end of file
+});</pre>
+</body>
+</html>