docs/output/Ext.direct.PollingProvider.js

   1 Ext.data.JsonP.Ext_direct_PollingProvider({
   2   "tagname": "class",
   3   "name": "Ext.direct.PollingProvider",
   4   "doc": "<p>Provides for repetitive polling of the server at distinct <a href=\"#/api/Ext.direct.PollingProvider-cfg-interval\" rel=\"Ext.direct.PollingProvider-cfg-interval\" class=\"docClass\">intervals</a>.\nThe initial request for data originates from the client, and then is responded to by the\nserver.</p>\n\n\n\n\n<p>All configurations for the PollingProvider should be generated by the server-side\nAPI portion of the Ext.Direct stack.</p>\n\n\n\n\n<p>An instance of PollingProvider may be created directly via the new keyword or by simply\nspecifying <tt>type = 'polling'</tt>.  For example:</p>\n\n\n<pre><code>var pollA = new Ext.direct.PollingProvider({\n    type:'polling',\n    url: 'php/pollA.php',\n});\nExt.direct.Manager.addProvider(pollA);\npollA.disconnect();\n\nExt.direct.Manager.addProvider(\n    {\n        type:'polling',\n        url: 'php/pollB.php',\n        id: 'pollB-provider'\n    }\n);\nvar pollB = Ext.direct.Manager.getProvider('pollB-provider');\n</code></pre>\n\n",
   5   "extends": "Ext.direct.JsonProvider",
   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": "baseParams",
  21       "member": "Ext.direct.PollingProvider",
  22       "type": "Object",
  23       "doc": "<p>An object containing properties which are to be sent as parameters\non every polling request</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/PollingProvider.js",
  26       "linenr": 53,
  27       "html_filename": "PollingProvider.html",
  28       "href": "PollingProvider.html#Ext-direct-PollingProvider-cfg-baseParams"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "id",
  33       "member": "Ext.direct.Provider",
  34       "type": "String",
  35       "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",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
  38       "linenr": 29,
  39       "html_filename": "Provider.html",
  40       "href": "Provider.html#Ext-direct-Provider-cfg-id",
  41       "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..."
  42     },
  43     {
  44       "tagname": "cfg",
  45       "name": "interval",
  46       "member": "Ext.direct.PollingProvider",
  47       "type": "Number",
  48       "doc": "<p>How often to poll the server-side in milliseconds (defaults to <tt>3000</tt> - every\n3 seconds).</p>\n",
  49       "private": false,
  50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/PollingProvider.js",
  51       "linenr": 46,
  52       "html_filename": "PollingProvider.html",
  53       "href": "PollingProvider.html#Ext-direct-PollingProvider-cfg-interval"
  54     },
  55     {
  56       "tagname": "cfg",
  57       "name": "listeners",
  58       "member": "Ext.util.Observable",
  59       "type": "Object",
  60       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
  61       "private": false,
  62       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
  63       "linenr": 103,
  64       "html_filename": "Observable.html",
  65       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
  66       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
  67     },
  68     {
  69       "tagname": "cfg",
  70       "name": "url",
  71       "member": "Ext.direct.PollingProvider",
  72       "type": "String/Function",
  73       "doc": "<p>The url which the PollingProvider should contact with each request. This can also be\nan imported Ext.Direct method which will accept the baseParams as its only argument.</p>\n",
  74       "private": false,
  75       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/PollingProvider.js",
  76       "linenr": 58,
  77       "html_filename": "PollingProvider.html",
  78       "href": "PollingProvider.html#Ext-direct-PollingProvider-cfg-url",
  79       "shortDoc": "The url which the PollingProvider should contact with each request. This can also be\nan imported Ext.Direct method wh..."
  80     }
  81   ],
  82   "method": [
  83     {
  84       "tagname": "method",
  85       "name": "addEvents",
  86       "member": "Ext.util.Observable",
  87       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
  88       "params": [
  89         {
  90           "type": "Object/String",
  91           "name": "o",
  92           "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",
  93           "optional": false
  94         },
  95         {
  96           "type": "String",
  97           "name": "",
  98           "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",
  99           "optional": false
 100         }
 101       ],
 102       "return": {
 103         "type": "void",
 104         "doc": "\n"
 105       },
 106       "private": false,
 107       "static": false,
 108       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 109       "linenr": 452,
 110       "html_filename": "Observable.html",
 111       "href": "Observable.html#Ext-util-Observable-method-addEvents",
 112       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
 113     },
 114     {
 115       "tagname": "method",
 116       "name": "addListener",
 117       "member": "Ext.util.Observable",
 118       "doc": "<p>Appends an event handler to this object.</p>\n",
 119       "params": [
 120         {
 121           "type": "String",
 122           "name": "eventName",
 123           "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",
 124           "optional": false
 125         },
 126         {
 127           "type": "Function",
 128           "name": "handler",
 129           "doc": "<p>The method the event invokes.</p>\n",
 130           "optional": false
 131         },
 132         {
 133           "type": "Object",
 134           "name": "scope",
 135           "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",
 136           "optional": true
 137         },
 138         {
 139           "type": "Object",
 140           "name": "options",
 141           "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",
 142           "optional": true
 143         }
 144       ],
 145       "return": {
 146         "type": "void",
 147         "doc": "\n"
 148       },
 149       "private": false,
 150       "static": false,
 151       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 152       "linenr": 271,
 153       "html_filename": "Observable.html",
 154       "href": "Observable.html#Ext-util-Observable-method-addListener",
 155       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
 156     },
 157     {
 158       "tagname": "method",
 159       "name": "addManagedListener",
 160       "member": "Ext.util.Observable",
 161       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
 162       "params": [
 163         {
 164           "type": "Observable/Element",
 165           "name": "item",
 166           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
 167           "optional": false
 168         },
 169         {
 170           "type": "Object/String",
 171           "name": "ename",
 172           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 173           "optional": false
 174         },
 175         {
 176           "type": "Function",
 177           "name": "fn",
 178           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 179           "optional": false
 180         },
 181         {
 182           "type": "Object",
 183           "name": "scope",
 184           "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",
 185           "optional": false
 186         },
 187         {
 188           "type": "Object",
 189           "name": "opt",
 190           "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",
 191           "optional": false
 192         }
 193       ],
 194       "return": {
 195         "type": "void",
 196         "doc": "\n"
 197       },
 198       "private": false,
 199       "static": false,
 200       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 201       "linenr": 155,
 202       "html_filename": "Observable.html",
 203       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
 204       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
 205     },
 206     {
 207       "tagname": "method",
 208       "name": "capture",
 209       "member": "Ext.util.Observable",
 210       "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",
 211       "params": [
 212         {
 213           "type": "Observable",
 214           "name": "o",
 215           "doc": "<p>The Observable to capture events from.</p>\n",
 216           "optional": false
 217         },
 218         {
 219           "type": "Function",
 220           "name": "fn",
 221           "doc": "<p>The function to call when an event is fired.</p>\n",
 222           "optional": false
 223         },
 224         {
 225           "type": "Object",
 226           "name": "scope",
 227           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
 228           "optional": true
 229         }
 230       ],
 231       "return": {
 232         "type": "void",
 233         "doc": "\n"
 234       },
 235       "private": false,
 236       "static": true,
 237       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 238       "linenr": 55,
 239       "html_filename": "Observable.html",
 240       "href": "Observable.html#Ext-util-Observable-method-capture",
 241       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
 242     },
 243     {
 244       "tagname": "method",
 245       "name": "clearListeners",
 246       "member": "Ext.util.Observable",
 247       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
 248       "params": [
 249
 250       ],
 251       "return": {
 252         "type": "void",
 253         "doc": "\n"
 254       },
 255       "private": false,
 256       "static": false,
 257       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 258       "linenr": 383,
 259       "html_filename": "Observable.html",
 260       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
 261       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
 262     },
 263     {
 264       "tagname": "method",
 265       "name": "clearManagedListeners",
 266       "member": "Ext.util.Observable",
 267       "doc": "<p>Removes all managed listeners for this object.</p>\n",
 268       "params": [
 269
 270       ],
 271       "return": {
 272         "type": "void",
 273         "doc": "\n"
 274       },
 275       "private": false,
 276       "static": false,
 277       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 278       "linenr": 412,
 279       "html_filename": "Observable.html",
 280       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
 281       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
 282     },
 283     {
 284       "tagname": "method",
 285       "name": "connect",
 286       "member": "Ext.direct.PollingProvider",
 287       "doc": "<p>Connect to the server-side and begin the polling process. To handle each\nresponse subscribe to the data event.</p>\n",
 288       "params": [
 289
 290       ],
 291       "return": {
 292         "type": "void",
 293         "doc": "\n"
 294       },
 295       "private": false,
 296       "static": false,
 297       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/PollingProvider.js",
 298       "linenr": 89,
 299       "html_filename": "PollingProvider.html",
 300       "href": "PollingProvider.html#Ext-direct-PollingProvider-method-connect",
 301       "shortDoc": "<p>Connect to the server-side and begin the polling process. To handle each\nresponse subscribe to the data event.</p>\n"
 302     },
 303     {
 304       "tagname": "method",
 305       "name": "createEvent",
 306       "member": "Ext.direct.JsonProvider",
 307       "doc": "<p>Create an event from a response object</p>\n",
 308       "params": [
 309         {
 310           "type": "Object",
 311           "name": "response",
 312           "doc": "<p>The XHR response object</p>\n",
 313           "optional": false
 314         }
 315       ],
 316       "return": {
 317         "type": "Ext.direct.Event",
 318         "doc": "<p>The event</p>\n"
 319       },
 320       "private": false,
 321       "static": false,
 322       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/JsonProvider.js",
 323       "linenr": 75,
 324       "html_filename": "JsonProvider.html",
 325       "href": "JsonProvider.html#Ext-direct-JsonProvider-method-createEvent",
 326       "shortDoc": "<p>Create an event from a response object</p>\n"
 327     },
 328     {
 329       "tagname": "method",
 330       "name": "disconnect",
 331       "member": "Ext.direct.PollingProvider",
 332       "doc": "<p>Disconnect from the server-side and stop the polling process. The disconnect\nevent will be fired on a successful disconnect.</p>\n",
 333       "params": [
 334
 335       ],
 336       "return": {
 337         "type": "void",
 338         "doc": "\n"
 339       },
 340       "private": false,
 341       "static": false,
 342       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/PollingProvider.js",
 343       "linenr": 123,
 344       "html_filename": "PollingProvider.html",
 345       "href": "PollingProvider.html#Ext-direct-PollingProvider-method-disconnect",
 346       "shortDoc": "Disconnect from the server-side and stop the polling process. The disconnect\nevent will be fired on a successful disc..."
 347     },
 348     {
 349       "tagname": "method",
 350       "name": "enableBubble",
 351       "member": "Ext.util.Observable",
 352       "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",
 353       "params": [
 354         {
 355           "type": "String/Array",
 356           "name": "events",
 357           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
 358           "optional": false
 359         }
 360       ],
 361       "return": {
 362         "type": "void",
 363         "doc": "\n"
 364       },
 365       "private": false,
 366       "static": false,
 367       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 368       "linenr": 554,
 369       "html_filename": "Observable.html",
 370       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
 371       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
 372     },
 373     {
 374       "tagname": "method",
 375       "name": "fireEvent",
 376       "member": "Ext.util.Observable",
 377       "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.PollingProvider-method-enableBubble\" rel=\"Ext.direct.PollingProvider-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
 378       "params": [
 379         {
 380           "type": "String",
 381           "name": "eventName",
 382           "doc": "<p>The name of the event to fire.</p>\n",
 383           "optional": false
 384         },
 385         {
 386           "type": "Object...",
 387           "name": "args",
 388           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
 389           "optional": false
 390         }
 391       ],
 392       "return": {
 393         "type": "Boolean",
 394         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
 395       },
 396       "private": false,
 397       "static": false,
 398       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 399       "linenr": 232,
 400       "html_filename": "Observable.html",
 401       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
 402       "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..."
 403     },
 404     {
 405       "tagname": "method",
 406       "name": "hasListener",
 407       "member": "Ext.util.Observable",
 408       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
 409       "params": [
 410         {
 411           "type": "String",
 412           "name": "eventName",
 413           "doc": "<p>The name of the event to check for</p>\n",
 414           "optional": false
 415         }
 416       ],
 417       "return": {
 418         "type": "Boolean",
 419         "doc": "<p>True if the event is being listened for, else false</p>\n"
 420       },
 421       "private": false,
 422       "static": false,
 423       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 424       "linenr": 480,
 425       "html_filename": "Observable.html",
 426       "href": "Observable.html#Ext-util-Observable-method-hasListener",
 427       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
 428     },
 429     {
 430       "tagname": "method",
 431       "name": "isConnected",
 432       "member": "Ext.direct.Provider",
 433       "doc": "<p>Returns whether or not the server-side is currently connected.\nAbstract method for subclasses to implement.</p>\n",
 434       "params": [
 435
 436       ],
 437       "return": {
 438         "type": "void",
 439         "doc": "\n"
 440       },
 441       "private": false,
 442       "static": false,
 443       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 444       "linenr": 78,
 445       "html_filename": "Provider.html",
 446       "href": "Provider.html#Ext-direct-Provider-method-isConnected",
 447       "shortDoc": "<p>Returns whether or not the server-side is currently connected.\nAbstract method for subclasses to implement.</p>\n"
 448     },
 449     {
 450       "tagname": "method",
 451       "name": "observe",
 452       "member": "Ext.util.Observable",
 453       "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",
 454       "params": [
 455         {
 456           "type": "Function",
 457           "name": "c",
 458           "doc": "<p>The class constructor to make observable.</p>\n",
 459           "optional": false
 460         },
 461         {
 462           "type": "Object",
 463           "name": "listeners",
 464           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
 465           "optional": false
 466         }
 467       ],
 468       "return": {
 469         "type": "void",
 470         "doc": "\n"
 471       },
 472       "private": false,
 473       "static": true,
 474       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 475       "linenr": 69,
 476       "html_filename": "Observable.html",
 477       "href": "Observable.html#Ext-util-Observable-method-observe",
 478       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
 479     },
 480     {
 481       "tagname": "method",
 482       "name": "on",
 483       "member": "Ext.util.Observable",
 484       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
 485       "params": [
 486         {
 487           "type": "String",
 488           "name": "eventName",
 489           "doc": "<p>The type of event to listen for</p>\n",
 490           "optional": false
 491         },
 492         {
 493           "type": "Function",
 494           "name": "handler",
 495           "doc": "<p>The method the event invokes</p>\n",
 496           "optional": false
 497         },
 498         {
 499           "type": "Object",
 500           "name": "scope",
 501           "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",
 502           "optional": true
 503         },
 504         {
 505           "type": "Object",
 506           "name": "options",
 507           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
 508           "optional": true
 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": 616,
 519       "html_filename": "Observable.html",
 520       "href": "Observable.html#Ext-util-Observable-method-on",
 521       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
 522     },
 523     {
 524       "tagname": "method",
 525       "name": "relayEvents",
 526       "member": "Ext.util.Observable",
 527       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
 528       "params": [
 529         {
 530           "type": "Object",
 531           "name": "origin",
 532           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
 533           "optional": false
 534         },
 535         {
 536           "type": "Array",
 537           "name": "events",
 538           "doc": "<p>Array of event names to relay.</p>\n",
 539           "optional": false
 540         },
 541         {
 542           "type": "Object",
 543           "name": "prefix",
 544           "doc": "\n",
 545           "optional": false
 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": 520,
 556       "html_filename": "Observable.html",
 557       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
 558       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
 559     },
 560     {
 561       "tagname": "method",
 562       "name": "releaseCapture",
 563       "member": "Ext.util.Observable",
 564       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
 565       "params": [
 566         {
 567           "type": "Observable",
 568           "name": "o",
 569           "doc": "<p>The Observable to release</p>\n",
 570           "optional": false
 571         }
 572       ],
 573       "return": {
 574         "type": "void",
 575         "doc": "\n"
 576       },
 577       "private": false,
 578       "static": true,
 579       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 580       "linenr": 46,
 581       "html_filename": "Observable.html",
 582       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
 583       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
 584     },
 585     {
 586       "tagname": "method",
 587       "name": "removeListener",
 588       "member": "Ext.util.Observable",
 589       "doc": "<p>Removes an event handler.</p>\n",
 590       "params": [
 591         {
 592           "type": "String",
 593           "name": "eventName",
 594           "doc": "<p>The type of event the handler was associated with.</p>\n",
 595           "optional": false
 596         },
 597         {
 598           "type": "Function",
 599           "name": "handler",
 600           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 601           "optional": false
 602         },
 603         {
 604           "type": "Object",
 605           "name": "scope",
 606           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 607           "optional": true
 608         }
 609       ],
 610       "return": {
 611         "type": "void",
 612         "doc": "\n"
 613       },
 614       "private": false,
 615       "static": false,
 616       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 617       "linenr": 352,
 618       "html_filename": "Observable.html",
 619       "href": "Observable.html#Ext-util-Observable-method-removeListener",
 620       "shortDoc": "<p>Removes an event handler.</p>\n"
 621     },
 622     {
 623       "tagname": "method",
 624       "name": "removeManagedListener",
 625       "member": "Ext.util.Observable",
 626       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.PollingProvider--mon\" rel=\"Ext.direct.PollingProvider--mon\" class=\"docClass\">mon</a> method.</p>\n",
 627       "params": [
 628         {
 629           "type": "Observable|Element",
 630           "name": "item",
 631           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
 632           "optional": false
 633         },
 634         {
 635           "type": "Object|String",
 636           "name": "ename",
 637           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
 638           "optional": false
 639         },
 640         {
 641           "type": "Function",
 642           "name": "fn",
 643           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
 644           "optional": false
 645         },
 646         {
 647           "type": "Object",
 648           "name": "scope",
 649           "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",
 650           "optional": false
 651         }
 652       ],
 653       "return": {
 654         "type": "void",
 655         "doc": "\n"
 656       },
 657       "private": false,
 658       "static": false,
 659       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 660       "linenr": 196,
 661       "html_filename": "Observable.html",
 662       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
 663       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.PollingProvider--mon\" rel=\"Ext.direct.PollingProvider--mon\" class=\"docClass\">mon</a> method.</p>\n"
 664     },
 665     {
 666       "tagname": "method",
 667       "name": "resumeEvents",
 668       "member": "Ext.util.Observable",
 669       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.direct.PollingProvider-method-suspendEvents\" rel=\"Ext.direct.PollingProvider-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",
 670       "params": [
 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": 502,
 681       "html_filename": "Observable.html",
 682       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
 683       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
 684     },
 685     {
 686       "tagname": "method",
 687       "name": "suspendEvents",
 688       "member": "Ext.util.Observable",
 689       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.direct.PollingProvider-method-resumeEvents\" rel=\"Ext.direct.PollingProvider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
 690       "params": [
 691         {
 692           "type": "Boolean",
 693           "name": "queueSuspended",
 694           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.direct.PollingProvider-method-resumeEvents\" rel=\"Ext.direct.PollingProvider-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
 695           "optional": false
 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": 490,
 706       "html_filename": "Observable.html",
 707       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
 708       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.direct.PollingProvider-method-resumeEvents\" rel=\"Ext.direct.PollingProvider-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
 709     },
 710     {
 711       "tagname": "method",
 712       "name": "un",
 713       "member": "Ext.util.Observable",
 714       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.direct.PollingProvider-method-removeListener\" rel=\"Ext.direct.PollingProvider-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
 715       "params": [
 716         {
 717           "type": "String",
 718           "name": "eventName",
 719           "doc": "<p>The type of event the handler was associated with.</p>\n",
 720           "optional": false
 721         },
 722         {
 723           "type": "Function",
 724           "name": "handler",
 725           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
 726           "optional": false
 727         },
 728         {
 729           "type": "Object",
 730           "name": "scope",
 731           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
 732           "optional": true
 733         }
 734       ],
 735       "return": {
 736         "type": "void",
 737         "doc": "\n"
 738       },
 739       "private": false,
 740       "static": false,
 741       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
 742       "linenr": 608,
 743       "html_filename": "Observable.html",
 744       "href": "Observable.html#Ext-util-Observable-method-un",
 745       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.direct.PollingProvider-method-removeListener\" rel=\"Ext.direct.PollingProvider-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
 746     }
 747   ],
 748   "property": [
 749
 750   ],
 751   "event": [
 752     {
 753       "tagname": "event",
 754       "name": "beforepoll",
 755       "member": "Ext.direct.PollingProvider",
 756       "doc": "<p>Fired immediately before a poll takes place, an event handler can return false\nin order to cancel the poll.</p>\n",
 757       "params": [
 758         {
 759           "type": "Ext.direct.PollingProvider",
 760           "name": "",
 761           "doc": "\n",
 762           "optional": false
 763         }
 764       ],
 765       "private": false,
 766       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/PollingProvider.js",
 767       "linenr": 68,
 768       "html_filename": "PollingProvider.html",
 769       "href": "PollingProvider.html#Ext-direct-PollingProvider-event-beforepoll",
 770       "shortDoc": "<p>Fired immediately before a poll takes place, an event handler can return false\nin order to cancel the poll.</p>\n"
 771     },
 772     {
 773       "tagname": "event",
 774       "name": "connect",
 775       "member": "Ext.direct.Provider",
 776       "doc": "<p>Fires when the Provider connects to the server-side</p>\n",
 777       "params": [
 778         {
 779           "type": "Ext.direct.Provider",
 780           "name": "provider",
 781           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
 782           "optional": false
 783         }
 784       ],
 785       "private": false,
 786       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 787       "linenr": 50,
 788       "html_filename": "Provider.html",
 789       "href": "Provider.html#Ext-direct-Provider-event-connect",
 790       "shortDoc": "<p>Fires when the Provider connects to the server-side</p>\n"
 791     },
 792     {
 793       "tagname": "event",
 794       "name": "data",
 795       "member": "Ext.direct.Provider",
 796       "doc": "<p>Fires when the Provider receives data from the server-side</p>\n",
 797       "params": [
 798         {
 799           "type": "Ext.direct.Provider",
 800           "name": "provider",
 801           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
 802           "optional": false
 803         },
 804         {
 805           "type": "event",
 806           "name": "e",
 807           "doc": "<p>The Ext.Direct.Event type that occurred.</p>\n",
 808           "optional": false
 809         }
 810       ],
 811       "private": false,
 812       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 813       "linenr": 62,
 814       "html_filename": "Provider.html",
 815       "href": "Provider.html#Ext-direct-Provider-event-data",
 816       "shortDoc": "<p>Fires when the Provider receives data from the server-side</p>\n"
 817     },
 818     {
 819       "tagname": "event",
 820       "name": "disconnect",
 821       "member": "Ext.direct.Provider",
 822       "doc": "<p>Fires when the Provider disconnects from the server-side</p>\n",
 823       "params": [
 824         {
 825           "type": "Ext.direct.Provider",
 826           "name": "provider",
 827           "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
 828           "optional": false
 829         }
 830       ],
 831       "private": false,
 832       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 833       "linenr": 56,
 834       "html_filename": "Provider.html",
 835       "href": "Provider.html#Ext-direct-Provider-event-disconnect",
 836       "shortDoc": "<p>Fires when the Provider disconnects from the server-side</p>\n"
 837     },
 838     {
 839       "tagname": "event",
 840       "name": "exception",
 841       "member": "Ext.direct.Provider",
 842       "doc": "<p>Fires when the Provider receives an exception from the server-side</p>\n",
 843       "params": [
 844
 845       ],
 846       "private": false,
 847       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/Provider.js",
 848       "linenr": 69,
 849       "html_filename": "Provider.html",
 850       "href": "Provider.html#Ext-direct-Provider-event-exception",
 851       "shortDoc": "<p>Fires when the Provider receives an exception from the server-side</p>\n"
 852     },
 853     {
 854       "tagname": "event",
 855       "name": "poll",
 856       "member": "Ext.direct.PollingProvider",
 857       "doc": "<p>This event has not yet been implemented.</p>\n",
 858       "params": [
 859         {
 860           "type": "Ext.direct.PollingProvider",
 861           "name": "",
 862           "doc": "\n",
 863           "optional": false
 864         }
 865       ],
 866       "private": false,
 867       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/PollingProvider.js",
 868       "linenr": 75,
 869       "html_filename": "PollingProvider.html",
 870       "href": "PollingProvider.html#Ext-direct-PollingProvider-event-poll",
 871       "shortDoc": "<p>This event has not yet been implemented.</p>\n"
 872     }
 873   ],
 874   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/direct/PollingProvider.js",
 875   "linenr": 1,
 876   "html_filename": "PollingProvider.html",
 877   "href": "PollingProvider.html#Ext-direct-PollingProvider",
 878   "cssVar": [
 879
 880   ],
 881   "cssMixin": [
 882
 883   ],
 884   "component": false,
 885   "superclasses": [
 886     "Ext.direct.Provider",
 887     "Ext.direct.JsonProvider"
 888   ],
 889   "subclasses": [
 890
 891   ],
 892   "mixedInto": [
 893
 894   ],
 895   "allMixins": [
 896     "Ext.util.Observable"
 897   ]
 898 });