Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.data.proxy.LocalStorage.js
1 Ext.data.JsonP.Ext_data_proxy_LocalStorage({
2   "allMixins": [
3     "Ext.util.Observable"
4   ],
5   "deprecated": null,
6   "docauthor": null,
7   "members": {
8     "cfg": [
9       {
10         "type": "Boolean",
11         "deprecated": null,
12         "alias": null,
13         "protected": false,
14         "tagname": "cfg",
15         "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchActions",
16         "shortDoc": "True to batch actions of a particular type when synchronizing the store. ...",
17         "static": false,
18         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
19         "private": false,
20         "name": "batchActions",
21         "owner": "Ext.data.proxy.Proxy",
22         "doc": "<p>True to batch actions of a particular type when synchronizing the store.\nDefaults to <tt>true</tt>.</p>\n",
23         "linenr": 61,
24         "html_filename": "Proxy2.html"
25       },
26       {
27         "type": "String",
28         "deprecated": null,
29         "alias": null,
30         "protected": false,
31         "tagname": "cfg",
32         "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchOrder",
33         "shortDoc": "Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. ...",
34         "static": false,
35         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
36         "private": false,
37         "name": "batchOrder",
38         "owner": "Ext.data.proxy.Proxy",
39         "doc": "<p>Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this\nto set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'</p>\n",
40         "linenr": 54,
41         "html_filename": "Proxy2.html"
42       },
43       {
44         "type": "String",
45         "deprecated": null,
46         "alias": null,
47         "protected": false,
48         "tagname": "cfg",
49         "href": "WebStorage.html#Ext-data-proxy-WebStorage-cfg-id",
50         "static": false,
51         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js",
52         "private": false,
53         "name": "id",
54         "owner": "Ext.data.proxy.WebStorage",
55         "doc": "<p>The unique ID used as the key in which all record data are stored in the local storage object</p>\n",
56         "linenr": 14,
57         "html_filename": "WebStorage.html"
58       },
59       {
60         "type": "Object",
61         "deprecated": null,
62         "alias": null,
63         "protected": false,
64         "tagname": "cfg",
65         "href": "Observable.html#Ext-util-Observable-cfg-listeners",
66         "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...",
67         "static": false,
68         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
69         "private": false,
70         "name": "listeners",
71         "owner": "Ext.util.Observable",
72         "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.data.proxy.LocalStorage-method-addListener\" rel=\"Ext.data.proxy.LocalStorage-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",
73         "linenr": 102,
74         "html_filename": "Observable.html"
75       },
76       {
77         "type": "String/Ext.data.Model",
78         "deprecated": null,
79         "alias": null,
80         "protected": false,
81         "tagname": "cfg",
82         "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-model",
83         "shortDoc": "The name of the Model to tie to this Proxy. ...",
84         "static": false,
85         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
86         "private": false,
87         "name": "model",
88         "owner": "Ext.data.proxy.Proxy",
89         "doc": "<p>The name of the Model to tie to this Proxy. Can be either the string name of\nthe Model, or a reference to the Model constructor. Required.</p>\n",
90         "linenr": 79,
91         "html_filename": "Proxy2.html"
92       }
93     ],
94     "method": [
95       {
96         "deprecated": null,
97         "alias": null,
98         "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-constructor",
99         "tagname": "method",
100         "protected": false,
101         "shortDoc": "Creates the proxy, throws an error if local storage is not supported in the current browser ...",
102         "static": false,
103         "params": [
104           {
105             "type": "Object",
106             "optional": true,
107             "doc": "<p>(optional) Config object.</p>\n",
108             "name": "config"
109           }
110         ],
111         "private": false,
112         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js",
113         "doc": "<p>Creates the proxy, throws an error if local storage is not supported in the current browser</p>\n",
114         "owner": "Ext.data.proxy.WebStorage",
115         "name": "LocalStorage",
116         "html_filename": "WebStorage.html",
117         "return": {
118           "type": "Object",
119           "doc": "\n"
120         },
121         "linenr": 19
122       },
123       {
124         "deprecated": null,
125         "alias": null,
126         "protected": false,
127         "tagname": "method",
128         "href": "Observable.html#Ext-util-Observable-method-addEvents",
129         "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...",
130         "static": false,
131         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
132         "private": false,
133         "params": [
134           {
135             "type": "Object/String",
136             "optional": false,
137             "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",
138             "name": "o"
139           },
140           {
141             "type": "String...",
142             "optional": false,
143             "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",
144             "name": "more"
145           }
146         ],
147         "name": "addEvents",
148         "owner": "Ext.util.Observable",
149         "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
150         "linenr": 494,
151         "return": {
152           "type": "void",
153           "doc": "\n"
154         },
155         "html_filename": "Observable.html"
156       },
157       {
158         "deprecated": null,
159         "alias": null,
160         "protected": false,
161         "tagname": "method",
162         "href": "Observable.html#Ext-util-Observable-method-addListener",
163         "shortDoc": "Appends an event handler to this object. ...",
164         "static": false,
165         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
166         "private": false,
167         "params": [
168           {
169             "type": "String",
170             "optional": false,
171             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
172             "name": "eventName"
173           },
174           {
175             "type": "Function",
176             "optional": false,
177             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.data.proxy.LocalStorage-method-fireEvent\" rel=\"Ext.data.proxy.LocalStorage-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
178             "name": "handler"
179           },
180           {
181             "type": "Object",
182             "optional": true,
183             "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",
184             "name": "scope"
185           },
186           {
187             "type": "Object",
188             "optional": true,
189             "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",
190             "name": "options"
191           }
192         ],
193         "name": "addListener",
194         "owner": "Ext.util.Observable",
195         "doc": "<p>Appends an event handler to this object.</p>\n",
196         "linenr": 278,
197         "return": {
198           "type": "void",
199           "doc": "\n"
200         },
201         "html_filename": "Observable.html"
202       },
203       {
204         "deprecated": null,
205         "alias": null,
206         "protected": false,
207         "tagname": "method",
208         "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
209         "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...",
210         "static": false,
211         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
212         "private": false,
213         "params": [
214           {
215             "type": "Observable/Element",
216             "optional": false,
217             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
218             "name": "item"
219           },
220           {
221             "type": "Object/String",
222             "optional": false,
223             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
224             "name": "ename"
225           },
226           {
227             "type": "Function",
228             "optional": true,
229             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
230             "name": "fn"
231           },
232           {
233             "type": "Object",
234             "optional": true,
235             "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",
236             "name": "scope"
237           },
238           {
239             "type": "Object",
240             "optional": true,
241             "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",
242             "name": "opt"
243           }
244         ],
245         "name": "addManagedListener",
246         "owner": "Ext.util.Observable",
247         "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
248         "linenr": 156,
249         "return": {
250           "type": "void",
251           "doc": "\n"
252         },
253         "html_filename": "Observable.html"
254       },
255       {
256         "deprecated": null,
257         "alias": null,
258         "protected": false,
259         "tagname": "method",
260         "href": "Base3.html#Ext-Base-method-addStatics",
261         "shortDoc": "Add / override static properties of this class. ...",
262         "static": true,
263         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
264         "private": false,
265         "params": [
266           {
267             "type": "Object",
268             "optional": false,
269             "doc": "\n",
270             "name": "members"
271           }
272         ],
273         "name": "addStatics",
274         "owner": "Ext.Base",
275         "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",
276         "linenr": 388,
277         "return": {
278           "type": "Ext.Base",
279           "doc": "<p>this</p>\n"
280         },
281         "html_filename": "Base3.html"
282       },
283       {
284         "deprecated": null,
285         "alias": null,
286         "protected": false,
287         "tagname": "method",
288         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-batch",
289         "shortDoc": "Performs a batch of Operations, in the order specified by batchOrder. ...",
290         "static": false,
291         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
292         "private": false,
293         "params": [
294           {
295             "type": "Object",
296             "optional": false,
297             "doc": "<p>Object containing the Model instances to act upon, keyed by action name</p>\n",
298             "name": "operations"
299           },
300           {
301             "type": "Object",
302             "optional": false,
303             "doc": "<p>Optional listeners object passed straight through to the Batch - see <a href=\"#/api/Ext.data.Batch\" rel=\"Ext.data.Batch\" class=\"docClass\">Ext.data.Batch</a></p>\n",
304             "name": "listeners"
305           }
306         ],
307         "name": "batch",
308         "owner": "Ext.data.proxy.Proxy",
309         "doc": "<p>Performs a batch of <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Operations</a>, in the order specified by <a href=\"#/api/Ext.data.proxy.LocalStorage-cfg-batchOrder\" rel=\"Ext.data.proxy.LocalStorage-cfg-batchOrder\" class=\"docClass\">batchOrder</a>. Used internally by\n<a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a>'s <a href=\"#/api/Ext.data.Store-method-sync\" rel=\"Ext.data.Store-method-sync\" class=\"docClass\">sync</a> method. Example usage:</p>\n\n<pre><code>myProxy.batch({\n    create : [myModel1, myModel2],\n    update : [myModel3],\n    destroy: [myModel4, myModel5]\n});\n</code></pre>\n\n\n<p>Where the myModel* above are <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a> instances - in this case 1 and 2 are new instances and have not been\nsaved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed.</p>\n",
310         "linenr": 242,
311         "return": {
312           "type": "Ext.data.Batch",
313           "doc": "<p>The newly created <a href=\"#/api/Ext.data.Batch\" rel=\"Ext.data.Batch\" class=\"docClass\">Ext.data.Batch</a> object</p>\n"
314         },
315         "html_filename": "Proxy2.html"
316       },
317       {
318         "deprecated": null,
319         "alias": null,
320         "protected": false,
321         "tagname": "method",
322         "href": "Base3.html#Ext-Base-method-callOverridden",
323         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
324         "static": false,
325         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
326         "private": false,
327         "params": [
328           {
329             "type": "Array/Arguments",
330             "optional": false,
331             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
332             "name": "args"
333           }
334         ],
335         "name": "callOverridden",
336         "owner": "Ext.Base",
337         "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",
338         "linenr": 269,
339         "return": {
340           "type": "Mixed",
341           "doc": "<p>Returns the result after calling the overridden method</p>\n"
342         },
343         "html_filename": "Base3.html"
344       },
345       {
346         "deprecated": null,
347         "alias": null,
348         "protected": true,
349         "tagname": "method",
350         "href": "Base3.html#Ext-Base-method-callParent",
351         "shortDoc": "Call the parent's overridden method. ...",
352         "static": false,
353         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
354         "private": false,
355         "params": [
356           {
357             "type": "Array/Arguments",
358             "optional": false,
359             "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",
360             "name": "args"
361           }
362         ],
363         "name": "callParent",
364         "owner": "Ext.Base",
365         "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",
366         "linenr": 124,
367         "return": {
368           "type": "Mixed",
369           "doc": "<p>Returns the result from the superclass' method</p>\n"
370         },
371         "html_filename": "Base3.html"
372       },
373       {
374         "deprecated": null,
375         "alias": null,
376         "protected": false,
377         "tagname": "method",
378         "href": "Observable.html#Ext-util-Observable-method-capture",
379         "shortDoc": "Starts capture on the specified Observable. ...",
380         "static": true,
381         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
382         "private": false,
383         "params": [
384           {
385             "type": "Observable",
386             "optional": false,
387             "doc": "<p>The Observable to capture events from.</p>\n",
388             "name": "o"
389           },
390           {
391             "type": "Function",
392             "optional": false,
393             "doc": "<p>The function to call when an event is fired.</p>\n",
394             "name": "fn"
395           },
396           {
397             "type": "Object",
398             "optional": true,
399             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to\nthe Observable firing the event.</p>\n",
400             "name": "scope"
401           }
402         ],
403         "name": "capture",
404         "owner": "Ext.util.Observable",
405         "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",
406         "linenr": 54,
407         "return": {
408           "type": "void",
409           "doc": "\n"
410         },
411         "html_filename": "Observable.html"
412       },
413       {
414         "deprecated": null,
415         "alias": null,
416         "protected": false,
417         "tagname": "method",
418         "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-clear",
419         "shortDoc": "Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage o...",
420         "static": false,
421         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js",
422         "private": false,
423         "params": [
424
425         ],
426         "name": "clear",
427         "owner": "Ext.data.proxy.WebStorage",
428         "doc": "<p>Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage object</p>\n",
429         "linenr": 372,
430         "return": {
431           "type": "void",
432           "doc": "\n"
433         },
434         "html_filename": "WebStorage.html"
435       },
436       {
437         "deprecated": null,
438         "alias": null,
439         "protected": false,
440         "tagname": "method",
441         "href": "Observable.html#Ext-util-Observable-method-clearListeners",
442         "shortDoc": "Removes all listeners for this object including the managed listeners ...",
443         "static": false,
444         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
445         "private": false,
446         "params": [
447
448         ],
449         "name": "clearListeners",
450         "owner": "Ext.util.Observable",
451         "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
452         "linenr": 425,
453         "return": {
454           "type": "void",
455           "doc": "\n"
456         },
457         "html_filename": "Observable.html"
458       },
459       {
460         "deprecated": null,
461         "alias": null,
462         "protected": false,
463         "tagname": "method",
464         "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
465         "shortDoc": "Removes all managed listeners for this object. ...",
466         "static": false,
467         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
468         "private": false,
469         "params": [
470
471         ],
472         "name": "clearManagedListeners",
473         "owner": "Ext.util.Observable",
474         "doc": "<p>Removes all managed listeners for this object.</p>\n",
475         "linenr": 454,
476         "return": {
477           "type": "void",
478           "doc": "\n"
479         },
480         "html_filename": "Observable.html"
481       },
482       {
483         "deprecated": null,
484         "alias": null,
485         "protected": false,
486         "tagname": "method",
487         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-create",
488         "shortDoc": "Performs the given create operation. ...",
489         "static": false,
490         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
491         "private": false,
492         "params": [
493           {
494             "type": "Ext.data.Operation",
495             "optional": false,
496             "doc": "<p>The Operation to perform</p>\n",
497             "name": "operation"
498           },
499           {
500             "type": "Function",
501             "optional": false,
502             "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
503             "name": "callback"
504           },
505           {
506             "type": "Object",
507             "optional": false,
508             "doc": "<p>Scope to execute the callback function in</p>\n",
509             "name": "scope"
510           }
511         ],
512         "name": "create",
513         "owner": "Ext.data.proxy.Proxy",
514         "doc": "<p>Performs the given create operation.</p>\n",
515         "linenr": 206,
516         "return": {
517           "type": "void",
518           "doc": "\n"
519         },
520         "html_filename": "Proxy2.html"
521       },
522       {
523         "deprecated": null,
524         "alias": null,
525         "protected": false,
526         "tagname": "method",
527         "href": "Base3.html#Ext-Base-method-createAlias",
528         "shortDoc": "Create aliases for existing prototype methods. ...",
529         "static": true,
530         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
531         "private": false,
532         "params": [
533           {
534             "type": "String/Object",
535             "optional": false,
536             "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",
537             "name": "alias"
538           },
539           {
540             "type": "String/Object",
541             "optional": false,
542             "doc": "<p>The original method name</p>\n",
543             "name": "origin"
544           }
545         ],
546         "name": "createAlias",
547         "owner": "Ext.Base",
548         "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",
549         "linenr": 648,
550         "return": {
551           "type": "void",
552           "doc": "\n"
553         },
554         "html_filename": "Base3.html"
555       },
556       {
557         "deprecated": null,
558         "alias": null,
559         "protected": false,
560         "tagname": "method",
561         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-destroy",
562         "shortDoc": "Performs the given destroy operation. ...",
563         "static": false,
564         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
565         "private": false,
566         "params": [
567           {
568             "type": "Ext.data.Operation",
569             "optional": false,
570             "doc": "<p>The Operation to perform</p>\n",
571             "name": "operation"
572           },
573           {
574             "type": "Function",
575             "optional": false,
576             "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
577             "name": "callback"
578           },
579           {
580             "type": "Object",
581             "optional": false,
582             "doc": "<p>Scope to execute the callback function in</p>\n",
583             "name": "scope"
584           }
585         ],
586         "name": "destroy",
587         "owner": "Ext.data.proxy.Proxy",
588         "doc": "<p>Performs the given destroy operation.</p>\n",
589         "linenr": 233,
590         "return": {
591           "type": "void",
592           "doc": "\n"
593         },
594         "html_filename": "Proxy2.html"
595       },
596       {
597         "deprecated": null,
598         "alias": null,
599         "protected": false,
600         "tagname": "method",
601         "href": "Observable.html#Ext-util-Observable-method-enableBubble",
602         "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...",
603         "static": false,
604         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
605         "private": false,
606         "params": [
607           {
608             "type": "String/[String]",
609             "optional": false,
610             "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
611             "name": "events"
612           }
613         ],
614         "name": "enableBubble",
615         "owner": "Ext.util.Observable",
616         "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",
617         "linenr": 609,
618         "return": {
619           "type": "void",
620           "doc": "\n"
621         },
622         "html_filename": "Observable.html"
623       },
624       {
625         "deprecated": null,
626         "alias": null,
627         "protected": false,
628         "tagname": "method",
629         "href": "Observable.html#Ext-util-Observable-method-fireEvent",
630         "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...",
631         "static": false,
632         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
633         "private": false,
634         "params": [
635           {
636             "type": "String",
637             "optional": false,
638             "doc": "<p>The name of the event to fire.</p>\n",
639             "name": "eventName"
640           },
641           {
642             "type": "Object...",
643             "optional": false,
644             "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
645             "name": "args"
646           }
647         ],
648         "name": "fireEvent",
649         "owner": "Ext.util.Observable",
650         "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.data.proxy.LocalStorage-method-addListener\" rel=\"Ext.data.proxy.LocalStorage-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.data.proxy.LocalStorage-method-enableBubble\" rel=\"Ext.data.proxy.LocalStorage-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n",
651         "linenr": 233,
652         "return": {
653           "type": "Boolean",
654           "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
655         },
656         "html_filename": "Observable.html"
657       },
658       {
659         "deprecated": null,
660         "alias": null,
661         "protected": false,
662         "tagname": "method",
663         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getModel",
664         "shortDoc": "Returns the model attached to this Proxy ...",
665         "static": false,
666         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
667         "private": false,
668         "params": [
669
670         ],
671         "name": "getModel",
672         "owner": "Ext.data.proxy.Proxy",
673         "doc": "<p>Returns the model attached to this Proxy</p>\n",
674         "linenr": 124,
675         "return": {
676           "type": "Ext.data.Model",
677           "doc": "<p>The model</p>\n"
678         },
679         "html_filename": "Proxy2.html"
680       },
681       {
682         "deprecated": null,
683         "alias": null,
684         "protected": false,
685         "tagname": "method",
686         "href": "Base3.html#Ext-Base-method-getName",
687         "shortDoc": "Get the current class' name in string format. ...",
688         "static": false,
689         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
690         "private": false,
691         "params": [
692
693         ],
694         "name": "getName",
695         "owner": "Ext.Base",
696         "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",
697         "linenr": 631,
698         "return": {
699           "type": "String",
700           "doc": "<p>className</p>\n"
701         },
702         "html_filename": "Base3.html"
703       },
704       {
705         "deprecated": null,
706         "alias": null,
707         "protected": false,
708         "tagname": "method",
709         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getReader",
710         "shortDoc": "Returns the reader currently attached to this proxy instance ...",
711         "static": false,
712         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
713         "private": false,
714         "params": [
715
716         ],
717         "name": "getReader",
718         "owner": "Ext.data.proxy.Proxy",
719         "doc": "<p>Returns the reader currently attached to this proxy instance</p>\n",
720         "linenr": 163,
721         "return": {
722           "type": "Ext.data.reader.Reader",
723           "doc": "<p>The Reader instance</p>\n"
724         },
725         "html_filename": "Proxy2.html"
726       },
727       {
728         "deprecated": null,
729         "alias": null,
730         "protected": false,
731         "tagname": "method",
732         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getWriter",
733         "shortDoc": "Returns the writer currently attached to this proxy instance ...",
734         "static": false,
735         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
736         "private": false,
737         "params": [
738
739         ],
740         "name": "getWriter",
741         "owner": "Ext.data.proxy.Proxy",
742         "doc": "<p>Returns the writer currently attached to this proxy instance</p>\n",
743         "linenr": 198,
744         "return": {
745           "type": "Ext.data.writer.Writer",
746           "doc": "<p>The Writer instance</p>\n"
747         },
748         "html_filename": "Proxy2.html"
749       },
750       {
751         "deprecated": null,
752         "alias": null,
753         "protected": false,
754         "tagname": "method",
755         "href": "Observable.html#Ext-util-Observable-method-hasListener",
756         "shortDoc": "Checks to see if this object has any listeners for a specified event ...",
757         "static": false,
758         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
759         "private": false,
760         "params": [
761           {
762             "type": "String",
763             "optional": false,
764             "doc": "<p>The name of the event to check for</p>\n",
765             "name": "eventName"
766           }
767         ],
768         "name": "hasListener",
769         "owner": "Ext.util.Observable",
770         "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
771         "linenr": 530,
772         "return": {
773           "type": "Boolean",
774           "doc": "<p>True if the event is being listened for, else false</p>\n"
775         },
776         "html_filename": "Observable.html"
777       },
778       {
779         "deprecated": null,
780         "alias": null,
781         "protected": false,
782         "tagname": "method",
783         "href": "Base3.html#Ext-Base-method-implement",
784         "shortDoc": "Add methods / properties to the prototype of this class. ...",
785         "static": true,
786         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
787         "private": false,
788         "params": [
789           {
790             "type": "Object",
791             "optional": false,
792             "doc": "\n",
793             "name": "members"
794           }
795         ],
796         "name": "implement",
797         "owner": "Ext.Base",
798         "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",
799         "linenr": 415,
800         "return": {
801           "type": "void",
802           "doc": "\n"
803         },
804         "html_filename": "Base3.html"
805       },
806       {
807         "deprecated": null,
808         "alias": null,
809         "protected": true,
810         "tagname": "method",
811         "href": "Base3.html#Ext-Base-method-initConfig",
812         "shortDoc": "Initialize configuration for this class. ...",
813         "static": false,
814         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
815         "private": false,
816         "params": [
817           {
818             "type": "Object",
819             "optional": false,
820             "doc": "\n",
821             "name": "config"
822           }
823         ],
824         "name": "initConfig",
825         "owner": "Ext.Base",
826         "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",
827         "linenr": 63,
828         "return": {
829           "type": "Object",
830           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
831         },
832         "html_filename": "Base3.html"
833       },
834       {
835         "deprecated": null,
836         "alias": {
837           "tagname": "alias",
838           "cls": "Ext.util.Observable",
839           "doc": null,
840           "owner": "addManagedListener"
841         },
842         "protected": false,
843         "tagname": "method",
844         "href": "Observable.html#Ext-util-Observable-method-mon",
845         "shortDoc": "Shorthand for addManagedListener. ...",
846         "static": false,
847         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
848         "private": false,
849         "params": [
850           {
851             "type": "Observable/Element",
852             "optional": false,
853             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
854             "name": "item"
855           },
856           {
857             "type": "Object/String",
858             "optional": false,
859             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
860             "name": "ename"
861           },
862           {
863             "type": "Function",
864             "optional": true,
865             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
866             "name": "fn"
867           },
868           {
869             "type": "Object",
870             "optional": true,
871             "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",
872             "name": "scope"
873           },
874           {
875             "type": "Object",
876             "optional": true,
877             "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",
878             "name": "opt"
879           }
880         ],
881         "name": "mon",
882         "owner": "Ext.util.Observable",
883         "doc": "<p>Shorthand for <a href=\"#/api/Ext.data.proxy.LocalStorage-method-addManagedListener\" rel=\"Ext.data.proxy.LocalStorage-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",
884         "linenr": 681,
885         "return": {
886           "type": "void",
887           "doc": "\n"
888         },
889         "html_filename": "Observable.html"
890       },
891       {
892         "deprecated": null,
893         "alias": {
894           "tagname": "alias",
895           "cls": "Ext.util.Observable",
896           "doc": null,
897           "owner": "removeManagedListener"
898         },
899         "protected": false,
900         "tagname": "method",
901         "href": "Observable.html#Ext-util-Observable-method-mun",
902         "shortDoc": "Shorthand for removeManagedListener. ...",
903         "static": false,
904         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
905         "private": false,
906         "params": [
907           {
908             "type": "Observable|Element",
909             "optional": false,
910             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
911             "name": "item"
912           },
913           {
914             "type": "Object|String",
915             "optional": false,
916             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
917             "name": "ename"
918           },
919           {
920             "type": "Function",
921             "optional": false,
922             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
923             "name": "fn"
924           },
925           {
926             "type": "Object",
927             "optional": false,
928             "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",
929             "name": "scope"
930           }
931         ],
932         "name": "mun",
933         "owner": "Ext.util.Observable",
934         "doc": "<p>Shorthand for <a href=\"#/api/Ext.data.proxy.LocalStorage-method-removeManagedListener\" rel=\"Ext.data.proxy.LocalStorage-method-removeManagedListener\" class=\"docClass\">removeManagedListener</a>.</p>\n\n<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.proxy.LocalStorage-method-mon\" rel=\"Ext.data.proxy.LocalStorage-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
935         "linenr": 687,
936         "return": {
937           "type": "void",
938           "doc": "\n"
939         },
940         "html_filename": "Observable.html"
941       },
942       {
943         "deprecated": null,
944         "alias": null,
945         "protected": false,
946         "tagname": "method",
947         "href": "Observable.html#Ext-util-Observable-method-observe",
948         "shortDoc": "Sets observability on the passed class constructor. ...",
949         "static": true,
950         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
951         "private": false,
952         "params": [
953           {
954             "type": "Function",
955             "optional": false,
956             "doc": "<p>The class constructor to make observable.</p>\n",
957             "name": "c"
958           },
959           {
960             "type": "Object",
961             "optional": false,
962             "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.data.proxy.LocalStorage-method-addListener\" rel=\"Ext.data.proxy.LocalStorage-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
963             "name": "listeners"
964           }
965         ],
966         "name": "observe",
967         "owner": "Ext.util.Observable",
968         "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",
969         "linenr": 69,
970         "return": {
971           "type": "void",
972           "doc": "\n"
973         },
974         "html_filename": "Observable.html"
975       },
976       {
977         "deprecated": null,
978         "alias": {
979           "tagname": "alias",
980           "cls": "Ext.util.Observable",
981           "doc": null,
982           "owner": "addListener"
983         },
984         "protected": false,
985         "tagname": "method",
986         "href": "Observable.html#Ext-util-Observable-method-on",
987         "shortDoc": "Shorthand for addListener. ...",
988         "static": false,
989         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
990         "private": false,
991         "params": [
992           {
993             "type": "String",
994             "optional": false,
995             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
996             "name": "eventName"
997           },
998           {
999             "type": "Function",
1000             "optional": false,
1001             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.data.proxy.LocalStorage-method-fireEvent\" rel=\"Ext.data.proxy.LocalStorage-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
1002             "name": "handler"
1003           },
1004           {
1005             "type": "Object",
1006             "optional": true,
1007             "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",
1008             "name": "scope"
1009           },
1010           {
1011             "type": "Object",
1012             "optional": true,
1013             "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",
1014             "name": "options"
1015           }
1016         ],
1017         "name": "on",
1018         "owner": "Ext.util.Observable",
1019         "doc": "<p>Shorthand for <a href=\"#/api/Ext.data.proxy.LocalStorage-method-addListener\" rel=\"Ext.data.proxy.LocalStorage-method-addListener\" class=\"docClass\">addListener</a>.</p>\n\n<p>Appends an event handler to this object.</p>\n",
1020         "linenr": 669,
1021         "return": {
1022           "type": "void",
1023           "doc": "\n"
1024         },
1025         "html_filename": "Observable.html"
1026       },
1027       {
1028         "deprecated": null,
1029         "alias": null,
1030         "protected": false,
1031         "tagname": "method",
1032         "href": "Base3.html#Ext-Base-method-override",
1033         "shortDoc": "Override prototype members of this class. ...",
1034         "static": true,
1035         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1036         "private": false,
1037         "params": [
1038           {
1039             "type": "Object",
1040             "optional": false,
1041             "doc": "\n",
1042             "name": "members"
1043           }
1044         ],
1045         "name": "override",
1046         "owner": "Ext.Base",
1047         "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",
1048         "linenr": 518,
1049         "return": {
1050           "type": "Ext.Base",
1051           "doc": "<p>this</p>\n"
1052         },
1053         "html_filename": "Base3.html"
1054       },
1055       {
1056         "deprecated": null,
1057         "alias": null,
1058         "protected": false,
1059         "tagname": "method",
1060         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-read",
1061         "shortDoc": "Performs the given read operation. ...",
1062         "static": false,
1063         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
1064         "private": false,
1065         "params": [
1066           {
1067             "type": "Ext.data.Operation",
1068             "optional": false,
1069             "doc": "<p>The Operation to perform</p>\n",
1070             "name": "operation"
1071           },
1072           {
1073             "type": "Function",
1074             "optional": false,
1075             "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
1076             "name": "callback"
1077           },
1078           {
1079             "type": "Object",
1080             "optional": false,
1081             "doc": "<p>Scope to execute the callback function in</p>\n",
1082             "name": "scope"
1083           }
1084         ],
1085         "name": "read",
1086         "owner": "Ext.data.proxy.Proxy",
1087         "doc": "<p>Performs the given read operation.</p>\n",
1088         "linenr": 215,
1089         "return": {
1090           "type": "void",
1091           "doc": "\n"
1092         },
1093         "html_filename": "Proxy2.html"
1094       },
1095       {
1096         "deprecated": null,
1097         "alias": null,
1098         "protected": false,
1099         "tagname": "method",
1100         "href": "Observable.html#Ext-util-Observable-method-relayEvents",
1101         "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...",
1102         "static": false,
1103         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1104         "private": false,
1105         "params": [
1106           {
1107             "type": "Object",
1108             "optional": false,
1109             "doc": "<p>The Observable whose events this object is to relay.</p>\n",
1110             "name": "origin"
1111           },
1112           {
1113             "type": "[String]",
1114             "optional": false,
1115             "doc": "<p>Array of event names to relay.</p>\n",
1116             "name": "events"
1117           },
1118           {
1119             "type": "Object",
1120             "optional": false,
1121             "doc": "\n",
1122             "name": "prefix"
1123           }
1124         ],
1125         "name": "relayEvents",
1126         "owner": "Ext.util.Observable",
1127         "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code>this</code>.</p>\n",
1128         "linenr": 573,
1129         "return": {
1130           "type": "void",
1131           "doc": "\n"
1132         },
1133         "html_filename": "Observable.html"
1134       },
1135       {
1136         "deprecated": null,
1137         "alias": null,
1138         "protected": false,
1139         "tagname": "method",
1140         "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
1141         "shortDoc": "Removes all added captures from the Observable. ...",
1142         "static": true,
1143         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1144         "private": false,
1145         "params": [
1146           {
1147             "type": "Observable",
1148             "optional": false,
1149             "doc": "<p>The Observable to release</p>\n",
1150             "name": "o"
1151           }
1152         ],
1153         "name": "releaseCapture",
1154         "owner": "Ext.util.Observable",
1155         "doc": "<p>Removes <strong>all</strong> added captures from the Observable.</p>\n",
1156         "linenr": 44,
1157         "return": {
1158           "type": "void",
1159           "doc": "\n"
1160         },
1161         "html_filename": "Observable.html"
1162       },
1163       {
1164         "deprecated": null,
1165         "alias": null,
1166         "protected": false,
1167         "tagname": "method",
1168         "href": "Observable.html#Ext-util-Observable-method-removeListener",
1169         "shortDoc": "Removes an event handler. ...",
1170         "static": false,
1171         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1172         "private": false,
1173         "params": [
1174           {
1175             "type": "String",
1176             "optional": false,
1177             "doc": "<p>The type of event the handler was associated with.</p>\n",
1178             "name": "eventName"
1179           },
1180           {
1181             "type": "Function",
1182             "optional": false,
1183             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.data.proxy.LocalStorage-method-addListener\" rel=\"Ext.data.proxy.LocalStorage-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1184             "name": "handler"
1185           },
1186           {
1187             "type": "Object",
1188             "optional": true,
1189             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1190             "name": "scope"
1191           }
1192         ],
1193         "name": "removeListener",
1194         "owner": "Ext.util.Observable",
1195         "doc": "<p>Removes an event handler.</p>\n",
1196         "linenr": 392,
1197         "return": {
1198           "type": "void",
1199           "doc": "\n"
1200         },
1201         "html_filename": "Observable.html"
1202       },
1203       {
1204         "deprecated": null,
1205         "alias": null,
1206         "protected": false,
1207         "tagname": "method",
1208         "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
1209         "shortDoc": "Removes listeners that were added by the mon method. ...",
1210         "static": false,
1211         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1212         "private": false,
1213         "params": [
1214           {
1215             "type": "Observable|Element",
1216             "optional": false,
1217             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
1218             "name": "item"
1219           },
1220           {
1221             "type": "Object|String",
1222             "optional": false,
1223             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
1224             "name": "ename"
1225           },
1226           {
1227             "type": "Function",
1228             "optional": false,
1229             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
1230             "name": "fn"
1231           },
1232           {
1233             "type": "Object",
1234             "optional": false,
1235             "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",
1236             "name": "scope"
1237           }
1238         ],
1239         "name": "removeManagedListener",
1240         "owner": "Ext.util.Observable",
1241         "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.proxy.LocalStorage-method-mon\" rel=\"Ext.data.proxy.LocalStorage-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
1242         "linenr": 197,
1243         "return": {
1244           "type": "void",
1245           "doc": "\n"
1246         },
1247         "html_filename": "Observable.html"
1248       },
1249       {
1250         "deprecated": null,
1251         "alias": null,
1252         "protected": false,
1253         "tagname": "method",
1254         "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
1255         "shortDoc": "Resumes firing events (see suspendEvents). ...",
1256         "static": false,
1257         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1258         "private": false,
1259         "params": [
1260
1261         ],
1262         "name": "resumeEvents",
1263         "owner": "Ext.util.Observable",
1264         "doc": "<p>Resumes firing events (see <a href=\"#/api/Ext.data.proxy.LocalStorage-method-suspendEvents\" rel=\"Ext.data.proxy.LocalStorage-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",
1265         "linenr": 554,
1266         "return": {
1267           "type": "void",
1268           "doc": "\n"
1269         },
1270         "html_filename": "Observable.html"
1271       },
1272       {
1273         "deprecated": null,
1274         "alias": null,
1275         "protected": false,
1276         "tagname": "method",
1277         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setModel",
1278         "shortDoc": "Sets the model associated with this proxy. ...",
1279         "static": false,
1280         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
1281         "private": false,
1282         "params": [
1283           {
1284             "type": "String|Ext.data.Model",
1285             "optional": false,
1286             "doc": "<p>The new model. Can be either the model name string,\nor a reference to the model's constructor</p>\n",
1287             "name": "model"
1288           },
1289           {
1290             "type": "Boolean",
1291             "optional": false,
1292             "doc": "<p>Sets the new model on the associated Store, if one is present</p>\n",
1293             "name": "setOnStore"
1294           }
1295         ],
1296         "name": "setModel",
1297         "owner": "Ext.data.proxy.Proxy",
1298         "doc": "<p>Sets the model associated with this proxy. This will only usually be called by a Store</p>\n",
1299         "linenr": 104,
1300         "return": {
1301           "type": "void",
1302           "doc": "\n"
1303         },
1304         "html_filename": "Proxy2.html"
1305       },
1306       {
1307         "deprecated": null,
1308         "alias": null,
1309         "protected": false,
1310         "tagname": "method",
1311         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setReader",
1312         "shortDoc": "Sets the Proxy's Reader by string, config object or Reader instance ...",
1313         "static": false,
1314         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
1315         "private": false,
1316         "params": [
1317           {
1318             "type": "String|Object|Ext.data.reader.Reader",
1319             "optional": false,
1320             "doc": "<p>The new Reader, which can be either a type string, a configuration object\nor an <a href=\"#/api/Ext.data.reader.Reader\" rel=\"Ext.data.reader.Reader\" class=\"docClass\">Ext.data.reader.Reader</a> instance</p>\n",
1321             "name": "reader"
1322           }
1323         ],
1324         "name": "setReader",
1325         "owner": "Ext.data.proxy.Proxy",
1326         "doc": "<p>Sets the Proxy's Reader by string, config object or Reader instance</p>\n",
1327         "linenr": 132,
1328         "return": {
1329           "type": "Ext.data.reader.Reader",
1330           "doc": "<p>The attached Reader object</p>\n"
1331         },
1332         "html_filename": "Proxy2.html"
1333       },
1334       {
1335         "deprecated": null,
1336         "alias": null,
1337         "protected": false,
1338         "tagname": "method",
1339         "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-setRecord",
1340         "shortDoc": "Saves the given record in the Proxy. ...",
1341         "static": false,
1342         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js",
1343         "private": false,
1344         "params": [
1345           {
1346             "type": "Ext.data.Model",
1347             "optional": false,
1348             "doc": "<p>The model instance</p>\n",
1349             "name": "record"
1350           },
1351           {
1352             "type": "String",
1353             "optional": false,
1354             "doc": "<p>The id to save the record under (defaults to the value of the record's getId() function)</p>\n",
1355             "name": "id"
1356           }
1357         ],
1358         "name": "setRecord",
1359         "owner": "Ext.data.proxy.WebStorage",
1360         "doc": "<p>Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data</p>\n",
1361         "linenr": 211,
1362         "return": {
1363           "type": "void",
1364           "doc": "\n"
1365         },
1366         "html_filename": "WebStorage.html"
1367       },
1368       {
1369         "deprecated": null,
1370         "alias": null,
1371         "protected": false,
1372         "tagname": "method",
1373         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setWriter",
1374         "shortDoc": "Sets the Proxy's Writer by string, config object or Writer instance ...",
1375         "static": false,
1376         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
1377         "private": false,
1378         "params": [
1379           {
1380             "type": "String|Object|Ext.data.writer.Writer",
1381             "optional": false,
1382             "doc": "<p>The new Writer, which can be either a type string, a configuration object\nor an <a href=\"#/api/Ext.data.writer.Writer\" rel=\"Ext.data.writer.Writer\" class=\"docClass\">Ext.data.writer.Writer</a> instance</p>\n",
1383             "name": "writer"
1384           }
1385         ],
1386         "name": "setWriter",
1387         "owner": "Ext.data.proxy.Proxy",
1388         "doc": "<p>Sets the Proxy's Writer by string, config object or Writer instance</p>\n",
1389         "linenr": 171,
1390         "return": {
1391           "type": "Ext.data.writer.Writer",
1392           "doc": "<p>The attached Writer object</p>\n"
1393         },
1394         "html_filename": "Proxy2.html"
1395       },
1396       {
1397         "deprecated": null,
1398         "alias": null,
1399         "protected": true,
1400         "tagname": "method",
1401         "href": "Base3.html#Ext-Base-method-statics",
1402         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
1403         "static": false,
1404         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1405         "private": false,
1406         "params": [
1407
1408         ],
1409         "name": "statics",
1410         "owner": "Ext.Base",
1411         "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",
1412         "linenr": 199,
1413         "return": {
1414           "type": "Class",
1415           "doc": "\n"
1416         },
1417         "html_filename": "Base3.html"
1418       },
1419       {
1420         "deprecated": null,
1421         "alias": null,
1422         "protected": false,
1423         "tagname": "method",
1424         "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1425         "shortDoc": "Suspends the firing of all events. ...",
1426         "static": false,
1427         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1428         "private": false,
1429         "params": [
1430           {
1431             "type": "Boolean",
1432             "optional": false,
1433             "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.data.proxy.LocalStorage-method-resumeEvents\" rel=\"Ext.data.proxy.LocalStorage-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events.</p>\n",
1434             "name": "queueSuspended"
1435           }
1436         ],
1437         "name": "suspendEvents",
1438         "owner": "Ext.util.Observable",
1439         "doc": "<p>Suspends the firing of all events. (see <a href=\"#/api/Ext.data.proxy.LocalStorage-method-resumeEvents\" rel=\"Ext.data.proxy.LocalStorage-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
1440         "linenr": 541,
1441         "return": {
1442           "type": "void",
1443           "doc": "\n"
1444         },
1445         "html_filename": "Observable.html"
1446       },
1447       {
1448         "deprecated": null,
1449         "alias": {
1450           "tagname": "alias",
1451           "cls": "Ext.util.Observable",
1452           "doc": null,
1453           "owner": "removeListener"
1454         },
1455         "protected": false,
1456         "tagname": "method",
1457         "href": "Observable.html#Ext-util-Observable-method-un",
1458         "shortDoc": "Shorthand for removeListener. ...",
1459         "static": false,
1460         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1461         "private": false,
1462         "params": [
1463           {
1464             "type": "String",
1465             "optional": false,
1466             "doc": "<p>The type of event the handler was associated with.</p>\n",
1467             "name": "eventName"
1468           },
1469           {
1470             "type": "Function",
1471             "optional": false,
1472             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.data.proxy.LocalStorage-method-addListener\" rel=\"Ext.data.proxy.LocalStorage-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1473             "name": "handler"
1474           },
1475           {
1476             "type": "Object",
1477             "optional": true,
1478             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1479             "name": "scope"
1480           }
1481         ],
1482         "name": "un",
1483         "owner": "Ext.util.Observable",
1484         "doc": "<p>Shorthand for <a href=\"#/api/Ext.data.proxy.LocalStorage-method-removeListener\" rel=\"Ext.data.proxy.LocalStorage-method-removeListener\" class=\"docClass\">removeListener</a>.</p>\n\n<p>Removes an event handler.</p>\n",
1485         "linenr": 675,
1486         "return": {
1487           "type": "void",
1488           "doc": "\n"
1489         },
1490         "html_filename": "Observable.html"
1491       },
1492       {
1493         "deprecated": null,
1494         "alias": null,
1495         "protected": false,
1496         "tagname": "method",
1497         "href": "Proxy2.html#Ext-data-proxy-Proxy-method-update",
1498         "shortDoc": "Performs the given update operation. ...",
1499         "static": false,
1500         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/Proxy.js",
1501         "private": false,
1502         "params": [
1503           {
1504             "type": "Ext.data.Operation",
1505             "optional": false,
1506             "doc": "<p>The Operation to perform</p>\n",
1507             "name": "operation"
1508           },
1509           {
1510             "type": "Function",
1511             "optional": false,
1512             "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
1513             "name": "callback"
1514           },
1515           {
1516             "type": "Object",
1517             "optional": false,
1518             "doc": "<p>Scope to execute the callback function in</p>\n",
1519             "name": "scope"
1520           }
1521         ],
1522         "name": "update",
1523         "owner": "Ext.data.proxy.Proxy",
1524         "doc": "<p>Performs the given update operation.</p>\n",
1525         "linenr": 224,
1526         "return": {
1527           "type": "void",
1528           "doc": "\n"
1529         },
1530         "html_filename": "Proxy2.html"
1531       }
1532     ],
1533     "property": [
1534       {
1535         "type": "Object",
1536         "deprecated": null,
1537         "alias": null,
1538         "protected": false,
1539         "tagname": "property",
1540         "href": "WebStorage.html#Ext-data-proxy-WebStorage-property-cache",
1541         "static": false,
1542         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/WebStorage.js",
1543         "private": false,
1544         "name": "cache",
1545         "owner": "Ext.data.proxy.WebStorage",
1546         "doc": "<p>Cached map of records already retrieved by this Proxy - ensures that the same instance is always retrieved</p>\n",
1547         "linenr": 26,
1548         "html_filename": "WebStorage.html"
1549       },
1550       {
1551         "type": "Class",
1552         "deprecated": null,
1553         "alias": null,
1554         "protected": true,
1555         "tagname": "property",
1556         "href": "Base3.html#Ext-Base-property-self",
1557         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
1558         "static": false,
1559         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1560         "private": false,
1561         "name": "self",
1562         "owner": "Ext.Base",
1563         "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",
1564         "linenr": 18,
1565         "html_filename": "Base3.html"
1566       }
1567     ],
1568     "cssVar": [
1569
1570     ],
1571     "cssMixin": [
1572
1573     ],
1574     "event": [
1575
1576     ]
1577   },
1578   "singleton": false,
1579   "alias": null,
1580   "superclasses": [
1581     "Ext.Base",
1582     "Ext.data.proxy.Proxy",
1583     "Ext.data.proxy.Client",
1584     "Ext.data.proxy.WebStorage"
1585   ],
1586   "protected": false,
1587   "tagname": "class",
1588   "mixins": [
1589
1590   ],
1591   "href": "LocalStorage.html#Ext-data-proxy-LocalStorage",
1592   "subclasses": [
1593
1594   ],
1595   "static": false,
1596   "author": "Ed Spencer",
1597   "component": false,
1598   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/proxy/LocalStorage.js",
1599   "private": false,
1600   "alternateClassNames": [
1601     "Ext.data.LocalStorageProxy"
1602   ],
1603   "name": "Ext.data.proxy.LocalStorage",
1604   "doc": "<p>The LocalStorageProxy uses the new HTML5 localStorage API to save <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a> data locally on\nthe client browser. HTML5 localStorage is a key-value store (e.g. cannot save complex objects like JSON), so\nLocalStorageProxy automatically serializes and deserializes data when saving and retrieving it.</p>\n\n\n\n\n<p>localStorage is extremely useful for saving user-specific information without needing to build server-side \ninfrastructure to support it. Let's imagine we're writing a Twitter search application and want to save the user's\nsearches locally so they can easily perform a saved search again later. We'd start by creating a Search model:</p>\n\n\n\n\n<pre><code>Ext.define('Search', {\n    fields: ['id', 'query'],\n    extend: 'Ext.data.Model',\n    proxy: {\n        type: 'localstorage',\n        id  : 'twitter-Searches'\n    }\n});\n</code></pre>\n\n\n\n\n<p>Our Search model contains just two fields - id and query - plus a Proxy definition. The only configuration we\nneed to pass to the LocalStorage proxy is an <a href=\"#/api/Ext.data.proxy.LocalStorage-cfg-id\" rel=\"Ext.data.proxy.LocalStorage-cfg-id\" class=\"docClass\">id</a>. This is important as it separates the Model data in this\nProxy from all others. The localStorage API puts all data into a single shared namespace, so by setting an id we\nenable LocalStorageProxy to manage the saved Search data.</p>\n\n\n\n\n<p>Saving our data into localStorage is easy and would usually be done with a <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Store</a>:</p>\n\n\n\n\n<pre><code>//our Store automatically picks up the LocalStorageProxy defined on the Search model\nvar store = new Ext.data.Store({\n    model: \"Search\"\n});\n\n//loads any existing Search data from localStorage\nstore.load();\n\n//now add some Searches\nstore.add({query: 'Sencha Touch'});\nstore.add({query: 'Ext JS'});\n\n//finally, save our Search data to localStorage\nstore.sync();\n</code></pre>\n\n\n\n\n<p>The LocalStorageProxy automatically gives our new Searches an id when we call store.sync(). It encodes the Model\ndata and places it into localStorage. We can also save directly to localStorage, bypassing the Store altogether:</p>\n\n\n\n\n<pre><code>var search = Ext.ModelManager.create({query: 'Sencha Animator'}, 'Search');\n\n//uses the configured LocalStorageProxy to save the new Search to localStorage\nsearch.save();\n</code></pre>\n\n\n\n\n<p><u>Limitations</u></p>\n\n\n\n\n<p>If this proxy is used in a browser where local storage is not supported, the constructor will throw an error.\nA local storage proxy requires a unique ID which is used as a key in which all record data are stored in the\nlocal storage object.</p>\n\n\n\n\n<p>It's important to supply this unique ID as it cannot be reliably determined otherwise. If no id is provided\nbut the attached store has a storeId, the storeId will be used. If neither option is presented the proxy will\nthrow an error.</p>\n\n",
1605   "mixedInto": [
1606
1607   ],
1608   "linenr": 1,
1609   "xtypes": [
1610
1611   ],
1612   "html_filename": "LocalStorage.html",
1613   "extends": "Ext.data.proxy.WebStorage"
1614 });