Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.app.EventBus.js
1 Ext.data.JsonP.Ext_app_EventBus({
2   "tagname": "class",
3   "name": "Ext.app.EventBus",
4   "doc": "<p>Class documentation for the MVC classes will be present before 4.0 final, in the mean time please refer to the MVC\nguide</p>\n",
5   "extends": null,
6   "mixins": [
7     "Ext.util.Observable"
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": true,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "listeners",
21       "member": "Ext.util.Observable",
22       "type": "Object",
23       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.app.EventBus-method-addListener\" rel=\"Ext.app.EventBus-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
26       "linenr": 103,
27       "html_filename": "Observable.html",
28       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
29       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
30     }
31   ],
32   "method": [
33     {
34       "tagname": "method",
35       "name": "addEvents",
36       "member": "Ext.util.Observable",
37       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
38       "params": [
39         {
40           "type": "Object/String",
41           "name": "o",
42           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
43           "optional": false
44         },
45         {
46           "type": "String",
47           "name": "",
48           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
49           "optional": false
50         }
51       ],
52       "return": {
53         "type": "void",
54         "doc": "\n"
55       },
56       "private": false,
57       "static": false,
58       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
59       "linenr": 452,
60       "html_filename": "Observable.html",
61       "href": "Observable.html#Ext-util-Observable-method-addEvents",
62       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
63     },
64     {
65       "tagname": "method",
66       "name": "addListener",
67       "member": "Ext.util.Observable",
68       "doc": "<p>Appends an event handler to this object.</p>\n",
69       "params": [
70         {
71           "type": "String",
72           "name": "eventName",
73           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
74           "optional": false
75         },
76         {
77           "type": "Function",
78           "name": "handler",
79           "doc": "<p>The method the event invokes.</p>\n",
80           "optional": false
81         },
82         {
83           "type": "Object",
84           "name": "scope",
85           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
86           "optional": true
87         },
88         {
89           "type": "Object",
90           "name": "options",
91           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
92           "optional": true
93         }
94       ],
95       "return": {
96         "type": "void",
97         "doc": "\n"
98       },
99       "private": false,
100       "static": false,
101       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
102       "linenr": 271,
103       "html_filename": "Observable.html",
104       "href": "Observable.html#Ext-util-Observable-method-addListener",
105       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
106     },
107     {
108       "tagname": "method",
109       "name": "addManagedListener",
110       "member": "Ext.util.Observable",
111       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
112       "params": [
113         {
114           "type": "Observable/Element",
115           "name": "item",
116           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
117           "optional": false
118         },
119         {
120           "type": "Object/String",
121           "name": "ename",
122           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
123           "optional": false
124         },
125         {
126           "type": "Function",
127           "name": "fn",
128           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
129           "optional": false
130         },
131         {
132           "type": "Object",
133           "name": "scope",
134           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
135           "optional": false
136         },
137         {
138           "type": "Object",
139           "name": "opt",
140           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
141           "optional": false
142         }
143       ],
144       "return": {
145         "type": "void",
146         "doc": "\n"
147       },
148       "private": false,
149       "static": false,
150       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
151       "linenr": 155,
152       "html_filename": "Observable.html",
153       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
154       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
155     },
156     {
157       "tagname": "method",
158       "name": "capture",
159       "member": "Ext.util.Observable",
160       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
161       "params": [
162         {
163           "type": "Observable",
164           "name": "o",
165           "doc": "<p>The Observable to capture events from.</p>\n",
166           "optional": false
167         },
168         {
169           "type": "Function",
170           "name": "fn",
171           "doc": "<p>The function to call when an event is fired.</p>\n",
172           "optional": false
173         },
174         {
175           "type": "Object",
176           "name": "scope",
177           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
178           "optional": true
179         }
180       ],
181       "return": {
182         "type": "void",
183         "doc": "\n"
184       },
185       "private": false,
186       "static": true,
187       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
188       "linenr": 55,
189       "html_filename": "Observable.html",
190       "href": "Observable.html#Ext-util-Observable-method-capture",
191       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
192     },
193     {
194       "tagname": "method",
195       "name": "clearListeners",
196       "member": "Ext.util.Observable",
197       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
198       "params": [
199
200       ],
201       "return": {
202         "type": "void",
203         "doc": "\n"
204       },
205       "private": false,
206       "static": false,
207       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
208       "linenr": 383,
209       "html_filename": "Observable.html",
210       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
211       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
212     },
213     {
214       "tagname": "method",
215       "name": "clearManagedListeners",
216       "member": "Ext.util.Observable",
217       "doc": "<p>Removes all managed listeners for this object.</p>\n",
218       "params": [
219
220       ],
221       "return": {
222         "type": "void",
223         "doc": "\n"
224       },
225       "private": false,
226       "static": false,
227       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
228       "linenr": 412,
229       "html_filename": "Observable.html",
230       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
231       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
232     },
233     {
234       "tagname": "method",
235       "name": "enableBubble",
236       "member": "Ext.util.Observable",
237       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
238       "params": [
239         {
240           "type": "String/Array",
241           "name": "events",
242           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
243           "optional": false
244         }
245       ],
246       "return": {
247         "type": "void",
248         "doc": "\n"
249       },
250       "private": false,
251       "static": false,
252       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
253       "linenr": 554,
254       "html_filename": "Observable.html",
255       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
256       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
257     },
258     {
259       "tagname": "method",
260       "name": "fireEvent",
261       "member": "Ext.util.Observable",
262       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.app.EventBus-method-enableBubble\" rel=\"Ext.app.EventBus-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
263       "params": [
264         {
265           "type": "String",
266           "name": "eventName",
267           "doc": "<p>The name of the event to fire.</p>\n",
268           "optional": false
269         },
270         {
271           "type": "Object...",
272           "name": "args",
273           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
274           "optional": false
275         }
276       ],
277       "return": {
278         "type": "Boolean",
279         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
280       },
281       "private": false,
282       "static": false,
283       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
284       "linenr": 232,
285       "html_filename": "Observable.html",
286       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
287       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
288     },
289     {
290       "tagname": "method",
291       "name": "hasListener",
292       "member": "Ext.util.Observable",
293       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
294       "params": [
295         {
296           "type": "String",
297           "name": "eventName",
298           "doc": "<p>The name of the event to check for</p>\n",
299           "optional": false
300         }
301       ],
302       "return": {
303         "type": "Boolean",
304         "doc": "<p>True if the event is being listened for, else false</p>\n"
305       },
306       "private": false,
307       "static": false,
308       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
309       "linenr": 480,
310       "html_filename": "Observable.html",
311       "href": "Observable.html#Ext-util-Observable-method-hasListener",
312       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
313     },
314     {
315       "tagname": "method",
316       "name": "observe",
317       "member": "Ext.util.Observable",
318       "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",
319       "params": [
320         {
321           "type": "Function",
322           "name": "c",
323           "doc": "<p>The class constructor to make observable.</p>\n",
324           "optional": false
325         },
326         {
327           "type": "Object",
328           "name": "listeners",
329           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.app.EventBus-method-addListener\" rel=\"Ext.app.EventBus-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
330           "optional": false
331         }
332       ],
333       "return": {
334         "type": "void",
335         "doc": "\n"
336       },
337       "private": false,
338       "static": true,
339       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
340       "linenr": 69,
341       "html_filename": "Observable.html",
342       "href": "Observable.html#Ext-util-Observable-method-observe",
343       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
344     },
345     {
346       "tagname": "method",
347       "name": "on",
348       "member": "Ext.util.Observable",
349       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.app.EventBus-method-addListener\" rel=\"Ext.app.EventBus-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
350       "params": [
351         {
352           "type": "String",
353           "name": "eventName",
354           "doc": "<p>The type of event to listen for</p>\n",
355           "optional": false
356         },
357         {
358           "type": "Function",
359           "name": "handler",
360           "doc": "<p>The method the event invokes</p>\n",
361           "optional": false
362         },
363         {
364           "type": "Object",
365           "name": "scope",
366           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
367           "optional": true
368         },
369         {
370           "type": "Object",
371           "name": "options",
372           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
373           "optional": true
374         }
375       ],
376       "return": {
377         "type": "void",
378         "doc": "\n"
379       },
380       "private": false,
381       "static": false,
382       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
383       "linenr": 616,
384       "html_filename": "Observable.html",
385       "href": "Observable.html#Ext-util-Observable-method-on",
386       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.app.EventBus-method-addListener\" rel=\"Ext.app.EventBus-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
387     },
388     {
389       "tagname": "method",
390       "name": "relayEvents",
391       "member": "Ext.util.Observable",
392       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
393       "params": [
394         {
395           "type": "Object",
396           "name": "origin",
397           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
398           "optional": false
399         },
400         {
401           "type": "Array",
402           "name": "events",
403           "doc": "<p>Array of event names to relay.</p>\n",
404           "optional": false
405         },
406         {
407           "type": "Object",
408           "name": "prefix",
409           "doc": "\n",
410           "optional": false
411         }
412       ],
413       "return": {
414         "type": "void",
415         "doc": "\n"
416       },
417       "private": false,
418       "static": false,
419       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
420       "linenr": 520,
421       "html_filename": "Observable.html",
422       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
423       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
424     },
425     {
426       "tagname": "method",
427       "name": "releaseCapture",
428       "member": "Ext.util.Observable",
429       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
430       "params": [
431         {
432           "type": "Observable",
433           "name": "o",
434           "doc": "<p>The Observable to release</p>\n",
435           "optional": false
436         }
437       ],
438       "return": {
439         "type": "void",
440         "doc": "\n"
441       },
442       "private": false,
443       "static": true,
444       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
445       "linenr": 46,
446       "html_filename": "Observable.html",
447       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
448       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
449     },
450     {
451       "tagname": "method",
452       "name": "removeListener",
453       "member": "Ext.util.Observable",
454       "doc": "<p>Removes an event handler.</p>\n",
455       "params": [
456         {
457           "type": "String",
458           "name": "eventName",
459           "doc": "<p>The type of event the handler was associated with.</p>\n",
460           "optional": false
461         },
462         {
463           "type": "Function",
464           "name": "handler",
465           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.app.EventBus-method-addListener\" rel=\"Ext.app.EventBus-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
466           "optional": false
467         },
468         {
469           "type": "Object",
470           "name": "scope",
471           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
472           "optional": true
473         }
474       ],
475       "return": {
476         "type": "void",
477         "doc": "\n"
478       },
479       "private": false,
480       "static": false,
481       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
482       "linenr": 352,
483       "html_filename": "Observable.html",
484       "href": "Observable.html#Ext-util-Observable-method-removeListener",
485       "shortDoc": "<p>Removes an event handler.</p>\n"
486     },
487     {
488       "tagname": "method",
489       "name": "removeManagedListener",
490       "member": "Ext.util.Observable",
491       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.app.EventBus--mon\" rel=\"Ext.app.EventBus--mon\" class=\"docClass\">mon</a> method.</p>\n",
492       "params": [
493         {
494           "type": "Observable|Element",
495           "name": "item",
496           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
497           "optional": false
498         },
499         {
500           "type": "Object|String",
501           "name": "ename",
502           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
503           "optional": false
504         },
505         {
506           "type": "Function",
507           "name": "fn",
508           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
509           "optional": false
510         },
511         {
512           "type": "Object",
513           "name": "scope",
514           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
515           "optional": false
516         }
517       ],
518       "return": {
519         "type": "void",
520         "doc": "\n"
521       },
522       "private": false,
523       "static": false,
524       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
525       "linenr": 196,
526       "html_filename": "Observable.html",
527       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
528       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.app.EventBus--mon\" rel=\"Ext.app.EventBus--mon\" class=\"docClass\">mon</a> method.</p>\n"
529     },
530     {
531       "tagname": "method",
532       "name": "resumeEvents",
533       "member": "Ext.util.Observable",
534       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.app.EventBus-method-suspendEvents\" rel=\"Ext.app.EventBus-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
535       "params": [
536
537       ],
538       "return": {
539         "type": "void",
540         "doc": "\n"
541       },
542       "private": false,
543       "static": false,
544       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
545       "linenr": 502,
546       "html_filename": "Observable.html",
547       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
548       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
549     },
550     {
551       "tagname": "method",
552       "name": "suspendEvents",
553       "member": "Ext.util.Observable",
554       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.app.EventBus-method-resumeEvents\" rel=\"Ext.app.EventBus-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
555       "params": [
556         {
557           "type": "Boolean",
558           "name": "queueSuspended",
559           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.app.EventBus-method-resumeEvents\" rel=\"Ext.app.EventBus-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
560           "optional": false
561         }
562       ],
563       "return": {
564         "type": "void",
565         "doc": "\n"
566       },
567       "private": false,
568       "static": false,
569       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
570       "linenr": 490,
571       "html_filename": "Observable.html",
572       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
573       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.app.EventBus-method-resumeEvents\" rel=\"Ext.app.EventBus-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
574     },
575     {
576       "tagname": "method",
577       "name": "un",
578       "member": "Ext.util.Observable",
579       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.app.EventBus-method-removeListener\" rel=\"Ext.app.EventBus-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
580       "params": [
581         {
582           "type": "String",
583           "name": "eventName",
584           "doc": "<p>The type of event the handler was associated with.</p>\n",
585           "optional": false
586         },
587         {
588           "type": "Function",
589           "name": "handler",
590           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.app.EventBus-method-addListener\" rel=\"Ext.app.EventBus-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
591           "optional": false
592         },
593         {
594           "type": "Object",
595           "name": "scope",
596           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
597           "optional": true
598         }
599       ],
600       "return": {
601         "type": "void",
602         "doc": "\n"
603       },
604       "private": false,
605       "static": false,
606       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
607       "linenr": 608,
608       "html_filename": "Observable.html",
609       "href": "Observable.html#Ext-util-Observable-method-un",
610       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.app.EventBus-method-removeListener\" rel=\"Ext.app.EventBus-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
611     }
612   ],
613   "property": [
614
615   ],
616   "event": [
617
618   ],
619   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/EventBus.js",
620   "linenr": 1,
621   "html_filename": "EventBus.html",
622   "href": "EventBus.html#Ext-app-EventBus",
623   "cssVar": [
624
625   ],
626   "cssMixin": [
627
628   ],
629   "component": false,
630   "superclasses": [
631
632   ],
633   "subclasses": [
634
635   ],
636   "mixedInto": [
637
638   ],
639   "allMixins": [
640     "Ext.util.Observable"
641   ]
642 });