Observable TreeLoader
Package: | Ext.tree |
Defined In: | TreeLoader.js |
Class: | TreeLoader |
Extends: | Observable |
[{
id: 1,
text: 'A leaf Node',
leaf: true
},{
id: 2,
text: 'A folder Node',
children: [{
id: 3,
text: 'A child Node',
leaf: true
}]
}]
myTreeLoader.on("beforeload", function(treeLoader, node) {
this.baseParams.category = node.attributes.category;
}, this);
<
This would pass an HTTP parameter called "category" to the server containing
the value of the Node's "category" attribute. Config Options | Defined By | |
---|---|---|
baseAttrs : Object (optional) An object containing attributes to be added to all nodes created by this loader. If the attributes sent by...
(optional) 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.
|
TreeLoader | |
baseParams : Object
(optional) An object containing properties which specify HTTP parameters to be passed to each request for child nodes.
|
TreeLoader | |
clearOnLoad : Boolean
(optional) Default to true. Remove previously existing child nodes before loading.
|
TreeLoader | |
dataUrl : String The URL from which to request a Json string which specifies an array of node definition objects representing the chil...
The URL from which to request a Json string which specifies an array of node definition objects representing the child nodes to be loaded.
|
TreeLoader | |
listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b...
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 addListener example for attaching multiple handlers at once.
|
Observable | |
preloadChildren : Boolean
If set to true, the loader recursively loads "children" attributes when doing the first load on nodes.
|
TreeLoader | |
requestMethod : String
The HTTP request method for loading data (defaults to 'POST').
|
TreeLoader | |
uiProviders : Object (optional) An object containing properties which specify custom Ext.tree.TreeNodeUI implementations. If the optional ...
(optional) An object containing properties which specify custom Ext.tree.TreeNodeUI implementations. If the optional uiProvider attribute of a returned child node is a string rather than a reference to a TreeNodeUI implementation, this that string value is used as a property name in the uiProviders object.
|
TreeLoader | |
url : String
Equivalent to dataUrl.
|
TreeLoader |
Method | Defined By | |
---|---|---|
TreeLoader( Object config ) Creates a new Treeloader.
Creates a new Treeloader.
Parameters:
|
TreeLoader | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
Parameters:
|
Observable | |
createNode() : void Override this function for custom TreeNode node implementation
Override this function for custom TreeNode node implementation
Parameters:
|
TreeLoader | |
fireEvent( String eventName , Object... args ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
Parameters:
|
Observable | |
hasListener( String eventName ) : Boolean Checks to see if this object has any listeners for a specified event
Checks to see if this object has any listeners for a specified event
Parameters:
|
Observable | |
load( Ext.tree.TreeNode node , Function callback ) : void Load an Ext.tree.TreeNode from the URL specified in the constructor.
This is called automatically when a node is expa...
Load an Ext.tree.TreeNode 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 clearOnLoad option is false.)
Parameters:
|
TreeLoader | |
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (shorthand for addListener)
Parameters:
|
Observable | |
purgeListeners() : void Removes all listeners for this object
Removes all listeners for this object
Parameters:
|
Observable | |
removeListener( String eventName , Function handler , [Object scope ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
resumeEvents() : void Resume firing events. (see suspendEvents)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
suspendEvents() : void Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)
Parameters:
|
Observable | |
un( String eventName , Function handler , [Object scope ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable |
Event | Defined By | |
---|---|---|
beforeload : ( Object This , Object node , Object callback ) Fires before a network request is made to retrieve the Json text which specifies a node's children.
Fires before a network request is made to retrieve the Json text which specifies a node's children.
Listeners will be called with the following arguments:
|
TreeLoader | |
load : ( Object This , Object node , Object response ) Fires when the node has been successfuly loaded.
Fires when the node has been successfuly loaded.
Listeners will be called with the following arguments:
|
TreeLoader | |
loadexception : ( Object This , Object node , Object response ) Fires if the network request failed.
Fires if the network request failed.
Listeners will be called with the following arguments:
|
TreeLoader |