Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.data.proxy.Server.js
1 Ext.data.JsonP.Ext_data_proxy_Server({
2   "tagname": "class",
3   "name": "Ext.data.proxy.Server",
4   "doc": "<p>ServerProxy is a superclass of <a href=\"#/api/Ext.data.proxy.JsonP\" rel=\"Ext.data.proxy.JsonP\" class=\"docClass\">JsonPProxy</a> and <a href=\"#/api/Ext.data.proxy.Ajax\" rel=\"Ext.data.proxy.Ajax\" class=\"docClass\">AjaxProxy</a>,\nand would not usually be used directly.</p>\n\n\n\n\n<p>ServerProxy should ideally be named HttpProxy as it is a superclass for all HTTP proxies - for <a href=\"#/api/Ext\" rel=\"Ext\" class=\"docClass\">Ext</a> JS 4.x it has been \ncalled ServerProxy to enable any 3.x applications that reference the HttpProxy to continue to work (HttpProxy is now an \nalias of AjaxProxy).</p>\n\n",
5   "extends": "Ext.data.proxy.Proxy",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10     "Ext.data.ServerProxy"
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": "api",
21       "member": "Ext.data.proxy.Server",
22       "type": "Object",
23       "doc": "<p>Specific urls to call on CRUD action methods \"read\", \"create\", \"update\" and \"destroy\".\nDefaults to:</p>\n\n<pre><code>api: {\n    read    : undefined,\n    create  : undefined,\n    update  : undefined,\n    destroy : undefined\n}\n</code></pre>\n\n\n<p>The url is built based upon the action being executed <tt>[load|create|save|destroy]</tt>\nusing the commensurate <tt><a href=\"#/api/Ext.data.proxy.Server-cfg-api\" rel=\"Ext.data.proxy.Server-cfg-api\" class=\"docClass\">api</a></tt> property, or if undefined default to the\nconfigured <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a>.<a href=\"#/api/Ext.data.proxy.Server-cfg-url\" rel=\"Ext.data.proxy.Server-cfg-url\" class=\"docClass\">url</a>.</p>\n\n\n<br>\n\n\n<p>For example:</p>\n\n\n<pre><code>api: {\n    load :    '/controller/load',\n    create :  '/controller/new',\n    save :    '/controller/update',\n    destroy : '/controller/destroy_action'\n}\n</code></pre>\n\n\n<p>If the specific URL for a given CRUD action is undefined, the CRUD action request\nwill be directed to the configured <tt><a href=\"#/api/Ext.data.proxy.Server-cfg-url\" rel=\"Ext.data.proxy.Server-cfg-url\" class=\"docClass\">url</a></tt>.</p>\n\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
26       "linenr": 97,
27       "html_filename": "Server.html",
28       "href": "Server.html#Ext-data-proxy-Server-cfg-api",
29       "shortDoc": "Specific urls to call on CRUD action methods \"read\", \"create\", \"update\" and \"destroy\".\nDefaults to:\n\napi: {\n    read ..."
30     },
31     {
32       "tagname": "cfg",
33       "name": "batchActions",
34       "member": "Ext.data.proxy.Proxy",
35       "type": "Boolean",
36       "doc": "<p>True to batch actions of a particular type when synchronizing the store.\nDefaults to <tt>true</tt>.</p>\n",
37       "private": false,
38       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
39       "linenr": 64,
40       "html_filename": "Proxy2.html",
41       "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchActions"
42     },
43     {
44       "tagname": "cfg",
45       "name": "batchOrder",
46       "member": "Ext.data.proxy.Proxy",
47       "type": "String",
48       "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",
49       "private": false,
50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
51       "linenr": 57,
52       "html_filename": "Proxy2.html",
53       "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-batchOrder",
54       "shortDoc": "Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this\nto set a different ord..."
55     },
56     {
57       "tagname": "cfg",
58       "name": "cacheString",
59       "member": "Ext.data.proxy.Server",
60       "type": "String",
61       "doc": "<p>The name of the cache param added to the url when using noCache (defaults to \"_dc\")</p>\n",
62       "private": false,
63       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
64       "linenr": 87,
65       "html_filename": "Server.html",
66       "href": "Server.html#Ext-data-proxy-Server-cfg-cacheString"
67     },
68     {
69       "tagname": "cfg",
70       "name": "directionParam",
71       "member": "Ext.data.proxy.Server",
72       "type": "String",
73       "doc": "<p>The name of the direction parameter to send in a request. <strong>This is only used when simpleSortMode is set to true.</strong>\nDefaults to 'dir'.</p>\n",
74       "private": false,
75       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
76       "linenr": 69,
77       "html_filename": "Server.html",
78       "href": "Server.html#Ext-data-proxy-Server-cfg-directionParam",
79       "shortDoc": "The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true.\nDefau..."
80     },
81     {
82       "tagname": "cfg",
83       "name": "extraParams",
84       "member": "Ext.data.proxy.Server",
85       "type": "Object",
86       "doc": "<p>Extra parameters that will be included on every request. Individual requests with params\nof the same name will override these params when they are in conflict.</p>\n",
87       "private": false,
88       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
89       "linenr": 143,
90       "html_filename": "Server.html",
91       "href": "Server.html#Ext-data-proxy-Server-cfg-extraParams",
92       "shortDoc": "Extra parameters that will be included on every request. Individual requests with params\nof the same name will overri..."
93     },
94     {
95       "tagname": "cfg",
96       "name": "filterParam",
97       "member": "Ext.data.proxy.Server",
98       "type": "String",
99       "doc": "<p>The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set\nthis to undefined if you don't want to send a filter parameter</p>\n",
100       "private": false,
101       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
102       "linenr": 63,
103       "html_filename": "Server.html",
104       "href": "Server.html#Ext-data-proxy-Server-cfg-filterParam",
105       "shortDoc": "The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set\nthis to undefined if you don't wan..."
106     },
107     {
108       "tagname": "cfg",
109       "name": "groupParam",
110       "member": "Ext.data.proxy.Server",
111       "type": "String",
112       "doc": "<p>The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this\nto undefined if you don't want to send a group parameter</p>\n",
113       "private": false,
114       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
115       "linenr": 51,
116       "html_filename": "Server.html",
117       "href": "Server.html#Ext-data-proxy-Server-cfg-groupParam",
118       "shortDoc": "The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this\nto undefined if you don't want ..."
119     },
120     {
121       "tagname": "cfg",
122       "name": "limitParam",
123       "member": "Ext.data.proxy.Server",
124       "type": "String",
125       "doc": "<p>The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this\nto undefined if you don't want to send a limit parameter</p>\n",
126       "private": false,
127       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
128       "linenr": 45,
129       "html_filename": "Server.html",
130       "href": "Server.html#Ext-data-proxy-Server-cfg-limitParam",
131       "shortDoc": "The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this\nto undefined if you don't want ..."
132     },
133     {
134       "tagname": "cfg",
135       "name": "listeners",
136       "member": "Ext.util.Observable",
137       "type": "Object",
138       "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.Server-method-addListener\" rel=\"Ext.data.proxy.Server-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",
139       "private": false,
140       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
141       "linenr": 103,
142       "html_filename": "Observable.html",
143       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
144       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
145     },
146     {
147       "tagname": "cfg",
148       "name": "model",
149       "member": "Ext.data.proxy.Proxy",
150       "type": "String/Ext.data.Model",
151       "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",
152       "private": false,
153       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
154       "linenr": 82,
155       "html_filename": "Proxy2.html",
156       "href": "Proxy2.html#Ext-data-proxy-Proxy-cfg-model",
157       "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..."
158     },
159     {
160       "tagname": "cfg",
161       "name": "noCache",
162       "member": "Ext.data.proxy.Server",
163       "type": "Boolean",
164       "doc": "<p>(optional) Defaults to true. Disable caching by adding a unique parameter\nname to the request.</p>\n",
165       "private": false,
166       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
167       "linenr": 81,
168       "html_filename": "Server.html",
169       "href": "Server.html#Ext-data-proxy-Server-cfg-noCache"
170     },
171     {
172       "tagname": "cfg",
173       "name": "pageParam",
174       "member": "Ext.data.proxy.Server",
175       "type": "String",
176       "doc": "<p>The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to\nundefined if you don't want to send a page parameter</p>\n",
177       "private": false,
178       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
179       "linenr": 33,
180       "html_filename": "Server.html",
181       "href": "Server.html#Ext-data-proxy-Server-cfg-pageParam",
182       "shortDoc": "The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to\nundefined if you don't want to..."
183     },
184     {
185       "tagname": "cfg",
186       "name": "reader",
187       "member": "Ext.data.proxy.Server",
188       "type": "Object/String/Ext.data.reader.Reader",
189       "doc": "<p>The <a href=\"#/api/Ext.data.reader.Reader\" rel=\"Ext.data.reader.Reader\" class=\"docClass\">Ext.data.reader.Reader</a> to use to decode the server's response. This can\neither be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml').</p>\n",
190       "private": false,
191       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
192       "linenr": 23,
193       "html_filename": "Server.html",
194       "href": "Server.html#Ext-data-proxy-Server-cfg-reader",
195       "shortDoc": "The Ext.data.reader.Reader to use to decode the server's response. This can\neither be a Reader instance, a config obj..."
196     },
197     {
198       "tagname": "cfg",
199       "name": "simpleSortMode",
200       "member": "Ext.data.proxy.Server",
201       "type": "Boolean",
202       "doc": "<p>Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested.\nThe directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'</p>\n",
203       "private": false,
204       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
205       "linenr": 75,
206       "html_filename": "Server.html",
207       "href": "Server.html#Ext-data-proxy-Server-cfg-simpleSortMode",
208       "shortDoc": "Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote..."
209     },
210     {
211       "tagname": "cfg",
212       "name": "sortParam",
213       "member": "Ext.data.proxy.Server",
214       "type": "String",
215       "doc": "<p>The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this\nto undefined if you don't want to send a sort parameter</p>\n",
216       "private": false,
217       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
218       "linenr": 57,
219       "html_filename": "Server.html",
220       "href": "Server.html#Ext-data-proxy-Server-cfg-sortParam",
221       "shortDoc": "The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this\nto undefined if you don't want to..."
222     },
223     {
224       "tagname": "cfg",
225       "name": "startParam",
226       "member": "Ext.data.proxy.Server",
227       "type": "String",
228       "doc": "<p>The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this\nto undefined if you don't want to send a start parameter</p>\n",
229       "private": false,
230       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
231       "linenr": 39,
232       "html_filename": "Server.html",
233       "href": "Server.html#Ext-data-proxy-Server-cfg-startParam",
234       "shortDoc": "The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this\nto undefined if you don't want ..."
235     },
236     {
237       "tagname": "cfg",
238       "name": "timeout",
239       "member": "Ext.data.proxy.Server",
240       "type": "Number",
241       "doc": "<p>(optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.</p>\n",
242       "private": false,
243       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
244       "linenr": 92,
245       "html_filename": "Server.html",
246       "href": "Server.html#Ext-data-proxy-Server-cfg-timeout"
247     },
248     {
249       "tagname": "cfg",
250       "name": "url",
251       "member": "Ext.data.proxy.Server",
252       "type": "String",
253       "doc": "<p>The URL from which to request the data object.</p>\n",
254       "private": false,
255       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
256       "linenr": 19,
257       "html_filename": "Server.html",
258       "href": "Server.html#Ext-data-proxy-Server-cfg-url"
259     },
260     {
261       "tagname": "cfg",
262       "name": "writer",
263       "member": "Ext.data.proxy.Server",
264       "type": "Object/String/Ext.data.writer.Writer",
265       "doc": "<p>The <a href=\"#/api/Ext.data.writer.Writer\" rel=\"Ext.data.writer.Writer\" class=\"docClass\">Ext.data.writer.Writer</a> to use to encode any request sent to the server.\nThis can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').</p>\n",
266       "private": false,
267       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
268       "linenr": 28,
269       "html_filename": "Server.html",
270       "href": "Server.html#Ext-data-proxy-Server-cfg-writer",
271       "shortDoc": "The Ext.data.writer.Writer to use to encode any request sent to the server.\nThis can either be a Writer instance, a c..."
272     }
273   ],
274   "method": [
275     {
276       "tagname": "method",
277       "name": "Server",
278       "member": "Ext.data.proxy.Proxy",
279       "doc": "<p>Creates the Proxy</p>\n",
280       "params": [
281         {
282           "type": "Object",
283           "name": "config",
284           "doc": "<p>Optional config object</p>\n",
285           "optional": false
286         }
287       ],
288       "return": {
289         "type": "void",
290         "doc": "\n"
291       },
292       "private": false,
293       "static": false,
294       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
295       "linenr": 1,
296       "html_filename": "Proxy2.html",
297       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-constructor",
298       "shortDoc": "<p>Creates the Proxy</p>\n"
299     },
300     {
301       "tagname": "method",
302       "name": "addEvents",
303       "member": "Ext.util.Observable",
304       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
305       "params": [
306         {
307           "type": "Object/String",
308           "name": "o",
309           "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",
310           "optional": false
311         },
312         {
313           "type": "String",
314           "name": "",
315           "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",
316           "optional": false
317         }
318       ],
319       "return": {
320         "type": "void",
321         "doc": "\n"
322       },
323       "private": false,
324       "static": false,
325       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
326       "linenr": 452,
327       "html_filename": "Observable.html",
328       "href": "Observable.html#Ext-util-Observable-method-addEvents",
329       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
330     },
331     {
332       "tagname": "method",
333       "name": "addListener",
334       "member": "Ext.util.Observable",
335       "doc": "<p>Appends an event handler to this object.</p>\n",
336       "params": [
337         {
338           "type": "String",
339           "name": "eventName",
340           "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",
341           "optional": false
342         },
343         {
344           "type": "Function",
345           "name": "handler",
346           "doc": "<p>The method the event invokes.</p>\n",
347           "optional": false
348         },
349         {
350           "type": "Object",
351           "name": "scope",
352           "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",
353           "optional": true
354         },
355         {
356           "type": "Object",
357           "name": "options",
358           "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",
359           "optional": true
360         }
361       ],
362       "return": {
363         "type": "void",
364         "doc": "\n"
365       },
366       "private": false,
367       "static": false,
368       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
369       "linenr": 271,
370       "html_filename": "Observable.html",
371       "href": "Observable.html#Ext-util-Observable-method-addListener",
372       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
373     },
374     {
375       "tagname": "method",
376       "name": "addManagedListener",
377       "member": "Ext.util.Observable",
378       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
379       "params": [
380         {
381           "type": "Observable/Element",
382           "name": "item",
383           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
384           "optional": false
385         },
386         {
387           "type": "Object/String",
388           "name": "ename",
389           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
390           "optional": false
391         },
392         {
393           "type": "Function",
394           "name": "fn",
395           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
396           "optional": false
397         },
398         {
399           "type": "Object",
400           "name": "scope",
401           "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",
402           "optional": false
403         },
404         {
405           "type": "Object",
406           "name": "opt",
407           "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",
408           "optional": false
409         }
410       ],
411       "return": {
412         "type": "void",
413         "doc": "\n"
414       },
415       "private": false,
416       "static": false,
417       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
418       "linenr": 155,
419       "html_filename": "Observable.html",
420       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
421       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
422     },
423     {
424       "tagname": "method",
425       "name": "afterRequest",
426       "member": "Ext.data.proxy.Server",
427       "doc": "<p>Optional callback function which can be used to clean up after a request has been completed.</p>\n",
428       "params": [
429         {
430           "type": "Ext.data.Request",
431           "name": "request",
432           "doc": "<p>The Request object</p>\n",
433           "optional": false
434         },
435         {
436           "type": "Boolean",
437           "name": "success",
438           "doc": "<p>True if the request was successful</p>\n",
439           "optional": false
440         }
441       ],
442       "return": {
443         "type": "void",
444         "doc": "\n"
445       },
446       "private": false,
447       "static": false,
448       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
449       "linenr": 450,
450       "html_filename": "Server.html",
451       "href": "Server.html#Ext-data-proxy-Server-method-afterRequest",
452       "shortDoc": "<p>Optional callback function which can be used to clean up after a request has been completed.</p>\n"
453     },
454     {
455       "tagname": "method",
456       "name": "batch",
457       "member": "Ext.data.proxy.Proxy",
458       "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.Server-cfg-batchOrder\" rel=\"Ext.data.proxy.Server-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",
459       "params": [
460         {
461           "type": "Object",
462           "name": "operations",
463           "doc": "<p>Object containing the Model instances to act upon, keyed by action name</p>\n",
464           "optional": false
465         },
466         {
467           "type": "Object",
468           "name": "listeners",
469           "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",
470           "optional": false
471         }
472       ],
473       "return": {
474         "type": "Ext.data.Batch",
475         "doc": "<p>The newly created <a href=\"#/api/Ext.data.Batch\" rel=\"Ext.data.Batch\" class=\"docClass\">Ext.data.Batch</a> object</p>\n"
476       },
477       "private": false,
478       "static": false,
479       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
480       "linenr": 241,
481       "html_filename": "Proxy2.html",
482       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-batch",
483       "shortDoc": "Performs a batch of Operations, in the order specified by batchOrder. Used internally by\nExt.data.Store's sync method..."
484     },
485     {
486       "tagname": "method",
487       "name": "buildRequest",
488       "member": "Ext.data.proxy.Server",
489       "doc": "<p>Creates and returns an <a href=\"#/api/Ext.data.Request\" rel=\"Ext.data.Request\" class=\"docClass\">Ext.data.Request</a> object based on the options passed by the <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Store</a>\nthat this Proxy is attached to.</p>\n",
490       "params": [
491         {
492           "type": "Ext.data.Operation",
493           "name": "operation",
494           "doc": "<p>The <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Operation</a> object to execute</p>\n",
495           "optional": false
496         }
497       ],
498       "return": {
499         "type": "Ext.data.Request",
500         "doc": "<p>The request object</p>\n"
501       },
502       "private": false,
503       "static": false,
504       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
505       "linenr": 172,
506       "html_filename": "Server.html",
507       "href": "Server.html#Ext-data-proxy-Server-method-buildRequest",
508       "shortDoc": "<p>Creates and returns an <a href=\"#/api/Ext.data.Request\" rel=\"Ext.data.Request\" class=\"docClass\">Ext.data.Request</a> object based on the options passed by the <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Store</a>\nthat this Proxy is attached to.</p>\n"
509     },
510     {
511       "tagname": "method",
512       "name": "buildUrl",
513       "member": "Ext.data.proxy.Server",
514       "doc": "<p>Generates a url based on a given <a href=\"#/api/Ext.data.Request\" rel=\"Ext.data.Request\" class=\"docClass\">Ext.data.Request</a> object. By default, ServerProxy's buildUrl will\nadd the cache-buster param to the end of the url. Subclasses may need to perform additional modifications\nto the url.</p>\n",
515       "params": [
516         {
517           "type": "Ext.data.Request",
518           "name": "request",
519           "doc": "<p>The request object</p>\n",
520           "optional": false
521         }
522       ],
523       "return": {
524         "type": "String",
525         "doc": "<p>The url</p>\n"
526       },
527       "private": false,
528       "static": false,
529       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
530       "linenr": 399,
531       "html_filename": "Server.html",
532       "href": "Server.html#Ext-data-proxy-Server-method-buildUrl",
533       "shortDoc": "Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will\nadd the cache-buste..."
534     },
535     {
536       "tagname": "method",
537       "name": "capture",
538       "member": "Ext.util.Observable",
539       "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",
540       "params": [
541         {
542           "type": "Observable",
543           "name": "o",
544           "doc": "<p>The Observable to capture events from.</p>\n",
545           "optional": false
546         },
547         {
548           "type": "Function",
549           "name": "fn",
550           "doc": "<p>The function to call when an event is fired.</p>\n",
551           "optional": false
552         },
553         {
554           "type": "Object",
555           "name": "scope",
556           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
557           "optional": true
558         }
559       ],
560       "return": {
561         "type": "void",
562         "doc": "\n"
563       },
564       "private": false,
565       "static": true,
566       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
567       "linenr": 55,
568       "html_filename": "Observable.html",
569       "href": "Observable.html#Ext-util-Observable-method-capture",
570       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
571     },
572     {
573       "tagname": "method",
574       "name": "clearListeners",
575       "member": "Ext.util.Observable",
576       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
577       "params": [
578
579       ],
580       "return": {
581         "type": "void",
582         "doc": "\n"
583       },
584       "private": false,
585       "static": false,
586       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
587       "linenr": 383,
588       "html_filename": "Observable.html",
589       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
590       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
591     },
592     {
593       "tagname": "method",
594       "name": "clearManagedListeners",
595       "member": "Ext.util.Observable",
596       "doc": "<p>Removes all managed listeners for this object.</p>\n",
597       "params": [
598
599       ],
600       "return": {
601         "type": "void",
602         "doc": "\n"
603       },
604       "private": false,
605       "static": false,
606       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
607       "linenr": 412,
608       "html_filename": "Observable.html",
609       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
610       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
611     },
612     {
613       "tagname": "method",
614       "name": "create",
615       "member": "Ext.data.proxy.Proxy",
616       "doc": "<p>Performs the given create operation.</p>\n",
617       "params": [
618         {
619           "type": "Ext.data.Operation",
620           "name": "operation",
621           "doc": "<p>The Operation to perform</p>\n",
622           "optional": false
623         },
624         {
625           "type": "Function",
626           "name": "callback",
627           "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
628           "optional": false
629         },
630         {
631           "type": "Object",
632           "name": "scope",
633           "doc": "<p>Scope to execute the callback function in</p>\n",
634           "optional": false
635         }
636       ],
637       "return": {
638         "type": "void",
639         "doc": "\n"
640       },
641       "private": false,
642       "static": false,
643       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
644       "linenr": 205,
645       "html_filename": "Proxy2.html",
646       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-create",
647       "shortDoc": "<p>Performs the given create operation.</p>\n"
648     },
649     {
650       "tagname": "method",
651       "name": "destroy",
652       "member": "Ext.data.proxy.Proxy",
653       "doc": "<p>Performs the given destroy operation.</p>\n",
654       "params": [
655         {
656           "type": "Ext.data.Operation",
657           "name": "operation",
658           "doc": "<p>The Operation to perform</p>\n",
659           "optional": false
660         },
661         {
662           "type": "Function",
663           "name": "callback",
664           "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
665           "optional": false
666         },
667         {
668           "type": "Object",
669           "name": "scope",
670           "doc": "<p>Scope to execute the callback function in</p>\n",
671           "optional": false
672         }
673       ],
674       "return": {
675         "type": "void",
676         "doc": "\n"
677       },
678       "private": false,
679       "static": false,
680       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
681       "linenr": 232,
682       "html_filename": "Proxy2.html",
683       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-destroy",
684       "shortDoc": "<p>Performs the given destroy operation.</p>\n"
685     },
686     {
687       "tagname": "method",
688       "name": "doRequest",
689       "member": "Ext.data.proxy.Server",
690       "doc": "<p>In ServerProxy subclasses, the <a href=\"#/api/Ext.data.proxy.Server-method-create\" rel=\"Ext.data.proxy.Server-method-create\" class=\"docClass\">create</a>, <a href=\"#/api/Ext.data.proxy.Server-method-read\" rel=\"Ext.data.proxy.Server-method-read\" class=\"docClass\">read</a>, <a href=\"#/api/Ext.data.proxy.Server-method-update\" rel=\"Ext.data.proxy.Server-method-update\" class=\"docClass\">update</a> and <a href=\"#/api/Ext.data.proxy.Server-method-destroy\" rel=\"Ext.data.proxy.Server-method-destroy\" class=\"docClass\">destroy</a> methods all pass\nthrough to doRequest. Each ServerProxy subclass must implement the doRequest method - see <a href=\"#/api/Ext.data.proxy.JsonP\" rel=\"Ext.data.proxy.JsonP\" class=\"docClass\">Ext.data.proxy.JsonP</a>\nand <a href=\"#/api/Ext.data.proxy.Ajax\" rel=\"Ext.data.proxy.Ajax\" class=\"docClass\">Ext.data.proxy.Ajax</a> for examples. This method carries the same signature as each of the methods that delegate to it.</p>\n",
691       "params": [
692         {
693           "type": "Ext.data.Operation",
694           "name": "operation",
695           "doc": "<p>The <a href=\"#/api/Ext.data.Operation\" rel=\"Ext.data.Operation\" class=\"docClass\">Ext.data.Operation</a> object</p>\n",
696           "optional": false
697         },
698         {
699           "type": "Function",
700           "name": "callback",
701           "doc": "<p>The callback function to call when the Operation has completed</p>\n",
702           "optional": false
703         },
704         {
705           "type": "Object",
706           "name": "scope",
707           "doc": "<p>The scope in which to execute the callback</p>\n",
708           "optional": false
709         }
710       ],
711       "return": {
712         "type": "void",
713         "doc": "\n"
714       },
715       "private": false,
716       "static": false,
717       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
718       "linenr": 436,
719       "html_filename": "Server.html",
720       "href": "Server.html#Ext-data-proxy-Server-method-doRequest",
721       "shortDoc": "In ServerProxy subclasses, the create, read, update and destroy methods all pass\nthrough to doRequest. Each ServerPro..."
722     },
723     {
724       "tagname": "method",
725       "name": "enableBubble",
726       "member": "Ext.util.Observable",
727       "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",
728       "params": [
729         {
730           "type": "String/Array",
731           "name": "events",
732           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
733           "optional": false
734         }
735       ],
736       "return": {
737         "type": "void",
738         "doc": "\n"
739       },
740       "private": false,
741       "static": false,
742       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
743       "linenr": 554,
744       "html_filename": "Observable.html",
745       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
746       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
747     },
748     {
749       "tagname": "method",
750       "name": "encodeFilters",
751       "member": "Ext.data.proxy.Server",
752       "doc": "<p>Encodes the array of <a href=\"#/api/Ext.util.Filter\" rel=\"Ext.util.Filter\" class=\"docClass\">Ext.util.Filter</a> objects into a string to be sent in the request url. By default,\nthis simply JSON-encodes the filter data</p>\n",
753       "params": [
754         {
755           "type": "Array",
756           "name": "sorters",
757           "doc": "<p>The array of <a href=\"#/api/Ext.util.Filter\" rel=\"Ext.util.Filter\" class=\"docClass\">Filter</a> objects</p>\n",
758           "optional": false
759         }
760       ],
761       "return": {
762         "type": "String",
763         "doc": "<p>The encoded filters</p>\n"
764       },
765       "private": false,
766       "static": false,
767       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
768       "linenr": 319,
769       "html_filename": "Server.html",
770       "href": "Server.html#Ext-data-proxy-Server-method-encodeFilters",
771       "shortDoc": "Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default,\nthis simply JSO..."
772     },
773     {
774       "tagname": "method",
775       "name": "encodeSorters",
776       "member": "Ext.data.proxy.Server",
777       "doc": "<p>Encodes the array of <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Ext.util.Sorter</a> objects into a string to be sent in the request url. By default,\nthis simply JSON-encodes the sorter data</p>\n",
778       "params": [
779         {
780           "type": "Array",
781           "name": "sorters",
782           "doc": "<p>The array of <a href=\"#/api/Ext.util.Sorter\" rel=\"Ext.util.Sorter\" class=\"docClass\">Sorter</a> objects</p>\n",
783           "optional": false
784         }
785       ],
786       "return": {
787         "type": "String",
788         "doc": "<p>The encoded sorters</p>\n"
789       },
790       "private": false,
791       "static": false,
792       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
793       "linenr": 298,
794       "html_filename": "Server.html",
795       "href": "Server.html#Ext-data-proxy-Server-method-encodeSorters",
796       "shortDoc": "Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default,\nthis simply JSO..."
797     },
798     {
799       "tagname": "method",
800       "name": "fireEvent",
801       "member": "Ext.util.Observable",
802       "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.Server-method-enableBubble\" rel=\"Ext.data.proxy.Server-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
803       "params": [
804         {
805           "type": "String",
806           "name": "eventName",
807           "doc": "<p>The name of the event to fire.</p>\n",
808           "optional": false
809         },
810         {
811           "type": "Object...",
812           "name": "args",
813           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
814           "optional": false
815         }
816       ],
817       "return": {
818         "type": "Boolean",
819         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
820       },
821       "private": false,
822       "static": false,
823       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
824       "linenr": 232,
825       "html_filename": "Observable.html",
826       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
827       "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..."
828     },
829     {
830       "tagname": "method",
831       "name": "getModel",
832       "member": "Ext.data.proxy.Proxy",
833       "doc": "<p>Returns the model attached to this Proxy</p>\n",
834       "params": [
835
836       ],
837       "return": {
838         "type": "Ext.data.Model",
839         "doc": "<p>The model</p>\n"
840       },
841       "private": false,
842       "static": false,
843       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
844       "linenr": 123,
845       "html_filename": "Proxy2.html",
846       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getModel",
847       "shortDoc": "<p>Returns the model attached to this Proxy</p>\n"
848     },
849     {
850       "tagname": "method",
851       "name": "getReader",
852       "member": "Ext.data.proxy.Proxy",
853       "doc": "<p>Returns the reader currently attached to this proxy instance</p>\n",
854       "params": [
855
856       ],
857       "return": {
858         "type": "Ext.data.reader.Reader",
859         "doc": "<p>The Reader instance</p>\n"
860       },
861       "private": false,
862       "static": false,
863       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
864       "linenr": 162,
865       "html_filename": "Proxy2.html",
866       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getReader",
867       "shortDoc": "<p>Returns the reader currently attached to this proxy instance</p>\n"
868     },
869     {
870       "tagname": "method",
871       "name": "getWriter",
872       "member": "Ext.data.proxy.Proxy",
873       "doc": "<p>Returns the writer currently attached to this proxy instance</p>\n",
874       "params": [
875
876       ],
877       "return": {
878         "type": "Ext.data.writer.Writer",
879         "doc": "<p>The Writer instance</p>\n"
880       },
881       "private": false,
882       "static": false,
883       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
884       "linenr": 197,
885       "html_filename": "Proxy2.html",
886       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-getWriter",
887       "shortDoc": "<p>Returns the writer currently attached to this proxy instance</p>\n"
888     },
889     {
890       "tagname": "method",
891       "name": "hasListener",
892       "member": "Ext.util.Observable",
893       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
894       "params": [
895         {
896           "type": "String",
897           "name": "eventName",
898           "doc": "<p>The name of the event to check for</p>\n",
899           "optional": false
900         }
901       ],
902       "return": {
903         "type": "Boolean",
904         "doc": "<p>True if the event is being listened for, else false</p>\n"
905       },
906       "private": false,
907       "static": false,
908       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
909       "linenr": 480,
910       "html_filename": "Observable.html",
911       "href": "Observable.html#Ext-util-Observable-method-hasListener",
912       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
913     },
914     {
915       "tagname": "method",
916       "name": "observe",
917       "member": "Ext.util.Observable",
918       "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",
919       "params": [
920         {
921           "type": "Function",
922           "name": "c",
923           "doc": "<p>The class constructor to make observable.</p>\n",
924           "optional": false
925         },
926         {
927           "type": "Object",
928           "name": "listeners",
929           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.data.proxy.Server-method-addListener\" rel=\"Ext.data.proxy.Server-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
930           "optional": false
931         }
932       ],
933       "return": {
934         "type": "void",
935         "doc": "\n"
936       },
937       "private": false,
938       "static": true,
939       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
940       "linenr": 69,
941       "html_filename": "Observable.html",
942       "href": "Observable.html#Ext-util-Observable-method-observe",
943       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
944     },
945     {
946       "tagname": "method",
947       "name": "on",
948       "member": "Ext.util.Observable",
949       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.proxy.Server-method-addListener\" rel=\"Ext.data.proxy.Server-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
950       "params": [
951         {
952           "type": "String",
953           "name": "eventName",
954           "doc": "<p>The type of event to listen for</p>\n",
955           "optional": false
956         },
957         {
958           "type": "Function",
959           "name": "handler",
960           "doc": "<p>The method the event invokes</p>\n",
961           "optional": false
962         },
963         {
964           "type": "Object",
965           "name": "scope",
966           "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",
967           "optional": true
968         },
969         {
970           "type": "Object",
971           "name": "options",
972           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
973           "optional": true
974         }
975       ],
976       "return": {
977         "type": "void",
978         "doc": "\n"
979       },
980       "private": false,
981       "static": false,
982       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
983       "linenr": 616,
984       "html_filename": "Observable.html",
985       "href": "Observable.html#Ext-util-Observable-method-on",
986       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.proxy.Server-method-addListener\" rel=\"Ext.data.proxy.Server-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
987     },
988     {
989       "tagname": "method",
990       "name": "processResponse",
991       "member": "Ext.data.proxy.Server",
992       "doc": "\n",
993       "params": [
994         {
995           "type": "Object",
996           "name": "success",
997           "doc": "\n",
998           "optional": false
999         },
1000         {
1001           "type": "Object",
1002           "name": "operation",
1003           "doc": "\n",
1004           "optional": false
1005         },
1006         {
1007           "type": "Object",
1008           "name": "request",
1009           "doc": "\n",
1010           "optional": false
1011         },
1012         {
1013           "type": "Object",
1014           "name": "response",
1015           "doc": "\n",
1016           "optional": false
1017         },
1018         {
1019           "type": "Object",
1020           "name": "callback",
1021           "doc": "\n",
1022           "optional": false
1023         },
1024         {
1025           "type": "Object",
1026           "name": "scope",
1027           "doc": "\n",
1028           "optional": false
1029         }
1030       ],
1031       "return": {
1032         "type": "void",
1033         "doc": "\n"
1034       },
1035       "private": false,
1036       "static": false,
1037       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
1038       "linenr": 208,
1039       "html_filename": "Server.html",
1040       "href": "Server.html#Ext-data-proxy-Server-method-processResponse",
1041       "shortDoc": "\n"
1042     },
1043     {
1044       "tagname": "method",
1045       "name": "read",
1046       "member": "Ext.data.proxy.Proxy",
1047       "doc": "<p>Performs the given read operation.</p>\n",
1048       "params": [
1049         {
1050           "type": "Ext.data.Operation",
1051           "name": "operation",
1052           "doc": "<p>The Operation to perform</p>\n",
1053           "optional": false
1054         },
1055         {
1056           "type": "Function",
1057           "name": "callback",
1058           "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
1059           "optional": false
1060         },
1061         {
1062           "type": "Object",
1063           "name": "scope",
1064           "doc": "<p>Scope to execute the callback function in</p>\n",
1065           "optional": false
1066         }
1067       ],
1068       "return": {
1069         "type": "void",
1070         "doc": "\n"
1071       },
1072       "private": false,
1073       "static": false,
1074       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
1075       "linenr": 214,
1076       "html_filename": "Proxy2.html",
1077       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-read",
1078       "shortDoc": "<p>Performs the given read operation.</p>\n"
1079     },
1080     {
1081       "tagname": "method",
1082       "name": "relayEvents",
1083       "member": "Ext.util.Observable",
1084       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
1085       "params": [
1086         {
1087           "type": "Object",
1088           "name": "origin",
1089           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
1090           "optional": false
1091         },
1092         {
1093           "type": "Array",
1094           "name": "events",
1095           "doc": "<p>Array of event names to relay.</p>\n",
1096           "optional": false
1097         },
1098         {
1099           "type": "Object",
1100           "name": "prefix",
1101           "doc": "\n",
1102           "optional": false
1103         }
1104       ],
1105       "return": {
1106         "type": "void",
1107         "doc": "\n"
1108       },
1109       "private": false,
1110       "static": false,
1111       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1112       "linenr": 520,
1113       "html_filename": "Observable.html",
1114       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
1115       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
1116     },
1117     {
1118       "tagname": "method",
1119       "name": "releaseCapture",
1120       "member": "Ext.util.Observable",
1121       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
1122       "params": [
1123         {
1124           "type": "Observable",
1125           "name": "o",
1126           "doc": "<p>The Observable to release</p>\n",
1127           "optional": false
1128         }
1129       ],
1130       "return": {
1131         "type": "void",
1132         "doc": "\n"
1133       },
1134       "private": false,
1135       "static": true,
1136       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1137       "linenr": 46,
1138       "html_filename": "Observable.html",
1139       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
1140       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
1141     },
1142     {
1143       "tagname": "method",
1144       "name": "removeListener",
1145       "member": "Ext.util.Observable",
1146       "doc": "<p>Removes an event handler.</p>\n",
1147       "params": [
1148         {
1149           "type": "String",
1150           "name": "eventName",
1151           "doc": "<p>The type of event the handler was associated with.</p>\n",
1152           "optional": false
1153         },
1154         {
1155           "type": "Function",
1156           "name": "handler",
1157           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.proxy.Server-method-addListener\" rel=\"Ext.data.proxy.Server-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1158           "optional": false
1159         },
1160         {
1161           "type": "Object",
1162           "name": "scope",
1163           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1164           "optional": true
1165         }
1166       ],
1167       "return": {
1168         "type": "void",
1169         "doc": "\n"
1170       },
1171       "private": false,
1172       "static": false,
1173       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1174       "linenr": 352,
1175       "html_filename": "Observable.html",
1176       "href": "Observable.html#Ext-util-Observable-method-removeListener",
1177       "shortDoc": "<p>Removes an event handler.</p>\n"
1178     },
1179     {
1180       "tagname": "method",
1181       "name": "removeManagedListener",
1182       "member": "Ext.util.Observable",
1183       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.proxy.Server--mon\" rel=\"Ext.data.proxy.Server--mon\" class=\"docClass\">mon</a> method.</p>\n",
1184       "params": [
1185         {
1186           "type": "Observable|Element",
1187           "name": "item",
1188           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
1189           "optional": false
1190         },
1191         {
1192           "type": "Object|String",
1193           "name": "ename",
1194           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
1195           "optional": false
1196         },
1197         {
1198           "type": "Function",
1199           "name": "fn",
1200           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
1201           "optional": false
1202         },
1203         {
1204           "type": "Object",
1205           "name": "scope",
1206           "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",
1207           "optional": false
1208         }
1209       ],
1210       "return": {
1211         "type": "void",
1212         "doc": "\n"
1213       },
1214       "private": false,
1215       "static": false,
1216       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1217       "linenr": 196,
1218       "html_filename": "Observable.html",
1219       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
1220       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.proxy.Server--mon\" rel=\"Ext.data.proxy.Server--mon\" class=\"docClass\">mon</a> method.</p>\n"
1221     },
1222     {
1223       "tagname": "method",
1224       "name": "resumeEvents",
1225       "member": "Ext.util.Observable",
1226       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.data.proxy.Server-method-suspendEvents\" rel=\"Ext.data.proxy.Server-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",
1227       "params": [
1228
1229       ],
1230       "return": {
1231         "type": "void",
1232         "doc": "\n"
1233       },
1234       "private": false,
1235       "static": false,
1236       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1237       "linenr": 502,
1238       "html_filename": "Observable.html",
1239       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
1240       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
1241     },
1242     {
1243       "tagname": "method",
1244       "name": "setModel",
1245       "member": "Ext.data.proxy.Proxy",
1246       "doc": "<p>Sets the model associated with this proxy. This will only usually be called by a Store</p>\n",
1247       "params": [
1248         {
1249           "type": "String|Ext.data.Model",
1250           "name": "model",
1251           "doc": "<p>The new model. Can be either the model name string,\nor a reference to the model's constructor</p>\n",
1252           "optional": false
1253         },
1254         {
1255           "type": "Boolean",
1256           "name": "setOnStore",
1257           "doc": "<p>Sets the new model on the associated Store, if one is present</p>\n",
1258           "optional": false
1259         }
1260       ],
1261       "return": {
1262         "type": "void",
1263         "doc": "\n"
1264       },
1265       "private": false,
1266       "static": false,
1267       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
1268       "linenr": 103,
1269       "html_filename": "Proxy2.html",
1270       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setModel",
1271       "shortDoc": "<p>Sets the model associated with this proxy. This will only usually be called by a Store</p>\n"
1272     },
1273     {
1274       "tagname": "method",
1275       "name": "setReader",
1276       "member": "Ext.data.proxy.Proxy",
1277       "doc": "<p>Sets the Proxy's Reader by string, config object or Reader instance</p>\n",
1278       "params": [
1279         {
1280           "type": "String|Object|Ext.data.reader.Reader",
1281           "name": "reader",
1282           "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",
1283           "optional": false
1284         }
1285       ],
1286       "return": {
1287         "type": "Ext.data.reader.Reader",
1288         "doc": "<p>The attached Reader object</p>\n"
1289       },
1290       "private": false,
1291       "static": false,
1292       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
1293       "linenr": 131,
1294       "html_filename": "Proxy2.html",
1295       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setReader",
1296       "shortDoc": "<p>Sets the Proxy's Reader by string, config object or Reader instance</p>\n"
1297     },
1298     {
1299       "tagname": "method",
1300       "name": "setWriter",
1301       "member": "Ext.data.proxy.Proxy",
1302       "doc": "<p>Sets the Proxy's Writer by string, config object or Writer instance</p>\n",
1303       "params": [
1304         {
1305           "type": "String|Object|Ext.data.writer.Writer",
1306           "name": "writer",
1307           "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",
1308           "optional": false
1309         }
1310       ],
1311       "return": {
1312         "type": "Ext.data.writer.Writer",
1313         "doc": "<p>The attached Writer object</p>\n"
1314       },
1315       "private": false,
1316       "static": false,
1317       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
1318       "linenr": 170,
1319       "html_filename": "Proxy2.html",
1320       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-setWriter",
1321       "shortDoc": "<p>Sets the Proxy's Writer by string, config object or Writer instance</p>\n"
1322     },
1323     {
1324       "tagname": "method",
1325       "name": "suspendEvents",
1326       "member": "Ext.util.Observable",
1327       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.proxy.Server-method-resumeEvents\" rel=\"Ext.data.proxy.Server-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
1328       "params": [
1329         {
1330           "type": "Boolean",
1331           "name": "queueSuspended",
1332           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.data.proxy.Server-method-resumeEvents\" rel=\"Ext.data.proxy.Server-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
1333           "optional": false
1334         }
1335       ],
1336       "return": {
1337         "type": "void",
1338         "doc": "\n"
1339       },
1340       "private": false,
1341       "static": false,
1342       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1343       "linenr": 490,
1344       "html_filename": "Observable.html",
1345       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1346       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.proxy.Server-method-resumeEvents\" rel=\"Ext.data.proxy.Server-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
1347     },
1348     {
1349       "tagname": "method",
1350       "name": "un",
1351       "member": "Ext.util.Observable",
1352       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.proxy.Server-method-removeListener\" rel=\"Ext.data.proxy.Server-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
1353       "params": [
1354         {
1355           "type": "String",
1356           "name": "eventName",
1357           "doc": "<p>The type of event the handler was associated with.</p>\n",
1358           "optional": false
1359         },
1360         {
1361           "type": "Function",
1362           "name": "handler",
1363           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.proxy.Server-method-addListener\" rel=\"Ext.data.proxy.Server-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1364           "optional": false
1365         },
1366         {
1367           "type": "Object",
1368           "name": "scope",
1369           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1370           "optional": true
1371         }
1372       ],
1373       "return": {
1374         "type": "void",
1375         "doc": "\n"
1376       },
1377       "private": false,
1378       "static": false,
1379       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1380       "linenr": 608,
1381       "html_filename": "Observable.html",
1382       "href": "Observable.html#Ext-util-Observable-method-un",
1383       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.proxy.Server-method-removeListener\" rel=\"Ext.data.proxy.Server-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
1384     },
1385     {
1386       "tagname": "method",
1387       "name": "update",
1388       "member": "Ext.data.proxy.Proxy",
1389       "doc": "<p>Performs the given update operation.</p>\n",
1390       "params": [
1391         {
1392           "type": "Ext.data.Operation",
1393           "name": "operation",
1394           "doc": "<p>The Operation to perform</p>\n",
1395           "optional": false
1396         },
1397         {
1398           "type": "Function",
1399           "name": "callback",
1400           "doc": "<p>Callback function to be called when the Operation has completed (whether successful or not)</p>\n",
1401           "optional": false
1402         },
1403         {
1404           "type": "Object",
1405           "name": "scope",
1406           "doc": "<p>Scope to execute the callback function in</p>\n",
1407           "optional": false
1408         }
1409       ],
1410       "return": {
1411         "type": "void",
1412         "doc": "\n"
1413       },
1414       "private": false,
1415       "static": false,
1416       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Proxy.js",
1417       "linenr": 223,
1418       "html_filename": "Proxy2.html",
1419       "href": "Proxy2.html#Ext-data-proxy-Proxy-method-update",
1420       "shortDoc": "<p>Performs the given update operation.</p>\n"
1421     }
1422   ],
1423   "property": [
1424
1425   ],
1426   "event": [
1427     {
1428       "tagname": "event",
1429       "name": "exception",
1430       "member": "Ext.data.proxy.Server",
1431       "doc": "<p>Fires when the server returns an exception</p>\n",
1432       "params": [
1433         {
1434           "type": "Ext.data.proxy.Proxy",
1435           "name": "this",
1436           "doc": "\n",
1437           "optional": false
1438         },
1439         {
1440           "type": "Object",
1441           "name": "response",
1442           "doc": "<p>The response from the AJAX request</p>\n",
1443           "optional": false
1444         },
1445         {
1446           "type": "Ext.data.Operation",
1447           "name": "operation",
1448           "doc": "<p>The operation that triggered request</p>\n",
1449           "optional": false
1450         }
1451       ],
1452       "private": false,
1453       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
1454       "linenr": 132,
1455       "html_filename": "Server.html",
1456       "href": "Server.html#Ext-data-proxy-Server-event-exception",
1457       "shortDoc": "<p>Fires when the server returns an exception</p>\n"
1458     }
1459   ],
1460   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/proxy/Server.js",
1461   "linenr": 1,
1462   "html_filename": "Server.html",
1463   "href": "Server.html#Ext-data-proxy-Server",
1464   "cssVar": [
1465
1466   ],
1467   "cssMixin": [
1468
1469   ],
1470   "component": false,
1471   "superclasses": [
1472     "Ext.data.proxy.Proxy"
1473   ],
1474   "subclasses": [
1475     "Ext.data.proxy.Ajax",
1476     "Ext.data.proxy.Direct",
1477     "Ext.data.proxy.JsonP"
1478   ],
1479   "mixedInto": [
1480
1481   ],
1482   "allMixins": [
1483     "Ext.util.Observable"
1484   ]
1485 });