Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.direct.RemotingEvent.js
1 Ext.data.JsonP.Ext_direct_RemotingEvent({
2   "allMixins": [
3
4   ],
5   "deprecated": null,
6   "docauthor": null,
7   "members": {
8     "cfg": [
9
10     ],
11     "method": [
12       {
13         "deprecated": null,
14         "alias": null,
15         "href": "Event.html#Ext-direct-Event-method-constructor",
16         "tagname": "method",
17         "protected": false,
18         "shortDoc": "Creates new Event. ...",
19         "static": false,
20         "params": [
21           {
22             "type": "Object",
23             "optional": true,
24             "doc": "<p>(optional) Config object.</p>\n",
25             "name": "config"
26           }
27         ],
28         "private": false,
29         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/Event.js",
30         "doc": "<p>Creates new Event.</p>\n",
31         "owner": "Ext.direct.Event",
32         "name": "RemotingEvent",
33         "html_filename": "Event.html",
34         "return": {
35           "type": "Object",
36           "doc": "\n"
37         },
38         "linenr": 20
39       },
40       {
41         "deprecated": null,
42         "alias": null,
43         "protected": false,
44         "tagname": "method",
45         "href": "Base3.html#Ext-Base-method-addStatics",
46         "shortDoc": "Add / override static properties of this class. ...",
47         "static": true,
48         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
49         "private": false,
50         "params": [
51           {
52             "type": "Object",
53             "optional": false,
54             "doc": "\n",
55             "name": "members"
56           }
57         ],
58         "name": "addStatics",
59         "owner": "Ext.Base",
60         "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",
61         "linenr": 388,
62         "return": {
63           "type": "Ext.Base",
64           "doc": "<p>this</p>\n"
65         },
66         "html_filename": "Base3.html"
67       },
68       {
69         "deprecated": null,
70         "alias": null,
71         "protected": false,
72         "tagname": "method",
73         "href": "Base3.html#Ext-Base-method-callOverridden",
74         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
75         "static": false,
76         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
77         "private": false,
78         "params": [
79           {
80             "type": "Array/Arguments",
81             "optional": false,
82             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
83             "name": "args"
84           }
85         ],
86         "name": "callOverridden",
87         "owner": "Ext.Base",
88         "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",
89         "linenr": 269,
90         "return": {
91           "type": "Mixed",
92           "doc": "<p>Returns the result after calling the overridden method</p>\n"
93         },
94         "html_filename": "Base3.html"
95       },
96       {
97         "deprecated": null,
98         "alias": null,
99         "protected": true,
100         "tagname": "method",
101         "href": "Base3.html#Ext-Base-method-callParent",
102         "shortDoc": "Call the parent's overridden method. ...",
103         "static": false,
104         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
105         "private": false,
106         "params": [
107           {
108             "type": "Array/Arguments",
109             "optional": false,
110             "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",
111             "name": "args"
112           }
113         ],
114         "name": "callParent",
115         "owner": "Ext.Base",
116         "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",
117         "linenr": 124,
118         "return": {
119           "type": "Mixed",
120           "doc": "<p>Returns the result from the superclass' method</p>\n"
121         },
122         "html_filename": "Base3.html"
123       },
124       {
125         "deprecated": null,
126         "alias": null,
127         "protected": false,
128         "tagname": "method",
129         "href": "Base3.html#Ext-Base-method-create",
130         "shortDoc": "Create a new instance of this Class. ...",
131         "static": true,
132         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
133         "private": false,
134         "params": [
135
136         ],
137         "name": "create",
138         "owner": "Ext.Base",
139         "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",
140         "linenr": 329,
141         "return": {
142           "type": "Object",
143           "doc": "<p>the created instance.</p>\n"
144         },
145         "html_filename": "Base3.html"
146       },
147       {
148         "deprecated": null,
149         "alias": null,
150         "protected": false,
151         "tagname": "method",
152         "href": "Base3.html#Ext-Base-method-createAlias",
153         "shortDoc": "Create aliases for existing prototype methods. ...",
154         "static": true,
155         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
156         "private": false,
157         "params": [
158           {
159             "type": "String/Object",
160             "optional": false,
161             "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",
162             "name": "alias"
163           },
164           {
165             "type": "String/Object",
166             "optional": false,
167             "doc": "<p>The original method name</p>\n",
168             "name": "origin"
169           }
170         ],
171         "name": "createAlias",
172         "owner": "Ext.Base",
173         "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",
174         "linenr": 648,
175         "return": {
176           "type": "void",
177           "doc": "\n"
178         },
179         "html_filename": "Base3.html"
180       },
181       {
182         "deprecated": null,
183         "alias": null,
184         "protected": false,
185         "tagname": "method",
186         "href": "Event.html#Ext-direct-Event-method-getData",
187         "shortDoc": "Return the raw data for this event. ...",
188         "static": false,
189         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/Event.js",
190         "private": false,
191         "params": [
192
193         ],
194         "name": "getData",
195         "owner": "Ext.direct.Event",
196         "doc": "<p>Return the raw data for this event.</p>\n",
197         "linenr": 28,
198         "return": {
199           "type": "Object",
200           "doc": "<p>The data from the event</p>\n"
201         },
202         "html_filename": "Event.html"
203       },
204       {
205         "deprecated": null,
206         "alias": null,
207         "protected": false,
208         "tagname": "method",
209         "href": "Base3.html#Ext-Base-method-getName",
210         "shortDoc": "Get the current class' name in string format. ...",
211         "static": false,
212         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
213         "private": false,
214         "params": [
215
216         ],
217         "name": "getName",
218         "owner": "Ext.Base",
219         "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",
220         "linenr": 631,
221         "return": {
222           "type": "String",
223           "doc": "<p>className</p>\n"
224         },
225         "html_filename": "Base3.html"
226       },
227       {
228         "deprecated": null,
229         "alias": null,
230         "protected": false,
231         "tagname": "method",
232         "href": "RemotingEvent.html#Ext-direct-RemotingEvent-method-getTransaction",
233         "shortDoc": "Get the transaction associated with this event. ...",
234         "static": false,
235         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/RemotingEvent.js",
236         "private": false,
237         "params": [
238
239         ],
240         "name": "getTransaction",
241         "owner": "Ext.direct.RemotingEvent",
242         "doc": "<p>Get the transaction associated with this event.</p>\n",
243         "linenr": 18,
244         "return": {
245           "type": "Ext.direct.Transaction",
246           "doc": "<p>The transaction</p>\n"
247         },
248         "html_filename": "RemotingEvent.html"
249       },
250       {
251         "deprecated": null,
252         "alias": null,
253         "protected": false,
254         "tagname": "method",
255         "href": "Base3.html#Ext-Base-method-implement",
256         "shortDoc": "Add methods / properties to the prototype of this class. ...",
257         "static": true,
258         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
259         "private": false,
260         "params": [
261           {
262             "type": "Object",
263             "optional": false,
264             "doc": "\n",
265             "name": "members"
266           }
267         ],
268         "name": "implement",
269         "owner": "Ext.Base",
270         "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",
271         "linenr": 415,
272         "return": {
273           "type": "void",
274           "doc": "\n"
275         },
276         "html_filename": "Base3.html"
277       },
278       {
279         "deprecated": null,
280         "alias": null,
281         "protected": true,
282         "tagname": "method",
283         "href": "Base3.html#Ext-Base-method-initConfig",
284         "shortDoc": "Initialize configuration for this class. ...",
285         "static": false,
286         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
287         "private": false,
288         "params": [
289           {
290             "type": "Object",
291             "optional": false,
292             "doc": "\n",
293             "name": "config"
294           }
295         ],
296         "name": "initConfig",
297         "owner": "Ext.Base",
298         "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",
299         "linenr": 63,
300         "return": {
301           "type": "Object",
302           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
303         },
304         "html_filename": "Base3.html"
305       },
306       {
307         "deprecated": null,
308         "alias": null,
309         "protected": false,
310         "tagname": "method",
311         "href": "Base3.html#Ext-Base-method-override",
312         "shortDoc": "Override prototype members of this class. ...",
313         "static": true,
314         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
315         "private": false,
316         "params": [
317           {
318             "type": "Object",
319             "optional": false,
320             "doc": "\n",
321             "name": "members"
322           }
323         ],
324         "name": "override",
325         "owner": "Ext.Base",
326         "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",
327         "linenr": 518,
328         "return": {
329           "type": "Ext.Base",
330           "doc": "<p>this</p>\n"
331         },
332         "html_filename": "Base3.html"
333       },
334       {
335         "deprecated": null,
336         "alias": null,
337         "protected": true,
338         "tagname": "method",
339         "href": "Base3.html#Ext-Base-method-statics",
340         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
341         "static": false,
342         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
343         "private": false,
344         "params": [
345
346         ],
347         "name": "statics",
348         "owner": "Ext.Base",
349         "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",
350         "linenr": 199,
351         "return": {
352           "type": "Class",
353           "doc": "\n"
354         },
355         "html_filename": "Base3.html"
356       }
357     ],
358     "property": [
359       {
360         "type": "Class",
361         "deprecated": null,
362         "alias": null,
363         "protected": true,
364         "tagname": "property",
365         "href": "Base3.html#Ext-Base-property-self",
366         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
367         "static": false,
368         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
369         "private": false,
370         "name": "self",
371         "owner": "Ext.Base",
372         "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",
373         "linenr": 18,
374         "html_filename": "Base3.html"
375       }
376     ],
377     "cssVar": [
378
379     ],
380     "cssMixin": [
381
382     ],
383     "event": [
384
385     ]
386   },
387   "singleton": false,
388   "alias": null,
389   "superclasses": [
390     "Ext.Base",
391     "Ext.direct.Event"
392   ],
393   "protected": false,
394   "tagname": "class",
395   "mixins": [
396
397   ],
398   "href": "RemotingEvent.html#Ext-direct-RemotingEvent",
399   "subclasses": [
400     "Ext.direct.ExceptionEvent"
401   ],
402   "static": false,
403   "author": null,
404   "component": false,
405   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/direct/RemotingEvent.js",
406   "private": false,
407   "alternateClassNames": [
408
409   ],
410   "name": "Ext.direct.RemotingEvent",
411   "doc": "<p>An event that is fired when data is received from a\n<a href=\"#/api/Ext.direct.RemotingProvider\" rel=\"Ext.direct.RemotingProvider\" class=\"docClass\">Ext.direct.RemotingProvider</a>. Contains a method to the\nrelated transaction for the direct request, see <a href=\"#/api/Ext.direct.RemotingEvent-method-getTransaction\" rel=\"Ext.direct.RemotingEvent-method-getTransaction\" class=\"docClass\">getTransaction</a></p>\n",
412   "mixedInto": [
413
414   ],
415   "linenr": 1,
416   "xtypes": [
417
418   ],
419   "html_filename": "RemotingEvent.html",
420   "extends": "Ext.direct.Event"
421 });