docs/api/Ext.util.History.html

   1 <!DOCTYPE html><html><head><title>Ext.util.History | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.util.History',
  13         docClass: 'Ext.util.History',
  14         docReq: 'Ext.util.History',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'History.html#Ext-util.History';
  33     clsInfo = {"methods":["add","addEvents","addListener","addManagedListener","back","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","forward","getToken","hasListener","init","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","suspendEvents","un"],"cfgs":["listeners"],"properties":["fieldId","iframeId"],"events":["change","ready"],"subclasses":[]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/History.html#Ext-util.History" target="_blank">Ext.util.History</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>History management component that allows you to register arbitrary tokens that signify application
  38 history state on navigation actions.  You can then handle the history <a href="Ext.util.History.html#change" rel="Ext.util.History#change" class="docClass">change</a> event in order
  39 to reset your application UI to the appropriate state when the user navigates forward or backward through
  40 the browser history stack.</p>
  41 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-listeners" class="member f inherited"><a href="Ext.util.History.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.util.History.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
  42 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
  43 object during initialization.  This should be a valid listeners config object as specified in the
  44 <a href="Ext.util.History.html#addListener" rel="Ext.util.History#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
  45
  46 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
  47
  48
  49 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
  50
  51
  52 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
  53 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
  54 events directly from a child element of a Component, we need to specify the <code>element</code> option to
  55 identify the Component property to add a DOM listener to:</p>
  56
  57 <pre><code>new Ext.panel.Panel({
  58     width: 400,
  59     height: 200,
  60     dockedItems: [{
  61         xtype: 'toolbar'
  62     }],
  63     listeners: {
  64         click: {
  65             element: 'el', //bind to the underlying el property on the panel
  66             fn: function(){ console.log('click el'); }
  67         },
  68         dblclick: {
  69             element: 'body', //bind to the underlying body property on the panel
  70             fn: function(){ console.log('dblclick body'); }
  71         }
  72     }
  73 });
  74 </code></pre>
  75
  76
  77 <p></p></p>
  78 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-fieldId" class="member f ni"><a href="Ext.util.History.html#property-fieldId" rel="property-fieldId" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-property-fieldId" class="viewSource">view source</a></div><a name="fieldId"></a><a name="property-fieldId"></a><a href="Ext.util.History.html#" rel="property-fieldId" class="cls expand">fieldId</a><span> : String</span></div><div class="description"><div class="short"><p>The id of the hidden field required for storing the current history token.</p>
  79 </div><div class="long"><p>The id of the hidden field required for storing the current history token.</p>
  80 </div></div></div><div id="property-iframeId" class="member ni"><a href="Ext.util.History.html#property-iframeId" rel="property-iframeId" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-property-iframeId" class="viewSource">view source</a></div><a name="iframeId"></a><a name="property-iframeId"></a><a href="Ext.util.History.html#" rel="property-iframeId" class="cls expand">iframeId</a><span> : String</span></div><div class="description"><div class="short"><p>The id of the iframe required by IE to manage the history stack.</p>
  81 </div><div class="long"><p>The id of the iframe required by IE to manage the history stack.</p>
  82 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-add" class="member f ni"><a href="Ext.util.History.html#method-add" rel="method-add" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-method-add" class="viewSource">view source</a></div><a name="add"></a><a name="method-add"></a><a href="Ext.util.History.html#" rel="method-add" class="cls expand">add</a>(
  83 <span class="pre">String token, Boolean preventDuplicates</span>)
  84  : void</div><div class="description"><div class="short">Add a new token to the history stack. This can be any arbitrary value, although it would
  85 commonly be the concatenatio...</div><div class="long"><p>Add a new token to the history stack. This can be any arbitrary value, although it would
  86 commonly be the concatenation of a component id and another id marking the specifc history
  87 state of that component.  Example usage:</p>
  88
  89 <pre><code>// Handle tab changes on a TabPanel
  90 tabPanel.on('tabchange', function(tabPanel, tab){
  91 Ext.History.add(tabPanel.id + ':' + tab.id);
  92 });
  93 </code></pre>
  94
  95 <h3 class="pa">Parameters</h3><ul><li><span class="pre">token</span> : String<div class="sub-desc"><p>The value that defines a particular application-specific history state</p>
  96 </div></li><li><span class="pre">preventDuplicates</span> : Boolean<div class="sub-desc"><p>When true, if the passed token matches the current token
  97 it will not save a new history step. Set to false if the same state can be saved more than once
  98 at the same history stack location (defaults to true).</p>
  99 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 100 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.util.History.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.util.History.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
 101 <span class="pre">Object/String o, String </span>)
 102  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
 103 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
 104 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
 105 or the first event name string if multiple event names are being passed as separate parameters.</p>
 106 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
 107 Usage:</p>
 108
 109 <pre><code>this.addEvents('storeloaded', 'storecleared');
 110 </code></pre>
 111
 112 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 113 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.util.History.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.util.History.html#" rel="method-addListener" class="cls expand">addListener</a>(
 114 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
 115  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
 116 </div><div class="long"><p>Appends an event handler to this object.</p>
 117 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
 118 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
 119 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 120 <b>If omitted, defaults to the object which fired the event.</b></p>
 121 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
 122 properties. This may contain any of the following properties:<ul>
 123 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 124 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 125 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
 126 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
 127 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
 128 by the specified number of milliseconds. If the event fires again within that time, the original
 129 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 130 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
 131 if the event was bubbled up from a child Observable.</div></li>
 132 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
 133 The name of a Component property which references an element to add a listener to.</p>
 134
 135 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
 136 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
 137 <pre><code>new Ext.panel.Panel({
 138     title: 'The title',
 139     listeners: {
 140         click: this.handlePanelClick,
 141         element: 'body'
 142     }
 143 });
 144 </code></pre></p>
 145
 146
 147 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
 148
 149
 150 <p></div></li>
 151 </ul><br></p>
 152
 153 <p>
 154 <b>Combining Options</b><br>
 155 Using the options argument, it is possible to combine different types of listeners:<br>
 156 <br>
 157 A delayed, one-time listener.
 158 <pre><code>myPanel.on('hide', this.handleClick, this, {
 159 single: true,
 160 delay: 100
 161 });</code></pre>
 162 <p>
 163 <b>Attaching multiple handlers in 1 call</b><br>
 164 The method also allows for a single argument to be passed which is a config object containing properties
 165 which specify multiple events. For example:
 166 <pre><code>myGridPanel.on({
 167     cellClick: this.onCellClick,
 168     mouseover: this.onMouseOver,
 169     mouseout: this.onMouseOut,
 170     scope: this // Important. Ensure "this" is correct during handler execution
 171 });
 172 </code></pre>.
 173 <p>
 174
 175 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 176 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.util.History.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.util.History.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
 177 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
 178  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
 179 is destroyed.
 180
 181 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
 182 is destroyed.
 183
 184 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
 185 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
 186 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 187 is the handler function.</p>
 188 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 189 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
 190 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 191 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
 192 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 193 </li></ul></div></div></div><div id="method-back" class="member ni"><a href="Ext.util.History.html#method-back" rel="method-back" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-method-back" class="viewSource">view source</a></div><a name="back"></a><a name="method-back"></a><a href="Ext.util.History.html#" rel="method-back" class="cls expand">back</a> : void</div><div class="description"><div class="short"><p>Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).</p>
 194 </div><div class="long"><p>Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).</p>
 195 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 196 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.util.History.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.util.History.html#" rel="method-capture" class="cls expand">capture</a>(
 197 <span class="pre">Observable o, Function fn, [Object scope]</span>)
 198  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
 199 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
 200 to the supplied function with the event name + standard signature of the event
 201 <b>before</b> the event is fired. If the supplied function returns false,
 202 the event will not fire.</p>
 203 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
 204 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
 205 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
 206 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 207 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.util.History.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.util.History.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
 208 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
 209 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 210 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.util.History.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.util.History.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
 211 </div><div class="long"><p>Removes all managed listeners for this object.</p>
 212 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 213 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.util.History.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.util.History.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
 214 <span class="pre">String/Array events</span>)
 215  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
 216 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
 217 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
 218
 219
 220 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
 221 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
 222 access the required target more quickly.</p>
 223
 224
 225 <p>Example:</p>
 226
 227
 228 <pre><code>Ext.override(Ext.form.field.Base, {
 229 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
 230 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
 231     this.enableBubble('change');
 232 }),
 233
 234 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
 235 getBubbleTarget : function() {
 236     if (!this.formPanel) {
 237         this.formPanel = this.findParentByType('form');
 238     }
 239     return this.formPanel;
 240 }
 241 });
 242
 243 var myForm = new Ext.formPanel({
 244 title: 'User Details',
 245 items: [{
 246     ...
 247 }],
 248 listeners: {
 249     change: function() {
 250         // Title goes red if form has been modified.
 251         myForm.header.setStyle('color', 'red');
 252     }
 253 }
 254 });
 255 </code></pre>
 256
 257 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
 258 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 259 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.util.History.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.util.History.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
 260 <span class="pre">String eventName, Object... args</span>)
 261  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 262
 263
 264 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
 265
 266
 267 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
 268 by calling <a href="Ext.util.History.html#enableBubble" rel="Ext.util.History#enableBubble" class="docClass">enableBubble</a>.</p>
 269
 270 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
 271 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
 272 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
 273 </li></ul></div></div></div><div id="method-forward" class="member ni"><a href="Ext.util.History.html#method-forward" rel="method-forward" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-method-forward" class="viewSource">view source</a></div><a name="forward"></a><a name="method-forward"></a><a href="Ext.util.History.html#" rel="method-forward" class="cls expand">forward</a> : void</div><div class="description"><div class="short"><p>Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).</p>
 274 </div><div class="long"><p>Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).</p>
 275 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 276 </li></ul></div></div></div><div id="method-getToken" class="member ni"><a href="Ext.util.History.html#method-getToken" rel="method-getToken" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-method-getToken" class="viewSource">view source</a></div><a name="getToken"></a><a name="method-getToken"></a><a href="Ext.util.History.html#" rel="method-getToken" class="cls expand">getToken</a> : String</div><div class="description"><div class="short"><p>Retrieves the currently-active history token.</p>
 277 </div><div class="long"><p>Retrieves the currently-active history token.</p>
 278 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The token</p>
 279 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.util.History.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.util.History.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
 280 <span class="pre">String eventName</span>)
 281  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
 282 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
 283 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
 284 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
 285 </li></ul></div></div></div><div id="method-init" class="member ni"><a href="Ext.util.History.html#method-init" rel="method-init" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-method-init" class="viewSource">view source</a></div><a name="init"></a><a name="method-init"></a><a href="Ext.util.History.html#" rel="method-init" class="cls expand">init</a>(
 286 <span class="pre">[Boolean onReady], [Object scope]</span>)
 287  : void</div><div class="description"><div class="short"><p>Initialize the global History instance.</p>
 288 </div><div class="long"><p>Initialize the global History instance.</p>
 289 <h3 class="pa">Parameters</h3><ul><li><span class="pre">onReady</span> : Boolean<div class="sub-desc"><p>(optional) A callback function that will be called once the history
 290 component is fully initialized.</p>
 291 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser window.</p>
 292 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 293 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.util.History.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.util.History.html#" rel="method-observe" class="cls expand">observe</a>(
 294 <span class="pre">Function c, Object listeners</span>)
 295  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
 296
 297 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
 298
 299 <p>This makes any event fired on any instance of the passed class also fire a single event through
 300 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
 301
 302 <p>Usage:</p>
 303
 304 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
 305 Ext.data.Connection.on('beforerequest', function(con, options) {
 306     console.log('Ajax request made to ' + options.url);
 307 });
 308 </code></pre>
 309 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
 310 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.util.History.html#addListener" rel="Ext.util.History#addListener" class="docClass">addListener</a>.</p>
 311 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 312 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.util.History.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.util.History.html#" rel="method-on" class="cls expand">on</a>(
 313 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
 314  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.util.History.html#addListener" rel="Ext.util.History#addListener" class="docClass">addListener</a>.)</p>
 315 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.util.History.html#addListener" rel="Ext.util.History#addListener" class="docClass">addListener</a>.)</p>
 316 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
 317 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
 318 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 319 <b>If omitted, defaults to the object which fired the event.</b></p>
 320 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
 321 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 322 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.util.History.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.util.History.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
 323 <span class="pre">Object origin, Array events, Object prefix</span>)
 324  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
 325 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
 326 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
 327 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
 328 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
 329 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 330 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.util.History.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.util.History.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
 331 <span class="pre">Observable o</span>)
 332  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
 333 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
 334 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
 335 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 336 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.util.History.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.util.History.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
 337 <span class="pre">String eventName, Function handler, [Object scope]</span>)
 338  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
 339 </div><div class="long"><p>Removes an event handler.</p>
 340 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
 341 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.util.History.html#addListener" rel="Ext.util.History#addListener" class="docClass">addListener</a> call.</b></p>
 342 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
 343 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 344 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.util.History.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.util.History.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
 345 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
 346  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.util.History.html#mon" rel="Ext.util.History#mon" class="docClass">mon</a> method.</p>
 347 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.util.History.html#mon" rel="Ext.util.History#mon" class="docClass">mon</a> method.</p>
 348 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
 349 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
 350 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 351 is the handler function.</p>
 352 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 353 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
 354 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 355 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.util.History.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.util.History.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
 356 If events were suspended using the queueSuspended parameter, then all
 357 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.util.History.html#suspendEvents" rel="Ext.util.History#suspendEvents" class="docClass">suspendEvents</a>)
 358 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
 359 events fired during event suspension will be sent to any listeners now.</p>
 360 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 361 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.util.History.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.util.History.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
 362 <span class="pre">Boolean queueSuspended</span>)
 363  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.util.History.html#resumeEvents" rel="Ext.util.History#resumeEvents" class="docClass">resumeEvents</a>)</p>
 364 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.util.History.html#resumeEvents" rel="Ext.util.History#resumeEvents" class="docClass">resumeEvents</a>)</p>
 365 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
 366 after the <a href="Ext.util.History.html#resumeEvents" rel="Ext.util.History#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
 367 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 368 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.util.History.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.util.History.html#" rel="method-un" class="cls expand">un</a>(
 369 <span class="pre">String eventName, Function handler, [Object scope]</span>)
 370  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.util.History.html#removeListener" rel="Ext.util.History#removeListener" class="docClass">removeListener</a>.)</p>
 371 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.util.History.html#removeListener" rel="Ext.util.History#removeListener" class="docClass">removeListener</a>.)</p>
 372 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
 373 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.util.History.html#addListener" rel="Ext.util.History#addListener" class="docClass">addListener</a> call.</b></p>
 374 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
 375 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 376 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-change" class="member f ni"><a href="Ext.util.History.html#event-change" rel="event-change" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-event-change" class="viewSource">view source</a></div><a name="change"></a><a name="event-change"></a><a href="Ext.util.History.html#" rel="event-change" class="cls expand">change</a>(
 377 <span class="pre">String token</span>)
 378 </div><div class="description"><div class="short"><p>Fires when navigation back or forwards within the local page's history occurs.</p>
 379 </div><div class="long"><p>Fires when navigation back or forwards within the local page's history occurs.</p>
 380 <h3 class="pa">Parameters</h3><ul><li><span class="pre">token</span> : String<div class="sub-desc"><p>An identifier associated with the page state at that point in its history.</p>
 381 </div></li></ul></div></div></div><div id="event-ready" class="member ni"><a href="Ext.util.History.html#event-ready" rel="event-ready" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.History.html" class="definedIn docClass">Ext.util.History</a><br/><a href="../source/History.html#Ext-util.History-event-ready" class="viewSource">view source</a></div><a name="ready"></a><a name="event-ready"></a><a href="Ext.util.History.html#" rel="event-ready" class="cls expand">ready</a>(
 382 <span class="pre">Ext.util.History The</span>)
 383 </div><div class="description"><div class="short"><p>Fires when the <a href="Ext.util.History.html" rel="Ext.util.History" class="docClass">Ext.util.History</a> singleton has been initialized and is ready for use.</p>
 384 </div><div class="long"><p>Fires when the <a href="Ext.util.History.html" rel="Ext.util.History" class="docClass">Ext.util.History</a> singleton has been initialized and is ready for use.</p>
 385 <h3 class="pa">Parameters</h3><ul><li><span class="pre">The</span> : Ext.util.History<div class="sub-desc"><p>Ext.util.History singleton.</p>
 386 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>