Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.ElementLoader.js
1 Ext.data.JsonP.Ext_ElementLoader({
2   "tagname": "class",
3   "name": "Ext.ElementLoader",
4   "doc": "<p>A class used to load remote content to an Element. Sample usage:</p>\n\n<pre><code>Ext.get('el').load({\n    url: 'myPage.php',\n    scripts: true,\n    params: {\n        id: 1\n    }\n});\n</code></pre>\n\n\n<p>\nIn general this class will not be instanced directly, rather the <a href=\"#/api/Ext.core.Element-event-load\" rel=\"Ext.core.Element-event-load\" class=\"docClass\">Ext.core.Element.load</a> method\nwill be used.\n</p>\n\n",
5   "extends": null,
6   "mixins": [
7     "Ext.util.Observable"
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "ajaxOptions",
21       "member": "Ext.ElementLoader",
22       "type": "Object",
23       "doc": "<p>Any additional options to be passed to the request, for example timeout or headers. Defaults to <tt>null</tt>.</p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
26       "linenr": 75,
27       "html_filename": "ElementLoader.html",
28       "href": "ElementLoader.html#Ext-ElementLoader-cfg-ajaxOptions"
29     },
30     {
31       "tagname": "cfg",
32       "name": "autoLoad",
33       "member": "Ext.ElementLoader",
34       "type": "Boolean/Object",
35       "doc": "<p>True to have the loader make a request as soon as it is created. Defaults to <tt>false</tt>.\nThis argument can also be a set of options that will be passed to <a href=\"#/api/Ext.ElementLoader-method-load\" rel=\"Ext.ElementLoader-method-load\" class=\"docClass\">load</a> is called.</p>\n",
36       "private": false,
37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
38       "linenr": 59,
39       "html_filename": "ElementLoader.html",
40       "href": "ElementLoader.html#Ext-ElementLoader-cfg-autoLoad",
41       "shortDoc": "True to have the loader make a request as soon as it is created. Defaults to false.\nThis argument can also be a set o..."
42     },
43     {
44       "tagname": "cfg",
45       "name": "baseParams",
46       "member": "Ext.ElementLoader",
47       "type": "Object",
48       "doc": "<p>Params that will be attached to every request. These parameters\nwill not be overridden by any params in the load options. Defaults to <tt>null</tt>.</p>\n",
49       "private": false,
50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
51       "linenr": 53,
52       "html_filename": "ElementLoader.html",
53       "href": "ElementLoader.html#Ext-ElementLoader-cfg-baseParams",
54       "shortDoc": "Params that will be attached to every request. These parameters\nwill not be overridden by any params in the load opti..."
55     },
56     {
57       "tagname": "cfg",
58       "name": "failure",
59       "member": "Ext.ElementLoader",
60       "type": "Function",
61       "doc": "<p>A function to be called when a load request fails.</p>\n",
62       "private": false,
63       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
64       "linenr": 89,
65       "html_filename": "ElementLoader.html",
66       "href": "ElementLoader.html#Ext-ElementLoader-cfg-failure"
67     },
68     {
69       "tagname": "cfg",
70       "name": "listeners",
71       "member": "Ext.util.Observable",
72       "type": "Object",
73       "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.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-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",
74       "private": false,
75       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
76       "linenr": 103,
77       "html_filename": "Observable.html",
78       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
79       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
80     },
81     {
82       "tagname": "cfg",
83       "name": "loadMask",
84       "member": "Ext.ElementLoader",
85       "type": "Mixed",
86       "doc": "<p>True or a string to show when the element is loading.</p>\n",
87       "private": false,
88       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
89       "linenr": 70,
90       "html_filename": "ElementLoader.html",
91       "href": "ElementLoader.html#Ext-ElementLoader-cfg-loadMask"
92     },
93     {
94       "tagname": "cfg",
95       "name": "params",
96       "member": "Ext.ElementLoader",
97       "type": "Object",
98       "doc": "<p>Any params to be attached to the Ajax request. These parameters will\nbe overridden by any params in the load options. Defaults to <tt>null</tt>.</p>\n",
99       "private": false,
100       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
101       "linenr": 47,
102       "html_filename": "ElementLoader.html",
103       "href": "ElementLoader.html#Ext-ElementLoader-cfg-params",
104       "shortDoc": "Any params to be attached to the Ajax request. These parameters will\nbe overridden by any params in the load options...."
105     },
106     {
107       "tagname": "cfg",
108       "name": "renderer",
109       "member": "Ext.ElementLoader",
110       "type": "Function",
111       "doc": "<p>A custom function to render the content to the element. The passed parameters\nare</p>\n\n<ul>\n<li>The loader</li>\n<li>The response</li>\n<li>The active request</li>\n</ul>\n\n",
112       "private": false,
113       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
114       "linenr": 97,
115       "html_filename": "ElementLoader.html",
116       "href": "ElementLoader.html#Ext-ElementLoader-cfg-renderer",
117       "shortDoc": "A custom function to render the content to the element. The passed parameters\nare\n\n\nThe loader\nThe response\nThe activ..."
118     },
119     {
120       "tagname": "cfg",
121       "name": "scope",
122       "member": "Ext.ElementLoader",
123       "type": "Object",
124       "doc": "<p>The scope to execute the <a href=\"#/api/Ext.ElementLoader-cfg-success\" rel=\"Ext.ElementLoader-cfg-success\" class=\"docClass\">success</a> and <a href=\"#/api/Ext.ElementLoader-cfg-failure\" rel=\"Ext.ElementLoader-cfg-failure\" class=\"docClass\">failure</a> functions in.</p>\n",
125       "private": false,
126       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
127       "linenr": 93,
128       "html_filename": "ElementLoader.html",
129       "href": "ElementLoader.html#Ext-ElementLoader-cfg-scope"
130     },
131     {
132       "tagname": "cfg",
133       "name": "scripts",
134       "member": "Ext.ElementLoader",
135       "type": "Boolean",
136       "doc": "<p>True to parse any inline script tags in the response.</p>\n",
137       "private": false,
138       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
139       "linenr": 80,
140       "html_filename": "ElementLoader.html",
141       "href": "ElementLoader.html#Ext-ElementLoader-cfg-scripts"
142     },
143     {
144       "tagname": "cfg",
145       "name": "success",
146       "member": "Ext.ElementLoader",
147       "type": "Function",
148       "doc": "<p>A function to be called when a load request is successful.</p>\n",
149       "private": false,
150       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
151       "linenr": 85,
152       "html_filename": "ElementLoader.html",
153       "href": "ElementLoader.html#Ext-ElementLoader-cfg-success"
154     },
155     {
156       "tagname": "cfg",
157       "name": "target",
158       "member": "Ext.ElementLoader",
159       "type": "Mixed",
160       "doc": "<p>The target element for the loader. It can be the DOM element, the id or an Ext.Element.</p>\n",
161       "private": false,
162       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
163       "linenr": 65,
164       "html_filename": "ElementLoader.html",
165       "href": "ElementLoader.html#Ext-ElementLoader-cfg-target"
166     },
167     {
168       "tagname": "cfg",
169       "name": "url",
170       "member": "Ext.ElementLoader",
171       "type": "String",
172       "doc": "<p>The url to retrieve the content from. Defaults to <tt>null</tt>.</p>\n",
173       "private": false,
174       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
175       "linenr": 42,
176       "html_filename": "ElementLoader.html",
177       "href": "ElementLoader.html#Ext-ElementLoader-cfg-url"
178     }
179   ],
180   "method": [
181     {
182       "tagname": "method",
183       "name": "abort",
184       "member": "Ext.ElementLoader",
185       "doc": "<p>Aborts the active load request</p>\n",
186       "params": [
187
188       ],
189       "return": {
190         "type": "void",
191         "doc": "\n"
192       },
193       "private": false,
194       "static": false,
195       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
196       "linenr": 180,
197       "html_filename": "ElementLoader.html",
198       "href": "ElementLoader.html#Ext-ElementLoader-method-abort",
199       "shortDoc": "<p>Aborts the active load request</p>\n"
200     },
201     {
202       "tagname": "method",
203       "name": "addEvents",
204       "member": "Ext.util.Observable",
205       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
206       "params": [
207         {
208           "type": "Object/String",
209           "name": "o",
210           "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",
211           "optional": false
212         },
213         {
214           "type": "String",
215           "name": "",
216           "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",
217           "optional": false
218         }
219       ],
220       "return": {
221         "type": "void",
222         "doc": "\n"
223       },
224       "private": false,
225       "static": false,
226       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
227       "linenr": 452,
228       "html_filename": "Observable.html",
229       "href": "Observable.html#Ext-util-Observable-method-addEvents",
230       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
231     },
232     {
233       "tagname": "method",
234       "name": "addListener",
235       "member": "Ext.util.Observable",
236       "doc": "<p>Appends an event handler to this object.</p>\n",
237       "params": [
238         {
239           "type": "String",
240           "name": "eventName",
241           "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",
242           "optional": false
243         },
244         {
245           "type": "Function",
246           "name": "handler",
247           "doc": "<p>The method the event invokes.</p>\n",
248           "optional": false
249         },
250         {
251           "type": "Object",
252           "name": "scope",
253           "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",
254           "optional": true
255         },
256         {
257           "type": "Object",
258           "name": "options",
259           "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",
260           "optional": true
261         }
262       ],
263       "return": {
264         "type": "void",
265         "doc": "\n"
266       },
267       "private": false,
268       "static": false,
269       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
270       "linenr": 271,
271       "html_filename": "Observable.html",
272       "href": "Observable.html#Ext-util-Observable-method-addListener",
273       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
274     },
275     {
276       "tagname": "method",
277       "name": "addManagedListener",
278       "member": "Ext.util.Observable",
279       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
280       "params": [
281         {
282           "type": "Observable/Element",
283           "name": "item",
284           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
285           "optional": false
286         },
287         {
288           "type": "Object/String",
289           "name": "ename",
290           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
291           "optional": false
292         },
293         {
294           "type": "Function",
295           "name": "fn",
296           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
297           "optional": false
298         },
299         {
300           "type": "Object",
301           "name": "scope",
302           "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",
303           "optional": false
304         },
305         {
306           "type": "Object",
307           "name": "opt",
308           "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",
309           "optional": false
310         }
311       ],
312       "return": {
313         "type": "void",
314         "doc": "\n"
315       },
316       "private": false,
317       "static": false,
318       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
319       "linenr": 155,
320       "html_filename": "Observable.html",
321       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
322       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
323     },
324     {
325       "tagname": "method",
326       "name": "capture",
327       "member": "Ext.util.Observable",
328       "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",
329       "params": [
330         {
331           "type": "Observable",
332           "name": "o",
333           "doc": "<p>The Observable to capture events from.</p>\n",
334           "optional": false
335         },
336         {
337           "type": "Function",
338           "name": "fn",
339           "doc": "<p>The function to call when an event is fired.</p>\n",
340           "optional": false
341         },
342         {
343           "type": "Object",
344           "name": "scope",
345           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
346           "optional": true
347         }
348       ],
349       "return": {
350         "type": "void",
351         "doc": "\n"
352       },
353       "private": false,
354       "static": true,
355       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
356       "linenr": 55,
357       "html_filename": "Observable.html",
358       "href": "Observable.html#Ext-util-Observable-method-capture",
359       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
360     },
361     {
362       "tagname": "method",
363       "name": "clearListeners",
364       "member": "Ext.util.Observable",
365       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
366       "params": [
367
368       ],
369       "return": {
370         "type": "void",
371         "doc": "\n"
372       },
373       "private": false,
374       "static": false,
375       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
376       "linenr": 383,
377       "html_filename": "Observable.html",
378       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
379       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
380     },
381     {
382       "tagname": "method",
383       "name": "clearManagedListeners",
384       "member": "Ext.util.Observable",
385       "doc": "<p>Removes all managed listeners for this object.</p>\n",
386       "params": [
387
388       ],
389       "return": {
390         "type": "void",
391         "doc": "\n"
392       },
393       "private": false,
394       "static": false,
395       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
396       "linenr": 412,
397       "html_filename": "Observable.html",
398       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
399       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
400     },
401     {
402       "tagname": "method",
403       "name": "destroy",
404       "member": "Ext.ElementLoader",
405       "doc": "<p>Destroys the loader. Any active requests will be aborted.</p>\n",
406       "params": [
407
408       ],
409       "return": {
410         "type": "void",
411         "doc": "\n"
412       },
413       "private": false,
414       "static": false,
415       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
416       "linenr": 364,
417       "html_filename": "ElementLoader.html",
418       "href": "ElementLoader.html#Ext-ElementLoader-method-destroy",
419       "shortDoc": "<p>Destroys the loader. Any active requests will be aborted.</p>\n"
420     },
421     {
422       "tagname": "method",
423       "name": "enableBubble",
424       "member": "Ext.util.Observable",
425       "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",
426       "params": [
427         {
428           "type": "String/Array",
429           "name": "events",
430           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
431           "optional": false
432         }
433       ],
434       "return": {
435         "type": "void",
436         "doc": "\n"
437       },
438       "private": false,
439       "static": false,
440       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
441       "linenr": 554,
442       "html_filename": "Observable.html",
443       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
444       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
445     },
446     {
447       "tagname": "method",
448       "name": "fireEvent",
449       "member": "Ext.util.Observable",
450       "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.ElementLoader-method-enableBubble\" rel=\"Ext.ElementLoader-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
451       "params": [
452         {
453           "type": "String",
454           "name": "eventName",
455           "doc": "<p>The name of the event to fire.</p>\n",
456           "optional": false
457         },
458         {
459           "type": "Object...",
460           "name": "args",
461           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
462           "optional": false
463         }
464       ],
465       "return": {
466         "type": "Boolean",
467         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
468       },
469       "private": false,
470       "static": false,
471       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
472       "linenr": 232,
473       "html_filename": "Observable.html",
474       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
475       "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..."
476     },
477     {
478       "tagname": "method",
479       "name": "getTarget",
480       "member": "Ext.ElementLoader",
481       "doc": "<p>Get the target of this loader.</p>\n",
482       "params": [
483
484       ],
485       "return": {
486         "type": "Ext.Component",
487         "doc": "<p>target The target, null if none exists.</p>\n"
488       },
489       "private": false,
490       "static": false,
491       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
492       "linenr": 172,
493       "html_filename": "ElementLoader.html",
494       "href": "ElementLoader.html#Ext-ElementLoader-method-getTarget",
495       "shortDoc": "<p>Get the target of this loader.</p>\n"
496     },
497     {
498       "tagname": "method",
499       "name": "hasListener",
500       "member": "Ext.util.Observable",
501       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
502       "params": [
503         {
504           "type": "String",
505           "name": "eventName",
506           "doc": "<p>The name of the event to check for</p>\n",
507           "optional": false
508         }
509       ],
510       "return": {
511         "type": "Boolean",
512         "doc": "<p>True if the event is being listened for, else false</p>\n"
513       },
514       "private": false,
515       "static": false,
516       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
517       "linenr": 480,
518       "html_filename": "Observable.html",
519       "href": "Observable.html#Ext-util-Observable-method-hasListener",
520       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
521     },
522     {
523       "tagname": "method",
524       "name": "isAutoRefreshing",
525       "member": "Ext.ElementLoader",
526       "doc": "<p>Checks whether the loader is automatically refreshing. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n",
527       "params": [
528
529       ],
530       "return": {
531         "type": "Boolean",
532         "doc": "<p>True if the loader is automatically refreshing</p>\n"
533       },
534       "private": false,
535       "static": false,
536       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
537       "linenr": 356,
538       "html_filename": "ElementLoader.html",
539       "href": "ElementLoader.html#Ext-ElementLoader-method-isAutoRefreshing",
540       "shortDoc": "<p>Checks whether the loader is automatically refreshing. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n"
541     },
542     {
543       "tagname": "method",
544       "name": "load",
545       "member": "Ext.ElementLoader",
546       "doc": "<p>Load new data from the server.</p>\n",
547       "params": [
548         {
549           "type": "Object",
550           "name": "options",
551           "doc": "<p>The options for the request. They can be any configuration option that can be specified for\nthe class, with the exception of the target option. Note that any options passed to the method will override any\nclass defaults.</p>\n",
552           "optional": false
553         }
554       ],
555       "return": {
556         "type": "void",
557         "doc": "\n"
558       },
559       "private": false,
560       "static": false,
561       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
562       "linenr": 211,
563       "html_filename": "ElementLoader.html",
564       "href": "ElementLoader.html#Ext-ElementLoader-method-load",
565       "shortDoc": "<p>Load new data from the server.</p>\n"
566     },
567     {
568       "tagname": "method",
569       "name": "observe",
570       "member": "Ext.util.Observable",
571       "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",
572       "params": [
573         {
574           "type": "Function",
575           "name": "c",
576           "doc": "<p>The class constructor to make observable.</p>\n",
577           "optional": false
578         },
579         {
580           "type": "Object",
581           "name": "listeners",
582           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
583           "optional": false
584         }
585       ],
586       "return": {
587         "type": "void",
588         "doc": "\n"
589       },
590       "private": false,
591       "static": true,
592       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
593       "linenr": 69,
594       "html_filename": "Observable.html",
595       "href": "Observable.html#Ext-util-Observable-method-observe",
596       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
597     },
598     {
599       "tagname": "method",
600       "name": "on",
601       "member": "Ext.util.Observable",
602       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
603       "params": [
604         {
605           "type": "String",
606           "name": "eventName",
607           "doc": "<p>The type of event to listen for</p>\n",
608           "optional": false
609         },
610         {
611           "type": "Function",
612           "name": "handler",
613           "doc": "<p>The method the event invokes</p>\n",
614           "optional": false
615         },
616         {
617           "type": "Object",
618           "name": "scope",
619           "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",
620           "optional": true
621         },
622         {
623           "type": "Object",
624           "name": "options",
625           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
626           "optional": true
627         }
628       ],
629       "return": {
630         "type": "void",
631         "doc": "\n"
632       },
633       "private": false,
634       "static": false,
635       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
636       "linenr": 616,
637       "html_filename": "Observable.html",
638       "href": "Observable.html#Ext-util-Observable-method-on",
639       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
640     },
641     {
642       "tagname": "method",
643       "name": "relayEvents",
644       "member": "Ext.util.Observable",
645       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
646       "params": [
647         {
648           "type": "Object",
649           "name": "origin",
650           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
651           "optional": false
652         },
653         {
654           "type": "Array",
655           "name": "events",
656           "doc": "<p>Array of event names to relay.</p>\n",
657           "optional": false
658         },
659         {
660           "type": "Object",
661           "name": "prefix",
662           "doc": "\n",
663           "optional": false
664         }
665       ],
666       "return": {
667         "type": "void",
668         "doc": "\n"
669       },
670       "private": false,
671       "static": false,
672       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
673       "linenr": 520,
674       "html_filename": "Observable.html",
675       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
676       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
677     },
678     {
679       "tagname": "method",
680       "name": "releaseCapture",
681       "member": "Ext.util.Observable",
682       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
683       "params": [
684         {
685           "type": "Observable",
686           "name": "o",
687           "doc": "<p>The Observable to release</p>\n",
688           "optional": false
689         }
690       ],
691       "return": {
692         "type": "void",
693         "doc": "\n"
694       },
695       "private": false,
696       "static": true,
697       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
698       "linenr": 46,
699       "html_filename": "Observable.html",
700       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
701       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
702     },
703     {
704       "tagname": "method",
705       "name": "removeListener",
706       "member": "Ext.util.Observable",
707       "doc": "<p>Removes an event handler.</p>\n",
708       "params": [
709         {
710           "type": "String",
711           "name": "eventName",
712           "doc": "<p>The type of event the handler was associated with.</p>\n",
713           "optional": false
714         },
715         {
716           "type": "Function",
717           "name": "handler",
718           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
719           "optional": false
720         },
721         {
722           "type": "Object",
723           "name": "scope",
724           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
725           "optional": true
726         }
727       ],
728       "return": {
729         "type": "void",
730         "doc": "\n"
731       },
732       "private": false,
733       "static": false,
734       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
735       "linenr": 352,
736       "html_filename": "Observable.html",
737       "href": "Observable.html#Ext-util-Observable-method-removeListener",
738       "shortDoc": "<p>Removes an event handler.</p>\n"
739     },
740     {
741       "tagname": "method",
742       "name": "removeManagedListener",
743       "member": "Ext.util.Observable",
744       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.ElementLoader--mon\" rel=\"Ext.ElementLoader--mon\" class=\"docClass\">mon</a> method.</p>\n",
745       "params": [
746         {
747           "type": "Observable|Element",
748           "name": "item",
749           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
750           "optional": false
751         },
752         {
753           "type": "Object|String",
754           "name": "ename",
755           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
756           "optional": false
757         },
758         {
759           "type": "Function",
760           "name": "fn",
761           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
762           "optional": false
763         },
764         {
765           "type": "Object",
766           "name": "scope",
767           "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",
768           "optional": false
769         }
770       ],
771       "return": {
772         "type": "void",
773         "doc": "\n"
774       },
775       "private": false,
776       "static": false,
777       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
778       "linenr": 196,
779       "html_filename": "Observable.html",
780       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
781       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.ElementLoader--mon\" rel=\"Ext.ElementLoader--mon\" class=\"docClass\">mon</a> method.</p>\n"
782     },
783     {
784       "tagname": "method",
785       "name": "resumeEvents",
786       "member": "Ext.util.Observable",
787       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.ElementLoader-method-suspendEvents\" rel=\"Ext.ElementLoader-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",
788       "params": [
789
790       ],
791       "return": {
792         "type": "void",
793         "doc": "\n"
794       },
795       "private": false,
796       "static": false,
797       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
798       "linenr": 502,
799       "html_filename": "Observable.html",
800       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
801       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
802     },
803     {
804       "tagname": "method",
805       "name": "setTarget",
806       "member": "Ext.ElementLoader",
807       "doc": "<p>Set an {Ext.Element} as the target of this loader. Note that if the target is changed,\nany active requests will be aborted.</p>\n",
808       "params": [
809         {
810           "type": "Mixed",
811           "name": "target",
812           "doc": "<p>The element</p>\n",
813           "optional": false
814         }
815       ],
816       "return": {
817         "type": "void",
818         "doc": "\n"
819       },
820       "private": false,
821       "static": false,
822       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
823       "linenr": 158,
824       "html_filename": "ElementLoader.html",
825       "href": "ElementLoader.html#Ext-ElementLoader-method-setTarget",
826       "shortDoc": "Set an {Ext.Element} as the target of this loader. Note that if the target is changed,\nany active requests will be ab..."
827     },
828     {
829       "tagname": "method",
830       "name": "startAutoRefresh",
831       "member": "Ext.ElementLoader",
832       "doc": "<p>Automatically refreshes the content over a specified period.</p>\n",
833       "params": [
834         {
835           "type": "Number",
836           "name": "interval",
837           "doc": "<p>The interval to refresh in ms.</p>\n",
838           "optional": false
839         },
840         {
841           "type": "Object",
842           "name": "options",
843           "doc": "<p>(optional) The options to pass to the load method. See <a href=\"#/api/Ext.ElementLoader-method-load\" rel=\"Ext.ElementLoader-method-load\" class=\"docClass\">load</a></p>\n",
844           "optional": true
845         }
846       ],
847       "return": {
848         "type": "void",
849         "doc": "\n"
850       },
851       "private": false,
852       "static": false,
853       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
854       "linenr": 335,
855       "html_filename": "ElementLoader.html",
856       "href": "ElementLoader.html#Ext-ElementLoader-method-startAutoRefresh",
857       "shortDoc": "<p>Automatically refreshes the content over a specified period.</p>\n"
858     },
859     {
860       "tagname": "method",
861       "name": "stopAutoRefresh",
862       "member": "Ext.ElementLoader",
863       "doc": "<p>Clears any auto refresh. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n",
864       "params": [
865
866       ],
867       "return": {
868         "type": "void",
869         "doc": "\n"
870       },
871       "private": false,
872       "static": false,
873       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
874       "linenr": 348,
875       "html_filename": "ElementLoader.html",
876       "href": "ElementLoader.html#Ext-ElementLoader-method-stopAutoRefresh",
877       "shortDoc": "<p>Clears any auto refresh. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n"
878     },
879     {
880       "tagname": "method",
881       "name": "suspendEvents",
882       "member": "Ext.util.Observable",
883       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.ElementLoader-method-resumeEvents\" rel=\"Ext.ElementLoader-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
884       "params": [
885         {
886           "type": "Boolean",
887           "name": "queueSuspended",
888           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.ElementLoader-method-resumeEvents\" rel=\"Ext.ElementLoader-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
889           "optional": false
890         }
891       ],
892       "return": {
893         "type": "void",
894         "doc": "\n"
895       },
896       "private": false,
897       "static": false,
898       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
899       "linenr": 490,
900       "html_filename": "Observable.html",
901       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
902       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.ElementLoader-method-resumeEvents\" rel=\"Ext.ElementLoader-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
903     },
904     {
905       "tagname": "method",
906       "name": "un",
907       "member": "Ext.util.Observable",
908       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.ElementLoader-method-removeListener\" rel=\"Ext.ElementLoader-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
909       "params": [
910         {
911           "type": "String",
912           "name": "eventName",
913           "doc": "<p>The type of event the handler was associated with.</p>\n",
914           "optional": false
915         },
916         {
917           "type": "Function",
918           "name": "handler",
919           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
920           "optional": false
921         },
922         {
923           "type": "Object",
924           "name": "scope",
925           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
926           "optional": true
927         }
928       ],
929       "return": {
930         "type": "void",
931         "doc": "\n"
932       },
933       "private": false,
934       "static": false,
935       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
936       "linenr": 608,
937       "html_filename": "Observable.html",
938       "href": "Observable.html#Ext-util-Observable-method-un",
939       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.ElementLoader-method-removeListener\" rel=\"Ext.ElementLoader-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
940     }
941   ],
942   "property": [
943
944   ],
945   "event": [
946     {
947       "tagname": "event",
948       "name": "beforeload",
949       "member": "Ext.ElementLoader",
950       "doc": "<p>Fires before a load request is made to the server.\nReturning false from an event listener can prevent the load\nfrom occurring.</p>\n",
951       "params": [
952         {
953           "type": "Ext.ElementLoader",
954           "name": "this",
955           "doc": "\n",
956           "optional": false
957         },
958         {
959           "type": "Object",
960           "name": "options",
961           "doc": "<p>The options passed to the request</p>\n",
962           "optional": false
963         }
964       ],
965       "private": false,
966       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
967       "linenr": 117,
968       "html_filename": "ElementLoader.html",
969       "href": "ElementLoader.html#Ext-ElementLoader-event-beforeload",
970       "shortDoc": "Fires before a load request is made to the server.\nReturning false from an event listener can prevent the load\nfrom o..."
971     },
972     {
973       "tagname": "event",
974       "name": "exception",
975       "member": "Ext.ElementLoader",
976       "doc": "<p>Fires after a successful load.</p>\n",
977       "params": [
978         {
979           "type": "Ext.ElementLoader",
980           "name": "this",
981           "doc": "\n",
982           "optional": false
983         },
984         {
985           "type": "Object",
986           "name": "response",
987           "doc": "<p>The response from the server</p>\n",
988           "optional": false
989         },
990         {
991           "type": "Object",
992           "name": "options",
993           "doc": "<p>The options passed to the request</p>\n",
994           "optional": false
995         }
996       ],
997       "private": false,
998       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
999       "linenr": 136,
1000       "html_filename": "ElementLoader.html",
1001       "href": "ElementLoader.html#Ext-ElementLoader-event-exception",
1002       "shortDoc": "<p>Fires after a successful load.</p>\n"
1003     }
1004   ],
1005   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
1006   "linenr": 1,
1007   "html_filename": "ElementLoader.html",
1008   "href": "ElementLoader.html#Ext-ElementLoader",
1009   "cssVar": [
1010
1011   ],
1012   "cssMixin": [
1013
1014   ],
1015   "component": false,
1016   "superclasses": [
1017
1018   ],
1019   "subclasses": [
1020     "Ext.ComponentLoader"
1021   ],
1022   "mixedInto": [
1023
1024   ],
1025   "allMixins": [
1026     "Ext.util.Observable"
1027   ]
1028 });