Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / src / state / Provider.js
index f7bccde..81536fb 100644 (file)
@@ -1,3 +1,17 @@
+/*
+
+This file is part of Ext JS 4
+
+Copyright (c) 2011 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.
+
+*/
 /**
  * @class Ext.state.Provider
  * <p>Abstract base class for state provider implementations. The provider is responsible
@@ -28,7 +42,7 @@ Ext.define('Ext.state.Provider', {
         /**
          * @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
          */
@@ -40,8 +54,8 @@ Ext.define('Ext.state.Provider', {
     /**
      * 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] == "undefined" ?
@@ -61,7 +75,7 @@ Ext.define('Ext.state.Provider', {
     /**
      * 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;
@@ -72,7 +86,7 @@ Ext.define('Ext.state.Provider', {
     /**
      * 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){
 
@@ -131,7 +145,7 @@ Ext.define('Ext.state.Provider', {
 
     /**
      * 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 +183,4 @@ Ext.define('Ext.state.Provider', {
         }
         return escape(enc);
     }
-});
\ No newline at end of file
+});