docs/output/Ext.state.Provider.js

   1 Ext.data.JsonP.Ext_state_Provider({
   2   "tagname": "class",
   3   "name": "Ext.state.Provider",
   4   "doc": "<p>Abstract base class for state provider implementations. The provider is responsible\nfor setting values  and extracting values to/from the underlying storage source. The \nstorage source can vary and the details should be implemented in a subclass. For example\na provider could use a server side database or the browser localstorage where supported.</p>\n\n\n\n\n<p>This class provides methods for encoding and decoding <b>typed</b> variables including \ndates and defines the Provider interface. By default these methods put the value and the\ntype information into a delimited string that can be stored. These should be overridden in \na subclass if you want to change the format of the encoded value and subsequent decoding.</p>\n\n",
   5   "extends": null,
   6   "mixins": [
   7     "Ext.util.Observable"
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  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.state.Provider-method-addListener\" rel=\"Ext.state.Provider-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       "tagname": "cfg",
  33       "name": "prefix",
  34       "member": "Ext.state.Provider",
  35       "type": "String",
  36       "doc": "<p>A string to prefix to items stored in the underlying state store.\nDefaults to <tt>'ext-'</tt></p>\n",
  37       "private": false,
  38       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Provider.js",
  39       "linenr": 18,
  40       "html_filename": "Provider2.html",
  41       "href": "Provider2.html#Ext-state-Provider-cfg-prefix"
  42     }
  43   ],
  44   "method": [
  45     {
  46       "tagname": "method",
  47       "name": "addEvents",
  48       "member": "Ext.util.Observable",
  49       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
  50       "params": [
  51         {
  52           "type": "Object/String",
  53           "name": "o",
  54           "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",
  55           "optional": false
  56         },
  57         {
  58           "type": "String",
  59           "name": "",
  60           "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",
  61           "optional": false
  62         }
  63       ],
  64       "return": {
  65         "type": "void",
  66         "doc": "\n"
  67       },
  68       "private": false,
  69       "static": false,
  70       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  71       "linenr": 452,
  72       "html_filename": "Observable.html",
  73       "href": "Observable.html#Ext-util-Observable-method-addEvents",
  74       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
  75     },
  76     {
  77       "tagname": "method",
  78       "name": "addListener",
  79       "member": "Ext.util.Observable",
  80       "doc": "<p>Appends an event handler to this object.</p>\n",
  81       "params": [
  82         {
  83           "type": "String",
  84           "name": "eventName",
  85           "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",
  86           "optional": false
  87         },
  88         {
  89           "type": "Function",
  90           "name": "handler",
  91           "doc": "<p>The method the event invokes.</p>\n",
  92           "optional": false
  93         },
  94         {
  95           "type": "Object",
  96           "name": "scope",
  97           "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",
  98           "optional": true
  99         },
 100         {
 101           "type": "Object",
 102           "name": "options",
 103           "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",
 104           "optional": true
 105         }
 106       ],
 107       "return": {
 108         "type": "void",
 109         "doc": "\n"
 110       },
 111       "private": false,
 112       "static": false,
 113       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 114       "linenr": 271,
 115       "html_filename": "Observable.html",
 116       "href": "Observable.html#Ext-util-Observable-method-addListener",
 117       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
 118     },
 119     {
 120       "tagname": "method",
 121       "name": "addManagedListener",
 122       "member": "Ext.util.Observable",
 123       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
 124       "params": [
 125         {
 126           "type": "Observable/Element",
 127           "name": "item",
 128           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 129           "optional": false
 130         },
 131         {
 132           "type": "Object/String",
 133           "name": "ename",
 134           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 135           "optional": false
 136         },
 137         {
 138           "type": "Function",
 139           "name": "fn",
 140           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 141           "optional": false
 142         },
 143         {
 144           "type": "Object",
 145           "name": "scope",
 146           "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",
 147           "optional": false
 148         },
 149         {
 150           "type": "Object",
 151           "name": "opt",
 152           "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",
 153           "optional": false
 154         }
 155       ],
 156       "return": {
 157         "type": "void",
 158         "doc": "\n"
 159       },
 160       "private": false,
 161       "static": false,
 162       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 163       "linenr": 155,
 164       "html_filename": "Observable.html",
 165       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 166       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
 167     },
 168     {
 169       "tagname": "method",
 170       "name": "capture",
 171       "member": "Ext.util.Observable",
 172       "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",
 173       "params": [
 174         {
 175           "type": "Observable",
 176           "name": "o",
 177           "doc": "<p>The Observable to capture events from.</p>\n",
 178           "optional": false
 179         },
 180         {
 181           "type": "Function",
 182           "name": "fn",
 183           "doc": "<p>The function to call when an event is fired.</p>\n",
 184           "optional": false
 185         },
 186         {
 187           "type": "Object",
 188           "name": "scope",
 189           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
 190           "optional": true
 191         }
 192       ],
 193       "return": {
 194         "type": "void",
 195         "doc": "\n"
 196       },
 197       "private": false,
 198       "static": true,
 199       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 200       "linenr": 55,
 201       "html_filename": "Observable.html",
 202       "href": "Observable.html#Ext-util-Observable-method-capture",
 203       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
 204     },
 205     {
 206       "tagname": "method",
 207       "name": "clear",
 208       "member": "Ext.state.Provider",
 209       "doc": "<p>Clears a value from the state</p>\n",
 210       "params": [
 211         {
 212           "type": "String",
 213           "name": "name",
 214           "doc": "<p>The key name</p>\n",
 215           "optional": false
 216         }
 217       ],
 218       "return": {
 219         "type": "void",
 220         "doc": "\n"
 221       },
 222       "private": false,
 223       "static": false,
 224       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Provider.js",
 225       "linenr": 51,
 226       "html_filename": "Provider2.html",
 227       "href": "Provider2.html#Ext-state-Provider-method-clear",
 228       "shortDoc": "<p>Clears a value from the state</p>\n"
 229     },
 230     {
 231       "tagname": "method",
 232       "name": "clearListeners",
 233       "member": "Ext.util.Observable",
 234       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 235       "params": [
 236
 237       ],
 238       "return": {
 239         "type": "void",
 240         "doc": "\n"
 241       },
 242       "private": false,
 243       "static": false,
 244       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 245       "linenr": 383,
 246       "html_filename": "Observable.html",
 247       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 248       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
 249     },
 250     {
 251       "tagname": "method",
 252       "name": "clearManagedListeners",
 253       "member": "Ext.util.Observable",
 254       "doc": "<p>Removes all managed listeners for this object.</p>\n",
 255       "params": [
 256
 257       ],
 258       "return": {
 259         "type": "void",
 260         "doc": "\n"
 261       },
 262       "private": false,
 263       "static": false,
 264       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 265       "linenr": 412,
 266       "html_filename": "Observable.html",
 267       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 268       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
 269     },
 270     {
 271       "tagname": "method",
 272       "name": "decodeValue",
 273       "member": "Ext.state.Provider",
 274       "doc": "<p>Decodes a string previously encoded with <a href=\"#/api/Ext.state.Provider-method-encodeValue\" rel=\"Ext.state.Provider-method-encodeValue\" class=\"docClass\">encodeValue</a>.</p>\n",
 275       "params": [
 276         {
 277           "type": "String",
 278           "name": "value",
 279           "doc": "<p>The value to decode</p>\n",
 280           "optional": false
 281         }
 282       ],
 283       "return": {
 284         "type": "Mixed",
 285         "doc": "<p>The decoded value</p>\n"
 286       },
 287       "private": false,
 288       "static": false,
 289       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Provider.js",
 290       "linenr": 72,
 291       "html_filename": "Provider2.html",
 292       "href": "Provider2.html#Ext-state-Provider-method-decodeValue",
 293       "shortDoc": "<p>Decodes a string previously encoded with <a href=\"#/api/Ext.state.Provider-method-encodeValue\" rel=\"Ext.state.Provider-method-encodeValue\" class=\"docClass\">encodeValue</a>.</p>\n"
 294     },
 295     {
 296       "tagname": "method",
 297       "name": "enableBubble",
 298       "member": "Ext.util.Observable",
 299       "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",
 300       "params": [
 301         {
 302           "type": "String/Array",
 303           "name": "events",
 304           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 305           "optional": false
 306         }
 307       ],
 308       "return": {
 309         "type": "void",
 310         "doc": "\n"
 311       },
 312       "private": false,
 313       "static": false,
 314       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 315       "linenr": 554,
 316       "html_filename": "Observable.html",
 317       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 318       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 319     },
 320     {
 321       "tagname": "method",
 322       "name": "encodeValue",
 323       "member": "Ext.state.Provider",
 324       "doc": "<p>Encodes a value including type information.  Decode with <a href=\"#/api/Ext.state.Provider-method-decodeValue\" rel=\"Ext.state.Provider-method-decodeValue\" class=\"docClass\">decodeValue</a>.</p>\n",
 325       "params": [
 326         {
 327           "type": "Mixed",
 328           "name": "value",
 329           "doc": "<p>The value to encode</p>\n",
 330           "optional": false
 331         }
 332       ],
 333       "return": {
 334         "type": "String",
 335         "doc": "<p>The encoded value</p>\n"
 336       },
 337       "private": false,
 338       "static": false,
 339       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Provider.js",
 340       "linenr": 132,
 341       "html_filename": "Provider2.html",
 342       "href": "Provider2.html#Ext-state-Provider-method-encodeValue",
 343       "shortDoc": "<p>Encodes a value including type information.  Decode with <a href=\"#/api/Ext.state.Provider-method-decodeValue\" rel=\"Ext.state.Provider-method-decodeValue\" class=\"docClass\">decodeValue</a>.</p>\n"
 344     },
 345     {
 346       "tagname": "method",
 347       "name": "fireEvent",
 348       "member": "Ext.util.Observable",
 349       "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.state.Provider-method-enableBubble\" rel=\"Ext.state.Provider-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 350       "params": [
 351         {
 352           "type": "String",
 353           "name": "eventName",
 354           "doc": "<p>The name of the event to fire.</p>\n",
 355           "optional": false
 356         },
 357         {
 358           "type": "Object...",
 359           "name": "args",
 360           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 361           "optional": false
 362         }
 363       ],
 364       "return": {
 365         "type": "Boolean",
 366         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 367       },
 368       "private": false,
 369       "static": false,
 370       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 371       "linenr": 232,
 372       "html_filename": "Observable.html",
 373       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 374       "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..."
 375     },
 376     {
 377       "tagname": "method",
 378       "name": "get",
 379       "member": "Ext.state.Provider",
 380       "doc": "<p>Returns the current value for a key</p>\n",
 381       "params": [
 382         {
 383           "type": "String",
 384           "name": "name",
 385           "doc": "<p>The key name</p>\n",
 386           "optional": false
 387         },
 388         {
 389           "type": "Mixed",
 390           "name": "defaultValue",
 391           "doc": "<p>A default value to return if the key's value is not found</p>\n",
 392           "optional": false
 393         }
 394       ],
 395       "return": {
 396         "type": "Mixed",
 397         "doc": "<p>The state data</p>\n"
 398       },
 399       "private": false,
 400       "static": false,
 401       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Provider.js",
 402       "linenr": 40,
 403       "html_filename": "Provider2.html",
 404       "href": "Provider2.html#Ext-state-Provider-method-get",
 405       "shortDoc": "<p>Returns the current value for a key</p>\n"
 406     },
 407     {
 408       "tagname": "method",
 409       "name": "hasListener",
 410       "member": "Ext.util.Observable",
 411       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 412       "params": [
 413         {
 414           "type": "String",
 415           "name": "eventName",
 416           "doc": "<p>The name of the event to check for</p>\n",
 417           "optional": false
 418         }
 419       ],
 420       "return": {
 421         "type": "Boolean",
 422         "doc": "<p>True if the event is being listened for, else false</p>\n"
 423       },
 424       "private": false,
 425       "static": false,
 426       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 427       "linenr": 480,
 428       "html_filename": "Observable.html",
 429       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 430       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 431     },
 432     {
 433       "tagname": "method",
 434       "name": "observe",
 435       "member": "Ext.util.Observable",
 436       "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",
 437       "params": [
 438         {
 439           "type": "Function",
 440           "name": "c",
 441           "doc": "<p>The class constructor to make observable.</p>\n",
 442           "optional": false
 443         },
 444         {
 445           "type": "Object",
 446           "name": "listeners",
 447           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.state.Provider-method-addListener\" rel=\"Ext.state.Provider-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
 448           "optional": false
 449         }
 450       ],
 451       "return": {
 452         "type": "void",
 453         "doc": "\n"
 454       },
 455       "private": false,
 456       "static": true,
 457       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 458       "linenr": 69,
 459       "html_filename": "Observable.html",
 460       "href": "Observable.html#Ext-util-Observable-method-observe",
 461       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
 462     },
 463     {
 464       "tagname": "method",
 465       "name": "on",
 466       "member": "Ext.util.Observable",
 467       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.state.Provider-method-addListener\" rel=\"Ext.state.Provider-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
 468       "params": [
 469         {
 470           "type": "String",
 471           "name": "eventName",
 472           "doc": "<p>The type of event to listen for</p>\n",
 473           "optional": false
 474         },
 475         {
 476           "type": "Function",
 477           "name": "handler",
 478           "doc": "<p>The method the event invokes</p>\n",
 479           "optional": false
 480         },
 481         {
 482           "type": "Object",
 483           "name": "scope",
 484           "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",
 485           "optional": true
 486         },
 487         {
 488           "type": "Object",
 489           "name": "options",
 490           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
 491           "optional": true
 492         }
 493       ],
 494       "return": {
 495         "type": "void",
 496         "doc": "\n"
 497       },
 498       "private": false,
 499       "static": false,
 500       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 501       "linenr": 616,
 502       "html_filename": "Observable.html",
 503       "href": "Observable.html#Ext-util-Observable-method-on",
 504       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.state.Provider-method-addListener\" rel=\"Ext.state.Provider-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
 505     },
 506     {
 507       "tagname": "method",
 508       "name": "relayEvents",
 509       "member": "Ext.util.Observable",
 510       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
 511       "params": [
 512         {
 513           "type": "Object",
 514           "name": "origin",
 515           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 516           "optional": false
 517         },
 518         {
 519           "type": "Array",
 520           "name": "events",
 521           "doc": "<p>Array of event names to relay.</p>\n",
 522           "optional": false
 523         },
 524         {
 525           "type": "Object",
 526           "name": "prefix",
 527           "doc": "\n",
 528           "optional": false
 529         }
 530       ],
 531       "return": {
 532         "type": "void",
 533         "doc": "\n"
 534       },
 535       "private": false,
 536       "static": false,
 537       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 538       "linenr": 520,
 539       "html_filename": "Observable.html",
 540       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 541       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
 542     },
 543     {
 544       "tagname": "method",
 545       "name": "releaseCapture",
 546       "member": "Ext.util.Observable",
 547       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
 548       "params": [
 549         {
 550           "type": "Observable",
 551           "name": "o",
 552           "doc": "<p>The Observable to release</p>\n",
 553           "optional": false
 554         }
 555       ],
 556       "return": {
 557         "type": "void",
 558         "doc": "\n"
 559       },
 560       "private": false,
 561       "static": true,
 562       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 563       "linenr": 46,
 564       "html_filename": "Observable.html",
 565       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 566       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
 567     },
 568     {
 569       "tagname": "method",
 570       "name": "removeListener",
 571       "member": "Ext.util.Observable",
 572       "doc": "<p>Removes an event handler.</p>\n",
 573       "params": [
 574         {
 575           "type": "String",
 576           "name": "eventName",
 577           "doc": "<p>The type of event the handler was associated with.</p>\n",
 578           "optional": false
 579         },
 580         {
 581           "type": "Function",
 582           "name": "handler",
 583           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.state.Provider-method-addListener\" rel=\"Ext.state.Provider-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 584           "optional": false
 585         },
 586         {
 587           "type": "Object",
 588           "name": "scope",
 589           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 590           "optional": true
 591         }
 592       ],
 593       "return": {
 594         "type": "void",
 595         "doc": "\n"
 596       },
 597       "private": false,
 598       "static": false,
 599       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 600       "linenr": 352,
 601       "html_filename": "Observable.html",
 602       "href": "Observable.html#Ext-util-Observable-method-removeListener",
 603       "shortDoc": "<p>Removes an event handler.</p>\n"
 604     },
 605     {
 606       "tagname": "method",
 607       "name": "removeManagedListener",
 608       "member": "Ext.util.Observable",
 609       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.state.Provider--mon\" rel=\"Ext.state.Provider--mon\" class=\"docClass\">mon</a> method.</p>\n",
 610       "params": [
 611         {
 612           "type": "Observable|Element",
 613           "name": "item",
 614           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 615           "optional": false
 616         },
 617         {
 618           "type": "Object|String",
 619           "name": "ename",
 620           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 621           "optional": false
 622         },
 623         {
 624           "type": "Function",
 625           "name": "fn",
 626           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 627           "optional": false
 628         },
 629         {
 630           "type": "Object",
 631           "name": "scope",
 632           "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",
 633           "optional": false
 634         }
 635       ],
 636       "return": {
 637         "type": "void",
 638         "doc": "\n"
 639       },
 640       "private": false,
 641       "static": false,
 642       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 643       "linenr": 196,
 644       "html_filename": "Observable.html",
 645       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
 646       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.state.Provider--mon\" rel=\"Ext.state.Provider--mon\" class=\"docClass\">mon</a> method.</p>\n"
 647     },
 648     {
 649       "tagname": "method",
 650       "name": "resumeEvents",
 651       "member": "Ext.util.Observable",
 652       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.state.Provider-method-suspendEvents\" rel=\"Ext.state.Provider-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",
 653       "params": [
 654
 655       ],
 656       "return": {
 657         "type": "void",
 658         "doc": "\n"
 659       },
 660       "private": false,
 661       "static": false,
 662       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 663       "linenr": 502,
 664       "html_filename": "Observable.html",
 665       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
 666       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
 667     },
 668     {
 669       "tagname": "method",
 670       "name": "set",
 671       "member": "Ext.state.Provider",
 672       "doc": "<p>Sets the value for a key</p>\n",
 673       "params": [
 674         {
 675           "type": "String",
 676           "name": "name",
 677           "doc": "<p>The key name</p>\n",
 678           "optional": false
 679         },
 680         {
 681           "type": "Mixed",
 682           "name": "value",
 683           "doc": "<p>The value to set</p>\n",
 684           "optional": false
 685         }
 686       ],
 687       "return": {
 688         "type": "void",
 689         "doc": "\n"
 690       },
 691       "private": false,
 692       "static": false,
 693       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Provider.js",
 694       "linenr": 61,
 695       "html_filename": "Provider2.html",
 696       "href": "Provider2.html#Ext-state-Provider-method-set",
 697       "shortDoc": "<p>Sets the value for a key</p>\n"
 698     },
 699     {
 700       "tagname": "method",
 701       "name": "suspendEvents",
 702       "member": "Ext.util.Observable",
 703       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.state.Provider-method-resumeEvents\" rel=\"Ext.state.Provider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
 704       "params": [
 705         {
 706           "type": "Boolean",
 707           "name": "queueSuspended",
 708           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.state.Provider-method-resumeEvents\" rel=\"Ext.state.Provider-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
 709           "optional": false
 710         }
 711       ],
 712       "return": {
 713         "type": "void",
 714         "doc": "\n"
 715       },
 716       "private": false,
 717       "static": false,
 718       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 719       "linenr": 490,
 720       "html_filename": "Observable.html",
 721       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
 722       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.state.Provider-method-resumeEvents\" rel=\"Ext.state.Provider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
 723     },
 724     {
 725       "tagname": "method",
 726       "name": "un",
 727       "member": "Ext.util.Observable",
 728       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.state.Provider-method-removeListener\" rel=\"Ext.state.Provider-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
 729       "params": [
 730         {
 731           "type": "String",
 732           "name": "eventName",
 733           "doc": "<p>The type of event the handler was associated with.</p>\n",
 734           "optional": false
 735         },
 736         {
 737           "type": "Function",
 738           "name": "handler",
 739           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.state.Provider-method-addListener\" rel=\"Ext.state.Provider-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 740           "optional": false
 741         },
 742         {
 743           "type": "Object",
 744           "name": "scope",
 745           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 746           "optional": true
 747         }
 748       ],
 749       "return": {
 750         "type": "void",
 751         "doc": "\n"
 752       },
 753       "private": false,
 754       "static": false,
 755       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 756       "linenr": 608,
 757       "html_filename": "Observable.html",
 758       "href": "Observable.html#Ext-util-Observable-method-un",
 759       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.state.Provider-method-removeListener\" rel=\"Ext.state.Provider-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
 760     }
 761   ],
 762   "property": [
 763
 764   ],
 765   "event": [
 766     {
 767       "tagname": "event",
 768       "name": "statechange",
 769       "member": "Ext.state.Provider",
 770       "doc": "<p>Fires when a state change occurs.</p>\n",
 771       "params": [
 772         {
 773           "type": "Provider",
 774           "name": "this",
 775           "doc": "<p>This state provider</p>\n",
 776           "optional": false
 777         },
 778         {
 779           "type": "String",
 780           "name": "key",
 781           "doc": "<p>The state key which was changed</p>\n",
 782           "optional": false
 783         },
 784         {
 785           "type": "String",
 786           "name": "value",
 787           "doc": "<p>The encoded value for the state</p>\n",
 788           "optional": false
 789         }
 790       ],
 791       "private": false,
 792       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Provider.js",
 793       "linenr": 28,
 794       "html_filename": "Provider2.html",
 795       "href": "Provider2.html#Ext-state-Provider-event-statechange",
 796       "shortDoc": "<p>Fires when a state change occurs.</p>\n"
 797     }
 798   ],
 799   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Provider.js",
 800   "linenr": 1,
 801   "html_filename": "Provider2.html",
 802   "href": "Provider2.html#Ext-state-Provider",
 803   "cssVar": [
 804
 805   ],
 806   "cssMixin": [
 807
 808   ],
 809   "component": false,
 810   "superclasses": [
 811
 812   ],
 813   "subclasses": [
 814     "Ext.state.CookieProvider"
 815   ],
 816   "mixedInto": [
 817
 818   ],
 819   "allMixins": [
 820     "Ext.util.Observable"
 821   ]
 822 });