X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/source/Stateful.html diff --git a/docs/source/Stateful.html b/docs/source/Stateful.html index b08248a6..4a5d7df3 100644 --- a/docs/source/Stateful.html +++ b/docs/source/Stateful.html @@ -1,4 +1,21 @@ -Sencha Documentation Project
/**
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
  * @class Ext.state.Stateful
  * A mixin for being able to save the state of an object to an underlying 
  * {@link Ext.state.Provider}.
@@ -15,7 +32,7 @@ Ext.define('Ext.state.Stateful', {
     
     /* End Definitions */
     
-    /**
+    /**
      * @cfg {Boolean} stateful
      * <p>A flag which causes the object to attempt to restore the state of
      * internal properties from a saved state on startup. The object must have
@@ -55,13 +72,13 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
      */
     stateful: true,
     
-    /**
+    /**
      * @cfg {String} stateId
      * The unique id for this object to use for state management purposes.
      * <p>See {@link #stateful} for an explanation of saving and restoring state.</p>
      */
     
-    /**
+    /**
      * @cfg {Array} stateEvents
      * <p>An array of events that, when fired, should trigger this object to
      * save its state (defaults to none). <code>stateEvents</code> may be any type
@@ -71,7 +88,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
      * restoring object state.</p>
      */
     
-    /**
+    /**
      * @cfg {Number} saveBuffer A buffer to be applied if many state events are fired within
      * a short period. Defaults to 100.
      */
@@ -98,7 +115,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
             me.stateEvents.concat(config.stateEvents);
         }
         this.addEvents(
-            /**
+            /**
              * @event beforestaterestore
              * Fires before the state of the object is restored. Return false from an event handler to stop the restore.
              * @param {Ext.state.Stateful} this
@@ -109,7 +126,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
              */
             'beforestaterestore',
             
-            /**
+            /**
              * @event staterestore
              * Fires after the state of the object is restored.
              * @param {Ext.state.Stateful} this
@@ -119,7 +136,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
              */
             'staterestore',
             
-            /**
+            /**
              * @event beforestatesave
              * Fires before the state of the object is saved to the configured state provider. Return false to stop the save.
              * @param {Ext.state.Stateful} this
@@ -130,7 +147,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
              */
             'beforestatesave',
             
-            /**
+            /**
              * @event statesave
              * Fires after the state of the object is saved to the configured state provider.
              * @param {Ext.state.Stateful} this
@@ -148,7 +165,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         }
     },
     
-    /**
+    /**
      * Initializes any state events for this object.
      * @private
      */
@@ -156,7 +173,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         this.addStateEvents(this.stateEvents);
     },
     
-    /**
+    /**
      * Add events that will trigger the state to be saved.
      * @param {String/Array} events The event name or an array of event names.
      */
@@ -174,7 +191,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         }
     },
     
-    /**
+    /**
      * This method is called when any of the {@link #stateEvents} are fired.
      * @private
      */
@@ -192,7 +209,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         }
     },
     
-    /**
+    /**
      * Saves the state of the object to the persistence store.
      * @private
      */
@@ -213,7 +230,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         }
     },
     
-    /**
+    /**
      * Gets the current state of the object. By default this function returns null,
      * it should be overridden in subclasses to implement methods for getting the state.
      * @return {Object} The current state
@@ -222,7 +239,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         return null;    
     },
     
-    /**
+    /**
      * Applies the state to the object. This should be overridden in subclasses to do
      * more complex state operations. By default it applies the state properties onto
      * the current object.
@@ -234,7 +251,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         }
     },
     
-    /**
+    /**
      * Gets the state id for this object.
      * @return {String} The state id, null if not found.
      */
@@ -248,7 +265,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         return id;
     },
     
-    /**
+    /**
      * Initializes the state of the object upon construction.
      * @private
      */
@@ -271,7 +288,7 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
         }
     },
     
-    /**
+    /**
      * Destroys this stateful object.
      */
     destroy: function(){
@@ -284,4 +301,6 @@ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
     }
     
 });
-

\ No newline at end of file
+
+ +