docs/output/Ext.direct.Provider.js

   1 Ext.data.JsonP.Ext_direct_Provider({
   2   "tagname": "class",
   3   "name": "Ext.direct.Provider",
   4   "doc": "<p>Ext.direct.Provider is an abstract class meant to be extended.</p>\n\n\n\n\n<p>For example ExtJs implements the following subclasses:</p>\n\n\n<pre><code>Provider\n|\n+---<a href=\"#/api/Ext.direct.JsonProvider\" rel=\"Ext.direct.JsonProvider\" class=\"docClass\">JsonProvider</a> \n    |\n    +---<a href=\"#/api/Ext.direct.PollingProvider\" rel=\"Ext.direct.PollingProvider\" class=\"docClass\">PollingProvider</a>   \n    |\n    +---<a href=\"#/api/Ext.direct.RemotingProvider\" rel=\"Ext.direct.RemotingProvider\" class=\"docClass\">RemotingProvider</a>   \n</code></pre>\n\n",
   5   "extends": null,
   6   "mixins": [
   7     "Ext.util.Observable"
   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.Provider-method-addListener\" rel=\"Ext.direct.Provider-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": "disconnect",
 269       "member": "Ext.direct.Provider",
 270       "doc": "<p>Abstract methods for subclasses to implement.</p>\n",
 271       "params": [
 272
 273       ],
 274       "return": {
 275         "type": "void",
 276         "doc": "\n"
 277       },
 278       "private": false,
 279       "static": false,
 280       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 281       "linenr": 92,
 282       "html_filename": "Provider.html",
 283       "href": "Provider.html#Ext-direct-Provider-method-disconnect",
 284       "shortDoc": "<p>Abstract methods for subclasses to implement.</p>\n"
 285     },
 286     {
 287       "tagname": "method",
 288       "name": "enableBubble",
 289       "member": "Ext.util.Observable",
 290       "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",
 291       "params": [
 292         {
 293           "type": "String/Array",
 294           "name": "events",
 295           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 296           "optional": false
 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/util/Observable.js",
 306       "linenr": 554,
 307       "html_filename": "Observable.html",
 308       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 309       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 310     },
 311     {
 312       "tagname": "method",
 313       "name": "fireEvent",
 314       "member": "Ext.util.Observable",
 315       "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.Provider-method-enableBubble\" rel=\"Ext.direct.Provider-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 316       "params": [
 317         {
 318           "type": "String",
 319           "name": "eventName",
 320           "doc": "<p>The name of the event to fire.</p>\n",
 321           "optional": false
 322         },
 323         {
 324           "type": "Object...",
 325           "name": "args",
 326           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 327           "optional": false
 328         }
 329       ],
 330       "return": {
 331         "type": "Boolean",
 332         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 333       },
 334       "private": false,
 335       "static": false,
 336       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 337       "linenr": 232,
 338       "html_filename": "Observable.html",
 339       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 340       "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..."
 341     },
 342     {
 343       "tagname": "method",
 344       "name": "hasListener",
 345       "member": "Ext.util.Observable",
 346       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 347       "params": [
 348         {
 349           "type": "String",
 350           "name": "eventName",
 351           "doc": "<p>The name of the event to check for</p>\n",
 352           "optional": false
 353         }
 354       ],
 355       "return": {
 356         "type": "Boolean",
 357         "doc": "<p>True if the event is being listened for, else false</p>\n"
 358       },
 359       "private": false,
 360       "static": false,
 361       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 362       "linenr": 480,
 363       "html_filename": "Observable.html",
 364       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 365       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 366     },
 367     {
 368       "tagname": "method",
 369       "name": "isConnected",
 370       "member": "Ext.direct.Provider",
 371       "doc": "<p>Returns whether or not the server-side is currently connected.\nAbstract method for subclasses to implement.</p>\n",
 372       "params": [
 373
 374       ],
 375       "return": {
 376         "type": "void",
 377         "doc": "\n"
 378       },
 379       "private": false,
 380       "static": false,
 381       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 382       "linenr": 78,
 383       "html_filename": "Provider.html",
 384       "href": "Provider.html#Ext-direct-Provider-method-isConnected",
 385       "shortDoc": "<p>Returns whether or not the server-side is currently connected.\nAbstract method for subclasses to implement.</p>\n"
 386     },
 387     {
 388       "tagname": "method",
 389       "name": "observe",
 390       "member": "Ext.util.Observable",
 391       "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",
 392       "params": [
 393         {
 394           "type": "Function",
 395           "name": "c",
 396           "doc": "<p>The class constructor to make observable.</p>\n",
 397           "optional": false
 398         },
 399         {
 400           "type": "Object",
 401           "name": "listeners",
 402           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.direct.Provider-method-addListener\" rel=\"Ext.direct.Provider-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
 403           "optional": false
 404         }
 405       ],
 406       "return": {
 407         "type": "void",
 408         "doc": "\n"
 409       },
 410       "private": false,
 411       "static": true,
 412       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 413       "linenr": 69,
 414       "html_filename": "Observable.html",
 415       "href": "Observable.html#Ext-util-Observable-method-observe",
 416       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
 417     },
 418     {
 419       "tagname": "method",
 420       "name": "on",
 421       "member": "Ext.util.Observable",
 422       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.direct.Provider-method-addListener\" rel=\"Ext.direct.Provider-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
 423       "params": [
 424         {
 425           "type": "String",
 426           "name": "eventName",
 427           "doc": "<p>The type of event to listen for</p>\n",
 428           "optional": false
 429         },
 430         {
 431           "type": "Function",
 432           "name": "handler",
 433           "doc": "<p>The method the event invokes</p>\n",
 434           "optional": false
 435         },
 436         {
 437           "type": "Object",
 438           "name": "scope",
 439           "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",
 440           "optional": true
 441         },
 442         {
 443           "type": "Object",
 444           "name": "options",
 445           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
 446           "optional": true
 447         }
 448       ],
 449       "return": {
 450         "type": "void",
 451         "doc": "\n"
 452       },
 453       "private": false,
 454       "static": false,
 455       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 456       "linenr": 616,
 457       "html_filename": "Observable.html",
 458       "href": "Observable.html#Ext-util-Observable-method-on",
 459       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.direct.Provider-method-addListener\" rel=\"Ext.direct.Provider-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
 460     },
 461     {
 462       "tagname": "method",
 463       "name": "relayEvents",
 464       "member": "Ext.util.Observable",
 465       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
 466       "params": [
 467         {
 468           "type": "Object",
 469           "name": "origin",
 470           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 471           "optional": false
 472         },
 473         {
 474           "type": "Array",
 475           "name": "events",
 476           "doc": "<p>Array of event names to relay.</p>\n",
 477           "optional": false
 478         },
 479         {
 480           "type": "Object",
 481           "name": "prefix",
 482           "doc": "\n",
 483           "optional": false
 484         }
 485       ],
 486       "return": {
 487         "type": "void",
 488         "doc": "\n"
 489       },
 490       "private": false,
 491       "static": false,
 492       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 493       "linenr": 520,
 494       "html_filename": "Observable.html",
 495       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 496       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
 497     },
 498     {
 499       "tagname": "method",
 500       "name": "releaseCapture",
 501       "member": "Ext.util.Observable",
 502       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
 503       "params": [
 504         {
 505           "type": "Observable",
 506           "name": "o",
 507           "doc": "<p>The Observable to release</p>\n",
 508           "optional": false
 509         }
 510       ],
 511       "return": {
 512         "type": "void",
 513         "doc": "\n"
 514       },
 515       "private": false,
 516       "static": true,
 517       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 518       "linenr": 46,
 519       "html_filename": "Observable.html",
 520       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 521       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
 522     },
 523     {
 524       "tagname": "method",
 525       "name": "removeListener",
 526       "member": "Ext.util.Observable",
 527       "doc": "<p>Removes an event handler.</p>\n",
 528       "params": [
 529         {
 530           "type": "String",
 531           "name": "eventName",
 532           "doc": "<p>The type of event the handler was associated with.</p>\n",
 533           "optional": false
 534         },
 535         {
 536           "type": "Function",
 537           "name": "handler",
 538           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.direct.Provider-method-addListener\" rel=\"Ext.direct.Provider-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 539           "optional": false
 540         },
 541         {
 542           "type": "Object",
 543           "name": "scope",
 544           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 545           "optional": true
 546         }
 547       ],
 548       "return": {
 549         "type": "void",
 550         "doc": "\n"
 551       },
 552       "private": false,
 553       "static": false,
 554       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 555       "linenr": 352,
 556       "html_filename": "Observable.html",
 557       "href": "Observable.html#Ext-util-Observable-method-removeListener",
 558       "shortDoc": "<p>Removes an event handler.</p>\n"
 559     },
 560     {
 561       "tagname": "method",
 562       "name": "removeManagedListener",
 563       "member": "Ext.util.Observable",
 564       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.Provider--mon\" rel=\"Ext.direct.Provider--mon\" class=\"docClass\">mon</a> method.</p>\n",
 565       "params": [
 566         {
 567           "type": "Observable|Element",
 568           "name": "item",
 569           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 570           "optional": false
 571         },
 572         {
 573           "type": "Object|String",
 574           "name": "ename",
 575           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 576           "optional": false
 577         },
 578         {
 579           "type": "Function",
 580           "name": "fn",
 581           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 582           "optional": false
 583         },
 584         {
 585           "type": "Object",
 586           "name": "scope",
 587           "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",
 588           "optional": false
 589         }
 590       ],
 591       "return": {
 592         "type": "void",
 593         "doc": "\n"
 594       },
 595       "private": false,
 596       "static": false,
 597       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 598       "linenr": 196,
 599       "html_filename": "Observable.html",
 600       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
 601       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.Provider--mon\" rel=\"Ext.direct.Provider--mon\" class=\"docClass\">mon</a> method.</p>\n"
 602     },
 603     {
 604       "tagname": "method",
 605       "name": "resumeEvents",
 606       "member": "Ext.util.Observable",
 607       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.direct.Provider-method-suspendEvents\" rel=\"Ext.direct.Provider-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",
 608       "params": [
 609
 610       ],
 611       "return": {
 612         "type": "void",
 613         "doc": "\n"
 614       },
 615       "private": false,
 616       "static": false,
 617       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 618       "linenr": 502,
 619       "html_filename": "Observable.html",
 620       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
 621       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
 622     },
 623     {
 624       "tagname": "method",
 625       "name": "suspendEvents",
 626       "member": "Ext.util.Observable",
 627       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.direct.Provider-method-resumeEvents\" rel=\"Ext.direct.Provider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
 628       "params": [
 629         {
 630           "type": "Boolean",
 631           "name": "queueSuspended",
 632           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.direct.Provider-method-resumeEvents\" rel=\"Ext.direct.Provider-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
 633           "optional": false
 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": 490,
 644       "html_filename": "Observable.html",
 645       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
 646       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.direct.Provider-method-resumeEvents\" rel=\"Ext.direct.Provider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
 647     },
 648     {
 649       "tagname": "method",
 650       "name": "un",
 651       "member": "Ext.util.Observable",
 652       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.direct.Provider-method-removeListener\" rel=\"Ext.direct.Provider-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
 653       "params": [
 654         {
 655           "type": "String",
 656           "name": "eventName",
 657           "doc": "<p>The type of event the handler was associated with.</p>\n",
 658           "optional": false
 659         },
 660         {
 661           "type": "Function",
 662           "name": "handler",
 663           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.direct.Provider-method-addListener\" rel=\"Ext.direct.Provider-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 664           "optional": false
 665         },
 666         {
 667           "type": "Object",
 668           "name": "scope",
 669           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 670           "optional": true
 671         }
 672       ],
 673       "return": {
 674         "type": "void",
 675         "doc": "\n"
 676       },
 677       "private": false,
 678       "static": false,
 679       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 680       "linenr": 608,
 681       "html_filename": "Observable.html",
 682       "href": "Observable.html#Ext-util-Observable-method-un",
 683       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.direct.Provider-method-removeListener\" rel=\"Ext.direct.Provider-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
 684     }
 685   ],
 686   "property": [
 687
 688   ],
 689   "event": [
 690     {
 691       "tagname": "event",
 692       "name": "connect",
 693       "member": "Ext.direct.Provider",
 694       "doc": "<p>Fires when the Provider connects to the server-side</p>\n",
 695       "params": [
 696         {
 697           "type": "Ext.direct.Provider",
 698           "name": "provider",
 699           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
 700           "optional": false
 701         }
 702       ],
 703       "private": false,
 704       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 705       "linenr": 50,
 706       "html_filename": "Provider.html",
 707       "href": "Provider.html#Ext-direct-Provider-event-connect",
 708       "shortDoc": "<p>Fires when the Provider connects to the server-side</p>\n"
 709     },
 710     {
 711       "tagname": "event",
 712       "name": "data",
 713       "member": "Ext.direct.Provider",
 714       "doc": "<p>Fires when the Provider receives data from the server-side</p>\n",
 715       "params": [
 716         {
 717           "type": "Ext.direct.Provider",
 718           "name": "provider",
 719           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
 720           "optional": false
 721         },
 722         {
 723           "type": "event",
 724           "name": "e",
 725           "doc": "<p>The Ext.Direct.Event type that occurred.</p>\n",
 726           "optional": false
 727         }
 728       ],
 729       "private": false,
 730       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 731       "linenr": 62,
 732       "html_filename": "Provider.html",
 733       "href": "Provider.html#Ext-direct-Provider-event-data",
 734       "shortDoc": "<p>Fires when the Provider receives data from the server-side</p>\n"
 735     },
 736     {
 737       "tagname": "event",
 738       "name": "disconnect",
 739       "member": "Ext.direct.Provider",
 740       "doc": "<p>Fires when the Provider disconnects from the server-side</p>\n",
 741       "params": [
 742         {
 743           "type": "Ext.direct.Provider",
 744           "name": "provider",
 745           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
 746           "optional": false
 747         }
 748       ],
 749       "private": false,
 750       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 751       "linenr": 56,
 752       "html_filename": "Provider.html",
 753       "href": "Provider.html#Ext-direct-Provider-event-disconnect",
 754       "shortDoc": "<p>Fires when the Provider disconnects from the server-side</p>\n"
 755     },
 756     {
 757       "tagname": "event",
 758       "name": "exception",
 759       "member": "Ext.direct.Provider",
 760       "doc": "<p>Fires when the Provider receives an exception from the server-side</p>\n",
 761       "params": [
 762
 763       ],
 764       "private": false,
 765       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 766       "linenr": 69,
 767       "html_filename": "Provider.html",
 768       "href": "Provider.html#Ext-direct-Provider-event-exception",
 769       "shortDoc": "<p>Fires when the Provider receives an exception from the server-side</p>\n"
 770     }
 771   ],
 772   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 773   "linenr": 1,
 774   "html_filename": "Provider.html",
 775   "href": "Provider.html#Ext-direct-Provider",
 776   "cssVar": [
 777
 778   ],
 779   "cssMixin": [
 780
 781   ],
 782   "component": false,
 783   "superclasses": [
 784
 785   ],
 786   "subclasses": [
 787     "Ext.direct.JsonProvider"
 788   ],
 789   "mixedInto": [
 790
 791   ],
 792   "allMixins": [
 793     "Ext.util.Observable"
 794   ]
 795 });