Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.direct.PollingProvider.js
1 Ext.data.JsonP.Ext_direct_PollingProvider({
2   "allMixins": [
3     "Ext.util.Observable"
4   ],
5   "deprecated": null,
6   "docauthor": null,
7   "members": {
8     "cfg": [
9       {
10         "type": "Object",
11         "deprecated": null,
12         "alias": null,
13         "protected": false,
14         "tagname": "cfg",
15         "href": "PollingProvider.html#Ext-direct-PollingProvider-cfg-baseParams",
16         "static": false,
17         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/PollingProvider.js",
18         "private": false,
19         "name": "baseParams",
20         "owner": "Ext.direct.PollingProvider",
21         "doc": "<p>An object containing properties which are to be sent as parameters\non every polling request</p>\n",
22         "linenr": 53,
23         "html_filename": "PollingProvider.html"
24       },
25       {
26         "type": "String",
27         "deprecated": null,
28         "alias": null,
29         "protected": false,
30         "tagname": "cfg",
31         "href": "Provider2.html#Ext-direct-Provider-cfg-id",
32         "shortDoc": "The unique id of the provider (defaults to an auto-assigned id). ...",
33         "static": false,
34         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/Provider.js",
35         "private": false,
36         "name": "id",
37         "owner": "Ext.direct.Provider",
38         "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",
39         "linenr": 29,
40         "html_filename": "Provider2.html"
41       },
42       {
43         "type": "Number",
44         "deprecated": null,
45         "alias": null,
46         "protected": false,
47         "tagname": "cfg",
48         "href": "PollingProvider.html#Ext-direct-PollingProvider-cfg-interval",
49         "static": false,
50         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/PollingProvider.js",
51         "private": false,
52         "name": "interval",
53         "owner": "Ext.direct.PollingProvider",
54         "doc": "<p>How often to poll the server-side in milliseconds (defaults to <tt>3000</tt> - every\n3 seconds).</p>\n",
55         "linenr": 46,
56         "html_filename": "PollingProvider.html"
57       },
58       {
59         "type": "Object",
60         "deprecated": null,
61         "alias": null,
62         "protected": false,
63         "tagname": "cfg",
64         "href": "Observable.html#Ext-util-Observable-cfg-listeners",
65         "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...",
66         "static": false,
67         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
68         "private": false,
69         "name": "listeners",
70         "owner": "Ext.util.Observable",
71         "doc": "<p>A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the <a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple\nhandlers at once.</p>\n\n<p><strong>DOM events from ExtJS <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></strong></p>\n\n<p>While <em>some</em> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly 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 <strong><code><a href=\"#/api/Ext.view.View-event-itemclick\" rel=\"Ext.view.View-event-itemclick\" class=\"docClass\">itemclick</a></code></strong> event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the <code>element</code> option to identify the Component property to add a\nDOM 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",
72         "linenr": 102,
73         "html_filename": "Observable.html"
74       },
75       {
76         "type": "String/Function",
77         "deprecated": null,
78         "alias": null,
79         "protected": false,
80         "tagname": "cfg",
81         "href": "PollingProvider.html#Ext-direct-PollingProvider-cfg-url",
82         "shortDoc": "The url which the PollingProvider should contact with each request. ...",
83         "static": false,
84         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/PollingProvider.js",
85         "private": false,
86         "name": "url",
87         "owner": "Ext.direct.PollingProvider",
88         "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",
89         "linenr": 58,
90         "html_filename": "PollingProvider.html"
91       }
92     ],
93     "method": [
94       {
95         "deprecated": null,
96         "alias": null,
97         "protected": false,
98         "tagname": "method",
99         "href": "Observable.html#Ext-util-Observable-method-addEvents",
100         "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...",
101         "static": false,
102         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
103         "private": false,
104         "params": [
105           {
106             "type": "Object/String",
107             "optional": false,
108             "doc": "<p>Either an object with event names as properties with a value of <code>true</code> or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:</p>\n\n<pre><code>this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n</code></pre>\n",
109             "name": "o"
110           },
111           {
112             "type": "String...",
113             "optional": false,
114             "doc": "<p>Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n",
115             "name": "more"
116           }
117         ],
118         "name": "addEvents",
119         "owner": "Ext.util.Observable",
120         "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
121         "linenr": 494,
122         "return": {
123           "type": "void",
124           "doc": "\n"
125         },
126         "html_filename": "Observable.html"
127       },
128       {
129         "deprecated": null,
130         "alias": null,
131         "protected": false,
132         "tagname": "method",
133         "href": "Observable.html#Ext-util-Observable-method-addListener",
134         "shortDoc": "Appends an event handler to this object. ...",
135         "static": false,
136         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
137         "private": false,
138         "params": [
139           {
140             "type": "String",
141             "optional": false,
142             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
143             "name": "eventName"
144           },
145           {
146             "type": "Function",
147             "optional": false,
148             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.direct.PollingProvider-method-fireEvent\" rel=\"Ext.direct.PollingProvider-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
149             "name": "handler"
150           },
151           {
152             "type": "Object",
153             "optional": true,
154             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
155             "name": "scope"
156           },
157           {
158             "type": "Object",
159             "optional": true,
160             "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>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 by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty 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\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\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></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\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\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
161             "name": "options"
162           }
163         ],
164         "name": "addListener",
165         "owner": "Ext.util.Observable",
166         "doc": "<p>Appends an event handler to this object.</p>\n",
167         "linenr": 278,
168         "return": {
169           "type": "void",
170           "doc": "\n"
171         },
172         "html_filename": "Observable.html"
173       },
174       {
175         "deprecated": null,
176         "alias": null,
177         "protected": false,
178         "tagname": "method",
179         "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
180         "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...",
181         "static": false,
182         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
183         "private": false,
184         "params": [
185           {
186             "type": "Observable/Element",
187             "optional": false,
188             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
189             "name": "item"
190           },
191           {
192             "type": "Object/String",
193             "optional": false,
194             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
195             "name": "ename"
196           },
197           {
198             "type": "Function",
199             "optional": true,
200             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
201             "name": "fn"
202           },
203           {
204             "type": "Object",
205             "optional": true,
206             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
207             "name": "scope"
208           },
209           {
210             "type": "Object",
211             "optional": true,
212             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
213             "name": "opt"
214           }
215         ],
216         "name": "addManagedListener",
217         "owner": "Ext.util.Observable",
218         "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
219         "linenr": 156,
220         "return": {
221           "type": "void",
222           "doc": "\n"
223         },
224         "html_filename": "Observable.html"
225       },
226       {
227         "deprecated": null,
228         "alias": null,
229         "protected": false,
230         "tagname": "method",
231         "href": "Base3.html#Ext-Base-method-addStatics",
232         "shortDoc": "Add / override static properties of this class. ...",
233         "static": true,
234         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
235         "private": false,
236         "params": [
237           {
238             "type": "Object",
239             "optional": false,
240             "doc": "\n",
241             "name": "members"
242           }
243         ],
244         "name": "addStatics",
245         "owner": "Ext.Base",
246         "doc": "<p>Add / override static properties of this class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n</code></pre>\n",
247         "linenr": 388,
248         "return": {
249           "type": "Ext.Base",
250           "doc": "<p>this</p>\n"
251         },
252         "html_filename": "Base3.html"
253       },
254       {
255         "deprecated": null,
256         "alias": null,
257         "protected": false,
258         "tagname": "method",
259         "href": "Base3.html#Ext-Base-method-callOverridden",
260         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
261         "static": false,
262         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
263         "private": false,
264         "params": [
265           {
266             "type": "Array/Arguments",
267             "optional": false,
268             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
269             "name": "args"
270           }
271         ],
272         "name": "callOverridden",
273         "owner": "Ext.Base",
274         "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">Ext.Base.override</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
275         "linenr": 269,
276         "return": {
277           "type": "Mixed",
278           "doc": "<p>Returns the result after calling the overridden method</p>\n"
279         },
280         "html_filename": "Base3.html"
281       },
282       {
283         "deprecated": null,
284         "alias": null,
285         "protected": true,
286         "tagname": "method",
287         "href": "Base3.html#Ext-Base-method-callParent",
288         "shortDoc": "Call the parent's overridden method. ...",
289         "static": false,
290         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
291         "private": false,
292         "params": [
293           {
294             "type": "Array/Arguments",
295             "optional": false,
296             "doc": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
297             "name": "args"
298           }
299         ],
300         "name": "callParent",
301         "owner": "Ext.Base",
302         "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n</code></pre>\n",
303         "linenr": 124,
304         "return": {
305           "type": "Mixed",
306           "doc": "<p>Returns the result from the superclass' method</p>\n"
307         },
308         "html_filename": "Base3.html"
309       },
310       {
311         "deprecated": null,
312         "alias": null,
313         "protected": false,
314         "tagname": "method",
315         "href": "Observable.html#Ext-util-Observable-method-capture",
316         "shortDoc": "Starts capture on the specified Observable. ...",
317         "static": true,
318         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
319         "private": false,
320         "params": [
321           {
322             "type": "Observable",
323             "optional": false,
324             "doc": "<p>The Observable to capture events from.</p>\n",
325             "name": "o"
326           },
327           {
328             "type": "Function",
329             "optional": false,
330             "doc": "<p>The function to call when an event is fired.</p>\n",
331             "name": "fn"
332           },
333           {
334             "type": "Object",
335             "optional": true,
336             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to\nthe Observable firing the event.</p>\n",
337             "name": "scope"
338           }
339         ],
340         "name": "capture",
341         "owner": "Ext.util.Observable",
342         "doc": "<p>Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event <strong>before</strong> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
343         "linenr": 54,
344         "return": {
345           "type": "void",
346           "doc": "\n"
347         },
348         "html_filename": "Observable.html"
349       },
350       {
351         "deprecated": null,
352         "alias": null,
353         "protected": false,
354         "tagname": "method",
355         "href": "Observable.html#Ext-util-Observable-method-clearListeners",
356         "shortDoc": "Removes all listeners for this object including the managed listeners ...",
357         "static": false,
358         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
359         "private": false,
360         "params": [
361
362         ],
363         "name": "clearListeners",
364         "owner": "Ext.util.Observable",
365         "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
366         "linenr": 425,
367         "return": {
368           "type": "void",
369           "doc": "\n"
370         },
371         "html_filename": "Observable.html"
372       },
373       {
374         "deprecated": null,
375         "alias": null,
376         "protected": false,
377         "tagname": "method",
378         "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
379         "shortDoc": "Removes all managed listeners for this object. ...",
380         "static": false,
381         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
382         "private": false,
383         "params": [
384
385         ],
386         "name": "clearManagedListeners",
387         "owner": "Ext.util.Observable",
388         "doc": "<p>Removes all managed listeners for this object.</p>\n",
389         "linenr": 454,
390         "return": {
391           "type": "void",
392           "doc": "\n"
393         },
394         "html_filename": "Observable.html"
395       },
396       {
397         "deprecated": null,
398         "alias": null,
399         "protected": false,
400         "tagname": "method",
401         "href": "PollingProvider.html#Ext-direct-PollingProvider-method-connect",
402         "shortDoc": "Connect to the server-side and begin the polling process. ...",
403         "static": false,
404         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/PollingProvider.js",
405         "private": false,
406         "params": [
407
408         ],
409         "name": "connect",
410         "owner": "Ext.direct.PollingProvider",
411         "doc": "<p>Connect to the server-side and begin the polling process. To handle each\nresponse subscribe to the data event.</p>\n",
412         "linenr": 89,
413         "return": {
414           "type": "void",
415           "doc": "\n"
416         },
417         "html_filename": "PollingProvider.html"
418       },
419       {
420         "deprecated": null,
421         "alias": null,
422         "protected": false,
423         "tagname": "method",
424         "href": "Base3.html#Ext-Base-method-create",
425         "shortDoc": "Create a new instance of this Class. ...",
426         "static": true,
427         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
428         "private": false,
429         "params": [
430
431         ],
432         "name": "create",
433         "owner": "Ext.Base",
434         "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
435         "linenr": 329,
436         "return": {
437           "type": "Object",
438           "doc": "<p>the created instance.</p>\n"
439         },
440         "html_filename": "Base3.html"
441       },
442       {
443         "deprecated": null,
444         "alias": null,
445         "protected": false,
446         "tagname": "method",
447         "href": "Base3.html#Ext-Base-method-createAlias",
448         "shortDoc": "Create aliases for existing prototype methods. ...",
449         "static": true,
450         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
451         "private": false,
452         "params": [
453           {
454             "type": "String/Object",
455             "optional": false,
456             "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
457             "name": "alias"
458           },
459           {
460             "type": "String/Object",
461             "optional": false,
462             "doc": "<p>The original method name</p>\n",
463             "name": "origin"
464           }
465         ],
466         "name": "createAlias",
467         "owner": "Ext.Base",
468         "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -&gt; test.method1()\n</code></pre>\n",
469         "linenr": 648,
470         "return": {
471           "type": "void",
472           "doc": "\n"
473         },
474         "html_filename": "Base3.html"
475       },
476       {
477         "deprecated": null,
478         "alias": null,
479         "protected": false,
480         "tagname": "method",
481         "href": "JsonProvider.html#Ext-direct-JsonProvider-method-createEvent",
482         "shortDoc": "Create an event from a response object ...",
483         "static": false,
484         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/JsonProvider.js",
485         "private": false,
486         "params": [
487           {
488             "type": "Object",
489             "optional": false,
490             "doc": "<p>The XHR response object</p>\n",
491             "name": "response"
492           }
493         ],
494         "name": "createEvent",
495         "owner": "Ext.direct.JsonProvider",
496         "doc": "<p>Create an event from a response object</p>\n",
497         "linenr": 75,
498         "return": {
499           "type": "Ext.direct.Event",
500           "doc": "<p>The event</p>\n"
501         },
502         "html_filename": "JsonProvider.html"
503       },
504       {
505         "deprecated": null,
506         "alias": null,
507         "protected": false,
508         "tagname": "method",
509         "href": "PollingProvider.html#Ext-direct-PollingProvider-method-disconnect",
510         "shortDoc": "Disconnect from the server-side and stop the polling process. ...",
511         "static": false,
512         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/PollingProvider.js",
513         "private": false,
514         "params": [
515
516         ],
517         "name": "disconnect",
518         "owner": "Ext.direct.PollingProvider",
519         "doc": "<p>Disconnect from the server-side and stop the polling process. The disconnect\nevent will be fired on a successful disconnect.</p>\n",
520         "linenr": 123,
521         "return": {
522           "type": "void",
523           "doc": "\n"
524         },
525         "html_filename": "PollingProvider.html"
526       },
527       {
528         "deprecated": null,
529         "alias": null,
530         "protected": false,
531         "tagname": "method",
532         "href": "Observable.html#Ext-util-Observable-method-enableBubble",
533         "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...",
534         "static": false,
535         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
536         "private": false,
537         "params": [
538           {
539             "type": "String/[String]",
540             "optional": false,
541             "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
542             "name": "events"
543           }
544         ],
545         "name": "enableBubble",
546         "owner": "Ext.util.Observable",
547         "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling <code>this.getBubbleTarget()</code> if\npresent. There is no implementation in the Observable base class.</p>\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers.\nSee <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default implementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.</p>\n\n<p>Example:</p>\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\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",
548         "linenr": 609,
549         "return": {
550           "type": "void",
551           "doc": "\n"
552         },
553         "html_filename": "Observable.html"
554       },
555       {
556         "deprecated": null,
557         "alias": null,
558         "protected": false,
559         "tagname": "method",
560         "href": "Observable.html#Ext-util-Observable-method-fireEvent",
561         "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...",
562         "static": false,
563         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
564         "private": false,
565         "params": [
566           {
567             "type": "String",
568             "optional": false,
569             "doc": "<p>The name of the event to fire.</p>\n",
570             "name": "eventName"
571           },
572           {
573             "type": "Object...",
574             "optional": false,
575             "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
576             "name": "args"
577           }
578         ],
579         "name": "fireEvent",
580         "owner": "Ext.util.Observable",
581         "doc": "<p>Fires the specified event with the passed parameters (minus the event name, plus the <code>options</code> object passed\nto <a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a>).</p>\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>) by\ncalling <a href=\"#/api/Ext.direct.PollingProvider-method-enableBubble\" rel=\"Ext.direct.PollingProvider-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n",
582         "linenr": 233,
583         "return": {
584           "type": "Boolean",
585           "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
586         },
587         "html_filename": "Observable.html"
588       },
589       {
590         "deprecated": null,
591         "alias": null,
592         "protected": false,
593         "tagname": "method",
594         "href": "Base3.html#Ext-Base-method-getName",
595         "shortDoc": "Get the current class' name in string format. ...",
596         "static": false,
597         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
598         "private": false,
599         "params": [
600
601         ],
602         "name": "getName",
603         "owner": "Ext.Base",
604         "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n</code></pre>\n",
605         "linenr": 631,
606         "return": {
607           "type": "String",
608           "doc": "<p>className</p>\n"
609         },
610         "html_filename": "Base3.html"
611       },
612       {
613         "deprecated": null,
614         "alias": null,
615         "protected": false,
616         "tagname": "method",
617         "href": "Observable.html#Ext-util-Observable-method-hasListener",
618         "shortDoc": "Checks to see if this object has any listeners for a specified event ...",
619         "static": false,
620         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
621         "private": false,
622         "params": [
623           {
624             "type": "String",
625             "optional": false,
626             "doc": "<p>The name of the event to check for</p>\n",
627             "name": "eventName"
628           }
629         ],
630         "name": "hasListener",
631         "owner": "Ext.util.Observable",
632         "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
633         "linenr": 530,
634         "return": {
635           "type": "Boolean",
636           "doc": "<p>True if the event is being listened for, else false</p>\n"
637         },
638         "html_filename": "Observable.html"
639       },
640       {
641         "deprecated": null,
642         "alias": null,
643         "protected": false,
644         "tagname": "method",
645         "href": "Base3.html#Ext-Base-method-implement",
646         "shortDoc": "Add methods / properties to the prototype of this class. ...",
647         "static": true,
648         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
649         "private": false,
650         "params": [
651           {
652             "type": "Object",
653             "optional": false,
654             "doc": "\n",
655             "name": "members"
656           }
657         ],
658         "name": "implement",
659         "owner": "Ext.Base",
660         "doc": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n</code></pre>\n",
661         "linenr": 415,
662         "return": {
663           "type": "void",
664           "doc": "\n"
665         },
666         "html_filename": "Base3.html"
667       },
668       {
669         "deprecated": null,
670         "alias": null,
671         "protected": true,
672         "tagname": "method",
673         "href": "Base3.html#Ext-Base-method-initConfig",
674         "shortDoc": "Initialize configuration for this class. ...",
675         "static": false,
676         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
677         "private": false,
678         "params": [
679           {
680             "type": "Object",
681             "optional": false,
682             "doc": "\n",
683             "name": "config"
684           }
685         ],
686         "name": "initConfig",
687         "owner": "Ext.Base",
688         "doc": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n\n        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n</code></pre>\n",
689         "linenr": 63,
690         "return": {
691           "type": "Object",
692           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
693         },
694         "html_filename": "Base3.html"
695       },
696       {
697         "deprecated": null,
698         "alias": null,
699         "protected": false,
700         "tagname": "method",
701         "href": "Provider2.html#Ext-direct-Provider-method-isConnected",
702         "shortDoc": "Returns whether or not the server-side is currently connected. ...",
703         "static": false,
704         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/Provider.js",
705         "private": false,
706         "params": [
707
708         ],
709         "name": "isConnected",
710         "owner": "Ext.direct.Provider",
711         "doc": "<p>Returns whether or not the server-side is currently connected.\nAbstract method for subclasses to implement.</p>\n",
712         "linenr": 78,
713         "return": {
714           "type": "void",
715           "doc": "\n"
716         },
717         "html_filename": "Provider2.html"
718       },
719       {
720         "deprecated": null,
721         "alias": {
722           "tagname": "alias",
723           "cls": "Ext.util.Observable",
724           "doc": null,
725           "owner": "addManagedListener"
726         },
727         "protected": false,
728         "tagname": "method",
729         "href": "Observable.html#Ext-util-Observable-method-mon",
730         "shortDoc": "Shorthand for addManagedListener. ...",
731         "static": false,
732         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
733         "private": false,
734         "params": [
735           {
736             "type": "Observable/Element",
737             "optional": false,
738             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
739             "name": "item"
740           },
741           {
742             "type": "Object/String",
743             "optional": false,
744             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
745             "name": "ename"
746           },
747           {
748             "type": "Function",
749             "optional": true,
750             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
751             "name": "fn"
752           },
753           {
754             "type": "Object",
755             "optional": true,
756             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
757             "name": "scope"
758           },
759           {
760             "type": "Object",
761             "optional": true,
762             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
763             "name": "opt"
764           }
765         ],
766         "name": "mon",
767         "owner": "Ext.util.Observable",
768         "doc": "<p>Shorthand for <a href=\"#/api/Ext.direct.PollingProvider-method-addManagedListener\" rel=\"Ext.direct.PollingProvider-method-addManagedListener\" class=\"docClass\">addManagedListener</a>.</p>\n\n<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
769         "linenr": 681,
770         "return": {
771           "type": "void",
772           "doc": "\n"
773         },
774         "html_filename": "Observable.html"
775       },
776       {
777         "deprecated": null,
778         "alias": {
779           "tagname": "alias",
780           "cls": "Ext.util.Observable",
781           "doc": null,
782           "owner": "removeManagedListener"
783         },
784         "protected": false,
785         "tagname": "method",
786         "href": "Observable.html#Ext-util-Observable-method-mun",
787         "shortDoc": "Shorthand for removeManagedListener. ...",
788         "static": false,
789         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
790         "private": false,
791         "params": [
792           {
793             "type": "Observable|Element",
794             "optional": false,
795             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
796             "name": "item"
797           },
798           {
799             "type": "Object|String",
800             "optional": false,
801             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
802             "name": "ename"
803           },
804           {
805             "type": "Function",
806             "optional": false,
807             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
808             "name": "fn"
809           },
810           {
811             "type": "Object",
812             "optional": false,
813             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
814             "name": "scope"
815           }
816         ],
817         "name": "mun",
818         "owner": "Ext.util.Observable",
819         "doc": "<p>Shorthand for <a href=\"#/api/Ext.direct.PollingProvider-method-removeManagedListener\" rel=\"Ext.direct.PollingProvider-method-removeManagedListener\" class=\"docClass\">removeManagedListener</a>.</p>\n\n<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.PollingProvider-method-mon\" rel=\"Ext.direct.PollingProvider-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
820         "linenr": 687,
821         "return": {
822           "type": "void",
823           "doc": "\n"
824         },
825         "html_filename": "Observable.html"
826       },
827       {
828         "deprecated": null,
829         "alias": null,
830         "protected": false,
831         "tagname": "method",
832         "href": "Observable.html#Ext-util-Observable-method-observe",
833         "shortDoc": "Sets observability on the passed class constructor. ...",
834         "static": true,
835         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
836         "private": false,
837         "params": [
838           {
839             "type": "Function",
840             "optional": false,
841             "doc": "<p>The class constructor to make observable.</p>\n",
842             "name": "c"
843           },
844           {
845             "type": "Object",
846             "optional": false,
847             "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",
848             "name": "listeners"
849           }
850         ],
851         "name": "observe",
852         "owner": "Ext.util.Observable",
853         "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",
854         "linenr": 69,
855         "return": {
856           "type": "void",
857           "doc": "\n"
858         },
859         "html_filename": "Observable.html"
860       },
861       {
862         "deprecated": null,
863         "alias": {
864           "tagname": "alias",
865           "cls": "Ext.util.Observable",
866           "doc": null,
867           "owner": "addListener"
868         },
869         "protected": false,
870         "tagname": "method",
871         "href": "Observable.html#Ext-util-Observable-method-on",
872         "shortDoc": "Shorthand for addListener. ...",
873         "static": false,
874         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
875         "private": false,
876         "params": [
877           {
878             "type": "String",
879             "optional": false,
880             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
881             "name": "eventName"
882           },
883           {
884             "type": "Function",
885             "optional": false,
886             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.direct.PollingProvider-method-fireEvent\" rel=\"Ext.direct.PollingProvider-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
887             "name": "handler"
888           },
889           {
890             "type": "Object",
891             "optional": true,
892             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
893             "name": "scope"
894           },
895           {
896             "type": "Object",
897             "optional": true,
898             "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>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 by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty 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\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\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></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\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\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
899             "name": "options"
900           }
901         ],
902         "name": "on",
903         "owner": "Ext.util.Observable",
904         "doc": "<p>Shorthand for <a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a>.</p>\n\n<p>Appends an event handler to this object.</p>\n",
905         "linenr": 669,
906         "return": {
907           "type": "void",
908           "doc": "\n"
909         },
910         "html_filename": "Observable.html"
911       },
912       {
913         "deprecated": null,
914         "alias": null,
915         "protected": false,
916         "tagname": "method",
917         "href": "Base3.html#Ext-Base-method-override",
918         "shortDoc": "Override prototype members of this class. ...",
919         "static": true,
920         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
921         "private": false,
922         "params": [
923           {
924             "type": "Object",
925             "optional": false,
926             "doc": "\n",
927             "name": "members"
928           }
929         ],
930         "name": "override",
931         "owner": "Ext.Base",
932         "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">Ext.Base.callOverridden</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
933         "linenr": 518,
934         "return": {
935           "type": "Ext.Base",
936           "doc": "<p>this</p>\n"
937         },
938         "html_filename": "Base3.html"
939       },
940       {
941         "deprecated": null,
942         "alias": null,
943         "protected": false,
944         "tagname": "method",
945         "href": "Observable.html#Ext-util-Observable-method-relayEvents",
946         "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...",
947         "static": false,
948         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
949         "private": false,
950         "params": [
951           {
952             "type": "Object",
953             "optional": false,
954             "doc": "<p>The Observable whose events this object is to relay.</p>\n",
955             "name": "origin"
956           },
957           {
958             "type": "[String]",
959             "optional": false,
960             "doc": "<p>Array of event names to relay.</p>\n",
961             "name": "events"
962           },
963           {
964             "type": "Object",
965             "optional": false,
966             "doc": "\n",
967             "name": "prefix"
968           }
969         ],
970         "name": "relayEvents",
971         "owner": "Ext.util.Observable",
972         "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code>this</code>.</p>\n",
973         "linenr": 573,
974         "return": {
975           "type": "void",
976           "doc": "\n"
977         },
978         "html_filename": "Observable.html"
979       },
980       {
981         "deprecated": null,
982         "alias": null,
983         "protected": false,
984         "tagname": "method",
985         "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
986         "shortDoc": "Removes all added captures from the Observable. ...",
987         "static": true,
988         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
989         "private": false,
990         "params": [
991           {
992             "type": "Observable",
993             "optional": false,
994             "doc": "<p>The Observable to release</p>\n",
995             "name": "o"
996           }
997         ],
998         "name": "releaseCapture",
999         "owner": "Ext.util.Observable",
1000         "doc": "<p>Removes <strong>all</strong> added captures from the Observable.</p>\n",
1001         "linenr": 44,
1002         "return": {
1003           "type": "void",
1004           "doc": "\n"
1005         },
1006         "html_filename": "Observable.html"
1007       },
1008       {
1009         "deprecated": null,
1010         "alias": null,
1011         "protected": false,
1012         "tagname": "method",
1013         "href": "Observable.html#Ext-util-Observable-method-removeListener",
1014         "shortDoc": "Removes an event handler. ...",
1015         "static": false,
1016         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1017         "private": false,
1018         "params": [
1019           {
1020             "type": "String",
1021             "optional": false,
1022             "doc": "<p>The type of event the handler was associated with.</p>\n",
1023             "name": "eventName"
1024           },
1025           {
1026             "type": "Function",
1027             "optional": false,
1028             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1029             "name": "handler"
1030           },
1031           {
1032             "type": "Object",
1033             "optional": true,
1034             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1035             "name": "scope"
1036           }
1037         ],
1038         "name": "removeListener",
1039         "owner": "Ext.util.Observable",
1040         "doc": "<p>Removes an event handler.</p>\n",
1041         "linenr": 392,
1042         "return": {
1043           "type": "void",
1044           "doc": "\n"
1045         },
1046         "html_filename": "Observable.html"
1047       },
1048       {
1049         "deprecated": null,
1050         "alias": null,
1051         "protected": false,
1052         "tagname": "method",
1053         "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
1054         "shortDoc": "Removes listeners that were added by the mon method. ...",
1055         "static": false,
1056         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1057         "private": false,
1058         "params": [
1059           {
1060             "type": "Observable|Element",
1061             "optional": false,
1062             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
1063             "name": "item"
1064           },
1065           {
1066             "type": "Object|String",
1067             "optional": false,
1068             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
1069             "name": "ename"
1070           },
1071           {
1072             "type": "Function",
1073             "optional": false,
1074             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
1075             "name": "fn"
1076           },
1077           {
1078             "type": "Object",
1079             "optional": false,
1080             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
1081             "name": "scope"
1082           }
1083         ],
1084         "name": "removeManagedListener",
1085         "owner": "Ext.util.Observable",
1086         "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.direct.PollingProvider-method-mon\" rel=\"Ext.direct.PollingProvider-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
1087         "linenr": 197,
1088         "return": {
1089           "type": "void",
1090           "doc": "\n"
1091         },
1092         "html_filename": "Observable.html"
1093       },
1094       {
1095         "deprecated": null,
1096         "alias": null,
1097         "protected": false,
1098         "tagname": "method",
1099         "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
1100         "shortDoc": "Resumes firing events (see suspendEvents). ...",
1101         "static": false,
1102         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1103         "private": false,
1104         "params": [
1105
1106         ],
1107         "name": "resumeEvents",
1108         "owner": "Ext.util.Observable",
1109         "doc": "<p>Resumes firing events (see <a href=\"#/api/Ext.direct.PollingProvider-method-suspendEvents\" rel=\"Ext.direct.PollingProvider-method-suspendEvents\" class=\"docClass\">suspendEvents</a>).</p>\n\n<p>If events were suspended using the <code>**queueSuspended**</code> parameter, then all events fired\nduring event suspension will be sent to any listeners now.</p>\n",
1110         "linenr": 554,
1111         "return": {
1112           "type": "void",
1113           "doc": "\n"
1114         },
1115         "html_filename": "Observable.html"
1116       },
1117       {
1118         "deprecated": null,
1119         "alias": null,
1120         "protected": true,
1121         "tagname": "method",
1122         "href": "Base3.html#Ext-Base-method-statics",
1123         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
1124         "static": false,
1125         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1126         "private": false,
1127         "params": [
1128
1129         ],
1130         "name": "statics",
1131         "owner": "Ext.Base",
1132         "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">Ext.Base.self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n\n        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n</code></pre>\n",
1133         "linenr": 199,
1134         "return": {
1135           "type": "Class",
1136           "doc": "\n"
1137         },
1138         "html_filename": "Base3.html"
1139       },
1140       {
1141         "deprecated": null,
1142         "alias": null,
1143         "protected": false,
1144         "tagname": "method",
1145         "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1146         "shortDoc": "Suspends the firing of all events. ...",
1147         "static": false,
1148         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1149         "private": false,
1150         "params": [
1151           {
1152             "type": "Boolean",
1153             "optional": false,
1154             "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",
1155             "name": "queueSuspended"
1156           }
1157         ],
1158         "name": "suspendEvents",
1159         "owner": "Ext.util.Observable",
1160         "doc": "<p>Suspends 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",
1161         "linenr": 541,
1162         "return": {
1163           "type": "void",
1164           "doc": "\n"
1165         },
1166         "html_filename": "Observable.html"
1167       },
1168       {
1169         "deprecated": null,
1170         "alias": {
1171           "tagname": "alias",
1172           "cls": "Ext.util.Observable",
1173           "doc": null,
1174           "owner": "removeListener"
1175         },
1176         "protected": false,
1177         "tagname": "method",
1178         "href": "Observable.html#Ext-util-Observable-method-un",
1179         "shortDoc": "Shorthand for removeListener. ...",
1180         "static": false,
1181         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1182         "private": false,
1183         "params": [
1184           {
1185             "type": "String",
1186             "optional": false,
1187             "doc": "<p>The type of event the handler was associated with.</p>\n",
1188             "name": "eventName"
1189           },
1190           {
1191             "type": "Function",
1192             "optional": false,
1193             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.direct.PollingProvider-method-addListener\" rel=\"Ext.direct.PollingProvider-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1194             "name": "handler"
1195           },
1196           {
1197             "type": "Object",
1198             "optional": true,
1199             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1200             "name": "scope"
1201           }
1202         ],
1203         "name": "un",
1204         "owner": "Ext.util.Observable",
1205         "doc": "<p>Shorthand for <a href=\"#/api/Ext.direct.PollingProvider-method-removeListener\" rel=\"Ext.direct.PollingProvider-method-removeListener\" class=\"docClass\">removeListener</a>.</p>\n\n<p>Removes an event handler.</p>\n",
1206         "linenr": 675,
1207         "return": {
1208           "type": "void",
1209           "doc": "\n"
1210         },
1211         "html_filename": "Observable.html"
1212       }
1213     ],
1214     "property": [
1215       {
1216         "type": "Class",
1217         "deprecated": null,
1218         "alias": null,
1219         "protected": true,
1220         "tagname": "property",
1221         "href": "Base3.html#Ext-Base-property-self",
1222         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
1223         "static": false,
1224         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1225         "private": false,
1226         "name": "self",
1227         "owner": "Ext.Base",
1228         "doc": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>\nfor a detailed comparison</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); / dependent on 'this'\n\n        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n</code></pre>\n",
1229         "linenr": 18,
1230         "html_filename": "Base3.html"
1231       }
1232     ],
1233     "cssVar": [
1234
1235     ],
1236     "cssMixin": [
1237
1238     ],
1239     "event": [
1240       {
1241         "deprecated": null,
1242         "alias": null,
1243         "protected": false,
1244         "tagname": "event",
1245         "href": "PollingProvider.html#Ext-direct-PollingProvider-event-beforepoll",
1246         "shortDoc": "Fired immediately before a poll takes place, an event handler can return false\nin order to cancel the poll. ...",
1247         "static": false,
1248         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/PollingProvider.js",
1249         "private": false,
1250         "params": [
1251           {
1252             "type": "Ext.direct.PollingProvider",
1253             "optional": false,
1254             "doc": "\n",
1255             "name": ""
1256           },
1257           {
1258             "type": "Object",
1259             "tagname": "param",
1260             "name": "options",
1261             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1262           }
1263         ],
1264         "name": "beforepoll",
1265         "owner": "Ext.direct.PollingProvider",
1266         "doc": "<p>Fired immediately before a poll takes place, an event handler can return false\nin order to cancel the poll.</p>\n",
1267         "linenr": 68,
1268         "html_filename": "PollingProvider.html"
1269       },
1270       {
1271         "deprecated": null,
1272         "alias": null,
1273         "protected": false,
1274         "tagname": "event",
1275         "href": "Provider2.html#Ext-direct-Provider-event-connect",
1276         "shortDoc": "Fires when the Provider connects to the server-side ...",
1277         "static": false,
1278         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/Provider.js",
1279         "private": false,
1280         "params": [
1281           {
1282             "type": "Ext.direct.Provider",
1283             "optional": false,
1284             "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
1285             "name": "provider"
1286           },
1287           {
1288             "type": "Object",
1289             "tagname": "param",
1290             "name": "options",
1291             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1292           }
1293         ],
1294         "name": "connect",
1295         "owner": "Ext.direct.Provider",
1296         "doc": "<p>Fires when the Provider connects to the server-side</p>\n",
1297         "linenr": 50,
1298         "html_filename": "Provider2.html"
1299       },
1300       {
1301         "deprecated": null,
1302         "alias": null,
1303         "protected": false,
1304         "tagname": "event",
1305         "href": "Provider2.html#Ext-direct-Provider-event-data",
1306         "shortDoc": "Fires when the Provider receives data from the server-side ...",
1307         "static": false,
1308         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/Provider.js",
1309         "private": false,
1310         "params": [
1311           {
1312             "type": "Ext.direct.Provider",
1313             "optional": false,
1314             "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
1315             "name": "provider"
1316           },
1317           {
1318             "type": "event",
1319             "optional": false,
1320             "doc": "<p>The Ext.Direct.Event type that occurred.</p>\n",
1321             "name": "e"
1322           },
1323           {
1324             "type": "Object",
1325             "tagname": "param",
1326             "name": "options",
1327             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1328           }
1329         ],
1330         "name": "data",
1331         "owner": "Ext.direct.Provider",
1332         "doc": "<p>Fires when the Provider receives data from the server-side</p>\n",
1333         "linenr": 62,
1334         "html_filename": "Provider2.html"
1335       },
1336       {
1337         "deprecated": null,
1338         "alias": null,
1339         "protected": false,
1340         "tagname": "event",
1341         "href": "Provider2.html#Ext-direct-Provider-event-disconnect",
1342         "shortDoc": "Fires when the Provider disconnects from the server-side ...",
1343         "static": false,
1344         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/Provider.js",
1345         "private": false,
1346         "params": [
1347           {
1348             "type": "Ext.direct.Provider",
1349             "optional": false,
1350             "doc": "<p>The <a href=\"#/api/Ext.direct.Provider\" rel=\"Ext.direct.Provider\" class=\"docClass\">Provider</a>.</p>\n",
1351             "name": "provider"
1352           },
1353           {
1354             "type": "Object",
1355             "tagname": "param",
1356             "name": "options",
1357             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1358           }
1359         ],
1360         "name": "disconnect",
1361         "owner": "Ext.direct.Provider",
1362         "doc": "<p>Fires when the Provider disconnects from the server-side</p>\n",
1363         "linenr": 56,
1364         "html_filename": "Provider2.html"
1365       },
1366       {
1367         "deprecated": null,
1368         "alias": null,
1369         "protected": false,
1370         "tagname": "event",
1371         "href": "Provider2.html#Ext-direct-Provider-event-exception",
1372         "shortDoc": "Fires when the Provider receives an exception from the server-side ...",
1373         "static": false,
1374         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/Provider.js",
1375         "private": false,
1376         "params": [
1377           {
1378             "type": "Object",
1379             "tagname": "param",
1380             "name": "options",
1381             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1382           }
1383         ],
1384         "name": "exception",
1385         "owner": "Ext.direct.Provider",
1386         "doc": "<p>Fires when the Provider receives an exception from the server-side</p>\n",
1387         "linenr": 69,
1388         "html_filename": "Provider2.html"
1389       },
1390       {
1391         "deprecated": null,
1392         "alias": null,
1393         "protected": false,
1394         "tagname": "event",
1395         "href": "PollingProvider.html#Ext-direct-PollingProvider-event-poll",
1396         "shortDoc": "This event has not yet been implemented. ...",
1397         "static": false,
1398         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/PollingProvider.js",
1399         "private": false,
1400         "params": [
1401           {
1402             "type": "Ext.direct.PollingProvider",
1403             "optional": false,
1404             "doc": "\n",
1405             "name": ""
1406           },
1407           {
1408             "type": "Object",
1409             "tagname": "param",
1410             "name": "options",
1411             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1412           }
1413         ],
1414         "name": "poll",
1415         "owner": "Ext.direct.PollingProvider",
1416         "doc": "<p>This event has not yet been implemented.</p>\n",
1417         "linenr": 75,
1418         "html_filename": "PollingProvider.html"
1419       }
1420     ]
1421   },
1422   "singleton": false,
1423   "alias": null,
1424   "superclasses": [
1425     "Ext.Base",
1426     "Ext.direct.Provider",
1427     "Ext.direct.JsonProvider"
1428   ],
1429   "protected": false,
1430   "tagname": "class",
1431   "mixins": [
1432
1433   ],
1434   "href": "PollingProvider.html#Ext-direct-PollingProvider",
1435   "subclasses": [
1436
1437   ],
1438   "static": false,
1439   "author": null,
1440   "component": false,
1441   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/PollingProvider.js",
1442   "private": false,
1443   "alternateClassNames": [
1444
1445   ],
1446   "name": "Ext.direct.PollingProvider",
1447   "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",
1448   "mixedInto": [
1449
1450   ],
1451   "linenr": 1,
1452   "xtypes": [
1453
1454   ],
1455   "html_filename": "PollingProvider.html",
1456   "extends": "Ext.direct.JsonProvider"
1457 });