docs/output/Ext.util.History.js

   1 Ext.data.JsonP.Ext_util_History({
   2   "tagname": "class",
   3   "name": "Ext.util.History",
   4   "doc": "<p>History management component that allows you to register arbitrary tokens that signify application\nhistory state on navigation actions.  You can then handle the history <a href=\"#/api/Ext.util.History-event-change\" rel=\"Ext.util.History-event-change\" class=\"docClass\">change</a> event in order\nto reset your application UI to the appropriate state when the user navigates forward or backward through\nthe browser history stack.</p>\n\n<p><strong>Initializing</strong>\nThe <a href=\"#/api/Ext.util.History-method-init\" rel=\"Ext.util.History-method-init\" class=\"docClass\">init</a> method of the History object must be called before using History. This sets up the internal\nstate and must be the first thing called before using History.</p>\n\n<p><strong>Setup</strong>\nThe History objects requires elements on the page to keep track of the browser history. For older versions of IE,\nan IFrame is required to do the tracking. For other browsers, a hidden field can be used. The history objects expects\nthese to be on the page before the <a href=\"#/api/Ext.util.History-method-init\" rel=\"Ext.util.History-method-init\" class=\"docClass\">init</a> method is called. The following markup is suggested in order\nto support all browsers:</p>\n\n<pre><code>&lt;form id=\"history-form\" class=\"x-hide-display\"&gt;\n    &lt;input type=\"hidden\" id=\"x-history-field\" /&gt;\n    &lt;iframe id=\"x-history-frame\"&gt;&lt;/iframe&gt;\n&lt;/form&gt;\n</code></pre>\n",
   5   "extends": null,
   6   "mixins": [
   7     "Ext.util.Observable"
   8   ],
   9   "alternateClassNames": [
  10     "Ext.History"
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "listeners",
  21       "member": "Ext.util.Observable",
  22       "type": "Object",
  23       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  26       "linenr": 103,
  27       "html_filename": "Observable.html",
  28       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
  29       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
  30     }
  31   ],
  32   "method": [
  33     {
  34       "tagname": "method",
  35       "name": "add",
  36       "member": "Ext.util.History",
  37       "doc": "<p>Add a new token to the history stack. This can be any arbitrary value, although it would\ncommonly be the concatenation of a component id and another id marking the specifc history\nstate of that component.  Example usage:</p>\n\n<pre><code>// Handle tab changes on a TabPanel\ntabPanel.on('tabchange', function(tabPanel, tab){\nExt.History.add(tabPanel.id + ':' + tab.id);\n});\n</code></pre>\n\n",
  38       "params": [
  39         {
  40           "type": "String",
  41           "name": "token",
  42           "doc": "<p>The value that defines a particular application-specific history state</p>\n",
  43           "optional": false
  44         },
  45         {
  46           "type": "Boolean",
  47           "name": "preventDuplicates",
  48           "doc": "<p>When true, if the passed token matches the current token\nit will not save a new history step. Set to false if the same state can be saved more than once\nat the same history stack location (defaults to true).</p>\n",
  49           "optional": false
  50         }
  51       ],
  52       "return": {
  53         "type": "void",
  54         "doc": "\n"
  55       },
  56       "private": false,
  57       "static": false,
  58       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
  59       "linenr": 203,
  60       "html_filename": "History.html",
  61       "href": "History.html#Ext-util-History-method-add",
  62       "shortDoc": "Add a new token to the history stack. This can be any arbitrary value, although it would\ncommonly be the concatenatio..."
  63     },
  64     {
  65       "tagname": "method",
  66       "name": "addEvents",
  67       "member": "Ext.util.Observable",
  68       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
  69       "params": [
  70         {
  71           "type": "Object/String",
  72           "name": "o",
  73           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
  74           "optional": false
  75         },
  76         {
  77           "type": "String",
  78           "name": "",
  79           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
  80           "optional": false
  81         }
  82       ],
  83       "return": {
  84         "type": "void",
  85         "doc": "\n"
  86       },
  87       "private": false,
  88       "static": false,
  89       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  90       "linenr": 452,
  91       "html_filename": "Observable.html",
  92       "href": "Observable.html#Ext-util-Observable-method-addEvents",
  93       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
  94     },
  95     {
  96       "tagname": "method",
  97       "name": "addListener",
  98       "member": "Ext.util.Observable",
  99       "doc": "<p>Appends an event handler to this object.</p>\n",
 100       "params": [
 101         {
 102           "type": "String",
 103           "name": "eventName",
 104           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
 105           "optional": false
 106         },
 107         {
 108           "type": "Function",
 109           "name": "handler",
 110           "doc": "<p>The method the event invokes.</p>\n",
 111           "optional": false
 112         },
 113         {
 114           "type": "Object",
 115           "name": "scope",
 116           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
 117           "optional": true
 118         },
 119         {
 120           "type": "Object",
 121           "name": "options",
 122           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<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>\n<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>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<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>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
 123           "optional": true
 124         }
 125       ],
 126       "return": {
 127         "type": "void",
 128         "doc": "\n"
 129       },
 130       "private": false,
 131       "static": false,
 132       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 133       "linenr": 271,
 134       "html_filename": "Observable.html",
 135       "href": "Observable.html#Ext-util-Observable-method-addListener",
 136       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
 137     },
 138     {
 139       "tagname": "method",
 140       "name": "addManagedListener",
 141       "member": "Ext.util.Observable",
 142       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
 143       "params": [
 144         {
 145           "type": "Observable/Element",
 146           "name": "item",
 147           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 148           "optional": false
 149         },
 150         {
 151           "type": "Object/String",
 152           "name": "ename",
 153           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 154           "optional": false
 155         },
 156         {
 157           "type": "Function",
 158           "name": "fn",
 159           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 160           "optional": false
 161         },
 162         {
 163           "type": "Object",
 164           "name": "scope",
 165           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
 166           "optional": false
 167         },
 168         {
 169           "type": "Object",
 170           "name": "opt",
 171           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
 172           "optional": false
 173         }
 174       ],
 175       "return": {
 176         "type": "void",
 177         "doc": "\n"
 178       },
 179       "private": false,
 180       "static": false,
 181       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 182       "linenr": 155,
 183       "html_filename": "Observable.html",
 184       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 185       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
 186     },
 187     {
 188       "tagname": "method",
 189       "name": "back",
 190       "member": "Ext.util.History",
 191       "doc": "<p>Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).</p>\n",
 192       "params": [
 193
 194       ],
 195       "return": {
 196         "type": "void",
 197         "doc": "\n"
 198       },
 199       "private": false,
 200       "static": false,
 201       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 202       "linenr": 235,
 203       "html_filename": "History.html",
 204       "href": "History.html#Ext-util-History-method-back",
 205       "shortDoc": "<p>Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).</p>\n"
 206     },
 207     {
 208       "tagname": "method",
 209       "name": "capture",
 210       "member": "Ext.util.Observable",
 211       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
 212       "params": [
 213         {
 214           "type": "Observable",
 215           "name": "o",
 216           "doc": "<p>The Observable to capture events from.</p>\n",
 217           "optional": false
 218         },
 219         {
 220           "type": "Function",
 221           "name": "fn",
 222           "doc": "<p>The function to call when an event is fired.</p>\n",
 223           "optional": false
 224         },
 225         {
 226           "type": "Object",
 227           "name": "scope",
 228           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
 229           "optional": true
 230         }
 231       ],
 232       "return": {
 233         "type": "void",
 234         "doc": "\n"
 235       },
 236       "private": false,
 237       "static": true,
 238       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 239       "linenr": 55,
 240       "html_filename": "Observable.html",
 241       "href": "Observable.html#Ext-util-Observable-method-capture",
 242       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
 243     },
 244     {
 245       "tagname": "method",
 246       "name": "clearListeners",
 247       "member": "Ext.util.Observable",
 248       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 249       "params": [
 250
 251       ],
 252       "return": {
 253         "type": "void",
 254         "doc": "\n"
 255       },
 256       "private": false,
 257       "static": false,
 258       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 259       "linenr": 383,
 260       "html_filename": "Observable.html",
 261       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 262       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
 263     },
 264     {
 265       "tagname": "method",
 266       "name": "clearManagedListeners",
 267       "member": "Ext.util.Observable",
 268       "doc": "<p>Removes all managed listeners for this object.</p>\n",
 269       "params": [
 270
 271       ],
 272       "return": {
 273         "type": "void",
 274         "doc": "\n"
 275       },
 276       "private": false,
 277       "static": false,
 278       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 279       "linenr": 412,
 280       "html_filename": "Observable.html",
 281       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 282       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
 283     },
 284     {
 285       "tagname": "method",
 286       "name": "enableBubble",
 287       "member": "Ext.util.Observable",
 288       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" 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\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
 289       "params": [
 290         {
 291           "type": "String/Array",
 292           "name": "events",
 293           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 294           "optional": false
 295         }
 296       ],
 297       "return": {
 298         "type": "void",
 299         "doc": "\n"
 300       },
 301       "private": false,
 302       "static": false,
 303       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 304       "linenr": 554,
 305       "html_filename": "Observable.html",
 306       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 307       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 308     },
 309     {
 310       "tagname": "method",
 311       "name": "fireEvent",
 312       "member": "Ext.util.Observable",
 313       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.util.History-method-enableBubble\" rel=\"Ext.util.History-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 314       "params": [
 315         {
 316           "type": "String",
 317           "name": "eventName",
 318           "doc": "<p>The name of the event to fire.</p>\n",
 319           "optional": false
 320         },
 321         {
 322           "type": "Object...",
 323           "name": "args",
 324           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 325           "optional": false
 326         }
 327       ],
 328       "return": {
 329         "type": "Boolean",
 330         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 331       },
 332       "private": false,
 333       "static": false,
 334       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 335       "linenr": 232,
 336       "html_filename": "Observable.html",
 337       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 338       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
 339     },
 340     {
 341       "tagname": "method",
 342       "name": "forward",
 343       "member": "Ext.util.History",
 344       "doc": "<p>Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).</p>\n",
 345       "params": [
 346
 347       ],
 348       "return": {
 349         "type": "void",
 350         "doc": "\n"
 351       },
 352       "private": false,
 353       "static": false,
 354       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 355       "linenr": 242,
 356       "html_filename": "History.html",
 357       "href": "History.html#Ext-util-History-method-forward",
 358       "shortDoc": "<p>Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).</p>\n"
 359     },
 360     {
 361       "tagname": "method",
 362       "name": "getToken",
 363       "member": "Ext.util.History",
 364       "doc": "<p>Retrieves the currently-active history token.</p>\n",
 365       "params": [
 366
 367       ],
 368       "return": {
 369         "type": "String",
 370         "doc": "<p>The token</p>\n"
 371       },
 372       "private": false,
 373       "static": false,
 374       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 375       "linenr": 249,
 376       "html_filename": "History.html",
 377       "href": "History.html#Ext-util-History-method-getToken",
 378       "shortDoc": "<p>Retrieves the currently-active history token.</p>\n"
 379     },
 380     {
 381       "tagname": "method",
 382       "name": "hasListener",
 383       "member": "Ext.util.Observable",
 384       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 385       "params": [
 386         {
 387           "type": "String",
 388           "name": "eventName",
 389           "doc": "<p>The name of the event to check for</p>\n",
 390           "optional": false
 391         }
 392       ],
 393       "return": {
 394         "type": "Boolean",
 395         "doc": "<p>True if the event is being listened for, else false</p>\n"
 396       },
 397       "private": false,
 398       "static": false,
 399       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 400       "linenr": 480,
 401       "html_filename": "Observable.html",
 402       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 403       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 404     },
 405     {
 406       "tagname": "method",
 407       "name": "init",
 408       "member": "Ext.util.History",
 409       "doc": "<p>Initialize the global History instance.</p>\n",
 410       "params": [
 411         {
 412           "type": "Boolean",
 413           "name": "onReady",
 414           "doc": "<p>(optional) A callback function that will be called once the history\ncomponent is fully initialized.</p>\n",
 415           "optional": true
 416         },
 417         {
 418           "type": "Object",
 419           "name": "scope",
 420           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser window.</p>\n",
 421           "optional": true
 422         }
 423       ],
 424       "return": {
 425         "type": "void",
 426         "doc": "\n"
 427       },
 428       "private": false,
 429       "static": false,
 430       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 431       "linenr": 155,
 432       "html_filename": "History.html",
 433       "href": "History.html#Ext-util-History-method-init",
 434       "shortDoc": "<p>Initialize the global History instance.</p>\n"
 435     },
 436     {
 437       "tagname": "method",
 438       "name": "observe",
 439       "member": "Ext.util.Observable",
 440       "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
 441       "params": [
 442         {
 443           "type": "Function",
 444           "name": "c",
 445           "doc": "<p>The class constructor to make observable.</p>\n",
 446           "optional": false
 447         },
 448         {
 449           "type": "Object",
 450           "name": "listeners",
 451           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
 452           "optional": false
 453         }
 454       ],
 455       "return": {
 456         "type": "void",
 457         "doc": "\n"
 458       },
 459       "private": false,
 460       "static": true,
 461       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 462       "linenr": 69,
 463       "html_filename": "Observable.html",
 464       "href": "Observable.html#Ext-util-Observable-method-observe",
 465       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
 466     },
 467     {
 468       "tagname": "method",
 469       "name": "on",
 470       "member": "Ext.util.Observable",
 471       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
 472       "params": [
 473         {
 474           "type": "String",
 475           "name": "eventName",
 476           "doc": "<p>The type of event to listen for</p>\n",
 477           "optional": false
 478         },
 479         {
 480           "type": "Function",
 481           "name": "handler",
 482           "doc": "<p>The method the event invokes</p>\n",
 483           "optional": false
 484         },
 485         {
 486           "type": "Object",
 487           "name": "scope",
 488           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
 489           "optional": true
 490         },
 491         {
 492           "type": "Object",
 493           "name": "options",
 494           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
 495           "optional": true
 496         }
 497       ],
 498       "return": {
 499         "type": "void",
 500         "doc": "\n"
 501       },
 502       "private": false,
 503       "static": false,
 504       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 505       "linenr": 616,
 506       "html_filename": "Observable.html",
 507       "href": "Observable.html#Ext-util-Observable-method-on",
 508       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
 509     },
 510     {
 511       "tagname": "method",
 512       "name": "relayEvents",
 513       "member": "Ext.util.Observable",
 514       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
 515       "params": [
 516         {
 517           "type": "Object",
 518           "name": "origin",
 519           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 520           "optional": false
 521         },
 522         {
 523           "type": "Array",
 524           "name": "events",
 525           "doc": "<p>Array of event names to relay.</p>\n",
 526           "optional": false
 527         },
 528         {
 529           "type": "Object",
 530           "name": "prefix",
 531           "doc": "\n",
 532           "optional": false
 533         }
 534       ],
 535       "return": {
 536         "type": "void",
 537         "doc": "\n"
 538       },
 539       "private": false,
 540       "static": false,
 541       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 542       "linenr": 520,
 543       "html_filename": "Observable.html",
 544       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 545       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
 546     },
 547     {
 548       "tagname": "method",
 549       "name": "releaseCapture",
 550       "member": "Ext.util.Observable",
 551       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
 552       "params": [
 553         {
 554           "type": "Observable",
 555           "name": "o",
 556           "doc": "<p>The Observable to release</p>\n",
 557           "optional": false
 558         }
 559       ],
 560       "return": {
 561         "type": "void",
 562         "doc": "\n"
 563       },
 564       "private": false,
 565       "static": true,
 566       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 567       "linenr": 46,
 568       "html_filename": "Observable.html",
 569       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 570       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
 571     },
 572     {
 573       "tagname": "method",
 574       "name": "removeListener",
 575       "member": "Ext.util.Observable",
 576       "doc": "<p>Removes an event handler.</p>\n",
 577       "params": [
 578         {
 579           "type": "String",
 580           "name": "eventName",
 581           "doc": "<p>The type of event the handler was associated with.</p>\n",
 582           "optional": false
 583         },
 584         {
 585           "type": "Function",
 586           "name": "handler",
 587           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 588           "optional": false
 589         },
 590         {
 591           "type": "Object",
 592           "name": "scope",
 593           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 594           "optional": true
 595         }
 596       ],
 597       "return": {
 598         "type": "void",
 599         "doc": "\n"
 600       },
 601       "private": false,
 602       "static": false,
 603       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 604       "linenr": 352,
 605       "html_filename": "Observable.html",
 606       "href": "Observable.html#Ext-util-Observable-method-removeListener",
 607       "shortDoc": "<p>Removes an event handler.</p>\n"
 608     },
 609     {
 610       "tagname": "method",
 611       "name": "removeManagedListener",
 612       "member": "Ext.util.Observable",
 613       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.util.History--mon\" rel=\"Ext.util.History--mon\" class=\"docClass\">mon</a> method.</p>\n",
 614       "params": [
 615         {
 616           "type": "Observable|Element",
 617           "name": "item",
 618           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 619           "optional": false
 620         },
 621         {
 622           "type": "Object|String",
 623           "name": "ename",
 624           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 625           "optional": false
 626         },
 627         {
 628           "type": "Function",
 629           "name": "fn",
 630           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 631           "optional": false
 632         },
 633         {
 634           "type": "Object",
 635           "name": "scope",
 636           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
 637           "optional": false
 638         }
 639       ],
 640       "return": {
 641         "type": "void",
 642         "doc": "\n"
 643       },
 644       "private": false,
 645       "static": false,
 646       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 647       "linenr": 196,
 648       "html_filename": "Observable.html",
 649       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
 650       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.util.History--mon\" rel=\"Ext.util.History--mon\" class=\"docClass\">mon</a> method.</p>\n"
 651     },
 652     {
 653       "tagname": "method",
 654       "name": "resumeEvents",
 655       "member": "Ext.util.Observable",
 656       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.util.History-method-suspendEvents\" rel=\"Ext.util.History-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
 657       "params": [
 658
 659       ],
 660       "return": {
 661         "type": "void",
 662         "doc": "\n"
 663       },
 664       "private": false,
 665       "static": false,
 666       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 667       "linenr": 502,
 668       "html_filename": "Observable.html",
 669       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
 670       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
 671     },
 672     {
 673       "tagname": "method",
 674       "name": "suspendEvents",
 675       "member": "Ext.util.Observable",
 676       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.util.History-method-resumeEvents\" rel=\"Ext.util.History-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
 677       "params": [
 678         {
 679           "type": "Boolean",
 680           "name": "queueSuspended",
 681           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.util.History-method-resumeEvents\" rel=\"Ext.util.History-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
 682           "optional": false
 683         }
 684       ],
 685       "return": {
 686         "type": "void",
 687         "doc": "\n"
 688       },
 689       "private": false,
 690       "static": false,
 691       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 692       "linenr": 490,
 693       "html_filename": "Observable.html",
 694       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
 695       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.util.History-method-resumeEvents\" rel=\"Ext.util.History-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
 696     },
 697     {
 698       "tagname": "method",
 699       "name": "un",
 700       "member": "Ext.util.Observable",
 701       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.util.History-method-removeListener\" rel=\"Ext.util.History-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
 702       "params": [
 703         {
 704           "type": "String",
 705           "name": "eventName",
 706           "doc": "<p>The type of event the handler was associated with.</p>\n",
 707           "optional": false
 708         },
 709         {
 710           "type": "Function",
 711           "name": "handler",
 712           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 713           "optional": false
 714         },
 715         {
 716           "type": "Object",
 717           "name": "scope",
 718           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 719           "optional": true
 720         }
 721       ],
 722       "return": {
 723         "type": "void",
 724         "doc": "\n"
 725       },
 726       "private": false,
 727       "static": false,
 728       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 729       "linenr": 608,
 730       "html_filename": "Observable.html",
 731       "href": "Observable.html#Ext-util-Observable-method-un",
 732       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.util.History-method-removeListener\" rel=\"Ext.util.History-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
 733     }
 734   ],
 735   "property": [
 736     {
 737       "tagname": "property",
 738       "name": "fieldId",
 739       "member": "Ext.util.History",
 740       "type": "String",
 741       "doc": "<p>The id of the hidden field required for storing the current history token.</p>\n",
 742       "private": false,
 743       "static": false,
 744       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 745       "linenr": 142,
 746       "html_filename": "History.html",
 747       "href": "History.html#Ext-util-History-property-fieldId"
 748     },
 749     {
 750       "tagname": "property",
 751       "name": "iframeId",
 752       "member": "Ext.util.History",
 753       "type": "String",
 754       "doc": "<p>The id of the iframe required by IE to manage the history stack.</p>\n",
 755       "private": false,
 756       "static": false,
 757       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 758       "linenr": 148,
 759       "html_filename": "History.html",
 760       "href": "History.html#Ext-util-History-property-iframeId"
 761     }
 762   ],
 763   "event": [
 764     {
 765       "tagname": "event",
 766       "name": "change",
 767       "member": "Ext.util.History",
 768       "doc": "<p>Fires when navigation back or forwards within the local page's history occurs.</p>\n",
 769       "params": [
 770         {
 771           "type": "String",
 772           "name": "token",
 773           "doc": "<p>An identifier associated with the page state at that point in its history.</p>\n",
 774           "optional": false
 775         }
 776       ],
 777       "private": false,
 778       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 779       "linenr": 189,
 780       "html_filename": "History.html",
 781       "href": "History.html#Ext-util-History-event-change",
 782       "shortDoc": "<p>Fires when navigation back or forwards within the local page's history occurs.</p>\n"
 783     },
 784     {
 785       "tagname": "event",
 786       "name": "ready",
 787       "member": "Ext.util.History",
 788       "doc": "<p>Fires when the <a href=\"#/api/Ext.util.History\" rel=\"Ext.util.History\" class=\"docClass\">Ext.util.History</a> singleton has been initialized and is ready for use.</p>\n",
 789       "params": [
 790         {
 791           "type": "Ext.util.History",
 792           "name": "The",
 793           "doc": "<p>Ext.util.History singleton.</p>\n",
 794           "optional": false
 795         }
 796       ],
 797       "private": false,
 798       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 799       "linenr": 183,
 800       "html_filename": "History.html",
 801       "href": "History.html#Ext-util-History-event-ready",
 802       "shortDoc": "<p>Fires when the <a href=\"#/api/Ext.util.History\" rel=\"Ext.util.History\" class=\"docClass\">Ext.util.History</a> singleton has been initialized and is ready for use.</p>\n"
 803     }
 804   ],
 805   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/History.js",
 806   "linenr": 1,
 807   "html_filename": "History.html",
 808   "href": "History.html#Ext-util-History",
 809   "cssVar": [
 810
 811   ],
 812   "cssMixin": [
 813
 814   ],
 815   "component": false,
 816   "superclasses": [
 817
 818   ],
 819   "subclasses": [
 820
 821   ],
 822   "mixedInto": [
 823
 824   ],
 825   "allMixins": [
 826     "Ext.util.Observable"
 827   ]
 828 });