1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>
<img src="resources/elbow-end.gif">TreeLoader</pre></div><h1>Class <a href="source/TreeLoader.html#cls-Ext.tree.TreeLoader">Ext.tree.TreeLoader</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/TreeLoader.html#cls-Ext.tree.TreeLoader">TreeLoader.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreeLoader.html#cls-Ext.tree.TreeLoader">TreeLoader</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description">A TreeLoader provides for lazy loading of an <a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">Ext.tree.TreeNode</a>'s child
nodes from a specified URL. The response must be a JavaScript Array definition
whose elements are node definition objects. e.g.:
<pre><code>[{
id: 1,
text: <em>'A leaf Node'</em>,
leaf: true
},{
id: 2,
text: <em>'A folder Node'</em>,
children: [{
id: 3,
text: <em>'A child Node'</em>,
leaf: true
}]
}]</code></pre>
<br><br>
A server request is sent, and child nodes are loaded only when a node is expanded.
The loading node's id is passed to the server under the parameter name "node" to
enable the server to produce the correct child nodes.
<br><br>
To pass extra parameters, an event handler may be attached to the "beforeload"
event, and the parameters specified in the TreeLoader's baseParams property:
<pre><code>myTreeLoader.on(<em>"beforeload"</em>, <b>function</b>(treeLoader, node) {
this.baseParams.category = node.attributes.category;
}, this);</code></pre>
This would pass an HTTP parameter called "category" to the server containing
the value of the Node's "category" attribute.</div><div class="hr"></div><a id="Ext.tree.TreeLoader-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-baseAttrs"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-baseAttrs">baseAttrs</a></b> : Object<div class="mdesc"><div class="short">An object containing attributes to be added to all nodes
created by this loader. If the attributes sent by the server...</div><div class="long">An object containing attributes to be added to all nodes
created by this loader. If the attributes sent by the server have an attribute in this object,
they take priority.</div></div></td><td class="msource">TreeLoader</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-baseParams"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-baseParams">baseParams</a></b> : Object<div class="mdesc">An object containing properties which
specify HTTP parameters to be passed to each request for child nodes.</div></td><td class="msource">TreeLoader</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-clearOnLoad"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-clearOnLoad">clearOnLoad</a></b> : Boolean<div class="mdesc">Default to true. Remove previously existing
child nodes before loading.</div></td><td class="msource">TreeLoader</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-dataUrl"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-dataUrl">dataUrl</a></b> : String<div class="mdesc"><div class="short">The URL from which to request a Json string which
specifies an array of node definition objects representing the chil...</div><div class="long">The URL from which to request a Json string which
specifies an array of node definition objects representing the child nodes
to be loaded.</div></div></td><td class="msource">TreeLoader</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-directFn"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-directFn">directFn</a></b> : Function<div class="mdesc">Function to call when executing a request.</div></td><td class="msource">TreeLoader</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
object during initialization. This should be a valid listeners config object as specified in the
<a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
<br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
<b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
<i>// The Component is appended to the argument list of all handler functions.</i>
Ext.DomObserver = Ext.extend(Object, {
constructor: <b>function</b>(config) {
this.listeners = config.listeners ? config.listeners : config;
},
<i>// Component passes itself into plugin's init method</i>
init: <b>function</b>(c) {
<b>var</b> p, l = this.listeners;
<b>for</b> (p <b>in</b> l) {
<b>if</b> (Ext.isFunction(l[p])) {
l[p] = this.createHandler(l[p], c);
} <b>else</b> {
l[p].fn = this.createHandler(l[p].fn, c);
}
}
<i>// Add the listeners to the Element immediately following the render call</i>
c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
<b>var</b> e = c.getEl();
<b>if</b> (e) {
e.on(l);
}
});
},
createHandler: <b>function</b>(fn, c) {
<b>return</b> <b>function</b>(e) {
fn.call(this, e, c);
};
}
});
<b>var</b> combo = <b>new</b> Ext.form.ComboBox({
<i>// Collapse combo when its element is clicked on</i>
plugins: [ <b>new</b> Ext.DomObserver({
click: <b>function</b>(evt, comp) {
comp.collapse();
}
})],
store: myStore,
typeAhead: true,
mode: <em>'local'</em>,
triggerAction: <em>'all'</em>
});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-nodeParameter"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-nodeParameter">nodeParameter</a></b> : String<div class="mdesc">The name of the parameter sent to the server which contains
the identifier of the node. Defaults to <tt>'node'</tt>.</div></td><td class="msource">TreeLoader</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-paramOrder"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-paramOrder">paramOrder</a></b> : Array/String<div class="mdesc"><div class="short">Defaults to undefined. Only used when using directFn.
Specifies the params in the order in which they must be passed ...</div><div class="long">Defaults to <tt>undefined</tt>. Only used when using directFn.
Specifies the params in the order in which they must be passed to the server-side Direct method
as either (1) an Array of String values, or (2) a String of params delimited by either whitespace,
comma, or pipe. For example,
any of the following would be acceptable:<pre><code>nodeParameter: <em>'node'</em>,
paramOrder: [<em>'param1'</em>,<em>'param2'</em>,<em>'param3'</em>]
paramOrder: <em>'node param1 param2 param3'</em>
paramOrder: <em>'param1,node,param2,param3'</em>
paramOrder: <em>'param1|param2|param|node'</em></code></pre></div></div></td><td class="msource">TreeLoader</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-paramsAsHash"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-paramsAsHash">paramsAsHash</a></b> : Boolean<div class="mdesc"><div class="short">Only used when using directFn.
Send parameters as a collection of named arguments (defaults to false). Providing a
pa...</div><div class="long">Only used when using directFn.
Send parameters as a collection of named arguments (defaults to <tt>false</tt>). Providing a
<tt><a href="output/Ext.tree.TreeLoader.html#Ext.tree.TreeLoader-paramOrder" ext:member="paramOrder" ext:cls="Ext.tree.TreeLoader">paramOrder</a></tt> nullifies this configuration.</div></div></td><td class="msource">TreeLoader</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-preloadChildren"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-preloadChildren">preloadChildren</a></b> : Boolean<div class="mdesc">If set to true, the loader recursively loads "children" attributes when doing the first load on nodes.</div></td><td class="msource">TreeLoader</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-requestMethod"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-requestMethod">requestMethod</a></b> : String<div class="mdesc">The HTTP request method for loading data (defaults to the value of <a href="output/Ext.Ajax.html#Ext.Ajax-method" ext:member="method" ext:cls="Ext.Ajax">Ext.Ajax.method</a>).</div></td><td class="msource">TreeLoader</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-uiProviders"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-uiProviders">uiProviders</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which
specify custom Ext.tree.TreeNodeUI implementations. If the optional
uiProvider ...</div><div class="long">An object containing properties which
specify custom <a href="output/Ext.tree.TreeNodeUI.html" ext:cls="Ext.tree.TreeNodeUI">Ext.tree.TreeNodeUI</a> implementations. If the optional
<i>uiProvider</i> attribute of a returned child node is a string rather
than a reference to a TreeNodeUI implementation, then that string value
is used as a property name in the uiProviders object.</div></div></td><td class="msource">TreeLoader</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-url"></a><b><a href="source/TreeLoader.html#cfg-Ext.tree.TreeLoader-url">url</a></b> : String<div class="mdesc">Equivalent to <a href="output/Ext.tree.TreeLoader.html#Ext.tree.TreeLoader-dataUrl" ext:member="dataUrl" ext:cls="Ext.tree.TreeLoader">dataUrl</a>.</div></td><td class="msource">TreeLoader</td></tr></tbody></table><a id="Ext.tree.TreeLoader-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.tree.TreeLoader-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-TreeLoader"></a><b class="constructor"><a href="source/TreeLoader.html#cls-Ext.tree.TreeLoader">TreeLoader</a></b><span class="openparen">( </span><span title="Required" class="required">Object config</span><span class="closeparen"> )</span><div class="mdesc"><div class="short">Creates a new Treeloader.</div><div class="long">Creates a new Treeloader.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">A config object containing config properties.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeLoader</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b><span class="openparen">( </span><span title="Required" class="required">Object|String o</span><span class="comma">, </span><span title="Required" class="required">string Optional.</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b><span class="openparen">( </span><span title="Required" class="required">String eventName</span><span class="comma">, </span><span title="Required" class="required">Function handler</span><span class="comma">, </span><span title="Optional" class="optional">[Object scope]</span><span class="comma">, </span><span title="Optional" class="optional">[Object options]</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
properties. This may contain any of the following properties:<ul>
<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
<b>If omitted, defaults to the object which fired the event.</b></div></li>
<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>
<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>
<li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
by the specified number of milliseconds. If the event fires again within that time, the original
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
<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>
if the event was bubbled up from a child Observable.</div></li>
</ul><br>
<p>
<b>Combining Options</b><br>
Using the options argument, it is possible to combine different types of listeners:<br>
<br>
A delayed, one-time listener.
<pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
single: true,
delay: 100
});</code></pre>
<p>
<b>Attaching multiple handlers in 1 call</b><br>
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
<p>
<pre><code>myGridPanel.on({
<em>'click'</em> : {
fn: this.onClick,
scope: this,
delay: 100
},
<em>'mouseover'</em> : {
fn: this.onMouseOver,
scope: this
},
<em>'mouseout'</em> : {
fn: this.onMouseOut,
scope: this
}
});</code></pre>
<p>
Or a shorthand syntax:<br>
<pre><code>myGridPanel.on({
<em>'click'</em> : this.onClick,
<em>'mouseover'</em> : this.onMouseOver,
<em>'mouseout'</em> : this.onMouseOut,
scope: this
});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-createNode"></a><b class="method"><a href="source/TreeLoader.html#method-Ext.tree.TreeLoader-createNode">createNode</a></b><span class="openparen">( </span><span title="Required" class="required">attr {Object}</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Override this function for custom TreeNode node implementation, or to
modify the attributes at creation time.
Example...</div><div class="long"><p>Override this function for custom TreeNode node implementation, or to
modify the attributes at creation time.</p>
Example:<pre><code><b>new</b> Ext.tree.TreePanel({
...
loader: <b>new</b> Ext.tree.TreeLoader({
url: <em>'dataUrl'</em>,
createNode: <b>function</b>(attr) {
<i>// Allow consolidation consignments to have</i>
<i>// consignments dropped into them.</i>
<b>if</b> (attr.isConsolidation) {
attr.iconCls = <em>'x-consol'</em>,
attr.allowDrop = true;
}
<b>return</b> Ext.tree.TreeLoader.prototype.createNode.call(this, attr);
}
}),
...
});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>{Object}</code> : attr<div class="sub-desc">The attributes from which to create the new node.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeLoader</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b class="method"><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b><span class="openparen">( </span><span title="Required" class="required">String/Array events</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
access the required target more quickly.</p>
<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
<i>// Add functionality to Field's initComponent to enable the change event to bubble</i>
initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
this.enableBubble(<em>'change'</em>);
}),
<i>// We know that we want Field's events to bubble directly to the FormPanel.</i>
getBubbleTarget : <b>function</b>() {
<b>if</b> (!this.formPanel) {
this.formPanel = this.findParentByType(<em>'form'</em>);
}
<b>return</b> this.formPanel;
}
});
<b>var</b> myForm = <b>new</b> Ext.formPanel({
title: <em>'User Details'</em>,
items: [{
...
}],
listeners: {
change: <b>function</b>() {
<i>// Title goes red <b>if</b> form has been modified.</i>
myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
}
}
});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b><span class="openparen">( </span><span title="Required" class="required">String eventName</span><span class="comma">, </span><span title="Required" class="required">Object... args</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">Boolean</span><div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
<p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b><span class="openparen">( </span><span title="Required" class="required">String eventName</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">Boolean</span><div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-load"></a><b class="method"><a href="source/TreeLoader.html#method-Ext.tree.TreeLoader-load">load</a></b><span class="openparen">( </span><span title="Required" class="required">Ext.tree.TreeNode node</span><span class="comma">, </span><span title="Required" class="required">Function callback</span><span class="comma">, </span><span title="Required" class="required">Object scope</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Load an Ext.tree.TreeNode from the URL specified in the constructor.
This is called automatically when a node is expa...</div><div class="long">Load an <a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">Ext.tree.TreeNode</a> from the URL specified in the constructor.
This is called automatically when a node is expanded, but may be used to reload
a node (or append new children if the <a href="output/Ext.tree.TreeLoader.html#Ext.tree.TreeLoader-clearOnLoad" ext:member="clearOnLoad" ext:cls="Ext.tree.TreeLoader">clearOnLoad</a> option is false.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>callback</code> : Function<div class="sub-desc">Function to call after the node has been loaded. The
function is passed the TreeNode which was requested to be loaded.</div></li><li><code>scope</code> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the callback is executed.
defaults to the loaded TreeNode.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeLoader</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b><span class="openparen">( </span><span title="Required" class="required">String eventName</span><span class="comma">, </span><span title="Required" class="required">Function handler</span><span class="comma">, </span><span title="Optional" class="optional">[Object scope]</span><span class="comma">, </span><span title="Optional" class="optional">[Object options]</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b><span class="openparen">(</span><span class="closeparen">)</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b class="method"><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b><span class="openparen">( </span><span title="Required" class="required">Object o</span><span class="comma">, </span><span title="Required" class="required">Array events</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b><span class="openparen">( </span><span title="Required" class="required">String eventName</span><span class="comma">, </span><span title="Required" class="required">Function handler</span><span class="comma">, </span><span title="Optional" class="optional">[Object scope]</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b><span class="openparen">(</span><span class="closeparen">)</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b><span class="openparen">( </span><span title="Required" class="required">Boolean queueSuspended</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b class="method"><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b><span class="openparen">( </span><span title="Required" class="required">String eventName</span><span class="comma">, </span><span title="Required" class="required">Function handler</span><span class="comma">, </span><span title="Optional" class="optional">[Object scope]</span><span class="closeparen"> )</span><span class="colon"> : </span><span class="return">void</span><div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.tree.TreeLoader-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-beforeload"></a><b class="event"><a href="source/TreeLoader.html#event-Ext.tree.TreeLoader-beforeload">beforeload</a></b><span class="colon"> : </span><span class="openparen">( </span><span title="Required" class="required">Object This</span><span class="comma">, </span><span title="Required" class="required">Object node</span><span class="comma">, </span><span title="Required" class="required">Object callback</span><span class="closeparen"> )</span><span> </span><div class="mdesc"><div class="short">Fires before a network request is made to retrieve the Json text which specifies a node's children.</div><div class="long">Fires before a network request is made to retrieve the Json text which specifies a node's children.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>This</code> : Object<div class="sub-desc">TreeLoader object.</div></li><li><code>node</code> : Object<div class="sub-desc">The <a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">Ext.tree.TreeNode</a> object being loaded.</div></li><li><code>callback</code> : Object<div class="sub-desc">The callback function specified in the <a href="output/Ext.tree.TreeLoader.html#Ext.tree.TreeLoader-load" ext:member="load" ext:cls="Ext.tree.TreeLoader">load</a> call.</div></li></ul></div></div></div></td><td class="msource">TreeLoader</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-load"></a><b class="event"><a href="source/TreeLoader.html#event-Ext.tree.TreeLoader-load">load</a></b><span class="colon"> : </span><span class="openparen">( </span><span title="Required" class="required">Object This</span><span class="comma">, </span><span title="Required" class="required">Object node</span><span class="comma">, </span><span title="Required" class="required">Object response</span><span class="closeparen"> )</span><span> </span><div class="mdesc"><div class="short">Fires when the node has been successfuly loaded.</div><div class="long">Fires when the node has been successfuly loaded.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>This</code> : Object<div class="sub-desc">TreeLoader object.</div></li><li><code>node</code> : Object<div class="sub-desc">The <a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">Ext.tree.TreeNode</a> object being loaded.</div></li><li><code>response</code> : Object<div class="sub-desc">The response object containing the data from the server.</div></li></ul></div></div></div></td><td class="msource">TreeLoader</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeLoader-loadexception"></a><b class="event"><a href="source/TreeLoader.html#event-Ext.tree.TreeLoader-loadexception">loadexception</a></b><span class="colon"> : </span><span class="openparen">( </span><span title="Required" class="required">Object This</span><span class="comma">, </span><span title="Required" class="required">Object node</span><span class="comma">, </span><span title="Required" class="required">Object response</span><span class="closeparen"> )</span><span> </span><div class="mdesc"><div class="short">Fires if the network request failed.</div><div class="long">Fires if the network request failed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>This</code> : Object<div class="sub-desc">TreeLoader object.</div></li><li><code>node</code> : Object<div class="sub-desc">The <a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">Ext.tree.TreeNode</a> object being loaded.</div></li><li><code>response</code> : Object<div class="sub-desc">The response object containing the data from the server.</div></li></ul></div></div></div></td><td class="msource">TreeLoader</td></tr></tbody></table></div>
|
