Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.state.LocalStorageProvider.js
1 Ext.data.JsonP.Ext_state_LocalStorageProvider({
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.state.LocalStorageProvider-method-addListener\" rel=\"Ext.state.LocalStorageProvider-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         "type": "String",
28         "deprecated": null,
29         "alias": null,
30         "protected": false,
31         "tagname": "cfg",
32         "href": "Provider.html#Ext-state-Provider-cfg-prefix",
33         "shortDoc": "A string to prefix to items stored in the underlying state store. ...",
34         "static": false,
35         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Provider.js",
36         "private": false,
37         "name": "prefix",
38         "owner": "Ext.state.Provider",
39         "doc": "<p>A string to prefix to items stored in the underlying state store.\nDefaults to <tt>'ext-'</tt></p>\n",
40         "linenr": 18,
41         "html_filename": "Provider.html"
42       }
43     ],
44     "method": [
45       {
46         "deprecated": null,
47         "alias": null,
48         "protected": false,
49         "tagname": "method",
50         "href": "Observable.html#Ext-util-Observable-method-addEvents",
51         "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...",
52         "static": false,
53         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
54         "private": false,
55         "params": [
56           {
57             "type": "Object/String",
58             "optional": false,
59             "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",
60             "name": "o"
61           },
62           {
63             "type": "String...",
64             "optional": false,
65             "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",
66             "name": "more"
67           }
68         ],
69         "name": "addEvents",
70         "owner": "Ext.util.Observable",
71         "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
72         "linenr": 494,
73         "return": {
74           "type": "void",
75           "doc": "\n"
76         },
77         "html_filename": "Observable.html"
78       },
79       {
80         "deprecated": null,
81         "alias": null,
82         "protected": false,
83         "tagname": "method",
84         "href": "Observable.html#Ext-util-Observable-method-addListener",
85         "shortDoc": "Appends an event handler to this object. ...",
86         "static": false,
87         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
88         "private": false,
89         "params": [
90           {
91             "type": "String",
92             "optional": false,
93             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
94             "name": "eventName"
95           },
96           {
97             "type": "Function",
98             "optional": false,
99             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.state.LocalStorageProvider-method-fireEvent\" rel=\"Ext.state.LocalStorageProvider-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
100             "name": "handler"
101           },
102           {
103             "type": "Object",
104             "optional": true,
105             "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",
106             "name": "scope"
107           },
108           {
109             "type": "Object",
110             "optional": true,
111             "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",
112             "name": "options"
113           }
114         ],
115         "name": "addListener",
116         "owner": "Ext.util.Observable",
117         "doc": "<p>Appends an event handler to this object.</p>\n",
118         "linenr": 278,
119         "return": {
120           "type": "void",
121           "doc": "\n"
122         },
123         "html_filename": "Observable.html"
124       },
125       {
126         "deprecated": null,
127         "alias": null,
128         "protected": false,
129         "tagname": "method",
130         "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
131         "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...",
132         "static": false,
133         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
134         "private": false,
135         "params": [
136           {
137             "type": "Observable/Element",
138             "optional": false,
139             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
140             "name": "item"
141           },
142           {
143             "type": "Object/String",
144             "optional": false,
145             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
146             "name": "ename"
147           },
148           {
149             "type": "Function",
150             "optional": true,
151             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
152             "name": "fn"
153           },
154           {
155             "type": "Object",
156             "optional": true,
157             "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",
158             "name": "scope"
159           },
160           {
161             "type": "Object",
162             "optional": true,
163             "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",
164             "name": "opt"
165           }
166         ],
167         "name": "addManagedListener",
168         "owner": "Ext.util.Observable",
169         "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
170         "linenr": 156,
171         "return": {
172           "type": "void",
173           "doc": "\n"
174         },
175         "html_filename": "Observable.html"
176       },
177       {
178         "deprecated": null,
179         "alias": null,
180         "protected": false,
181         "tagname": "method",
182         "href": "Base3.html#Ext-Base-method-addStatics",
183         "shortDoc": "Add / override static properties of this class. ...",
184         "static": true,
185         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
186         "private": false,
187         "params": [
188           {
189             "type": "Object",
190             "optional": false,
191             "doc": "\n",
192             "name": "members"
193           }
194         ],
195         "name": "addStatics",
196         "owner": "Ext.Base",
197         "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",
198         "linenr": 388,
199         "return": {
200           "type": "Ext.Base",
201           "doc": "<p>this</p>\n"
202         },
203         "html_filename": "Base3.html"
204       },
205       {
206         "deprecated": null,
207         "alias": null,
208         "protected": false,
209         "tagname": "method",
210         "href": "Base3.html#Ext-Base-method-callOverridden",
211         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
212         "static": false,
213         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
214         "private": false,
215         "params": [
216           {
217             "type": "Array/Arguments",
218             "optional": false,
219             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
220             "name": "args"
221           }
222         ],
223         "name": "callOverridden",
224         "owner": "Ext.Base",
225         "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",
226         "linenr": 269,
227         "return": {
228           "type": "Mixed",
229           "doc": "<p>Returns the result after calling the overridden method</p>\n"
230         },
231         "html_filename": "Base3.html"
232       },
233       {
234         "deprecated": null,
235         "alias": null,
236         "protected": true,
237         "tagname": "method",
238         "href": "Base3.html#Ext-Base-method-callParent",
239         "shortDoc": "Call the parent's overridden method. ...",
240         "static": false,
241         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
242         "private": false,
243         "params": [
244           {
245             "type": "Array/Arguments",
246             "optional": false,
247             "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",
248             "name": "args"
249           }
250         ],
251         "name": "callParent",
252         "owner": "Ext.Base",
253         "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",
254         "linenr": 124,
255         "return": {
256           "type": "Mixed",
257           "doc": "<p>Returns the result from the superclass' method</p>\n"
258         },
259         "html_filename": "Base3.html"
260       },
261       {
262         "deprecated": null,
263         "alias": null,
264         "protected": false,
265         "tagname": "method",
266         "href": "Observable.html#Ext-util-Observable-method-capture",
267         "shortDoc": "Starts capture on the specified Observable. ...",
268         "static": true,
269         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
270         "private": false,
271         "params": [
272           {
273             "type": "Observable",
274             "optional": false,
275             "doc": "<p>The Observable to capture events from.</p>\n",
276             "name": "o"
277           },
278           {
279             "type": "Function",
280             "optional": false,
281             "doc": "<p>The function to call when an event is fired.</p>\n",
282             "name": "fn"
283           },
284           {
285             "type": "Object",
286             "optional": true,
287             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to\nthe Observable firing the event.</p>\n",
288             "name": "scope"
289           }
290         ],
291         "name": "capture",
292         "owner": "Ext.util.Observable",
293         "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",
294         "linenr": 54,
295         "return": {
296           "type": "void",
297           "doc": "\n"
298         },
299         "html_filename": "Observable.html"
300       },
301       {
302         "deprecated": null,
303         "alias": null,
304         "protected": false,
305         "tagname": "method",
306         "href": "Provider.html#Ext-state-Provider-method-clear",
307         "shortDoc": "Clears a value from the state ...",
308         "static": false,
309         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Provider.js",
310         "private": false,
311         "params": [
312           {
313             "type": "String",
314             "optional": false,
315             "doc": "<p>The key name</p>\n",
316             "name": "name"
317           }
318         ],
319         "name": "clear",
320         "owner": "Ext.state.Provider",
321         "doc": "<p>Clears a value from the state</p>\n",
322         "linenr": 51,
323         "return": {
324           "type": "void",
325           "doc": "\n"
326         },
327         "html_filename": "Provider.html"
328       },
329       {
330         "deprecated": null,
331         "alias": null,
332         "protected": false,
333         "tagname": "method",
334         "href": "Observable.html#Ext-util-Observable-method-clearListeners",
335         "shortDoc": "Removes all listeners for this object including the managed listeners ...",
336         "static": false,
337         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
338         "private": false,
339         "params": [
340
341         ],
342         "name": "clearListeners",
343         "owner": "Ext.util.Observable",
344         "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
345         "linenr": 425,
346         "return": {
347           "type": "void",
348           "doc": "\n"
349         },
350         "html_filename": "Observable.html"
351       },
352       {
353         "deprecated": null,
354         "alias": null,
355         "protected": false,
356         "tagname": "method",
357         "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
358         "shortDoc": "Removes all managed listeners for this object. ...",
359         "static": false,
360         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
361         "private": false,
362         "params": [
363
364         ],
365         "name": "clearManagedListeners",
366         "owner": "Ext.util.Observable",
367         "doc": "<p>Removes all managed listeners for this object.</p>\n",
368         "linenr": 454,
369         "return": {
370           "type": "void",
371           "doc": "\n"
372         },
373         "html_filename": "Observable.html"
374       },
375       {
376         "deprecated": null,
377         "alias": null,
378         "protected": false,
379         "tagname": "method",
380         "href": "Base3.html#Ext-Base-method-create",
381         "shortDoc": "Create a new instance of this Class. ...",
382         "static": true,
383         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
384         "private": false,
385         "params": [
386
387         ],
388         "name": "create",
389         "owner": "Ext.Base",
390         "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",
391         "linenr": 329,
392         "return": {
393           "type": "Object",
394           "doc": "<p>the created instance.</p>\n"
395         },
396         "html_filename": "Base3.html"
397       },
398       {
399         "deprecated": null,
400         "alias": null,
401         "protected": false,
402         "tagname": "method",
403         "href": "Base3.html#Ext-Base-method-createAlias",
404         "shortDoc": "Create aliases for existing prototype methods. ...",
405         "static": true,
406         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
407         "private": false,
408         "params": [
409           {
410             "type": "String/Object",
411             "optional": false,
412             "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",
413             "name": "alias"
414           },
415           {
416             "type": "String/Object",
417             "optional": false,
418             "doc": "<p>The original method name</p>\n",
419             "name": "origin"
420           }
421         ],
422         "name": "createAlias",
423         "owner": "Ext.Base",
424         "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",
425         "linenr": 648,
426         "return": {
427           "type": "void",
428           "doc": "\n"
429         },
430         "html_filename": "Base3.html"
431       },
432       {
433         "deprecated": null,
434         "alias": null,
435         "protected": false,
436         "tagname": "method",
437         "href": "Provider.html#Ext-state-Provider-method-decodeValue",
438         "shortDoc": "Decodes a string previously encoded with encodeValue. ...",
439         "static": false,
440         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Provider.js",
441         "private": false,
442         "params": [
443           {
444             "type": "String",
445             "optional": false,
446             "doc": "<p>The value to decode</p>\n",
447             "name": "value"
448           }
449         ],
450         "name": "decodeValue",
451         "owner": "Ext.state.Provider",
452         "doc": "<p>Decodes a string previously encoded with <a href=\"#/api/Ext.state.LocalStorageProvider-method-encodeValue\" rel=\"Ext.state.LocalStorageProvider-method-encodeValue\" class=\"docClass\">encodeValue</a>.</p>\n",
453         "linenr": 72,
454         "return": {
455           "type": "Mixed",
456           "doc": "<p>The decoded value</p>\n"
457         },
458         "html_filename": "Provider.html"
459       },
460       {
461         "deprecated": null,
462         "alias": null,
463         "protected": false,
464         "tagname": "method",
465         "href": "Observable.html#Ext-util-Observable-method-enableBubble",
466         "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...",
467         "static": false,
468         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
469         "private": false,
470         "params": [
471           {
472             "type": "String/[String]",
473             "optional": false,
474             "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
475             "name": "events"
476           }
477         ],
478         "name": "enableBubble",
479         "owner": "Ext.util.Observable",
480         "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",
481         "linenr": 609,
482         "return": {
483           "type": "void",
484           "doc": "\n"
485         },
486         "html_filename": "Observable.html"
487       },
488       {
489         "deprecated": null,
490         "alias": null,
491         "protected": false,
492         "tagname": "method",
493         "href": "Provider.html#Ext-state-Provider-method-encodeValue",
494         "shortDoc": "Encodes a value including type information. ...",
495         "static": false,
496         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Provider.js",
497         "private": false,
498         "params": [
499           {
500             "type": "Mixed",
501             "optional": false,
502             "doc": "<p>The value to encode</p>\n",
503             "name": "value"
504           }
505         ],
506         "name": "encodeValue",
507         "owner": "Ext.state.Provider",
508         "doc": "<p>Encodes a value including type information.  Decode with <a href=\"#/api/Ext.state.LocalStorageProvider-method-decodeValue\" rel=\"Ext.state.LocalStorageProvider-method-decodeValue\" class=\"docClass\">decodeValue</a>.</p>\n",
509         "linenr": 132,
510         "return": {
511           "type": "String",
512           "doc": "<p>The encoded value</p>\n"
513         },
514         "html_filename": "Provider.html"
515       },
516       {
517         "deprecated": null,
518         "alias": null,
519         "protected": false,
520         "tagname": "method",
521         "href": "Observable.html#Ext-util-Observable-method-fireEvent",
522         "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...",
523         "static": false,
524         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
525         "private": false,
526         "params": [
527           {
528             "type": "String",
529             "optional": false,
530             "doc": "<p>The name of the event to fire.</p>\n",
531             "name": "eventName"
532           },
533           {
534             "type": "Object...",
535             "optional": false,
536             "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
537             "name": "args"
538           }
539         ],
540         "name": "fireEvent",
541         "owner": "Ext.util.Observable",
542         "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.state.LocalStorageProvider-method-addListener\" rel=\"Ext.state.LocalStorageProvider-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.state.LocalStorageProvider-method-enableBubble\" rel=\"Ext.state.LocalStorageProvider-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n",
543         "linenr": 233,
544         "return": {
545           "type": "Boolean",
546           "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
547         },
548         "html_filename": "Observable.html"
549       },
550       {
551         "deprecated": null,
552         "alias": null,
553         "protected": false,
554         "tagname": "method",
555         "href": "Provider.html#Ext-state-Provider-method-get",
556         "shortDoc": "Returns the current value for a key ...",
557         "static": false,
558         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Provider.js",
559         "private": false,
560         "params": [
561           {
562             "type": "String",
563             "optional": false,
564             "doc": "<p>The key name</p>\n",
565             "name": "name"
566           },
567           {
568             "type": "Mixed",
569             "optional": false,
570             "doc": "<p>A default value to return if the key's value is not found</p>\n",
571             "name": "defaultValue"
572           }
573         ],
574         "name": "get",
575         "owner": "Ext.state.Provider",
576         "doc": "<p>Returns the current value for a key</p>\n",
577         "linenr": 40,
578         "return": {
579           "type": "Mixed",
580           "doc": "<p>The state data</p>\n"
581         },
582         "html_filename": "Provider.html"
583       },
584       {
585         "deprecated": null,
586         "alias": null,
587         "protected": false,
588         "tagname": "method",
589         "href": "Base3.html#Ext-Base-method-getName",
590         "shortDoc": "Get the current class' name in string format. ...",
591         "static": false,
592         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
593         "private": false,
594         "params": [
595
596         ],
597         "name": "getName",
598         "owner": "Ext.Base",
599         "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",
600         "linenr": 631,
601         "return": {
602           "type": "String",
603           "doc": "<p>className</p>\n"
604         },
605         "html_filename": "Base3.html"
606       },
607       {
608         "deprecated": null,
609         "alias": null,
610         "protected": false,
611         "tagname": "method",
612         "href": "Observable.html#Ext-util-Observable-method-hasListener",
613         "shortDoc": "Checks to see if this object has any listeners for a specified event ...",
614         "static": false,
615         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
616         "private": false,
617         "params": [
618           {
619             "type": "String",
620             "optional": false,
621             "doc": "<p>The name of the event to check for</p>\n",
622             "name": "eventName"
623           }
624         ],
625         "name": "hasListener",
626         "owner": "Ext.util.Observable",
627         "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
628         "linenr": 530,
629         "return": {
630           "type": "Boolean",
631           "doc": "<p>True if the event is being listened for, else false</p>\n"
632         },
633         "html_filename": "Observable.html"
634       },
635       {
636         "deprecated": null,
637         "alias": null,
638         "protected": false,
639         "tagname": "method",
640         "href": "Base3.html#Ext-Base-method-implement",
641         "shortDoc": "Add methods / properties to the prototype of this class. ...",
642         "static": true,
643         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
644         "private": false,
645         "params": [
646           {
647             "type": "Object",
648             "optional": false,
649             "doc": "\n",
650             "name": "members"
651           }
652         ],
653         "name": "implement",
654         "owner": "Ext.Base",
655         "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",
656         "linenr": 415,
657         "return": {
658           "type": "void",
659           "doc": "\n"
660         },
661         "html_filename": "Base3.html"
662       },
663       {
664         "deprecated": null,
665         "alias": null,
666         "protected": true,
667         "tagname": "method",
668         "href": "Base3.html#Ext-Base-method-initConfig",
669         "shortDoc": "Initialize configuration for this class. ...",
670         "static": false,
671         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
672         "private": false,
673         "params": [
674           {
675             "type": "Object",
676             "optional": false,
677             "doc": "\n",
678             "name": "config"
679           }
680         ],
681         "name": "initConfig",
682         "owner": "Ext.Base",
683         "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",
684         "linenr": 63,
685         "return": {
686           "type": "Object",
687           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
688         },
689         "html_filename": "Base3.html"
690       },
691       {
692         "deprecated": null,
693         "alias": {
694           "tagname": "alias",
695           "cls": "Ext.util.Observable",
696           "doc": null,
697           "owner": "addManagedListener"
698         },
699         "protected": false,
700         "tagname": "method",
701         "href": "Observable.html#Ext-util-Observable-method-mon",
702         "shortDoc": "Shorthand for addManagedListener. ...",
703         "static": false,
704         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
705         "private": false,
706         "params": [
707           {
708             "type": "Observable/Element",
709             "optional": false,
710             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
711             "name": "item"
712           },
713           {
714             "type": "Object/String",
715             "optional": false,
716             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
717             "name": "ename"
718           },
719           {
720             "type": "Function",
721             "optional": true,
722             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
723             "name": "fn"
724           },
725           {
726             "type": "Object",
727             "optional": true,
728             "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",
729             "name": "scope"
730           },
731           {
732             "type": "Object",
733             "optional": true,
734             "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",
735             "name": "opt"
736           }
737         ],
738         "name": "mon",
739         "owner": "Ext.util.Observable",
740         "doc": "<p>Shorthand for <a href=\"#/api/Ext.state.LocalStorageProvider-method-addManagedListener\" rel=\"Ext.state.LocalStorageProvider-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",
741         "linenr": 681,
742         "return": {
743           "type": "void",
744           "doc": "\n"
745         },
746         "html_filename": "Observable.html"
747       },
748       {
749         "deprecated": null,
750         "alias": {
751           "tagname": "alias",
752           "cls": "Ext.util.Observable",
753           "doc": null,
754           "owner": "removeManagedListener"
755         },
756         "protected": false,
757         "tagname": "method",
758         "href": "Observable.html#Ext-util-Observable-method-mun",
759         "shortDoc": "Shorthand for removeManagedListener. ...",
760         "static": false,
761         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
762         "private": false,
763         "params": [
764           {
765             "type": "Observable|Element",
766             "optional": false,
767             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
768             "name": "item"
769           },
770           {
771             "type": "Object|String",
772             "optional": false,
773             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
774             "name": "ename"
775           },
776           {
777             "type": "Function",
778             "optional": false,
779             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
780             "name": "fn"
781           },
782           {
783             "type": "Object",
784             "optional": false,
785             "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",
786             "name": "scope"
787           }
788         ],
789         "name": "mun",
790         "owner": "Ext.util.Observable",
791         "doc": "<p>Shorthand for <a href=\"#/api/Ext.state.LocalStorageProvider-method-removeManagedListener\" rel=\"Ext.state.LocalStorageProvider-method-removeManagedListener\" class=\"docClass\">removeManagedListener</a>.</p>\n\n<p>Removes listeners that were added by the <a href=\"#/api/Ext.state.LocalStorageProvider-method-mon\" rel=\"Ext.state.LocalStorageProvider-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
792         "linenr": 687,
793         "return": {
794           "type": "void",
795           "doc": "\n"
796         },
797         "html_filename": "Observable.html"
798       },
799       {
800         "deprecated": null,
801         "alias": null,
802         "protected": false,
803         "tagname": "method",
804         "href": "Observable.html#Ext-util-Observable-method-observe",
805         "shortDoc": "Sets observability on the passed class constructor. ...",
806         "static": true,
807         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
808         "private": false,
809         "params": [
810           {
811             "type": "Function",
812             "optional": false,
813             "doc": "<p>The class constructor to make observable.</p>\n",
814             "name": "c"
815           },
816           {
817             "type": "Object",
818             "optional": false,
819             "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.state.LocalStorageProvider-method-addListener\" rel=\"Ext.state.LocalStorageProvider-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
820             "name": "listeners"
821           }
822         ],
823         "name": "observe",
824         "owner": "Ext.util.Observable",
825         "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",
826         "linenr": 69,
827         "return": {
828           "type": "void",
829           "doc": "\n"
830         },
831         "html_filename": "Observable.html"
832       },
833       {
834         "deprecated": null,
835         "alias": {
836           "tagname": "alias",
837           "cls": "Ext.util.Observable",
838           "doc": null,
839           "owner": "addListener"
840         },
841         "protected": false,
842         "tagname": "method",
843         "href": "Observable.html#Ext-util-Observable-method-on",
844         "shortDoc": "Shorthand for addListener. ...",
845         "static": false,
846         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
847         "private": false,
848         "params": [
849           {
850             "type": "String",
851             "optional": false,
852             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
853             "name": "eventName"
854           },
855           {
856             "type": "Function",
857             "optional": false,
858             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.state.LocalStorageProvider-method-fireEvent\" rel=\"Ext.state.LocalStorageProvider-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
859             "name": "handler"
860           },
861           {
862             "type": "Object",
863             "optional": true,
864             "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",
865             "name": "scope"
866           },
867           {
868             "type": "Object",
869             "optional": true,
870             "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",
871             "name": "options"
872           }
873         ],
874         "name": "on",
875         "owner": "Ext.util.Observable",
876         "doc": "<p>Shorthand for <a href=\"#/api/Ext.state.LocalStorageProvider-method-addListener\" rel=\"Ext.state.LocalStorageProvider-method-addListener\" class=\"docClass\">addListener</a>.</p>\n\n<p>Appends an event handler to this object.</p>\n",
877         "linenr": 669,
878         "return": {
879           "type": "void",
880           "doc": "\n"
881         },
882         "html_filename": "Observable.html"
883       },
884       {
885         "deprecated": null,
886         "alias": null,
887         "protected": false,
888         "tagname": "method",
889         "href": "Base3.html#Ext-Base-method-override",
890         "shortDoc": "Override prototype members of this class. ...",
891         "static": true,
892         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
893         "private": false,
894         "params": [
895           {
896             "type": "Object",
897             "optional": false,
898             "doc": "\n",
899             "name": "members"
900           }
901         ],
902         "name": "override",
903         "owner": "Ext.Base",
904         "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",
905         "linenr": 518,
906         "return": {
907           "type": "Ext.Base",
908           "doc": "<p>this</p>\n"
909         },
910         "html_filename": "Base3.html"
911       },
912       {
913         "deprecated": null,
914         "alias": null,
915         "protected": false,
916         "tagname": "method",
917         "href": "Observable.html#Ext-util-Observable-method-relayEvents",
918         "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...",
919         "static": false,
920         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
921         "private": false,
922         "params": [
923           {
924             "type": "Object",
925             "optional": false,
926             "doc": "<p>The Observable whose events this object is to relay.</p>\n",
927             "name": "origin"
928           },
929           {
930             "type": "[String]",
931             "optional": false,
932             "doc": "<p>Array of event names to relay.</p>\n",
933             "name": "events"
934           },
935           {
936             "type": "Object",
937             "optional": false,
938             "doc": "\n",
939             "name": "prefix"
940           }
941         ],
942         "name": "relayEvents",
943         "owner": "Ext.util.Observable",
944         "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code>this</code>.</p>\n",
945         "linenr": 573,
946         "return": {
947           "type": "void",
948           "doc": "\n"
949         },
950         "html_filename": "Observable.html"
951       },
952       {
953         "deprecated": null,
954         "alias": null,
955         "protected": false,
956         "tagname": "method",
957         "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
958         "shortDoc": "Removes all added captures from the Observable. ...",
959         "static": true,
960         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
961         "private": false,
962         "params": [
963           {
964             "type": "Observable",
965             "optional": false,
966             "doc": "<p>The Observable to release</p>\n",
967             "name": "o"
968           }
969         ],
970         "name": "releaseCapture",
971         "owner": "Ext.util.Observable",
972         "doc": "<p>Removes <strong>all</strong> added captures from the Observable.</p>\n",
973         "linenr": 44,
974         "return": {
975           "type": "void",
976           "doc": "\n"
977         },
978         "html_filename": "Observable.html"
979       },
980       {
981         "deprecated": null,
982         "alias": null,
983         "protected": false,
984         "tagname": "method",
985         "href": "Observable.html#Ext-util-Observable-method-removeListener",
986         "shortDoc": "Removes an event handler. ...",
987         "static": false,
988         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
989         "private": false,
990         "params": [
991           {
992             "type": "String",
993             "optional": false,
994             "doc": "<p>The type of event the handler was associated with.</p>\n",
995             "name": "eventName"
996           },
997           {
998             "type": "Function",
999             "optional": false,
1000             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.state.LocalStorageProvider-method-addListener\" rel=\"Ext.state.LocalStorageProvider-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1001             "name": "handler"
1002           },
1003           {
1004             "type": "Object",
1005             "optional": true,
1006             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1007             "name": "scope"
1008           }
1009         ],
1010         "name": "removeListener",
1011         "owner": "Ext.util.Observable",
1012         "doc": "<p>Removes an event handler.</p>\n",
1013         "linenr": 392,
1014         "return": {
1015           "type": "void",
1016           "doc": "\n"
1017         },
1018         "html_filename": "Observable.html"
1019       },
1020       {
1021         "deprecated": null,
1022         "alias": null,
1023         "protected": false,
1024         "tagname": "method",
1025         "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
1026         "shortDoc": "Removes listeners that were added by the mon method. ...",
1027         "static": false,
1028         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1029         "private": false,
1030         "params": [
1031           {
1032             "type": "Observable|Element",
1033             "optional": false,
1034             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
1035             "name": "item"
1036           },
1037           {
1038             "type": "Object|String",
1039             "optional": false,
1040             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
1041             "name": "ename"
1042           },
1043           {
1044             "type": "Function",
1045             "optional": false,
1046             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
1047             "name": "fn"
1048           },
1049           {
1050             "type": "Object",
1051             "optional": false,
1052             "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",
1053             "name": "scope"
1054           }
1055         ],
1056         "name": "removeManagedListener",
1057         "owner": "Ext.util.Observable",
1058         "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.state.LocalStorageProvider-method-mon\" rel=\"Ext.state.LocalStorageProvider-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
1059         "linenr": 197,
1060         "return": {
1061           "type": "void",
1062           "doc": "\n"
1063         },
1064         "html_filename": "Observable.html"
1065       },
1066       {
1067         "deprecated": null,
1068         "alias": null,
1069         "protected": false,
1070         "tagname": "method",
1071         "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
1072         "shortDoc": "Resumes firing events (see suspendEvents). ...",
1073         "static": false,
1074         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1075         "private": false,
1076         "params": [
1077
1078         ],
1079         "name": "resumeEvents",
1080         "owner": "Ext.util.Observable",
1081         "doc": "<p>Resumes firing events (see <a href=\"#/api/Ext.state.LocalStorageProvider-method-suspendEvents\" rel=\"Ext.state.LocalStorageProvider-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",
1082         "linenr": 554,
1083         "return": {
1084           "type": "void",
1085           "doc": "\n"
1086         },
1087         "html_filename": "Observable.html"
1088       },
1089       {
1090         "deprecated": null,
1091         "alias": null,
1092         "protected": false,
1093         "tagname": "method",
1094         "href": "Provider.html#Ext-state-Provider-method-set",
1095         "shortDoc": "Sets the value for a key ...",
1096         "static": false,
1097         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Provider.js",
1098         "private": false,
1099         "params": [
1100           {
1101             "type": "String",
1102             "optional": false,
1103             "doc": "<p>The key name</p>\n",
1104             "name": "name"
1105           },
1106           {
1107             "type": "Mixed",
1108             "optional": false,
1109             "doc": "<p>The value to set</p>\n",
1110             "name": "value"
1111           }
1112         ],
1113         "name": "set",
1114         "owner": "Ext.state.Provider",
1115         "doc": "<p>Sets the value for a key</p>\n",
1116         "linenr": 61,
1117         "return": {
1118           "type": "void",
1119           "doc": "\n"
1120         },
1121         "html_filename": "Provider.html"
1122       },
1123       {
1124         "deprecated": null,
1125         "alias": null,
1126         "protected": true,
1127         "tagname": "method",
1128         "href": "Base3.html#Ext-Base-method-statics",
1129         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
1130         "static": false,
1131         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1132         "private": false,
1133         "params": [
1134
1135         ],
1136         "name": "statics",
1137         "owner": "Ext.Base",
1138         "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",
1139         "linenr": 199,
1140         "return": {
1141           "type": "Class",
1142           "doc": "\n"
1143         },
1144         "html_filename": "Base3.html"
1145       },
1146       {
1147         "deprecated": null,
1148         "alias": null,
1149         "protected": false,
1150         "tagname": "method",
1151         "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1152         "shortDoc": "Suspends the firing of all events. ...",
1153         "static": false,
1154         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1155         "private": false,
1156         "params": [
1157           {
1158             "type": "Boolean",
1159             "optional": false,
1160             "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.state.LocalStorageProvider-method-resumeEvents\" rel=\"Ext.state.LocalStorageProvider-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events.</p>\n",
1161             "name": "queueSuspended"
1162           }
1163         ],
1164         "name": "suspendEvents",
1165         "owner": "Ext.util.Observable",
1166         "doc": "<p>Suspends the firing of all events. (see <a href=\"#/api/Ext.state.LocalStorageProvider-method-resumeEvents\" rel=\"Ext.state.LocalStorageProvider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
1167         "linenr": 541,
1168         "return": {
1169           "type": "void",
1170           "doc": "\n"
1171         },
1172         "html_filename": "Observable.html"
1173       },
1174       {
1175         "deprecated": null,
1176         "alias": {
1177           "tagname": "alias",
1178           "cls": "Ext.util.Observable",
1179           "doc": null,
1180           "owner": "removeListener"
1181         },
1182         "protected": false,
1183         "tagname": "method",
1184         "href": "Observable.html#Ext-util-Observable-method-un",
1185         "shortDoc": "Shorthand for removeListener. ...",
1186         "static": false,
1187         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1188         "private": false,
1189         "params": [
1190           {
1191             "type": "String",
1192             "optional": false,
1193             "doc": "<p>The type of event the handler was associated with.</p>\n",
1194             "name": "eventName"
1195           },
1196           {
1197             "type": "Function",
1198             "optional": false,
1199             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.state.LocalStorageProvider-method-addListener\" rel=\"Ext.state.LocalStorageProvider-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1200             "name": "handler"
1201           },
1202           {
1203             "type": "Object",
1204             "optional": true,
1205             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1206             "name": "scope"
1207           }
1208         ],
1209         "name": "un",
1210         "owner": "Ext.util.Observable",
1211         "doc": "<p>Shorthand for <a href=\"#/api/Ext.state.LocalStorageProvider-method-removeListener\" rel=\"Ext.state.LocalStorageProvider-method-removeListener\" class=\"docClass\">removeListener</a>.</p>\n\n<p>Removes an event handler.</p>\n",
1212         "linenr": 675,
1213         "return": {
1214           "type": "void",
1215           "doc": "\n"
1216         },
1217         "html_filename": "Observable.html"
1218       }
1219     ],
1220     "property": [
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": "Provider.html#Ext-state-Provider-event-statechange",
1252         "shortDoc": "Fires when a state change occurs. ...",
1253         "static": false,
1254         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Provider.js",
1255         "private": false,
1256         "params": [
1257           {
1258             "type": "Provider",
1259             "optional": false,
1260             "doc": "<p>This state provider</p>\n",
1261             "name": "this"
1262           },
1263           {
1264             "type": "String",
1265             "optional": false,
1266             "doc": "<p>The state key which was changed</p>\n",
1267             "name": "key"
1268           },
1269           {
1270             "type": "String",
1271             "optional": false,
1272             "doc": "<p>The encoded value for the state</p>\n",
1273             "name": "value"
1274           },
1275           {
1276             "type": "Object",
1277             "tagname": "param",
1278             "name": "options",
1279             "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"
1280           }
1281         ],
1282         "name": "statechange",
1283         "owner": "Ext.state.Provider",
1284         "doc": "<p>Fires when a state change occurs.</p>\n",
1285         "linenr": 28,
1286         "html_filename": "Provider.html"
1287       }
1288     ]
1289   },
1290   "singleton": false,
1291   "alias": null,
1292   "superclasses": [
1293     "Ext.Base",
1294     "Ext.state.Provider"
1295   ],
1296   "protected": false,
1297   "tagname": "class",
1298   "mixins": [
1299
1300   ],
1301   "href": "LocalStorageProvider.html#Ext-state-LocalStorageProvider",
1302   "subclasses": [
1303
1304   ],
1305   "static": false,
1306   "author": null,
1307   "component": false,
1308   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/LocalStorageProvider.js",
1309   "private": false,
1310   "alternateClassNames": [
1311
1312   ],
1313   "name": "Ext.state.LocalStorageProvider",
1314   "doc": "<p>A Provider implementation which saves and retrieves state via the HTML5 localStorage object.\nIf the browser does not support local storage, an exception will be thrown upon instantiating\nthis class.</p>\n",
1315   "mixedInto": [
1316
1317   ],
1318   "linenr": 1,
1319   "xtypes": [
1320
1321   ],
1322   "html_filename": "LocalStorageProvider.html",
1323   "extends": "Ext.state.Provider"
1324 });