X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/source/History.html diff --git a/docs/source/History.html b/docs/source/History.html index e8464b43..56e847b6 100644 --- a/docs/source/History.html +++ b/docs/source/History.html @@ -1,9 +1,44 @@ -Sencha Documentation Project
/**
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
  * @class Ext.util.History
- * History management component that allows you to register arbitrary tokens that signify application
- * history state on navigation actions.  You can then handle the history {@link #change} event in order
- * to reset your application UI to the appropriate state when the user navigates forward or backward through
- * the browser history stack.
+
+History management component that allows you to register arbitrary tokens that signify application
+history state on navigation actions.  You can then handle the history {@link #change} event in order
+to reset your application UI to the appropriate state when the user navigates forward or backward through
+the browser history stack.
+
+__Initializing__
+The {@link #init} method of the History object must be called before using History. This sets up the internal
+state and must be the first thing called before using History.
+
+__Setup__
+The History objects requires elements on the page to keep track of the browser history. For older versions of IE,
+an IFrame is required to do the tracking. For other browsers, a hidden field can be used. The history objects expects
+these to be on the page before the {@link #init} method is called. The following markup is suggested in order
+to support all browsers:
+
+    <form id="history-form" class="x-hide-display">
+        <input type="hidden" id="x-history-field" />
+        <iframe id="x-history-frame"></iframe>
+    </form>
+
+ * @markdown
  * @singleton
  */
 Ext.define('Ext.util.History', {
@@ -121,20 +156,20 @@ Ext.define('Ext.util.History', {
         
     },
 
-    /**
+    /**
      * The id of the hidden field required for storing the current history token.
      * @type String
      * @property
      */
     fieldId: Ext.baseCSSPrefix + 'history-field',
-    /**
+    /**
      * The id of the iframe required by IE to manage the history stack.
      * @type String
      * @property
      */
     iframeId: Ext.baseCSSPrefix + 'history-frame',
 
-    /**
+    /**
      * Initialize the global History instance.
      * @param {Boolean} onReady (optional) A callback function that will be called once the history
      * component is fully initialized.
@@ -162,13 +197,13 @@ Ext.define('Ext.util.History', {
         }
         
         me.addEvents(
-            /**
+            /**
              * @event ready
              * Fires when the Ext.util.History singleton has been initialized and is ready for use.
              * @param {Ext.util.History} The Ext.util.History singleton.
              */
             'ready',
-            /**
+            /**
              * @event change
              * Fires when navigation back or forwards within the local page's history occurs.
              * @param {String} token An identifier associated with the page state at that point in its history.
@@ -182,7 +217,7 @@ Ext.define('Ext.util.History', {
         me.startUp();
     },
 
-    /**
+    /**
      * Add a new token to the history stack. This can be any arbitrary value, although it would
      * commonly be the concatenation of a component id and another id marking the specifc history
      * state of that component.  Example usage:
@@ -214,25 +249,27 @@ Ext.History.add(tabPanel.id + ':' + tab.id);
         }
     },
 
-    /**
+    /**
      * Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).
      */
     back: function() {
         window.history.go(-1);
     },
 
-    /**
+    /**
      * Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).
      */
     forward: function(){
         window.history.go(1);
     },
 
-    /**
+    /**
      * Retrieves the currently-active history token.
      * @return {String} The token
      */
     getToken: function() {
         return this.ready ? this.currentToken : this.getHash();
     }
-});

\ No newline at end of file
+});
+ +