docs/output/Ext.History.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.History-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.History-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.History-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                             <a class="inner-link" href="#Ext.History-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
   7                         <a class="bookmark" href="../docs/?class=Ext.History"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   8         </div>
   9                 <div class="inheritance res-block">
  10 <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
  11   <img src="resources/elbow-end.gif"/>History</pre></div>
  12                 <h1>Class Ext.History</h1>
  13         <table cellspacing="0">
  14             <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
  15             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/History.js" target="_blank">History.js</a></td></tr>
  16             <tr><td class="label">Class:</td><td class="hd-info">History</td></tr>
  17                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
  18                     </table>
  19         <div class="description">
  20             *
  21 History management component that allows you to register arbitrary tokens that signify application
  22 history state on navigation actions.  You can then handle the history <a ext:cls="Ext.History" ext:member="change" href="output/Ext.History.html#change">change</a> event in order
  23 to reset your application UI to the appropriate state when the user navigates forward or backward through
  24 the browser history stack.<br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
  25
  26         <div class="hr"></div>
  27                 <a id="Ext.History-configs"></a>
  28         <h2>Config Options</h2>
  29         <table cellspacing="0" class="member-table">
  30             <tr>
  31                 <th class="sig-header" colspan="2">Config Options</th>
  32                 <th class="msource-header">Defined By</th>
  33             </tr>
  34                 <tr class="config-row inherited expandable">\r
  35         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  36         <td class="sig">\r
  37         <a id="Ext.History-listeners"></a>\r
  38             <b>listeners</b> : Object            <div class="mdesc">\r
  39                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
  40             <div class="long">\r
  41                 (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>\r
  42                         </div>\r
  43         </td>\r
  44         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
  45     </tr>\r
  46             </table>
  47                 <a id="Ext.History-props"></a>
  48         <h2>Public Properties</h2>
  49                 <table cellspacing="0" class="member-table">
  50             <tr>
  51                 <th class="sig-header" colspan="2">Property</th>
  52                 <th class="msource-header">Defined By</th>
  53             </tr>
  54                 <tr class="property-row">\r
  55         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  56         <td class="sig">\r
  57         <a id="Ext.History-fieldId"></a>\r
  58             <b>fieldId</b> : String            <div class="mdesc">\r
  59                             The id of the hidden field required for storing the current history token.                        </div>\r
  60         </td>\r
  61         <td class="msource">History</td>\r
  62     </tr>\r
  63         <tr class="property-row alt">\r
  64         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  65         <td class="sig">\r
  66         <a id="Ext.History-iframeId"></a>\r
  67             <b>iframeId</b> : String            <div class="mdesc">\r
  68                             The id of the iframe required by IE to manage the history stack.                        </div>\r
  69         </td>\r
  70         <td class="msource">History</td>\r
  71     </tr>\r
  72             </table>
  73                 <a id="Ext.History-methods"></a>
  74         <h2>Public Methods</h2>
  75                 <table cellspacing="0" class="member-table">
  76             <tr>
  77                 <th class="sig-header" colspan="2">Method</th>
  78                 <th class="msource-header">Defined By</th>
  79             </tr>
  80                 <tr class="method-row expandable">\r
  81         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  82         <td class="sig">\r
  83         <a id="Ext.History-add"></a>\r
  84             <b>add</b>(&nbsp;<code>String token</code>, <code>Boolean preventDuplicates</code>&nbsp;) : void            <div class="mdesc">\r
  85                         <div class="short">Add a new token to the history stack. This can be any arbitrary value, although it would
  86 commonly be the concatenatio...</div>\r
  87             <div class="long">\r
  88                 Add a new token to the history stack. This can be any arbitrary value, although it would
  89 commonly be the concatenation of a component id and another id marking the specifc history
  90 state of that component.  Example usage:
  91 <pre><code><i>// Handle tab changes on a TabPanel</i>
  92 tabPanel.on(<em>'tabchange'</em>, <b>function</b>(tabPanel, tab){
  93     Ext.History.add(tabPanel.id + <em>':'</em> + tab.id);
  94 });</code></pre>    <div class="mdetail-params">\r
  95         <strong>Parameters:</strong>\r
  96         <ul><li><code>token</code> : String<div class="sub-desc">The value that defines a particular application-specific history state</div></li><li><code>preventDuplicates</code> : Boolean<div class="sub-desc">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).</div></li>        </ul>\r
  99         <strong>Returns:</strong>\r
 100         <ul>\r
 101             <li><code>void</code></li>\r
 102         </ul>\r
 103     </div>\r
 104                 </div>\r
 105                         </div>\r
 106         </td>\r
 107         <td class="msource">History</td>\r
 108     </tr>\r
 109         <tr class="method-row inherited alt expandable">\r
 110         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 111         <td class="sig">\r
 112         <a id="Ext.History-addEvents"></a>\r
 113             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
 114                         <div class="short">Used to define events on this Observable</div>\r
 115             <div class="long">\r
 116                 Used to define events on this Observable    <div class="mdetail-params">\r
 117         <strong>Parameters:</strong>\r
 118         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
 119         <strong>Returns:</strong>\r
 120         <ul>\r
 121             <li><code>void</code></li>\r
 122         </ul>\r
 123     </div>\r
 124                 </div>\r
 125                         </div>\r
 126         </td>\r
 127         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
 128     </tr>\r
 129         <tr class="method-row inherited expandable">\r
 130         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 131         <td class="sig">\r
 132         <a id="Ext.History-addListener"></a>\r
 133             <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 134                         <div class="short">Appends an event handler to this component</div>\r
 135             <div class="long">\r
 136                 Appends an event handler to this component    <div class="mdetail-params">\r
 137         <strong>Parameters:</strong>\r
 138         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
 139 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
 140 properties. This may contain any of the following properties:<ul>
 141 <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
 142 <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
 143 <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
 144 <li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
 145 by the specified number of milliseconds. If the event fires again within that time, the original
 146 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
 147 </ul><br>
 148 <p>
 149 <b>Combining Options</b><br>
 150 Using the options argument, it is possible to combine different types of listeners:<br>
 151 <br>
 152 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
 153 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
 154     single: true,
 155     delay: 100,
 156     forumId: 4
 157 });</code></pre>
 158 <p>
 159 <b>Attaching multiple handlers in 1 call</b><br>
 160 The method also allows for a single argument to be passed which is a config object containing properties
 161 which specify multiple handlers.
 162 <p>
 163 <pre><code>foo.on({
 164     <em>'click'</em> : {
 165         fn: <b>this</b>.onClick,
 166         scope: <b>this</b>,
 167         delay: 100
 168     },
 169     <em>'mouseover'</em> : {
 170         fn: <b>this</b>.onMouseOver,
 171         scope: <b>this</b>
 172     },
 173     <em>'mouseout'</em> : {
 174         fn: <b>this</b>.onMouseOut,
 175         scope: <b>this</b>
 176     }
 177 });</code></pre>
 178 <p>
 179 Or a shorthand syntax:<br>
 180 <pre><code>foo.on({
 181     <em>'click'</em> : <b>this</b>.onClick,
 182     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
 183     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
 184      scope: <b>this</b>
 185 });</code></pre></div></li>        </ul>\r
 186         <strong>Returns:</strong>\r
 187         <ul>\r
 188             <li><code>void</code></li>\r
 189         </ul>\r
 190     </div>\r
 191                 </div>\r
 192                         </div>\r
 193         </td>\r
 194         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
 195     </tr>\r
 196         <tr class="method-row alt expandable">\r
 197         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 198         <td class="sig">\r
 199         <a id="Ext.History-back"></a>\r
 200             <b>back</b>() : void            <div class="mdesc">\r
 201                         <div class="short">Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).</div>\r
 202             <div class="long">\r
 203                 Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).    <div class="mdetail-params">\r
 204         <strong>Parameters:</strong>\r
 205         <ul><li>None.</li>        </ul>\r
 206         <strong>Returns:</strong>\r
 207         <ul>\r
 208             <li><code>void</code></li>\r
 209         </ul>\r
 210     </div>\r
 211                 </div>\r
 212                         </div>\r
 213         </td>\r
 214         <td class="msource">History</td>\r
 215     </tr>\r
 216         <tr class="method-row inherited expandable">\r
 217         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 218         <td class="sig">\r
 219         <a id="Ext.History-fireEvent"></a>\r
 220             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
 221                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
 222             <div class="long">\r
 223                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
 224         <strong>Parameters:</strong>\r
 225         <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>\r
 226         <strong>Returns:</strong>\r
 227         <ul>\r
 228             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
 229         </ul>\r
 230     </div>\r
 231                 </div>\r
 232                         </div>\r
 233         </td>\r
 234         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
 235     </tr>\r
 236         <tr class="method-row alt expandable">\r
 237         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 238         <td class="sig">\r
 239         <a id="Ext.History-forward"></a>\r
 240             <b>forward</b>() : void            <div class="mdesc">\r
 241                         <div class="short">Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).</div>\r
 242             <div class="long">\r
 243                 Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).    <div class="mdetail-params">\r
 244         <strong>Parameters:</strong>\r
 245         <ul><li>None.</li>        </ul>\r
 246         <strong>Returns:</strong>\r
 247         <ul>\r
 248             <li><code>void</code></li>\r
 249         </ul>\r
 250     </div>\r
 251                 </div>\r
 252                         </div>\r
 253         </td>\r
 254         <td class="msource">History</td>\r
 255     </tr>\r
 256         <tr class="method-row expandable">\r
 257         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 258         <td class="sig">\r
 259         <a id="Ext.History-getToken"></a>\r
 260             <b>getToken</b>() : String            <div class="mdesc">\r
 261                         <div class="short">Retrieves the currently-active history token.</div>\r
 262             <div class="long">\r
 263                 Retrieves the currently-active history token.    <div class="mdetail-params">\r
 264         <strong>Parameters:</strong>\r
 265         <ul><li>None.</li>        </ul>\r
 266         <strong>Returns:</strong>\r
 267         <ul>\r
 268             <li><code>String</code><div class="sub-desc">The token</div></li>\r
 269         </ul>\r
 270     </div>\r
 271                 </div>\r
 272                         </div>\r
 273         </td>\r
 274         <td class="msource">History</td>\r
 275     </tr>\r
 276         <tr class="method-row inherited alt expandable">\r
 277         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 278         <td class="sig">\r
 279         <a id="Ext.History-hasListener"></a>\r
 280             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
 281                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
 282             <div class="long">\r
 283                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
 284         <strong>Parameters:</strong>\r
 285         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
 286         <strong>Returns:</strong>\r
 287         <ul>\r
 288             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
 289         </ul>\r
 290     </div>\r
 291                 </div>\r
 292                         </div>\r
 293         </td>\r
 294         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
 295     </tr>\r
 296         <tr class="method-row expandable">\r
 297         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 298         <td class="sig">\r
 299         <a id="Ext.History-init"></a>\r
 300             <b>init</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean onReady</code>]</span>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 301                         <div class="short">Initialize the global History instance.</div>\r
 302             <div class="long">\r
 303                 Initialize the global History instance.    <div class="mdetail-params">\r
 304         <strong>Parameters:</strong>\r
 305         <ul><li><code>onReady</code> : Boolean<div class="sub-desc">(optional) A callback function that will be called once the history
 306 component is fully initialized.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The callback scope</div></li>        </ul>\r
 307         <strong>Returns:</strong>\r
 308         <ul>\r
 309             <li><code>void</code></li>\r
 310         </ul>\r
 311     </div>\r
 312                 </div>\r
 313                         </div>\r
 314         </td>\r
 315         <td class="msource">History</td>\r
 316     </tr>\r
 317         <tr class="method-row inherited alt expandable">\r
 318         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 319         <td class="sig">\r
 320         <a id="Ext.History-on"></a>\r
 321             <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 322                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
 323             <div class="long">\r
 324                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
 325         <strong>Parameters:</strong>\r
 326         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
 327 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
 328         <strong>Returns:</strong>\r
 329         <ul>\r
 330             <li><code>void</code></li>\r
 331         </ul>\r
 332     </div>\r
 333                 </div>\r
 334                         </div>\r
 335         </td>\r
 336         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
 337     </tr>\r
 338         <tr class="method-row inherited expandable">\r
 339         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 340         <td class="sig">\r
 341         <a id="Ext.History-purgeListeners"></a>\r
 342             <b>purgeListeners</b>() : void            <div class="mdesc">\r
 343                         <div class="short">Removes all listeners for this object</div>\r
 344             <div class="long">\r
 345                 Removes all listeners for this object    <div class="mdetail-params">\r
 346         <strong>Parameters:</strong>\r
 347         <ul><li>None.</li>        </ul>\r
 348         <strong>Returns:</strong>\r
 349         <ul>\r
 350             <li><code>void</code></li>\r
 351         </ul>\r
 352     </div>\r
 353                 </div>\r
 354                         </div>\r
 355         </td>\r
 356         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
 357     </tr>\r
 358         <tr class="method-row inherited alt expandable">\r
 359         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 360         <td class="sig">\r
 361         <a id="Ext.History-relayEvents"></a>\r
 362             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
 363                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
 364             <div class="long">\r
 365                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
 366         <strong>Parameters:</strong>\r
 367         <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li>        </ul>\r
 368         <strong>Returns:</strong>\r
 369         <ul>\r
 370             <li><code>void</code></li>\r
 371         </ul>\r
 372     </div>\r
 373                 </div>\r
 374                         </div>\r
 375         </td>\r
 376         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
 377     </tr>\r
 378         <tr class="method-row inherited expandable">\r
 379         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 380         <td class="sig">\r
 381         <a id="Ext.History-removeListener"></a>\r
 382             <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 383                         <div class="short">Removes a listener</div>\r
 384             <div class="long">\r
 385                 Removes a listener    <div class="mdetail-params">\r
 386         <strong>Parameters:</strong>\r
 387         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
 388         <strong>Returns:</strong>\r
 389         <ul>\r
 390             <li><code>void</code></li>\r
 391         </ul>\r
 392     </div>\r
 393                 </div>\r
 394                         </div>\r
 395         </td>\r
 396         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
 397     </tr>\r
 398         <tr class="method-row inherited alt expandable">\r
 399         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 400         <td class="sig">\r
 401         <a id="Ext.History-resumeEvents"></a>\r
 402             <b>resumeEvents</b>() : void            <div class="mdesc">\r
 403                         <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
 404             <div class="long">\r
 405                 Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">\r
 406         <strong>Parameters:</strong>\r
 407         <ul><li>None.</li>        </ul>\r
 408         <strong>Returns:</strong>\r
 409         <ul>\r
 410             <li><code>void</code></li>\r
 411         </ul>\r
 412     </div>\r
 413                 </div>\r
 414                         </div>\r
 415         </td>\r
 416         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
 417     </tr>\r
 418         <tr class="method-row inherited expandable">\r
 419         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 420         <td class="sig">\r
 421         <a id="Ext.History-suspendEvents"></a>\r
 422             <b>suspendEvents</b>() : void            <div class="mdesc">\r
 423                         <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
 424             <div class="long">\r
 425                 Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">\r
 426         <strong>Parameters:</strong>\r
 427         <ul><li>None.</li>        </ul>\r
 428         <strong>Returns:</strong>\r
 429         <ul>\r
 430             <li><code>void</code></li>\r
 431         </ul>\r
 432     </div>\r
 433                 </div>\r
 434                         </div>\r
 435         </td>\r
 436         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
 437     </tr>\r
 438         <tr class="method-row inherited alt expandable">\r
 439         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 440         <td class="sig">\r
 441         <a id="Ext.History-un"></a>\r
 442             <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 443                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
 444             <div class="long">\r
 445                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
 446         <strong>Parameters:</strong>\r
 447         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
 448         <strong>Returns:</strong>\r
 449         <ul>\r
 450             <li><code>void</code></li>\r
 451         </ul>\r
 452     </div>\r
 453                 </div>\r
 454                         </div>\r
 455         </td>\r
 456         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
 457     </tr>\r
 458             </table>
 459                 <a id="Ext.History-events"></a>
 460         <h2>Public Events</h2>
 461         <div class="no-members">This class has no public events.</div>
 462         </div>