Observable TreeLoader XmlTreeLoader
Package: | Ext.ux.tree |
Defined In: | XmlTreeLoader.js |
Class: | XmlTreeLoader |
Extends: | TreeLoader |
A TreeLoader that can convert an XML document into a hierarchy of Ext.tree.TreeNodes. Any text value included as a text node in the XML will be added to the parent node as an attribute called innerText. Also, the tag name of each XML node will be added to the tree node as an attribute called tagName.
By default, this class expects that your source XML will provide the necessary attributes on each node as expected by the Ext.tree.TreePanel to display and load properly. However, you can provide your own custom processing of node attributes by overriding the processNode method and modifying the attributes as needed before they are used to create the associated TreeNode.
Config Options | Defined By | |
---|---|---|
baseAttrs : Object An object containing attributes to be added to all nodes
created by this loader. If the attributes sent by the serve... 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 An object containing properties which
specify HTTP parameters to be passed to each request for child nodes. | TreeLoader | |
clearOnLoad : Boolean 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 chi... 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 | |
directFn : Function Function to call when executing a request. | TreeLoader | |
listeners : Object A config object containing one or more event handlers to be added to this
object during initialization. This should ... 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. DOM events from ExtJs Components While some 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 DataView's
| Observable | |
paramOrder : Array/String Defaults to undefined. Only used when using directFn.
A list of params to be executed
server side. Specify the par... Defaults to undefined. Only used when using directFn.
A list of params to be executed
server side. Specify the params in the order in which they must be executed on the server-side
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:
| TreeLoader | |
paramsAsHash : Boolean Only used when using directFn.
Send parameters as a collection of named arguments (defaults to false). Providing a
... Only used when using directFn.
Send parameters as a collection of named arguments (defaults to false). Providing a
paramOrder nullifies this configuration. | TreeLoader | |
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 the value of Ext.Ajax.method). | TreeLoader | |
uiProviders : Object An object containing properties which
specify custom Ext.tree.TreeNodeUI implementations. If the optional
uiProvide... 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, then that string value
is used as a property name in the uiProviders object. | TreeLoader | |
url : String Equivalent to dataUrl. | TreeLoader |
Property | Defined By | |
---|---|---|
XML_NODE_ELEMENT : Number XML element node (value 1, read-only) | XmlTreeLoader | |
XML_NODE_TEXT : Number XML text node (value 3, read-only) | XmlTreeLoader |
Method | Defined By | |
---|---|---|
XmlTreeLoader( Object config )
Creates a new XmlTreeloader. Creates a new XmlTreeloader. Parameters:
| XmlTreeLoader | |
addEvents( Object|String o , string Optional. )
:
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
createNode( attr {Object} )
:
voidOverride this function for custom TreeNode node implementation, or to
modify the attributes at creation time.
Examp... Override this function for custom TreeNode node implementation, or to modify the attributes at creation time. Example:
Parameters:
| TreeLoader | |
enableBubble( Object events )
:
voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present... Enables events fired by this Observable to bubble up an owner hierarchy by calling
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. 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. Example:
Parameters:
| Observable | |
fireEvent( String eventName , Object... args )
:
BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters:
| Observable | |
hasListener( String eventName )
:
BooleanChecks 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 , (Object) scope )
:
voidLoad an Ext.tree.TreeNode from the URL specified in the constructor.
This is called automatically when a node is exp... 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 ] )
:
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
purgeListeners()
:
void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o , Array events )
:
voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
removeListener( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
resumeEvents()
:
void Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
suspendEvents( Boolean queueSuspended )
:
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (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 |