docs/output/Ext.state.CookieProvider.js

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