X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..HEAD:/docs/source/Provider2.html?ds=inline diff --git a/docs/source/Provider2.html b/docs/source/Provider2.html index feb1bcfd..48605b3d 100644 --- a/docs/source/Provider2.html +++ b/docs/source/Provider2.html @@ -1,4 +1,21 @@ -
/**
+
+
+
+
+ The source code
+
+
+
+
+
+
+ /**
* @class Ext.state.Provider
* <p>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'
},
- /**
+ /**
* @cfg {String} prefix A string to prefix to items stored in the underlying state store.
* Defaults to <tt>'ext-'</tt>
*/
@@ -25,10 +42,10 @@ Ext.define('Ext.state.Provider', {
config = config || {};
var me = this;
Ext.apply(me, config);
- /**
+ /**
* @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);
},
- /**
+ /**
* 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" ?
defaultValue : this.state[name];
},
- /**
+ /**
* Clears a value from the state
* @param {String} name The key name
*/
@@ -58,10 +75,10 @@ Ext.define('Ext.state.Provider', {
me.fireEvent("statechange", me, name, null);
},
- /**
+ /**
* 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("statechange", me, name, value);
},
- /**
+ /**
* 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', {
}
},
- /**
+ /**
* 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);
}
-});
\ No newline at end of file
+});
+
+