docs/output/Ext.util.History.js

   1 Ext.data.JsonP.Ext_util_History({
   2   "allMixins": [
   3     "Ext.util.Observable"
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9       {
  10         "type": "Object",
  11         "deprecated": null,
  12         "alias": null,
  13         "protected": false,
  14         "tagname": "cfg",
  15         "href": "Observable.html#Ext-util-Observable-cfg-listeners",
  16         "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...",
  17         "static": false,
  18         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
  19         "private": false,
  20         "name": "listeners",
  21         "owner": "Ext.util.Observable",
  22         "doc": "<p>A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the <a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple\nhandlers at once.</p>\n\n<p><strong>DOM events from ExtJS <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></strong></p>\n\n<p>While <em>some</em> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly 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 <strong><code><a href=\"#/api/Ext.view.View-event-itemclick\" rel=\"Ext.view.View-event-itemclick\" class=\"docClass\">itemclick</a></code></strong> event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the <code>element</code> option to identify the Component property to add a\nDOM 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",
  23         "linenr": 102,
  24         "html_filename": "Observable.html"
  25       }
  26     ],
  27     "method": [
  28       {
  29         "deprecated": null,
  30         "alias": null,
  31         "protected": false,
  32         "tagname": "method",
  33         "href": "History.html#Ext-util-History-method-add",
  34         "shortDoc": "Add a new token to the history stack. ...",
  35         "static": false,
  36         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
  37         "private": false,
  38         "params": [
  39           {
  40             "type": "String",
  41             "optional": false,
  42             "doc": "<p>The value that defines a particular application-specific history state</p>\n",
  43             "name": "token"
  44           },
  45           {
  46             "type": "Boolean",
  47             "optional": false,
  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             "name": "preventDuplicates"
  50           }
  51         ],
  52         "name": "add",
  53         "owner": "Ext.util.History",
  54         "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",
  55         "linenr": 203,
  56         "return": {
  57           "type": "void",
  58           "doc": "\n"
  59         },
  60         "html_filename": "History.html"
  61       },
  62       {
  63         "deprecated": null,
  64         "alias": null,
  65         "protected": false,
  66         "tagname": "method",
  67         "href": "Observable.html#Ext-util-Observable-method-addEvents",
  68         "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...",
  69         "static": false,
  70         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
  71         "private": false,
  72         "params": [
  73           {
  74             "type": "Object/String",
  75             "optional": false,
  76             "doc": "<p>Either an object with event names as properties with a value of <code>true</code> or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:</p>\n\n<pre><code>this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n</code></pre>\n",
  77             "name": "o"
  78           },
  79           {
  80             "type": "String...",
  81             "optional": false,
  82             "doc": "<p>Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n",
  83             "name": "more"
  84           }
  85         ],
  86         "name": "addEvents",
  87         "owner": "Ext.util.Observable",
  88         "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
  89         "linenr": 494,
  90         "return": {
  91           "type": "void",
  92           "doc": "\n"
  93         },
  94         "html_filename": "Observable.html"
  95       },
  96       {
  97         "deprecated": null,
  98         "alias": null,
  99         "protected": false,
 100         "tagname": "method",
 101         "href": "Observable.html#Ext-util-Observable-method-addListener",
 102         "shortDoc": "Appends an event handler to this object. ...",
 103         "static": false,
 104         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 105         "private": false,
 106         "params": [
 107           {
 108             "type": "String",
 109             "optional": false,
 110             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
 111             "name": "eventName"
 112           },
 113           {
 114             "type": "Function",
 115             "optional": false,
 116             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.util.History-method-fireEvent\" rel=\"Ext.util.History-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
 117             "name": "handler"
 118           },
 119           {
 120             "type": "Object",
 121             "optional": true,
 122             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
 123             "name": "scope"
 124           },
 125           {
 126             "type": "Object",
 127             "optional": true,
 128             "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>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 by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty 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\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\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></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\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\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
 129             "name": "options"
 130           }
 131         ],
 132         "name": "addListener",
 133         "owner": "Ext.util.Observable",
 134         "doc": "<p>Appends an event handler to this object.</p>\n",
 135         "linenr": 278,
 136         "return": {
 137           "type": "void",
 138           "doc": "\n"
 139         },
 140         "html_filename": "Observable.html"
 141       },
 142       {
 143         "deprecated": null,
 144         "alias": null,
 145         "protected": false,
 146         "tagname": "method",
 147         "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 148         "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...",
 149         "static": false,
 150         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 151         "private": false,
 152         "params": [
 153           {
 154             "type": "Observable/Element",
 155             "optional": false,
 156             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 157             "name": "item"
 158           },
 159           {
 160             "type": "Object/String",
 161             "optional": false,
 162             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 163             "name": "ename"
 164           },
 165           {
 166             "type": "Function",
 167             "optional": true,
 168             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
 169             "name": "fn"
 170           },
 171           {
 172             "type": "Object",
 173             "optional": true,
 174             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
 175             "name": "scope"
 176           },
 177           {
 178             "type": "Object",
 179             "optional": true,
 180             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
 181             "name": "opt"
 182           }
 183         ],
 184         "name": "addManagedListener",
 185         "owner": "Ext.util.Observable",
 186         "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
 187         "linenr": 156,
 188         "return": {
 189           "type": "void",
 190           "doc": "\n"
 191         },
 192         "html_filename": "Observable.html"
 193       },
 194       {
 195         "deprecated": null,
 196         "alias": null,
 197         "protected": false,
 198         "tagname": "method",
 199         "href": "Base3.html#Ext-Base-method-addStatics",
 200         "shortDoc": "Add / override static properties of this class. ...",
 201         "static": true,
 202         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 203         "private": false,
 204         "params": [
 205           {
 206             "type": "Object",
 207             "optional": false,
 208             "doc": "\n",
 209             "name": "members"
 210           }
 211         ],
 212         "name": "addStatics",
 213         "owner": "Ext.Base",
 214         "doc": "<p>Add / override static properties of this class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n</code></pre>\n",
 215         "linenr": 388,
 216         "return": {
 217           "type": "Ext.Base",
 218           "doc": "<p>this</p>\n"
 219         },
 220         "html_filename": "Base3.html"
 221       },
 222       {
 223         "deprecated": null,
 224         "alias": null,
 225         "protected": false,
 226         "tagname": "method",
 227         "href": "History.html#Ext-util-History-method-back",
 228         "shortDoc": "Programmatically steps back one step in browser history (equivalent to the user pressing the Back button). ...",
 229         "static": false,
 230         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
 231         "private": false,
 232         "params": [
 233
 234         ],
 235         "name": "back",
 236         "owner": "Ext.util.History",
 237         "doc": "<p>Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).</p>\n",
 238         "linenr": 235,
 239         "return": {
 240           "type": "void",
 241           "doc": "\n"
 242         },
 243         "html_filename": "History.html"
 244       },
 245       {
 246         "deprecated": null,
 247         "alias": null,
 248         "protected": false,
 249         "tagname": "method",
 250         "href": "Base3.html#Ext-Base-method-callOverridden",
 251         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
 252         "static": false,
 253         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 254         "private": false,
 255         "params": [
 256           {
 257             "type": "Array/Arguments",
 258             "optional": false,
 259             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
 260             "name": "args"
 261           }
 262         ],
 263         "name": "callOverridden",
 264         "owner": "Ext.Base",
 265         "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">Ext.Base.override</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
 266         "linenr": 269,
 267         "return": {
 268           "type": "Mixed",
 269           "doc": "<p>Returns the result after calling the overridden method</p>\n"
 270         },
 271         "html_filename": "Base3.html"
 272       },
 273       {
 274         "deprecated": null,
 275         "alias": null,
 276         "protected": true,
 277         "tagname": "method",
 278         "href": "Base3.html#Ext-Base-method-callParent",
 279         "shortDoc": "Call the parent's overridden method. ...",
 280         "static": false,
 281         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 282         "private": false,
 283         "params": [
 284           {
 285             "type": "Array/Arguments",
 286             "optional": false,
 287             "doc": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
 288             "name": "args"
 289           }
 290         ],
 291         "name": "callParent",
 292         "owner": "Ext.Base",
 293         "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n</code></pre>\n",
 294         "linenr": 124,
 295         "return": {
 296           "type": "Mixed",
 297           "doc": "<p>Returns the result from the superclass' method</p>\n"
 298         },
 299         "html_filename": "Base3.html"
 300       },
 301       {
 302         "deprecated": null,
 303         "alias": null,
 304         "protected": false,
 305         "tagname": "method",
 306         "href": "Observable.html#Ext-util-Observable-method-capture",
 307         "shortDoc": "Starts capture on the specified Observable. ...",
 308         "static": true,
 309         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 310         "private": false,
 311         "params": [
 312           {
 313             "type": "Observable",
 314             "optional": false,
 315             "doc": "<p>The Observable to capture events from.</p>\n",
 316             "name": "o"
 317           },
 318           {
 319             "type": "Function",
 320             "optional": false,
 321             "doc": "<p>The function to call when an event is fired.</p>\n",
 322             "name": "fn"
 323           },
 324           {
 325             "type": "Object",
 326             "optional": true,
 327             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to\nthe Observable firing the event.</p>\n",
 328             "name": "scope"
 329           }
 330         ],
 331         "name": "capture",
 332         "owner": "Ext.util.Observable",
 333         "doc": "<p>Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event <strong>before</strong> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
 334         "linenr": 54,
 335         "return": {
 336           "type": "void",
 337           "doc": "\n"
 338         },
 339         "html_filename": "Observable.html"
 340       },
 341       {
 342         "deprecated": null,
 343         "alias": null,
 344         "protected": false,
 345         "tagname": "method",
 346         "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 347         "shortDoc": "Removes all listeners for this object including the managed listeners ...",
 348         "static": false,
 349         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 350         "private": false,
 351         "params": [
 352
 353         ],
 354         "name": "clearListeners",
 355         "owner": "Ext.util.Observable",
 356         "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 357         "linenr": 425,
 358         "return": {
 359           "type": "void",
 360           "doc": "\n"
 361         },
 362         "html_filename": "Observable.html"
 363       },
 364       {
 365         "deprecated": null,
 366         "alias": null,
 367         "protected": false,
 368         "tagname": "method",
 369         "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 370         "shortDoc": "Removes all managed listeners for this object. ...",
 371         "static": false,
 372         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 373         "private": false,
 374         "params": [
 375
 376         ],
 377         "name": "clearManagedListeners",
 378         "owner": "Ext.util.Observable",
 379         "doc": "<p>Removes all managed listeners for this object.</p>\n",
 380         "linenr": 454,
 381         "return": {
 382           "type": "void",
 383           "doc": "\n"
 384         },
 385         "html_filename": "Observable.html"
 386       },
 387       {
 388         "deprecated": null,
 389         "alias": null,
 390         "protected": false,
 391         "tagname": "method",
 392         "href": "Base3.html#Ext-Base-method-create",
 393         "shortDoc": "Create a new instance of this Class. ...",
 394         "static": true,
 395         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 396         "private": false,
 397         "params": [
 398
 399         ],
 400         "name": "create",
 401         "owner": "Ext.Base",
 402         "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
 403         "linenr": 329,
 404         "return": {
 405           "type": "Object",
 406           "doc": "<p>the created instance.</p>\n"
 407         },
 408         "html_filename": "Base3.html"
 409       },
 410       {
 411         "deprecated": null,
 412         "alias": null,
 413         "protected": false,
 414         "tagname": "method",
 415         "href": "Base3.html#Ext-Base-method-createAlias",
 416         "shortDoc": "Create aliases for existing prototype methods. ...",
 417         "static": true,
 418         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 419         "private": false,
 420         "params": [
 421           {
 422             "type": "String/Object",
 423             "optional": false,
 424             "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
 425             "name": "alias"
 426           },
 427           {
 428             "type": "String/Object",
 429             "optional": false,
 430             "doc": "<p>The original method name</p>\n",
 431             "name": "origin"
 432           }
 433         ],
 434         "name": "createAlias",
 435         "owner": "Ext.Base",
 436         "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -&gt; test.method1()\n</code></pre>\n",
 437         "linenr": 648,
 438         "return": {
 439           "type": "void",
 440           "doc": "\n"
 441         },
 442         "html_filename": "Base3.html"
 443       },
 444       {
 445         "deprecated": null,
 446         "alias": null,
 447         "protected": false,
 448         "tagname": "method",
 449         "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 450         "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...",
 451         "static": false,
 452         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 453         "private": false,
 454         "params": [
 455           {
 456             "type": "String/[String]",
 457             "optional": false,
 458             "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 459             "name": "events"
 460           }
 461         ],
 462         "name": "enableBubble",
 463         "owner": "Ext.util.Observable",
 464         "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling <code>this.getBubbleTarget()</code> if\npresent. There is no implementation in the Observable base class.</p>\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers.\nSee <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default implementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.</p>\n\n<p>Example:</p>\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\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",
 465         "linenr": 609,
 466         "return": {
 467           "type": "void",
 468           "doc": "\n"
 469         },
 470         "html_filename": "Observable.html"
 471       },
 472       {
 473         "deprecated": null,
 474         "alias": null,
 475         "protected": false,
 476         "tagname": "method",
 477         "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 478         "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...",
 479         "static": false,
 480         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 481         "private": false,
 482         "params": [
 483           {
 484             "type": "String",
 485             "optional": false,
 486             "doc": "<p>The name of the event to fire.</p>\n",
 487             "name": "eventName"
 488           },
 489           {
 490             "type": "Object...",
 491             "optional": false,
 492             "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 493             "name": "args"
 494           }
 495         ],
 496         "name": "fireEvent",
 497         "owner": "Ext.util.Observable",
 498         "doc": "<p>Fires the specified event with the passed parameters (minus the event name, plus the <code>options</code> object passed\nto <a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a>).</p>\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>) by\ncalling <a href=\"#/api/Ext.util.History-method-enableBubble\" rel=\"Ext.util.History-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n",
 499         "linenr": 233,
 500         "return": {
 501           "type": "Boolean",
 502           "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 503         },
 504         "html_filename": "Observable.html"
 505       },
 506       {
 507         "deprecated": null,
 508         "alias": null,
 509         "protected": false,
 510         "tagname": "method",
 511         "href": "History.html#Ext-util-History-method-forward",
 512         "shortDoc": "Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button). ...",
 513         "static": false,
 514         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
 515         "private": false,
 516         "params": [
 517
 518         ],
 519         "name": "forward",
 520         "owner": "Ext.util.History",
 521         "doc": "<p>Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).</p>\n",
 522         "linenr": 242,
 523         "return": {
 524           "type": "void",
 525           "doc": "\n"
 526         },
 527         "html_filename": "History.html"
 528       },
 529       {
 530         "deprecated": null,
 531         "alias": null,
 532         "protected": false,
 533         "tagname": "method",
 534         "href": "Base3.html#Ext-Base-method-getName",
 535         "shortDoc": "Get the current class' name in string format. ...",
 536         "static": false,
 537         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 538         "private": false,
 539         "params": [
 540
 541         ],
 542         "name": "getName",
 543         "owner": "Ext.Base",
 544         "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n</code></pre>\n",
 545         "linenr": 631,
 546         "return": {
 547           "type": "String",
 548           "doc": "<p>className</p>\n"
 549         },
 550         "html_filename": "Base3.html"
 551       },
 552       {
 553         "deprecated": null,
 554         "alias": null,
 555         "protected": false,
 556         "tagname": "method",
 557         "href": "History.html#Ext-util-History-method-getToken",
 558         "shortDoc": "Retrieves the currently-active history token. ...",
 559         "static": false,
 560         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
 561         "private": false,
 562         "params": [
 563
 564         ],
 565         "name": "getToken",
 566         "owner": "Ext.util.History",
 567         "doc": "<p>Retrieves the currently-active history token.</p>\n",
 568         "linenr": 249,
 569         "return": {
 570           "type": "String",
 571           "doc": "<p>The token</p>\n"
 572         },
 573         "html_filename": "History.html"
 574       },
 575       {
 576         "deprecated": null,
 577         "alias": null,
 578         "protected": false,
 579         "tagname": "method",
 580         "href": "Observable.html#Ext-util-Observable-method-hasListener",
 581         "shortDoc": "Checks to see if this object has any listeners for a specified event ...",
 582         "static": false,
 583         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 584         "private": false,
 585         "params": [
 586           {
 587             "type": "String",
 588             "optional": false,
 589             "doc": "<p>The name of the event to check for</p>\n",
 590             "name": "eventName"
 591           }
 592         ],
 593         "name": "hasListener",
 594         "owner": "Ext.util.Observable",
 595         "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 596         "linenr": 530,
 597         "return": {
 598           "type": "Boolean",
 599           "doc": "<p>True if the event is being listened for, else false</p>\n"
 600         },
 601         "html_filename": "Observable.html"
 602       },
 603       {
 604         "deprecated": null,
 605         "alias": null,
 606         "protected": false,
 607         "tagname": "method",
 608         "href": "Base3.html#Ext-Base-method-implement",
 609         "shortDoc": "Add methods / properties to the prototype of this class. ...",
 610         "static": true,
 611         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 612         "private": false,
 613         "params": [
 614           {
 615             "type": "Object",
 616             "optional": false,
 617             "doc": "\n",
 618             "name": "members"
 619           }
 620         ],
 621         "name": "implement",
 622         "owner": "Ext.Base",
 623         "doc": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n</code></pre>\n",
 624         "linenr": 415,
 625         "return": {
 626           "type": "void",
 627           "doc": "\n"
 628         },
 629         "html_filename": "Base3.html"
 630       },
 631       {
 632         "deprecated": null,
 633         "alias": null,
 634         "protected": false,
 635         "tagname": "method",
 636         "href": "History.html#Ext-util-History-method-init",
 637         "shortDoc": "Initialize the global History instance. ...",
 638         "static": false,
 639         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
 640         "private": false,
 641         "params": [
 642           {
 643             "type": "Boolean",
 644             "optional": true,
 645             "doc": "<p>(optional) A callback function that will be called once the history\ncomponent is fully initialized.</p>\n",
 646             "name": "onReady"
 647           },
 648           {
 649             "type": "Object",
 650             "optional": true,
 651             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser window.</p>\n",
 652             "name": "scope"
 653           }
 654         ],
 655         "name": "init",
 656         "owner": "Ext.util.History",
 657         "doc": "<p>Initialize the global History instance.</p>\n",
 658         "linenr": 155,
 659         "return": {
 660           "type": "void",
 661           "doc": "\n"
 662         },
 663         "html_filename": "History.html"
 664       },
 665       {
 666         "deprecated": null,
 667         "alias": null,
 668         "protected": true,
 669         "tagname": "method",
 670         "href": "Base3.html#Ext-Base-method-initConfig",
 671         "shortDoc": "Initialize configuration for this class. ...",
 672         "static": false,
 673         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 674         "private": false,
 675         "params": [
 676           {
 677             "type": "Object",
 678             "optional": false,
 679             "doc": "\n",
 680             "name": "config"
 681           }
 682         ],
 683         "name": "initConfig",
 684         "owner": "Ext.Base",
 685         "doc": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n\n        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n</code></pre>\n",
 686         "linenr": 63,
 687         "return": {
 688           "type": "Object",
 689           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
 690         },
 691         "html_filename": "Base3.html"
 692       },
 693       {
 694         "deprecated": null,
 695         "alias": {
 696           "tagname": "alias",
 697           "cls": "Ext.util.Observable",
 698           "doc": null,
 699           "owner": "addManagedListener"
 700         },
 701         "protected": false,
 702         "tagname": "method",
 703         "href": "Observable.html#Ext-util-Observable-method-mon",
 704         "shortDoc": "Shorthand for addManagedListener. ...",
 705         "static": false,
 706         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 707         "private": false,
 708         "params": [
 709           {
 710             "type": "Observable/Element",
 711             "optional": false,
 712             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 713             "name": "item"
 714           },
 715           {
 716             "type": "Object/String",
 717             "optional": false,
 718             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 719             "name": "ename"
 720           },
 721           {
 722             "type": "Function",
 723             "optional": true,
 724             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
 725             "name": "fn"
 726           },
 727           {
 728             "type": "Object",
 729             "optional": true,
 730             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
 731             "name": "scope"
 732           },
 733           {
 734             "type": "Object",
 735             "optional": true,
 736             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
 737             "name": "opt"
 738           }
 739         ],
 740         "name": "mon",
 741         "owner": "Ext.util.Observable",
 742         "doc": "<p>Shorthand for <a href=\"#/api/Ext.util.History-method-addManagedListener\" rel=\"Ext.util.History-method-addManagedListener\" class=\"docClass\">addManagedListener</a>.</p>\n\n<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
 743         "linenr": 681,
 744         "return": {
 745           "type": "void",
 746           "doc": "\n"
 747         },
 748         "html_filename": "Observable.html"
 749       },
 750       {
 751         "deprecated": null,
 752         "alias": {
 753           "tagname": "alias",
 754           "cls": "Ext.util.Observable",
 755           "doc": null,
 756           "owner": "removeManagedListener"
 757         },
 758         "protected": false,
 759         "tagname": "method",
 760         "href": "Observable.html#Ext-util-Observable-method-mun",
 761         "shortDoc": "Shorthand for removeManagedListener. ...",
 762         "static": false,
 763         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 764         "private": false,
 765         "params": [
 766           {
 767             "type": "Observable|Element",
 768             "optional": false,
 769             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 770             "name": "item"
 771           },
 772           {
 773             "type": "Object|String",
 774             "optional": false,
 775             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 776             "name": "ename"
 777           },
 778           {
 779             "type": "Function",
 780             "optional": false,
 781             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
 782             "name": "fn"
 783           },
 784           {
 785             "type": "Object",
 786             "optional": false,
 787             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
 788             "name": "scope"
 789           }
 790         ],
 791         "name": "mun",
 792         "owner": "Ext.util.Observable",
 793         "doc": "<p>Shorthand for <a href=\"#/api/Ext.util.History-method-removeManagedListener\" rel=\"Ext.util.History-method-removeManagedListener\" class=\"docClass\">removeManagedListener</a>.</p>\n\n<p>Removes listeners that were added by the <a href=\"#/api/Ext.util.History-method-mon\" rel=\"Ext.util.History-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
 794         "linenr": 687,
 795         "return": {
 796           "type": "void",
 797           "doc": "\n"
 798         },
 799         "html_filename": "Observable.html"
 800       },
 801       {
 802         "deprecated": null,
 803         "alias": null,
 804         "protected": false,
 805         "tagname": "method",
 806         "href": "Observable.html#Ext-util-Observable-method-observe",
 807         "shortDoc": "Sets observability on the passed class constructor. ...",
 808         "static": true,
 809         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 810         "private": false,
 811         "params": [
 812           {
 813             "type": "Function",
 814             "optional": false,
 815             "doc": "<p>The class constructor to make observable.</p>\n",
 816             "name": "c"
 817           },
 818           {
 819             "type": "Object",
 820             "optional": false,
 821             "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",
 822             "name": "listeners"
 823           }
 824         ],
 825         "name": "observe",
 826         "owner": "Ext.util.Observable",
 827         "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",
 828         "linenr": 69,
 829         "return": {
 830           "type": "void",
 831           "doc": "\n"
 832         },
 833         "html_filename": "Observable.html"
 834       },
 835       {
 836         "deprecated": null,
 837         "alias": {
 838           "tagname": "alias",
 839           "cls": "Ext.util.Observable",
 840           "doc": null,
 841           "owner": "addListener"
 842         },
 843         "protected": false,
 844         "tagname": "method",
 845         "href": "Observable.html#Ext-util-Observable-method-on",
 846         "shortDoc": "Shorthand for addListener. ...",
 847         "static": false,
 848         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 849         "private": false,
 850         "params": [
 851           {
 852             "type": "String",
 853             "optional": false,
 854             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
 855             "name": "eventName"
 856           },
 857           {
 858             "type": "Function",
 859             "optional": false,
 860             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.util.History-method-fireEvent\" rel=\"Ext.util.History-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
 861             "name": "handler"
 862           },
 863           {
 864             "type": "Object",
 865             "optional": true,
 866             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
 867             "name": "scope"
 868           },
 869           {
 870             "type": "Object",
 871             "optional": true,
 872             "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>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 by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty 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\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\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></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\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\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
 873             "name": "options"
 874           }
 875         ],
 876         "name": "on",
 877         "owner": "Ext.util.Observable",
 878         "doc": "<p>Shorthand for <a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a>.</p>\n\n<p>Appends an event handler to this object.</p>\n",
 879         "linenr": 669,
 880         "return": {
 881           "type": "void",
 882           "doc": "\n"
 883         },
 884         "html_filename": "Observable.html"
 885       },
 886       {
 887         "deprecated": null,
 888         "alias": null,
 889         "protected": false,
 890         "tagname": "method",
 891         "href": "Base3.html#Ext-Base-method-override",
 892         "shortDoc": "Override prototype members of this class. ...",
 893         "static": true,
 894         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 895         "private": false,
 896         "params": [
 897           {
 898             "type": "Object",
 899             "optional": false,
 900             "doc": "\n",
 901             "name": "members"
 902           }
 903         ],
 904         "name": "override",
 905         "owner": "Ext.Base",
 906         "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">Ext.Base.callOverridden</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
 907         "linenr": 518,
 908         "return": {
 909           "type": "Ext.Base",
 910           "doc": "<p>this</p>\n"
 911         },
 912         "html_filename": "Base3.html"
 913       },
 914       {
 915         "deprecated": null,
 916         "alias": null,
 917         "protected": false,
 918         "tagname": "method",
 919         "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 920         "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...",
 921         "static": false,
 922         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 923         "private": false,
 924         "params": [
 925           {
 926             "type": "Object",
 927             "optional": false,
 928             "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 929             "name": "origin"
 930           },
 931           {
 932             "type": "[String]",
 933             "optional": false,
 934             "doc": "<p>Array of event names to relay.</p>\n",
 935             "name": "events"
 936           },
 937           {
 938             "type": "Object",
 939             "optional": false,
 940             "doc": "\n",
 941             "name": "prefix"
 942           }
 943         ],
 944         "name": "relayEvents",
 945         "owner": "Ext.util.Observable",
 946         "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code>this</code>.</p>\n",
 947         "linenr": 573,
 948         "return": {
 949           "type": "void",
 950           "doc": "\n"
 951         },
 952         "html_filename": "Observable.html"
 953       },
 954       {
 955         "deprecated": null,
 956         "alias": null,
 957         "protected": false,
 958         "tagname": "method",
 959         "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 960         "shortDoc": "Removes all added captures from the Observable. ...",
 961         "static": true,
 962         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 963         "private": false,
 964         "params": [
 965           {
 966             "type": "Observable",
 967             "optional": false,
 968             "doc": "<p>The Observable to release</p>\n",
 969             "name": "o"
 970           }
 971         ],
 972         "name": "releaseCapture",
 973         "owner": "Ext.util.Observable",
 974         "doc": "<p>Removes <strong>all</strong> added captures from the Observable.</p>\n",
 975         "linenr": 44,
 976         "return": {
 977           "type": "void",
 978           "doc": "\n"
 979         },
 980         "html_filename": "Observable.html"
 981       },
 982       {
 983         "deprecated": null,
 984         "alias": null,
 985         "protected": false,
 986         "tagname": "method",
 987         "href": "Observable.html#Ext-util-Observable-method-removeListener",
 988         "shortDoc": "Removes an event handler. ...",
 989         "static": false,
 990         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
 991         "private": false,
 992         "params": [
 993           {
 994             "type": "String",
 995             "optional": false,
 996             "doc": "<p>The type of event the handler was associated with.</p>\n",
 997             "name": "eventName"
 998           },
 999           {
1000             "type": "Function",
1001             "optional": false,
1002             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1003             "name": "handler"
1004           },
1005           {
1006             "type": "Object",
1007             "optional": true,
1008             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1009             "name": "scope"
1010           }
1011         ],
1012         "name": "removeListener",
1013         "owner": "Ext.util.Observable",
1014         "doc": "<p>Removes an event handler.</p>\n",
1015         "linenr": 392,
1016         "return": {
1017           "type": "void",
1018           "doc": "\n"
1019         },
1020         "html_filename": "Observable.html"
1021       },
1022       {
1023         "deprecated": null,
1024         "alias": null,
1025         "protected": false,
1026         "tagname": "method",
1027         "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
1028         "shortDoc": "Removes listeners that were added by the mon method. ...",
1029         "static": false,
1030         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1031         "private": false,
1032         "params": [
1033           {
1034             "type": "Observable|Element",
1035             "optional": false,
1036             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
1037             "name": "item"
1038           },
1039           {
1040             "type": "Object|String",
1041             "optional": false,
1042             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
1043             "name": "ename"
1044           },
1045           {
1046             "type": "Function",
1047             "optional": false,
1048             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
1049             "name": "fn"
1050           },
1051           {
1052             "type": "Object",
1053             "optional": false,
1054             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
1055             "name": "scope"
1056           }
1057         ],
1058         "name": "removeManagedListener",
1059         "owner": "Ext.util.Observable",
1060         "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.util.History-method-mon\" rel=\"Ext.util.History-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
1061         "linenr": 197,
1062         "return": {
1063           "type": "void",
1064           "doc": "\n"
1065         },
1066         "html_filename": "Observable.html"
1067       },
1068       {
1069         "deprecated": null,
1070         "alias": null,
1071         "protected": false,
1072         "tagname": "method",
1073         "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
1074         "shortDoc": "Resumes firing events (see suspendEvents). ...",
1075         "static": false,
1076         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1077         "private": false,
1078         "params": [
1079
1080         ],
1081         "name": "resumeEvents",
1082         "owner": "Ext.util.Observable",
1083         "doc": "<p>Resumes firing events (see <a href=\"#/api/Ext.util.History-method-suspendEvents\" rel=\"Ext.util.History-method-suspendEvents\" class=\"docClass\">suspendEvents</a>).</p>\n\n<p>If events were suspended using the <code>**queueSuspended**</code> parameter, then all events fired\nduring event suspension will be sent to any listeners now.</p>\n",
1084         "linenr": 554,
1085         "return": {
1086           "type": "void",
1087           "doc": "\n"
1088         },
1089         "html_filename": "Observable.html"
1090       },
1091       {
1092         "deprecated": null,
1093         "alias": null,
1094         "protected": true,
1095         "tagname": "method",
1096         "href": "Base3.html#Ext-Base-method-statics",
1097         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
1098         "static": false,
1099         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1100         "private": false,
1101         "params": [
1102
1103         ],
1104         "name": "statics",
1105         "owner": "Ext.Base",
1106         "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">Ext.Base.self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n\n        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n</code></pre>\n",
1107         "linenr": 199,
1108         "return": {
1109           "type": "Class",
1110           "doc": "\n"
1111         },
1112         "html_filename": "Base3.html"
1113       },
1114       {
1115         "deprecated": null,
1116         "alias": null,
1117         "protected": false,
1118         "tagname": "method",
1119         "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1120         "shortDoc": "Suspends the firing of all events. ...",
1121         "static": false,
1122         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1123         "private": false,
1124         "params": [
1125           {
1126             "type": "Boolean",
1127             "optional": false,
1128             "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",
1129             "name": "queueSuspended"
1130           }
1131         ],
1132         "name": "suspendEvents",
1133         "owner": "Ext.util.Observable",
1134         "doc": "<p>Suspends 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",
1135         "linenr": 541,
1136         "return": {
1137           "type": "void",
1138           "doc": "\n"
1139         },
1140         "html_filename": "Observable.html"
1141       },
1142       {
1143         "deprecated": null,
1144         "alias": {
1145           "tagname": "alias",
1146           "cls": "Ext.util.Observable",
1147           "doc": null,
1148           "owner": "removeListener"
1149         },
1150         "protected": false,
1151         "tagname": "method",
1152         "href": "Observable.html#Ext-util-Observable-method-un",
1153         "shortDoc": "Shorthand for removeListener. ...",
1154         "static": false,
1155         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1156         "private": false,
1157         "params": [
1158           {
1159             "type": "String",
1160             "optional": false,
1161             "doc": "<p>The type of event the handler was associated with.</p>\n",
1162             "name": "eventName"
1163           },
1164           {
1165             "type": "Function",
1166             "optional": false,
1167             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.util.History-method-addListener\" rel=\"Ext.util.History-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1168             "name": "handler"
1169           },
1170           {
1171             "type": "Object",
1172             "optional": true,
1173             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1174             "name": "scope"
1175           }
1176         ],
1177         "name": "un",
1178         "owner": "Ext.util.Observable",
1179         "doc": "<p>Shorthand for <a href=\"#/api/Ext.util.History-method-removeListener\" rel=\"Ext.util.History-method-removeListener\" class=\"docClass\">removeListener</a>.</p>\n\n<p>Removes an event handler.</p>\n",
1180         "linenr": 675,
1181         "return": {
1182           "type": "void",
1183           "doc": "\n"
1184         },
1185         "html_filename": "Observable.html"
1186       }
1187     ],
1188     "property": [
1189       {
1190         "type": "String",
1191         "deprecated": null,
1192         "alias": null,
1193         "protected": false,
1194         "tagname": "property",
1195         "href": "History.html#Ext-util-History-property-fieldId",
1196         "static": false,
1197         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
1198         "private": false,
1199         "name": "fieldId",
1200         "owner": "Ext.util.History",
1201         "doc": "<p>The id of the hidden field required for storing the current history token.</p>\n",
1202         "linenr": 142,
1203         "html_filename": "History.html"
1204       },
1205       {
1206         "type": "String",
1207         "deprecated": null,
1208         "alias": null,
1209         "protected": false,
1210         "tagname": "property",
1211         "href": "History.html#Ext-util-History-property-iframeId",
1212         "static": false,
1213         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
1214         "private": false,
1215         "name": "iframeId",
1216         "owner": "Ext.util.History",
1217         "doc": "<p>The id of the iframe required by IE to manage the history stack.</p>\n",
1218         "linenr": 148,
1219         "html_filename": "History.html"
1220       },
1221       {
1222         "type": "Class",
1223         "deprecated": null,
1224         "alias": null,
1225         "protected": true,
1226         "tagname": "property",
1227         "href": "Base3.html#Ext-Base-property-self",
1228         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
1229         "static": false,
1230         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1231         "private": false,
1232         "name": "self",
1233         "owner": "Ext.Base",
1234         "doc": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>\nfor a detailed comparison</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); / dependent on 'this'\n\n        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n</code></pre>\n",
1235         "linenr": 18,
1236         "html_filename": "Base3.html"
1237       }
1238     ],
1239     "cssVar": [
1240
1241     ],
1242     "cssMixin": [
1243
1244     ],
1245     "event": [
1246       {
1247         "deprecated": null,
1248         "alias": null,
1249         "protected": false,
1250         "tagname": "event",
1251         "href": "History.html#Ext-util-History-event-change",
1252         "shortDoc": "Fires when navigation back or forwards within the local page's history occurs. ...",
1253         "static": false,
1254         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
1255         "private": false,
1256         "params": [
1257           {
1258             "type": "String",
1259             "optional": false,
1260             "doc": "<p>An identifier associated with the page state at that point in its history.</p>\n",
1261             "name": "token"
1262           },
1263           {
1264             "type": "Object",
1265             "tagname": "param",
1266             "name": "options",
1267             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1268           }
1269         ],
1270         "name": "change",
1271         "owner": "Ext.util.History",
1272         "doc": "<p>Fires when navigation back or forwards within the local page's history occurs.</p>\n",
1273         "linenr": 189,
1274         "html_filename": "History.html"
1275       },
1276       {
1277         "deprecated": null,
1278         "alias": null,
1279         "protected": false,
1280         "tagname": "event",
1281         "href": "History.html#Ext-util-History-event-ready",
1282         "shortDoc": "Fires when the Ext.util.History singleton has been initialized and is ready for use. ...",
1283         "static": false,
1284         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
1285         "private": false,
1286         "params": [
1287           {
1288             "type": "Ext.util.History",
1289             "optional": false,
1290             "doc": "<p>Ext.util.History singleton.</p>\n",
1291             "name": "The"
1292           },
1293           {
1294             "type": "Object",
1295             "tagname": "param",
1296             "name": "options",
1297             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1298           }
1299         ],
1300         "name": "ready",
1301         "owner": "Ext.util.History",
1302         "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",
1303         "linenr": 183,
1304         "html_filename": "History.html"
1305       }
1306     ]
1307   },
1308   "singleton": true,
1309   "alias": null,
1310   "superclasses": [
1311     "Ext.Base"
1312   ],
1313   "protected": false,
1314   "tagname": "class",
1315   "mixins": [
1316     "Ext.util.Observable"
1317   ],
1318   "href": "History.html#Ext-util-History",
1319   "subclasses": [
1320
1321   ],
1322   "static": false,
1323   "author": null,
1324   "component": false,
1325   "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/History.js",
1326   "private": false,
1327   "alternateClassNames": [
1328     "Ext.History"
1329   ],
1330   "name": "Ext.util.History",
1331   "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",
1332   "mixedInto": [
1333
1334   ],
1335   "linenr": 1,
1336   "xtypes": [
1337
1338   ],
1339   "html_filename": "History.html",
1340   "extends": "Ext.Base"
1341 });