Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.direct.JsonProvider.js
1 Ext.data.JsonP.Ext_direct_JsonProvider({
2   "tagname": "class",
3   "name": "Ext.direct.JsonProvider",
4   "doc": "<p>A base provider for communicating using JSON. This is an abstract class\nand should not be instanced directly.</p>\n",
5   "extends": "Ext.direct.Provider",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "id",
21       "member": "Ext.direct.Provider",
22       "type": "String",
23       "doc": "<p>The unique id of the provider (defaults to an <a href=\"#/api/Ext-method-id\" rel=\"Ext-method-id\" class=\"docClass\">auto-assigned id</a>).\nYou should assign an id if you need to be able to access the provider later and you do\nnot have an object reference available, for example:</p>\n\n<pre><code>Ext.direct.Manager.addProvider({\n    type: 'polling',\n    url:  'php/poll.php',\n    id:   'poll-provider'\n});     \nvar p = <a href=\"#/api/Ext.direct.Manager\" rel=\"Ext.direct.Manager\" class=\"docClass\">Ext.direct.Manager</a>.<a href=\"#/api/Ext.direct.Manager-method-getProvider\" rel=\"Ext.direct.Manager-method-getProvider\" class=\"docClass\">getProvider</a>('poll-provider');\np.disconnect();\n</code></pre>\n\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
26       "linenr": 29,
27       "html_filename": "Provider.html",
28       "href": "Provider.html#Ext-direct-Provider-cfg-id",
29       "shortDoc": "The unique id of the provider (defaults to an auto-assigned id).\nYou should assign an id if you need to be able to ac..."
30     },
31     {
32       "tagname": "cfg",
33       "name": "listeners",
34       "member": "Ext.util.Observable",
35       "type": "Object",
36       "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.direct.JsonProvider-method-addListener\" rel=\"Ext.direct.JsonProvider-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",
37       "private": false,
38       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
39       "linenr": 103,
40       "html_filename": "Observable.html",
41       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
42       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
43     }
44   ],
45   "method": [
46     {
47       "tagname": "method",
48       "name": "addEvents",
49       "member": "Ext.util.Observable",
50       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
51       "params": [
52         {
53           "type": "Object/String",
54           "name": "o",
55           "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",
56           "optional": false
57         },
58         {
59           "type": "String",
60           "name": "",
61           "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",
62           "optional": false
63         }
64       ],
65       "return": {
66         "type": "void",
67         "doc": "\n"
68       },
69       "private": false,
70       "static": false,
71       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
72       "linenr": 452,
73       "html_filename": "Observable.html",
74       "href": "Observable.html#Ext-util-Observable-method-addEvents",
75       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
76     },
77     {
78       "tagname": "method",
79       "name": "addListener",
80       "member": "Ext.util.Observable",
81       "doc": "<p>Appends an event handler to this object.</p>\n",
82       "params": [
83         {
84           "type": "String",
85           "name": "eventName",
86           "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",
87           "optional": false
88         },
89         {
90           "type": "Function",
91           "name": "handler",
92           "doc": "<p>The method the event invokes.</p>\n",
93           "optional": false
94         },
95         {
96           "type": "Object",
97           "name": "scope",
98           "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",
99           "optional": true
100         },
101         {
102           "type": "Object",
103           "name": "options",
104           "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",
105           "optional": true
106         }
107       ],
108       "return": {
109         "type": "void",
110         "doc": "\n"
111       },
112       "private": false,
113       "static": false,
114       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
115       "linenr": 271,
116       "html_filename": "Observable.html",
117       "href": "Observable.html#Ext-util-Observable-method-addListener",
118       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
119     },
120     {
121       "tagname": "method",
122       "name": "addManagedListener",
123       "member": "Ext.util.Observable",
124       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
125       "params": [
126         {
127           "type": "Observable/Element",
128           "name": "item",
129           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
130           "optional": false
131         },
132         {
133           "type": "Object/String",
134           "name": "ename",
135           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
136           "optional": false
137         },
138         {
139           "type": "Function",
140           "name": "fn",
141           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
142           "optional": false
143         },
144         {
145           "type": "Object",
146           "name": "scope",
147           "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",
148           "optional": false
149         },
150         {
151           "type": "Object",
152           "name": "opt",
153           "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",
154           "optional": false
155         }
156       ],
157       "return": {
158         "type": "void",
159         "doc": "\n"
160       },
161       "private": false,
162       "static": false,
163       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
164       "linenr": 155,
165       "html_filename": "Observable.html",
166       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
167       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
168     },
169     {
170       "tagname": "method",
171       "name": "capture",
172       "member": "Ext.util.Observable",
173       "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",
174       "params": [
175         {
176           "type": "Observable",
177           "name": "o",
178           "doc": "<p>The Observable to capture events from.</p>\n",
179           "optional": false
180         },
181         {
182           "type": "Function",
183           "name": "fn",
184           "doc": "<p>The function to call when an event is fired.</p>\n",
185           "optional": false
186         },
187         {
188           "type": "Object",
189           "name": "scope",
190           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
191           "optional": true
192         }
193       ],
194       "return": {
195         "type": "void",
196         "doc": "\n"
197       },
198       "private": false,
199       "static": true,
200       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
201       "linenr": 55,
202       "html_filename": "Observable.html",
203       "href": "Observable.html#Ext-util-Observable-method-capture",
204       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
205     },
206     {
207       "tagname": "method",
208       "name": "clearListeners",
209       "member": "Ext.util.Observable",
210       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
211       "params": [
212
213       ],
214       "return": {
215         "type": "void",
216         "doc": "\n"
217       },
218       "private": false,
219       "static": false,
220       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
221       "linenr": 383,
222       "html_filename": "Observable.html",
223       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
224       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
225     },
226     {
227       "tagname": "method",
228       "name": "clearManagedListeners",
229       "member": "Ext.util.Observable",
230       "doc": "<p>Removes all managed listeners for this object.</p>\n",
231       "params": [
232
233       ],
234       "return": {
235         "type": "void",
236         "doc": "\n"
237       },
238       "private": false,
239       "static": false,
240       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
241       "linenr": 412,
242       "html_filename": "Observable.html",
243       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
244       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
245     },
246     {
247       "tagname": "method",
248       "name": "connect",
249       "member": "Ext.direct.Provider",
250       "doc": "<p>Abstract methods for subclasses to implement.</p>\n",
251       "params": [
252
253       ],
254       "return": {
255         "type": "void",
256         "doc": "\n"
257       },
258       "private": false,
259       "static": false,
260       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
261       "linenr": 86,
262       "html_filename": "Provider.html",
263       "href": "Provider.html#Ext-direct-Provider-method-connect",
264       "shortDoc": "<p>Abstract methods for subclasses to implement.</p>\n"
265     },
266     {
267       "tagname": "method",
268       "name": "createEvent",
269       "member": "Ext.direct.JsonProvider",
270       "doc": "<p>Create an event from a response object</p>\n",
271       "params": [
272         {
273           "type": "Object",
274           "name": "response",
275           "doc": "<p>The XHR response object</p>\n",
276           "optional": false
277         }
278       ],
279       "return": {
280         "type": "Ext.direct.Event",
281         "doc": "<p>The event</p>\n"
282       },
283       "private": false,
284       "static": false,
285       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/JsonProvider.js",
286       "linenr": 75,
287       "html_filename": "JsonProvider.html",
288       "href": "JsonProvider.html#Ext-direct-JsonProvider-method-createEvent",
289       "shortDoc": "<p>Create an event from a response object</p>\n"
290     },
291     {
292       "tagname": "method",
293       "name": "disconnect",
294       "member": "Ext.direct.Provider",
295       "doc": "<p>Abstract methods for subclasses to implement.</p>\n",
296       "params": [
297
298       ],
299       "return": {
300         "type": "void",
301         "doc": "\n"
302       },
303       "private": false,
304       "static": false,
305       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
306       "linenr": 92,
307       "html_filename": "Provider.html",
308       "href": "Provider.html#Ext-direct-Provider-method-disconnect",
309       "shortDoc": "<p>Abstract methods for subclasses to implement.</p>\n"
310     },
311     {
312       "tagname": "method",
313       "name": "enableBubble",
314       "member": "Ext.util.Observable",
315       "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",
316       "params": [
317         {
318           "type": "String/Array",
319           "name": "events",
320           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
321           "optional": false
322         }
323       ],
324       "return": {
325         "type": "void",
326         "doc": "\n"
327       },
328       "private": false,
329       "static": false,
330       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
331       "linenr": 554,
332       "html_filename": "Observable.html",
333       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
334       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
335     },
336     {
337       "tagname": "method",
338       "name": "fireEvent",
339       "member": "Ext.util.Observable",
340       "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.direct.JsonProvider-method-enableBubble\" rel=\"Ext.direct.JsonProvider-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
341       "params": [
342         {
343           "type": "String",
344           "name": "eventName",
345           "doc": "<p>The name of the event to fire.</p>\n",
346           "optional": false
347         },
348         {
349           "type": "Object...",
350           "name": "args",
351           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
352           "optional": false
353         }
354       ],
355       "return": {
356         "type": "Boolean",
357         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
358       },
359       "private": false,
360       "static": false,
361       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
362       "linenr": 232,
363       "html_filename": "Observable.html",
364       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
365       "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..."
366     },
367     {
368       "tagname": "method",
369       "name": "hasListener",
370       "member": "Ext.util.Observable",
371       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
372       "params": [
373         {
374           "type": "String",
375           "name": "eventName",
376           "doc": "<p>The name of the event to check for</p>\n",
377           "optional": false
378         }
379       ],
380       "return": {
381         "type": "Boolean",
382         "doc": "<p>True if the event is being listened for, else false</p>\n"
383       },
384       "private": false,
385       "static": false,
386       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
387       "linenr": 480,
388       "html_filename": "Observable.html",
389       "href": "Observable.html#Ext-util-Observable-method-hasListener",
390       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
391     },
392     {
393       "tagname": "method",
394       "name": "isConnected",
395       "member": "Ext.direct.Provider",
396       "doc": "<p>Returns whether or not the server-side is currently connected.\nAbstract method for subclasses to implement.</p>\n",
397       "params": [
398
399       ],
400       "return": {
401         "type": "void",
402         "doc": "\n"
403       },
404       "private": false,
405       "static": false,
406       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
407       "linenr": 78,
408       "html_filename": "Provider.html",
409       "href": "Provider.html#Ext-direct-Provider-method-isConnected",
410       "shortDoc": "<p>Returns whether or not the server-side is currently connected.\nAbstract method for subclasses to implement.</p>\n"
411     },
412     {
413       "tagname": "method",
414       "name": "observe",
415       "member": "Ext.util.Observable",
416       "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",
417       "params": [
418         {
419           "type": "Function",
420           "name": "c",
421           "doc": "<p>The class constructor to make observable.</p>\n",
422           "optional": false
423         },
424         {
425           "type": "Object",
426           "name": "listeners",
427           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.direct.JsonProvider-method-addListener\" rel=\"Ext.direct.JsonProvider-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
428           "optional": false
429         }
430       ],
431       "return": {
432         "type": "void",
433         "doc": "\n"
434       },
435       "private": false,
436       "static": true,
437       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
438       "linenr": 69,
439       "html_filename": "Observable.html",
440       "href": "Observable.html#Ext-util-Observable-method-observe",
441       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
442     },
443     {
444       "tagname": "method",
445       "name": "on",
446       "member": "Ext.util.Observable",
447       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.direct.JsonProvider-method-addListener\" rel=\"Ext.direct.JsonProvider-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
448       "params": [
449         {
450           "type": "String",
451           "name": "eventName",
452           "doc": "<p>The type of event to listen for</p>\n",
453           "optional": false
454         },
455         {
456           "type": "Function",
457           "name": "handler",
458           "doc": "<p>The method the event invokes</p>\n",
459           "optional": false
460         },
461         {
462           "type": "Object",
463           "name": "scope",
464           "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",
465           "optional": true
466         },
467         {
468           "type": "Object",
469           "name": "options",
470           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
471           "optional": true
472         }
473       ],
474       "return": {
475         "type": "void",
476         "doc": "\n"
477       },
478       "private": false,
479       "static": false,
480       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
481       "linenr": 616,
482       "html_filename": "Observable.html",
483       "href": "Observable.html#Ext-util-Observable-method-on",
484       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.direct.JsonProvider-method-addListener\" rel=\"Ext.direct.JsonProvider-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
485     },
486     {
487       "tagname": "method",
488       "name": "relayEvents",
489       "member": "Ext.util.Observable",
490       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
491       "params": [
492         {
493           "type": "Object",
494           "name": "origin",
495           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
496           "optional": false
497         },
498         {
499           "type": "Array",
500           "name": "events",
501           "doc": "<p>Array of event names to relay.</p>\n",
502           "optional": false
503         },
504         {
505           "type": "Object",
506           "name": "prefix",
507           "doc": "\n",
508           "optional": false
509         }
510       ],
511       "return": {
512         "type": "void",
513         "doc": "\n"
514       },
515       "private": false,
516       "static": false,
517       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
518       "linenr": 520,
519       "html_filename": "Observable.html",
520       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
521       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
522     },
523     {
524       "tagname": "method",
525       "name": "releaseCapture",
526       "member": "Ext.util.Observable",
527       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
528       "params": [
529         {
530           "type": "Observable",
531           "name": "o",
532           "doc": "<p>The Observable to release</p>\n",
533           "optional": false
534         }
535       ],
536       "return": {
537         "type": "void",
538         "doc": "\n"
539       },
540       "private": false,
541       "static": true,
542       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
543       "linenr": 46,
544       "html_filename": "Observable.html",
545       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
546       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
547     },
548     {
549       "tagname": "method",
550       "name": "removeListener",
551       "member": "Ext.util.Observable",
552       "doc": "<p>Removes an event handler.</p>\n",
553       "params": [
554         {
555           "type": "String",
556           "name": "eventName",
557           "doc": "<p>The type of event the handler was associated with.</p>\n",
558           "optional": false
559         },
560         {
561           "type": "Function",
562           "name": "handler",
563           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.direct.JsonProvider-method-addListener\" rel=\"Ext.direct.JsonProvider-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
564           "optional": false
565         },
566         {
567           "type": "Object",
568           "name": "scope",
569           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
570           "optional": true
571         }
572       ],
573       "return": {
574         "type": "void",
575         "doc": "\n"
576       },
577       "private": false,
578       "static": false,
579       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
580       "linenr": 352,
581       "html_filename": "Observable.html",
582       "href": "Observable.html#Ext-util-Observable-method-removeListener",
583       "shortDoc": "<p>Removes an event handler.</p>\n"
584     },
585     {
586       "tagname": "method",
587       "name": "removeManagedListener",
588       "member": "Ext.util.Observable",
589       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.JsonProvider--mon\" rel=\"Ext.direct.JsonProvider--mon\" class=\"docClass\">mon</a> method.</p>\n",
590       "params": [
591         {
592           "type": "Observable|Element",
593           "name": "item",
594           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
595           "optional": false
596         },
597         {
598           "type": "Object|String",
599           "name": "ename",
600           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
601           "optional": false
602         },
603         {
604           "type": "Function",
605           "name": "fn",
606           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
607           "optional": false
608         },
609         {
610           "type": "Object",
611           "name": "scope",
612           "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",
613           "optional": false
614         }
615       ],
616       "return": {
617         "type": "void",
618         "doc": "\n"
619       },
620       "private": false,
621       "static": false,
622       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
623       "linenr": 196,
624       "html_filename": "Observable.html",
625       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
626       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.JsonProvider--mon\" rel=\"Ext.direct.JsonProvider--mon\" class=\"docClass\">mon</a> method.</p>\n"
627     },
628     {
629       "tagname": "method",
630       "name": "resumeEvents",
631       "member": "Ext.util.Observable",
632       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.direct.JsonProvider-method-suspendEvents\" rel=\"Ext.direct.JsonProvider-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",
633       "params": [
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": 502,
644       "html_filename": "Observable.html",
645       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
646       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
647     },
648     {
649       "tagname": "method",
650       "name": "suspendEvents",
651       "member": "Ext.util.Observable",
652       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.direct.JsonProvider-method-resumeEvents\" rel=\"Ext.direct.JsonProvider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
653       "params": [
654         {
655           "type": "Boolean",
656           "name": "queueSuspended",
657           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.direct.JsonProvider-method-resumeEvents\" rel=\"Ext.direct.JsonProvider-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
658           "optional": false
659         }
660       ],
661       "return": {
662         "type": "void",
663         "doc": "\n"
664       },
665       "private": false,
666       "static": false,
667       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
668       "linenr": 490,
669       "html_filename": "Observable.html",
670       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
671       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.direct.JsonProvider-method-resumeEvents\" rel=\"Ext.direct.JsonProvider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
672     },
673     {
674       "tagname": "method",
675       "name": "un",
676       "member": "Ext.util.Observable",
677       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.direct.JsonProvider-method-removeListener\" rel=\"Ext.direct.JsonProvider-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
678       "params": [
679         {
680           "type": "String",
681           "name": "eventName",
682           "doc": "<p>The type of event the handler was associated with.</p>\n",
683           "optional": false
684         },
685         {
686           "type": "Function",
687           "name": "handler",
688           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.direct.JsonProvider-method-addListener\" rel=\"Ext.direct.JsonProvider-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
689           "optional": false
690         },
691         {
692           "type": "Object",
693           "name": "scope",
694           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
695           "optional": true
696         }
697       ],
698       "return": {
699         "type": "void",
700         "doc": "\n"
701       },
702       "private": false,
703       "static": false,
704       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
705       "linenr": 608,
706       "html_filename": "Observable.html",
707       "href": "Observable.html#Ext-util-Observable-method-un",
708       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.direct.JsonProvider-method-removeListener\" rel=\"Ext.direct.JsonProvider-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
709     }
710   ],
711   "property": [
712
713   ],
714   "event": [
715     {
716       "tagname": "event",
717       "name": "connect",
718       "member": "Ext.direct.Provider",
719       "doc": "<p>Fires when the Provider connects to the server-side</p>\n",
720       "params": [
721         {
722           "type": "Ext.direct.Provider",
723           "name": "provider",
724           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
725           "optional": false
726         }
727       ],
728       "private": false,
729       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
730       "linenr": 50,
731       "html_filename": "Provider.html",
732       "href": "Provider.html#Ext-direct-Provider-event-connect",
733       "shortDoc": "<p>Fires when the Provider connects to the server-side</p>\n"
734     },
735     {
736       "tagname": "event",
737       "name": "data",
738       "member": "Ext.direct.Provider",
739       "doc": "<p>Fires when the Provider receives data from the server-side</p>\n",
740       "params": [
741         {
742           "type": "Ext.direct.Provider",
743           "name": "provider",
744           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
745           "optional": false
746         },
747         {
748           "type": "event",
749           "name": "e",
750           "doc": "<p>The Ext.Direct.Event type that occurred.</p>\n",
751           "optional": false
752         }
753       ],
754       "private": false,
755       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
756       "linenr": 62,
757       "html_filename": "Provider.html",
758       "href": "Provider.html#Ext-direct-Provider-event-data",
759       "shortDoc": "<p>Fires when the Provider receives data from the server-side</p>\n"
760     },
761     {
762       "tagname": "event",
763       "name": "disconnect",
764       "member": "Ext.direct.Provider",
765       "doc": "<p>Fires when the Provider disconnects from the server-side</p>\n",
766       "params": [
767         {
768           "type": "Ext.direct.Provider",
769           "name": "provider",
770           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
771           "optional": false
772         }
773       ],
774       "private": false,
775       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
776       "linenr": 56,
777       "html_filename": "Provider.html",
778       "href": "Provider.html#Ext-direct-Provider-event-disconnect",
779       "shortDoc": "<p>Fires when the Provider disconnects from the server-side</p>\n"
780     },
781     {
782       "tagname": "event",
783       "name": "exception",
784       "member": "Ext.direct.Provider",
785       "doc": "<p>Fires when the Provider receives an exception from the server-side</p>\n",
786       "params": [
787
788       ],
789       "private": false,
790       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
791       "linenr": 69,
792       "html_filename": "Provider.html",
793       "href": "Provider.html#Ext-direct-Provider-event-exception",
794       "shortDoc": "<p>Fires when the Provider receives an exception from the server-side</p>\n"
795     }
796   ],
797   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/JsonProvider.js",
798   "linenr": 1,
799   "html_filename": "JsonProvider.html",
800   "href": "JsonProvider.html#Ext-direct-JsonProvider",
801   "cssVar": [
802
803   ],
804   "cssMixin": [
805
806   ],
807   "component": false,
808   "superclasses": [
809     "Ext.direct.Provider"
810   ],
811   "subclasses": [
812     "Ext.direct.PollingProvider",
813     "Ext.direct.RemotingProvider"
814   ],
815   "mixedInto": [
816
817   ],
818   "allMixins": [
819     "Ext.util.Observable"
820   ]
821 });