Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.data.proxy.SessionStorage.js
1 Ext.data.JsonP.Ext_data_proxy_SessionStorage({
2   "tagname": "class",
3   "name": "Ext.data.proxy.SessionStorage",
4   "doc": "<p>Proxy which uses HTML5 session storage as its data storage/retrieval mechanism.\nIf this proxy is used in a browser where session storage is not supported, the constructor will throw an error.\nA session storage proxy requires a unique ID which is used as a key in which all record data are stored in the\nsession 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\n\n\n<p>Proxies are almost always used with a <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">store</a>:<p>\n\n<pre><code>new Ext.data.Store({\n    proxy: {\n        type: 'sessionstorage',\n        id  : 'myProxyKey'\n    }\n});\n</code></pre>\n\n<p>Alternatively you can instantiate the Proxy directly:</p>\n\n<pre><code>new Ext.data.proxy.SessionStorage({\n    id  : 'myOtherProxyKey'\n});\n </code></pre>\n\n<p>Note that session storage is different to local storage (see <a href=\"#/api/Ext.data.proxy.LocalStorage\" rel=\"Ext.data.proxy.LocalStorage\" class=\"docClass\">Ext.data.proxy.LocalStorage</a>) - if a browser\nsession is ended (e.g. by closing the browser) then all data in a SessionStorageProxy are lost. Browser restarts\ndon't affect the <a href=\"#/api/Ext.data.proxy.LocalStorage\" rel=\"Ext.data.proxy.LocalStorage\" class=\"docClass\">Ext.data.proxy.LocalStorage</a> - the data are preserved.</p>\n\n",
5   "extends": "Ext.data.proxy.WebStorage",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10     "Ext.data.SessionStorageProxy"
11   ],
12   "xtype": null,
13   "author": "Ed Spencer",
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "batchActions",
21       "member": "Ext.data.proxy.Proxy",
22       "type": "Boolean",
23       "doc": "<p>True to batch actions of a particular type when synchronizing the store.\nDefaults to <tt>true</tt>.</p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
26       "linenr": 64,
27       "html_filename": "Proxy2.html",
28       "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchActions"
29     },
30     {
31       "tagname": "cfg",
32       "name": "batchOrder",
33       "member": "Ext.data.proxy.Proxy",
34       "type": "String",
35       "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",
36       "private": false,
37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
38       "linenr": 57,
39       "html_filename": "Proxy2.html",
40       "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchOrder",
41       "shortDoc": "Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this\nto set a different ord..."
42     },
43     {
44       "tagname": "cfg",
45       "name": "id",
46       "member": "Ext.data.proxy.WebStorage",
47       "type": "String",
48       "doc": "<p>The unique ID used as the key in which all record data are stored in the local storage object</p>\n",
49       "private": false,
50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js",
51       "linenr": 18,
52       "html_filename": "WebStorage.html",
53       "href": "WebStorage.html#Ext-data-proxy-WebStorage-cfg-id"
54     },
55     {
56       "tagname": "cfg",
57       "name": "listeners",
58       "member": "Ext.util.Observable",
59       "type": "Object",
60       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.data.proxy.SessionStorage-method-addListener\" rel=\"Ext.data.proxy.SessionStorage-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
61       "private": false,
62       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
63       "linenr": 103,
64       "html_filename": "Observable.html",
65       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
66       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
67     },
68     {
69       "tagname": "cfg",
70       "name": "model",
71       "member": "Ext.data.proxy.Proxy",
72       "type": "String/Ext.data.Model",
73       "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",
74       "private": false,
75       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
76       "linenr": 82,
77       "html_filename": "Proxy2.html",
78       "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-model",
79       "shortDoc": "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 c..."
80     }
81   ],
82   "method": [
83     {
84       "tagname": "method",
85       "name": "SessionStorage",
86       "member": "Ext.data.proxy.WebStorage",
87       "doc": "<p>Creates the proxy, throws an error if local storage is not supported in the current browser</p>\n",
88       "params": [
89         {
90           "type": "Object",
91           "name": "config",
92           "doc": "<p>Optional config object</p>\n",
93           "optional": false
94         }
95       ],
96       "return": {
97         "type": "void",
98         "doc": "\n"
99       },
100       "private": false,
101       "static": false,
102       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js",
103       "linenr": 1,
104       "html_filename": "WebStorage.html",
105       "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-constructor",
106       "shortDoc": "<p>Creates the proxy, throws an error if local storage is not supported in the current browser</p>\n"
107     },
108     {
109       "tagname": "method",
110       "name": "addEvents",
111       "member": "Ext.util.Observable",
112       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
113       "params": [
114         {
115           "type": "Object/String",
116           "name": "o",
117           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
118           "optional": false
119         },
120         {
121           "type": "String",
122           "name": "",
123           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
124           "optional": false
125         }
126       ],
127       "return": {
128         "type": "void",
129         "doc": "\n"
130       },
131       "private": false,
132       "static": false,
133       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
134       "linenr": 452,
135       "html_filename": "Observable.html",
136       "href": "Observable.html#Ext-util-Observable-method-addEvents",
137       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
138     },
139     {
140       "tagname": "method",
141       "name": "addListener",
142       "member": "Ext.util.Observable",
143       "doc": "<p>Appends an event handler to this object.</p>\n",
144       "params": [
145         {
146           "type": "String",
147           "name": "eventName",
148           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
149           "optional": false
150         },
151         {
152           "type": "Function",
153           "name": "handler",
154           "doc": "<p>The method the event invokes.</p>\n",
155           "optional": false
156         },
157         {
158           "type": "Object",
159           "name": "scope",
160           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
161           "optional": true
162         },
163         {
164           "type": "Object",
165           "name": "options",
166           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
167           "optional": true
168         }
169       ],
170       "return": {
171         "type": "void",
172         "doc": "\n"
173       },
174       "private": false,
175       "static": false,
176       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
177       "linenr": 271,
178       "html_filename": "Observable.html",
179       "href": "Observable.html#Ext-util-Observable-method-addListener",
180       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
181     },
182     {
183       "tagname": "method",
184       "name": "addManagedListener",
185       "member": "Ext.util.Observable",
186       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
187       "params": [
188         {
189           "type": "Observable/Element",
190           "name": "item",
191           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
192           "optional": false
193         },
194         {
195           "type": "Object/String",
196           "name": "ename",
197           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
198           "optional": false
199         },
200         {
201           "type": "Function",
202           "name": "fn",
203           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
204           "optional": false
205         },
206         {
207           "type": "Object",
208           "name": "scope",
209           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
210           "optional": false
211         },
212         {
213           "type": "Object",
214           "name": "opt",
215           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
216           "optional": false
217         }
218       ],
219       "return": {
220         "type": "void",
221         "doc": "\n"
222       },
223       "private": false,
224       "static": false,
225       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
226       "linenr": 155,
227       "html_filename": "Observable.html",
228       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
229       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
230     },
231     {
232       "tagname": "method",
233       "name": "batch",
234       "member": "Ext.data.proxy.Proxy",
235       "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.SessionStorage-cfg-batchOrder\" rel=\"Ext.data.proxy.SessionStorage-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",
236       "params": [
237         {
238           "type": "Object",
239           "name": "operations",
240           "doc": "<p>Object containing the Model instances to act upon, keyed by action name</p>\n",
241           "optional": false
242         },
243         {
244           "type": "Object",
245           "name": "listeners",
246           "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",
247           "optional": false
248         }
249       ],
250       "return": {
251         "type": "Ext.data.Batch",
252         "doc": "<p>The newly created <a href=\"#/api/Ext.data.Batch\" rel=\"Ext.data.Batch\" class=\"docClass\">Ext.data.Batch</a> object</p>\n"
253       },
254       "private": false,
255       "static": false,
256       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
257       "linenr": 241,
258       "html_filename": "Proxy2.html",
259       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-batch",
260       "shortDoc": "Performs a batch of Operations, in the order specified by batchOrder. Used internally by\nExt.data.Store's sync method..."
261     },
262     {
263       "tagname": "method",
264       "name": "capture",
265       "member": "Ext.util.Observable",
266       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
267       "params": [
268         {
269           "type": "Observable",
270           "name": "o",
271           "doc": "<p>The Observable to capture events from.</p>\n",
272           "optional": false
273         },
274         {
275           "type": "Function",
276           "name": "fn",
277           "doc": "<p>The function to call when an event is fired.</p>\n",
278           "optional": false
279         },
280         {
281           "type": "Object",
282           "name": "scope",
283           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
284           "optional": true
285         }
286       ],
287       "return": {
288         "type": "void",
289         "doc": "\n"
290       },
291       "private": false,
292       "static": true,
293       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
294       "linenr": 55,
295       "html_filename": "Observable.html",
296       "href": "Observable.html#Ext-util-Observable-method-capture",
297       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
298     },
299     {
300       "tagname": "method",
301       "name": "clear",
302       "member": "Ext.data.proxy.WebStorage",
303       "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",
304       "params": [
305
306       ],
307       "return": {
308         "type": "void",
309         "doc": "\n"
310       },
311       "private": false,
312       "static": false,
313       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js",
314       "linenr": 375,
315       "html_filename": "WebStorage.html",
316       "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-clear",
317       "shortDoc": "Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage o..."
318     },
319     {
320       "tagname": "method",
321       "name": "clearListeners",
322       "member": "Ext.util.Observable",
323       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
324       "params": [
325
326       ],
327       "return": {
328         "type": "void",
329         "doc": "\n"
330       },
331       "private": false,
332       "static": false,
333       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
334       "linenr": 383,
335       "html_filename": "Observable.html",
336       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
337       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
338     },
339     {
340       "tagname": "method",
341       "name": "clearManagedListeners",
342       "member": "Ext.util.Observable",
343       "doc": "<p>Removes all managed listeners for this object.</p>\n",
344       "params": [
345
346       ],
347       "return": {
348         "type": "void",
349         "doc": "\n"
350       },
351       "private": false,
352       "static": false,
353       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
354       "linenr": 412,
355       "html_filename": "Observable.html",
356       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
357       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
358     },
359     {
360       "tagname": "method",
361       "name": "create",
362       "member": "Ext.data.proxy.Proxy",
363       "doc": "<p>Performs the given create operation.</p>\n",
364       "params": [
365         {
366           "type": "Ext.data.Operation",
367           "name": "operation",
368           "doc": "<p>The Operation to perform</p>\n",
369           "optional": false
370         },
371         {
372           "type": "Function",
373           "name": "callback",
374           "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
375           "optional": false
376         },
377         {
378           "type": "Object",
379           "name": "scope",
380           "doc": "<p>Scope to execute the callback function in</p>\n",
381           "optional": false
382         }
383       ],
384       "return": {
385         "type": "void",
386         "doc": "\n"
387       },
388       "private": false,
389       "static": false,
390       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
391       "linenr": 205,
392       "html_filename": "Proxy2.html",
393       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-create",
394       "shortDoc": "<p>Performs the given create operation.</p>\n"
395     },
396     {
397       "tagname": "method",
398       "name": "destroy",
399       "member": "Ext.data.proxy.Proxy",
400       "doc": "<p>Performs the given destroy operation.</p>\n",
401       "params": [
402         {
403           "type": "Ext.data.Operation",
404           "name": "operation",
405           "doc": "<p>The Operation to perform</p>\n",
406           "optional": false
407         },
408         {
409           "type": "Function",
410           "name": "callback",
411           "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
412           "optional": false
413         },
414         {
415           "type": "Object",
416           "name": "scope",
417           "doc": "<p>Scope to execute the callback function in</p>\n",
418           "optional": false
419         }
420       ],
421       "return": {
422         "type": "void",
423         "doc": "\n"
424       },
425       "private": false,
426       "static": false,
427       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
428       "linenr": 232,
429       "html_filename": "Proxy2.html",
430       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-destroy",
431       "shortDoc": "<p>Performs the given destroy operation.</p>\n"
432     },
433     {
434       "tagname": "method",
435       "name": "enableBubble",
436       "member": "Ext.util.Observable",
437       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
438       "params": [
439         {
440           "type": "String/Array",
441           "name": "events",
442           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
443           "optional": false
444         }
445       ],
446       "return": {
447         "type": "void",
448         "doc": "\n"
449       },
450       "private": false,
451       "static": false,
452       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
453       "linenr": 554,
454       "html_filename": "Observable.html",
455       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
456       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
457     },
458     {
459       "tagname": "method",
460       "name": "fireEvent",
461       "member": "Ext.util.Observable",
462       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.data.proxy.SessionStorage-method-enableBubble\" rel=\"Ext.data.proxy.SessionStorage-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
463       "params": [
464         {
465           "type": "String",
466           "name": "eventName",
467           "doc": "<p>The name of the event to fire.</p>\n",
468           "optional": false
469         },
470         {
471           "type": "Object...",
472           "name": "args",
473           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
474           "optional": false
475         }
476       ],
477       "return": {
478         "type": "Boolean",
479         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
480       },
481       "private": false,
482       "static": false,
483       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
484       "linenr": 232,
485       "html_filename": "Observable.html",
486       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
487       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
488     },
489     {
490       "tagname": "method",
491       "name": "getModel",
492       "member": "Ext.data.proxy.Proxy",
493       "doc": "<p>Returns the model attached to this Proxy</p>\n",
494       "params": [
495
496       ],
497       "return": {
498         "type": "Ext.data.Model",
499         "doc": "<p>The model</p>\n"
500       },
501       "private": false,
502       "static": false,
503       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
504       "linenr": 123,
505       "html_filename": "Proxy2.html",
506       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getModel",
507       "shortDoc": "<p>Returns the model attached to this Proxy</p>\n"
508     },
509     {
510       "tagname": "method",
511       "name": "getReader",
512       "member": "Ext.data.proxy.Proxy",
513       "doc": "<p>Returns the reader currently attached to this proxy instance</p>\n",
514       "params": [
515
516       ],
517       "return": {
518         "type": "Ext.data.reader.Reader",
519         "doc": "<p>The Reader instance</p>\n"
520       },
521       "private": false,
522       "static": false,
523       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
524       "linenr": 162,
525       "html_filename": "Proxy2.html",
526       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getReader",
527       "shortDoc": "<p>Returns the reader currently attached to this proxy instance</p>\n"
528     },
529     {
530       "tagname": "method",
531       "name": "getWriter",
532       "member": "Ext.data.proxy.Proxy",
533       "doc": "<p>Returns the writer currently attached to this proxy instance</p>\n",
534       "params": [
535
536       ],
537       "return": {
538         "type": "Ext.data.writer.Writer",
539         "doc": "<p>The Writer instance</p>\n"
540       },
541       "private": false,
542       "static": false,
543       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
544       "linenr": 197,
545       "html_filename": "Proxy2.html",
546       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getWriter",
547       "shortDoc": "<p>Returns the writer currently attached to this proxy instance</p>\n"
548     },
549     {
550       "tagname": "method",
551       "name": "hasListener",
552       "member": "Ext.util.Observable",
553       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
554       "params": [
555         {
556           "type": "String",
557           "name": "eventName",
558           "doc": "<p>The name of the event to check for</p>\n",
559           "optional": false
560         }
561       ],
562       "return": {
563         "type": "Boolean",
564         "doc": "<p>True if the event is being listened for, else false</p>\n"
565       },
566       "private": false,
567       "static": false,
568       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
569       "linenr": 480,
570       "html_filename": "Observable.html",
571       "href": "Observable.html#Ext-util-Observable-method-hasListener",
572       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
573     },
574     {
575       "tagname": "method",
576       "name": "observe",
577       "member": "Ext.util.Observable",
578       "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",
579       "params": [
580         {
581           "type": "Function",
582           "name": "c",
583           "doc": "<p>The class constructor to make observable.</p>\n",
584           "optional": false
585         },
586         {
587           "type": "Object",
588           "name": "listeners",
589           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.data.proxy.SessionStorage-method-addListener\" rel=\"Ext.data.proxy.SessionStorage-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
590           "optional": false
591         }
592       ],
593       "return": {
594         "type": "void",
595         "doc": "\n"
596       },
597       "private": false,
598       "static": true,
599       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
600       "linenr": 69,
601       "html_filename": "Observable.html",
602       "href": "Observable.html#Ext-util-Observable-method-observe",
603       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
604     },
605     {
606       "tagname": "method",
607       "name": "on",
608       "member": "Ext.util.Observable",
609       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.proxy.SessionStorage-method-addListener\" rel=\"Ext.data.proxy.SessionStorage-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
610       "params": [
611         {
612           "type": "String",
613           "name": "eventName",
614           "doc": "<p>The type of event to listen for</p>\n",
615           "optional": false
616         },
617         {
618           "type": "Function",
619           "name": "handler",
620           "doc": "<p>The method the event invokes</p>\n",
621           "optional": false
622         },
623         {
624           "type": "Object",
625           "name": "scope",
626           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
627           "optional": true
628         },
629         {
630           "type": "Object",
631           "name": "options",
632           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
633           "optional": true
634         }
635       ],
636       "return": {
637         "type": "void",
638         "doc": "\n"
639       },
640       "private": false,
641       "static": false,
642       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
643       "linenr": 616,
644       "html_filename": "Observable.html",
645       "href": "Observable.html#Ext-util-Observable-method-on",
646       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.proxy.SessionStorage-method-addListener\" rel=\"Ext.data.proxy.SessionStorage-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
647     },
648     {
649       "tagname": "method",
650       "name": "read",
651       "member": "Ext.data.proxy.Proxy",
652       "doc": "<p>Performs the given read operation.</p>\n",
653       "params": [
654         {
655           "type": "Ext.data.Operation",
656           "name": "operation",
657           "doc": "<p>The Operation to perform</p>\n",
658           "optional": false
659         },
660         {
661           "type": "Function",
662           "name": "callback",
663           "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
664           "optional": false
665         },
666         {
667           "type": "Object",
668           "name": "scope",
669           "doc": "<p>Scope to execute the callback function in</p>\n",
670           "optional": false
671         }
672       ],
673       "return": {
674         "type": "void",
675         "doc": "\n"
676       },
677       "private": false,
678       "static": false,
679       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
680       "linenr": 214,
681       "html_filename": "Proxy2.html",
682       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-read",
683       "shortDoc": "<p>Performs the given read operation.</p>\n"
684     },
685     {
686       "tagname": "method",
687       "name": "relayEvents",
688       "member": "Ext.util.Observable",
689       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
690       "params": [
691         {
692           "type": "Object",
693           "name": "origin",
694           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
695           "optional": false
696         },
697         {
698           "type": "Array",
699           "name": "events",
700           "doc": "<p>Array of event names to relay.</p>\n",
701           "optional": false
702         },
703         {
704           "type": "Object",
705           "name": "prefix",
706           "doc": "\n",
707           "optional": false
708         }
709       ],
710       "return": {
711         "type": "void",
712         "doc": "\n"
713       },
714       "private": false,
715       "static": false,
716       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
717       "linenr": 520,
718       "html_filename": "Observable.html",
719       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
720       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
721     },
722     {
723       "tagname": "method",
724       "name": "releaseCapture",
725       "member": "Ext.util.Observable",
726       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
727       "params": [
728         {
729           "type": "Observable",
730           "name": "o",
731           "doc": "<p>The Observable to release</p>\n",
732           "optional": false
733         }
734       ],
735       "return": {
736         "type": "void",
737         "doc": "\n"
738       },
739       "private": false,
740       "static": true,
741       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
742       "linenr": 46,
743       "html_filename": "Observable.html",
744       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
745       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
746     },
747     {
748       "tagname": "method",
749       "name": "removeListener",
750       "member": "Ext.util.Observable",
751       "doc": "<p>Removes an event handler.</p>\n",
752       "params": [
753         {
754           "type": "String",
755           "name": "eventName",
756           "doc": "<p>The type of event the handler was associated with.</p>\n",
757           "optional": false
758         },
759         {
760           "type": "Function",
761           "name": "handler",
762           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.proxy.SessionStorage-method-addListener\" rel=\"Ext.data.proxy.SessionStorage-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
763           "optional": false
764         },
765         {
766           "type": "Object",
767           "name": "scope",
768           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
769           "optional": true
770         }
771       ],
772       "return": {
773         "type": "void",
774         "doc": "\n"
775       },
776       "private": false,
777       "static": false,
778       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
779       "linenr": 352,
780       "html_filename": "Observable.html",
781       "href": "Observable.html#Ext-util-Observable-method-removeListener",
782       "shortDoc": "<p>Removes an event handler.</p>\n"
783     },
784     {
785       "tagname": "method",
786       "name": "removeManagedListener",
787       "member": "Ext.util.Observable",
788       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.proxy.SessionStorage--mon\" rel=\"Ext.data.proxy.SessionStorage--mon\" class=\"docClass\">mon</a> method.</p>\n",
789       "params": [
790         {
791           "type": "Observable|Element",
792           "name": "item",
793           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
794           "optional": false
795         },
796         {
797           "type": "Object|String",
798           "name": "ename",
799           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
800           "optional": false
801         },
802         {
803           "type": "Function",
804           "name": "fn",
805           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
806           "optional": false
807         },
808         {
809           "type": "Object",
810           "name": "scope",
811           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
812           "optional": false
813         }
814       ],
815       "return": {
816         "type": "void",
817         "doc": "\n"
818       },
819       "private": false,
820       "static": false,
821       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
822       "linenr": 196,
823       "html_filename": "Observable.html",
824       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
825       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.proxy.SessionStorage--mon\" rel=\"Ext.data.proxy.SessionStorage--mon\" class=\"docClass\">mon</a> method.</p>\n"
826     },
827     {
828       "tagname": "method",
829       "name": "resumeEvents",
830       "member": "Ext.util.Observable",
831       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.data.proxy.SessionStorage-method-suspendEvents\" rel=\"Ext.data.proxy.SessionStorage-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
832       "params": [
833
834       ],
835       "return": {
836         "type": "void",
837         "doc": "\n"
838       },
839       "private": false,
840       "static": false,
841       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
842       "linenr": 502,
843       "html_filename": "Observable.html",
844       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
845       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
846     },
847     {
848       "tagname": "method",
849       "name": "setModel",
850       "member": "Ext.data.proxy.Proxy",
851       "doc": "<p>Sets the model associated with this proxy. This will only usually be called by a Store</p>\n",
852       "params": [
853         {
854           "type": "String|Ext.data.Model",
855           "name": "model",
856           "doc": "<p>The new model. Can be either the model name string,\nor a reference to the model's constructor</p>\n",
857           "optional": false
858         },
859         {
860           "type": "Boolean",
861           "name": "setOnStore",
862           "doc": "<p>Sets the new model on the associated Store, if one is present</p>\n",
863           "optional": false
864         }
865       ],
866       "return": {
867         "type": "void",
868         "doc": "\n"
869       },
870       "private": false,
871       "static": false,
872       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
873       "linenr": 103,
874       "html_filename": "Proxy2.html",
875       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setModel",
876       "shortDoc": "<p>Sets the model associated with this proxy. This will only usually be called by a Store</p>\n"
877     },
878     {
879       "tagname": "method",
880       "name": "setReader",
881       "member": "Ext.data.proxy.Proxy",
882       "doc": "<p>Sets the Proxy's Reader by string, config object or Reader instance</p>\n",
883       "params": [
884         {
885           "type": "String|Object|Ext.data.reader.Reader",
886           "name": "reader",
887           "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",
888           "optional": false
889         }
890       ],
891       "return": {
892         "type": "Ext.data.reader.Reader",
893         "doc": "<p>The attached Reader object</p>\n"
894       },
895       "private": false,
896       "static": false,
897       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
898       "linenr": 131,
899       "html_filename": "Proxy2.html",
900       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setReader",
901       "shortDoc": "<p>Sets the Proxy's Reader by string, config object or Reader instance</p>\n"
902     },
903     {
904       "tagname": "method",
905       "name": "setRecord",
906       "member": "Ext.data.proxy.WebStorage",
907       "doc": "<p>Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data</p>\n",
908       "params": [
909         {
910           "type": "Ext.data.Model",
911           "name": "record",
912           "doc": "<p>The model instance</p>\n",
913           "optional": false
914         },
915         {
916           "type": "String",
917           "name": "id",
918           "doc": "<p>The id to save the record under (defaults to the value of the record's getId() function)</p>\n",
919           "optional": false
920         }
921       ],
922       "return": {
923         "type": "void",
924         "doc": "\n"
925       },
926       "private": false,
927       "static": false,
928       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js",
929       "linenr": 214,
930       "html_filename": "WebStorage.html",
931       "href": "WebStorage.html#Ext-data-proxy-WebStorage-method-setRecord",
932       "shortDoc": "<p>Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data</p>\n"
933     },
934     {
935       "tagname": "method",
936       "name": "setWriter",
937       "member": "Ext.data.proxy.Proxy",
938       "doc": "<p>Sets the Proxy's Writer by string, config object or Writer instance</p>\n",
939       "params": [
940         {
941           "type": "String|Object|Ext.data.writer.Writer",
942           "name": "writer",
943           "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",
944           "optional": false
945         }
946       ],
947       "return": {
948         "type": "Ext.data.writer.Writer",
949         "doc": "<p>The attached Writer object</p>\n"
950       },
951       "private": false,
952       "static": false,
953       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
954       "linenr": 170,
955       "html_filename": "Proxy2.html",
956       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setWriter",
957       "shortDoc": "<p>Sets the Proxy's Writer by string, config object or Writer instance</p>\n"
958     },
959     {
960       "tagname": "method",
961       "name": "suspendEvents",
962       "member": "Ext.util.Observable",
963       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.proxy.SessionStorage-method-resumeEvents\" rel=\"Ext.data.proxy.SessionStorage-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
964       "params": [
965         {
966           "type": "Boolean",
967           "name": "queueSuspended",
968           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.data.proxy.SessionStorage-method-resumeEvents\" rel=\"Ext.data.proxy.SessionStorage-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
969           "optional": false
970         }
971       ],
972       "return": {
973         "type": "void",
974         "doc": "\n"
975       },
976       "private": false,
977       "static": false,
978       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
979       "linenr": 490,
980       "html_filename": "Observable.html",
981       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
982       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.proxy.SessionStorage-method-resumeEvents\" rel=\"Ext.data.proxy.SessionStorage-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
983     },
984     {
985       "tagname": "method",
986       "name": "un",
987       "member": "Ext.util.Observable",
988       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.proxy.SessionStorage-method-removeListener\" rel=\"Ext.data.proxy.SessionStorage-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
989       "params": [
990         {
991           "type": "String",
992           "name": "eventName",
993           "doc": "<p>The type of event the handler was associated with.</p>\n",
994           "optional": false
995         },
996         {
997           "type": "Function",
998           "name": "handler",
999           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.proxy.SessionStorage-method-addListener\" rel=\"Ext.data.proxy.SessionStorage-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1000           "optional": false
1001         },
1002         {
1003           "type": "Object",
1004           "name": "scope",
1005           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1006           "optional": true
1007         }
1008       ],
1009       "return": {
1010         "type": "void",
1011         "doc": "\n"
1012       },
1013       "private": false,
1014       "static": false,
1015       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1016       "linenr": 608,
1017       "html_filename": "Observable.html",
1018       "href": "Observable.html#Ext-util-Observable-method-un",
1019       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.proxy.SessionStorage-method-removeListener\" rel=\"Ext.data.proxy.SessionStorage-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
1020     },
1021     {
1022       "tagname": "method",
1023       "name": "update",
1024       "member": "Ext.data.proxy.Proxy",
1025       "doc": "<p>Performs the given update operation.</p>\n",
1026       "params": [
1027         {
1028           "type": "Ext.data.Operation",
1029           "name": "operation",
1030           "doc": "<p>The Operation to perform</p>\n",
1031           "optional": false
1032         },
1033         {
1034           "type": "Function",
1035           "name": "callback",
1036           "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
1037           "optional": false
1038         },
1039         {
1040           "type": "Object",
1041           "name": "scope",
1042           "doc": "<p>Scope to execute the callback function in</p>\n",
1043           "optional": false
1044         }
1045       ],
1046       "return": {
1047         "type": "void",
1048         "doc": "\n"
1049       },
1050       "private": false,
1051       "static": false,
1052       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
1053       "linenr": 223,
1054       "html_filename": "Proxy2.html",
1055       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-update",
1056       "shortDoc": "<p>Performs the given update operation.</p>\n"
1057     }
1058   ],
1059   "property": [
1060     {
1061       "tagname": "property",
1062       "name": "cache",
1063       "member": "Ext.data.proxy.WebStorage",
1064       "type": "Object",
1065       "doc": "<p>Cached map of records already retrieved by this Proxy - ensures that the same instance is always retrieved</p>\n",
1066       "private": false,
1067       "static": false,
1068       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/WebStorage.js",
1069       "linenr": 29,
1070       "html_filename": "WebStorage.html",
1071       "href": "WebStorage.html#Ext-data-proxy-WebStorage-property-cache"
1072     }
1073   ],
1074   "event": [
1075
1076   ],
1077   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/SessionStorage.js",
1078   "linenr": 1,
1079   "html_filename": "SessionStorage.html",
1080   "href": "SessionStorage.html#Ext-data-proxy-SessionStorage",
1081   "cssVar": [
1082
1083   ],
1084   "cssMixin": [
1085
1086   ],
1087   "component": false,
1088   "superclasses": [
1089     "Ext.data.proxy.Proxy",
1090     "Ext.data.proxy.Client",
1091     "Ext.data.proxy.WebStorage"
1092   ],
1093   "subclasses": [
1094
1095   ],
1096   "mixedInto": [
1097
1098   ],
1099   "allMixins": [
1100     "Ext.util.Observable"
1101   ]
1102 });