Hierarchy
Ext.util.ObservableExt.tree.TreeLoader
Files
TreeLoader.js

A TreeLoader provides for lazy loading of an Ext.tree.TreeNode's child\nnodes from a specified URL. The response must be a JavaScript Array definition\nwhose elements are node definition objects. e.g.:

\n\n

    [{\n        id: 1,\n        text: 'A leaf Node',\n        leaf: true\n    },{\n        id: 2,\n        text: 'A folder Node',\n        children: [{\n            id: 3,\n            text: 'A child Node',\n            leaf: true\n        }]\n   }]\n

\n\n\n

\n\n\n

A server request is sent, and child nodes are loaded only when a node is expanded.\nThe loading node's id is passed to the server under the parameter name \"node\" to\nenable the server to produce the correct child nodes.

\n\n

\n\n\n

To pass extra parameters, an event handler may be attached to the \"beforeload\"\nevent, and the parameters specified in the TreeLoader's baseParams property:

\n\n

    myTreeLoader.on(\"beforeload\", function(treeLoader, node) {\n        this.baseParams.category = node.attributes.category;\n    }, this);\n

\n\n\n

This would pass an HTTP parameter called \"category\" to the server containing\nthe value of the Node's \"category\" attribute.

Defined By

Config options

Ext.tree.TreeLoader
view source

baseAttrs : Object

(optional) An object containing attributes to be added to all nodes\ncreated by this loader. ...

(optional) An object containing attributes to be added to all nodes\ncreated by this loader. If the attributes sent by the server have an attribute in this object,\nthey take priority.

Ext.tree.TreeLoader
view source

baseParams : Object

(optional) An object containing properties which\nspecify HTTP parameters to be passed to each request for child nodes.

Ext.tree.TreeLoader
view source

clearOnLoad : Boolean

(optional) Default to true. ...

(optional) Default to true. Remove previously existing\nchild nodes before loading.

Defaults to: true

Ext.tree.TreeLoader
view source

dataUrl : String

The URL from which to request a Json string which\nspecifies an array of node definition objects representing the chil...

The URL from which to request a Json string which\nspecifies an array of node definition objects representing the child nodes\nto be loaded.

Ext.tree.TreeLoader
view source

directFn : Function

Function to call when executing a request.

Ext.util.Observable
view source

listeners : Object

(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. ...

(optional)

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\naddListener example for attaching multiple handlers at once.

\n\n

DOM events from ExtJs Components

\n\n\n

While some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n

is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a Component's HTMLElement, listeners must be added to the Element after the Component\nhas been rendered. A plugin can simplify this step:

\n\n

// Plugin is configured with a listeners config object.\n// The Component is appended to the argument list of all handler functions.\nExt.DomObserver = Ext.extend(Object, {\n    constructor: function(config) {\n        this.listeners = config.listeners ? config.listeners : config;\n    },\n\n    // Component passes itself into plugin's init method\n    init: function(c) {\n        var p, l = this.listeners;\n        for (p in l) {\n            if (Ext.isFunction(l[p])) {\n                l[p] = this.createHandler(l[p], c);\n            } else {\n                l[p].fn = this.createHandler(l[p].fn, c);\n            }\n        }\n\n        // Add the listeners to the Element immediately following the render call\n        c.render = c.render.createSequence(function() {\n            var e = c.getEl();\n            if (e) {\n                e.on(l);\n            }\n        });\n    },\n\n    createHandler: function(fn, c) {\n        return function(e) {\n            fn.call(this, e, c);\n        };\n    }\n});\n\nvar combo = new Ext.form.ComboBox({\n\n    // Collapse combo when its element is clicked on\n    plugins: [ new Ext.DomObserver({\n        click: function(evt, comp) {\n            comp.collapse();\n        }\n    })],\n    store: myStore,\n    typeAhead: true,\n    mode: 'local',\n    triggerAction: 'all'\n});\n

\n\n\n

Ext.tree.TreeLoader
view source

nodeParameter : String

The name of the parameter sent to the server which contains\nthe identifier of the node. ...

The name of the parameter sent to the server which contains\nthe identifier of the node. Defaults to 'node'.

Defaults to: 'node'

Ext.tree.TreeLoader
view source

paramOrder : Array/String

Defaults to undefined. ...

Defaults to undefined. Only used when using directFn.\nSpecifies the params in the order in which they must be passed to the server-side Direct method\nas either (1) an Array of String values, or (2) a String of params delimited by either whitespace,\ncomma, or pipe. For example,\nany of the following would be acceptable:

\n\n

nodeParameter: 'node',\nparamOrder: ['param1','param2','param3']\nparamOrder: 'node param1 param2 param3'\nparamOrder: 'param1,node,param2,param3'\nparamOrder: 'param1|param2|param|node'\n

\n\n

Ext.tree.TreeLoader
view source

paramsAsHash : Boolean

Only used when using directFn. ...

Only used when using directFn.\nSend parameters as a collection of named arguments (defaults to false). Providing a\nparamOrder nullifies this configuration.

Defaults to: false

Ext.tree.TreeLoader
view source

preloadChildren : Boolean

If set to true, the loader recursively loads \"children\" attributes when doing the first load on nodes.

Ext.tree.TreeLoader
view source

requestMethod : String

The HTTP request method for loading data (defaults to the value of Ext.Ajax.method).

Ext.tree.TreeLoader
view source

uiProviders : Object

(optional) An object containing properties which\nspecify custom Ext.tree.TreeNodeUI implementations. ...

(optional) An object containing properties which\nspecify custom Ext.tree.TreeNodeUI implementations. If the optional\nuiProvider attribute of a returned child node is a string rather\nthan a reference to a TreeNodeUI implementation, then that string value\nis used as a property name in the uiProviders object.

Defaults to: {}

Ext.tree.TreeLoader
view source

url : String

Equivalent to dataUrl.

Defined By

Methods

Ext.tree.TreeLoader
view source

newExt.tree.TreeLoader( config ) : Ext.tree.TreeLoader

Creates a new Treeloader. ...

Creates a new Treeloader.

Parameters

config : Object
A config object containing config properties.
\n

Returns

Ext.tree.TreeLoader
\n

Ext.util.Observable
view source

addEvents( o, Optional )

Adds 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

o : Object|String
Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.
\n
Optional : string
. Event name if multiple event names are being passed as separate parameters.\nUsage:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n\n

Ext.util.Observable
view source

addListener( eventName, handler, [scope], [options] )

Appends an event handler to this object. ...

Appends an event handler to this object.

Parameters

eventName : String
The name of the event to listen for.
\n
handler : Function
The method the event invokes.
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.\nproperties. This may contain any of the following properties:
- scope : Object
  The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
- target : Observable
  Only call the handler if the event was fired on the target Observable, not\nif the event was bubbled up from a child Observable.
\n\n
\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
```
myDataView.on('click', this.onClick, this, {\nsingle: true,\ndelay: 100\n});
```
\n
\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n
\n
```
myGridPanel.on({\n'click' : {\n    fn: this.onClick,\n    scope: this,\n    delay: 100\n},\n'mouseover' : {\n    fn: this.onMouseOver,\n    scope: this\n},\n'mouseout' : {\n    fn: this.onMouseOut,\n    scope: this\n}\n});
```
\n
\nOr a shorthand syntax:
\n
```
myGridPanel.on({\n'click' : this.onClick,\n'mouseover' : this.onMouseOver,\n'mouseout' : this.onMouseOut,\n scope: this\n});
```
\n\n

Ext.tree.TreeLoader
view source

createNode( attr )

Override this function for custom TreeNode node implementation, or to\nmodify the attributes at creation time. ...

Override this function for custom TreeNode node implementation, or to\nmodify the attributes at creation time.

\n\n\n

Example:

\n\n

new Ext.tree.TreePanel({\n    ...\n    loader: new Ext.tree.TreeLoader({\n        url: 'dataUrl',\n        createNode: function(attr) {\n//          Allow consolidation consignments to have\n//          consignments dropped into them.\n            if (attr.isConsolidation) {\n                attr.iconCls = 'x-consol',\n                attr.allowDrop = true;\n            }\n            return Ext.tree.TreeLoader.prototype.createNode.call(this, attr);\n        }\n    }),\n    ...\n});\n

\n\n

Parameters

attr : Object
{Object} The attributes from which to create the new node.
\n

Ext.util.Observable
view source

enableBubble( events )

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. ...

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.

\n\n\n

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.

\n\n\n

Example:

\n\n\n

Ext.override(Ext.form.Field, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n

\n\n

Parameters

events : String/Array
The event name to bubble, or an Array of event names.
\n

Ext.util.Observable
view source

fireEvent( eventName, 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).

\n\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.

\n\n

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

Boolean
returns false if any of the handlers return false otherwise it returns true.
\n

Ext.util.Observable
view source

hasListener( 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

eventName : String
The name of the event to check for
\n

Returns

Boolean
True if the event is being listened for, else false
\n

Ext.tree.TreeLoader
view source

load( node, callback, scope )

Load an Ext.tree.TreeNode from the URL specified in the constructor. ...

Load an Ext.tree.TreeNode from the URL specified in the constructor.\nThis is called automatically when a node is expanded, but may be used to reload\na node (or append new children if the clearOnLoad option is false.)

Parameters

node : Ext.tree.TreeNode
\n
callback : Function
Function to call after the node has been loaded. The\nfunction is passed the TreeNode which was requested to be loaded.
\n
scope : Object
The scope (this reference) in which the callback is executed.\ndefaults to the loaded TreeNode.
\n

Ext.util.Observable
view source

on( eventName, handler, [scope], [options] )

Appends an event handler to this object (shorthand for addListener.) ...

Appends an event handler to this object (shorthand for addListener.)

Parameters

eventName : String
The type of event to listen for
\n
handler : Function
The method the event invokes
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.
\n

Ext.util.Observable
view source

purgeListeners( )

Removes all listeners for this object ...

Removes all listeners for this object

Ext.util.Observable
view source

relayEvents( o, events )

Relays 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

o : Object
The Observable whose events this object is to relay.
\n
events : Array
Array of event names to relay.
\n

Ext.util.Observable
view source

removeListener( eventName, handler, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

Ext.util.Observable
view source

resumeEvents( )

Resume firing events. ...

Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.

Ext.util.Observable
view source

suspendEvents( queueSuspended )

Suspend the firing of all events. ...

Suspend the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n

Ext.util.Observable
view source

un( eventName, handler, [scope] )

Removes an event handler (shorthand for removeListener.) ...

Removes an event handler (shorthand for removeListener.)

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

Defined By

Events

Ext.tree.TreeLoader
view source

beforeload( This, node, 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.

Parameters

This : Object
TreeLoader object.
\n
node : Object
The Ext.tree.TreeNode object being loaded.
\n
callback : Object
The callback function specified in the load call.
\n

Ext.tree.TreeLoader
view source

load( This, node, response )

Fires when the node has been successfuly loaded. ...

Fires when the node has been successfuly loaded.

Parameters

This : Object
TreeLoader object.
\n
node : Object
The Ext.tree.TreeNode object being loaded.
\n
response : Object
The response object containing the data from the server.
\n

Ext.tree.TreeLoader
view source

loadexception( This, node, response )

Fires if the network request failed. ...

Fires if the network request failed.

Parameters

This : Object
TreeLoader object.
\n
node : Object
The Ext.tree.TreeNode object being loaded.
\n
response : Object
The response object containing the data from the server.
\n