Ext.tree.TreeNode

The id for this node. If one is not specified, one is generated.

Available since: 1.1.0

true if this node is a leaf and does not have children

Available since: 1.1.0

(optional)

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 click event passing the node clicked on. To access DOM events directly from a Component's HTMLElement, listeners must be added to the Element after the Component has been rendered. A plugin can simplify this step:

// Plugin is configured with a listeners config object.
// The Component is appended to the argument list of all handler functions.
Ext.DomObserver = Ext.extend(Object, {
    constructor: function(config) {
        this.listeners = config.listeners ? config.listeners : config;
    },

    // Component passes itself into plugin's init method
    init: function(c) {
        var p, l = this.listeners;
        for (p in l) {
            if (Ext.isFunction(l[p])) {
                l[p] = this.createHandler(l[p], c);
            } else {
                l[p].fn = this.createHandler(l[p].fn, c);
            }
        }

        // Add the listeners to the Element immediately following the render call
        c.render = c.render.createSequence(function() {
            var e = c.getEl();
            if (e) {
                e.on(l);
            }
        });
    },

    createHandler: function(fn, c) {
        return function(e) {
            fn.call(this, e, c);
        };
    }
});

var combo = new Ext.form.ComboBox({

    // Collapse combo when its element is clicked on
    plugins: [ new Ext.DomObserver({
        click: function(evt, comp) {
            comp.collapse();
        }
    })],
    store: myStore,
    typeAhead: true,
    mode: 'local',
    triggerAction: 'all'
});

Available since: 1.1.0

All child nodes of this node.

Defaults to: []

Available since: 1.1.0

The first direct child node of this node, or null if this node has no child nodes.

Available since: 1.1.0

The node id.

Available since: 1.1.0

The last direct child node of this node, or null if this node has no child nodes.

Available since: 1.1.0

The node immediately following this node in the tree, or null if there is no sibling node.

Available since: 1.1.0

The parent node for this node.

Available since: 1.1.0

The node immediately preceding this node in the tree, or null if there is no sibling node.

Available since: 1.1.0

Adds the specified events to the list of events which this Observable may fire.

Available since: 1.1.0

Parameters

• o : Object|String

  Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

• Optional : string

  . Event name if multiple event names are being passed as separate parameters. Usage:

  this.addEvents('storeloaded', 'storecleared');
  

Appends an event handler to this object.

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to listen for.

• handler : Function

  The method the event invokes.

• scope : Object (optional)

  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options : Object (optional)

  An object containing handler configuration. properties. This may contain any of the following properties:

  • scope : Object
    The scope (this reference) in which the handler function is executed. If 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 by the specified number of milliseconds. If the event fires again within that time, the original handler 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 if the event was bubbled up from a child Observable.

  
  

  Combining Options
  Using the options argument, it is possible to combine different types of listeners:
  
  A delayed, one-time listener.

  myDataView.on('click', this.onClick, this, {
  single: true,
  delay: 100
  });

  Attaching multiple handlers in 1 call
  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.

  myGridPanel.on({
  'click' : {
      fn: this.onClick,
      scope: this,
      delay: 100
  },
  'mouseover' : {
      fn: this.onMouseOver,
      scope: this
  },
  'mouseout' : {
      fn: this.onMouseOut,
      scope: this
  }
  });

  Or a shorthand syntax:
  

  myGridPanel.on({
  'click' : this.onClick,
  'mouseover' : this.onMouseOver,
  'mouseout' : this.onMouseOut,
   scope: this
  });

Bubbles up the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the bubble is stopped.

Available since: 1.1.0

Parameters

• fn : Function

  The function to call

• scope : Object (optional)

  The scope (this reference) in which the function is executed. Defaults to the current Node.

• args : Array (optional)

  The args to call the function with (default to passing the current Node)

Cascades down the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the cascade is stopped on that branch.

Available since: 1.1.0

Parameters

• fn : Function

  The function to call

• scope : Object (optional)

  The scope (this reference) in which the function is executed. Defaults to the current Node.

• args : Array (optional)

  The args to call the function with (default to passing the current Node)

private

Available since: Ext JS 3.4.0

Parameters

• destroy : Object

Returns true if this node is an ancestor (at any point) of the passed node.

Available since: 1.1.0

Parameters

• node : Node

Returns

• Boolean

Interates the child nodes of this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the iteration stops.

Available since: 1.1.0

Parameters

• fn : Function

  The function to call

• scope : Object (optional)

  The scope (this reference) in which the function is executed. Defaults to the current Node in the iteration.

• args : Array (optional)

  The args to call the function with (default to passing the current Node)

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

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:

Ext.override(Ext.form.Field, {
    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
        this.enableBubble('change');
    }),

    //  We know that we want Field's events to bubble directly to the FormPanel.
    getBubbleTarget : function() {
        if (!this.formPanel) {
            this.formPanel = this.findParentByType('form');
        }
        return this.formPanel;
    }
});

var myForm = new Ext.formPanel({
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Available since: Ext JS 3.4.0

Parameters

• events : String/Array

  The event name to bubble, or an Array of event names.

Finds the first child that has the attribute with the specified value.

Available since: 1.1.0

Parameters

• attribute : String

  The attribute name

• value : Mixed

  The value to search for

• deep : Boolean (optional)

  True to search through nodes deeper than the immediate children

Returns

• Node

  The found child or null if none was found

Finds the first child by a custom function. The child matches if the function passed returns true.

Available since: 1.1.0

Parameters

• fn : Function

  A function which must return true if the passed Node is the required Node.

• scope : Object (optional)

  The scope (this reference) in which the function is executed. Defaults to the Node being tested.

• deep : Boolean (optional)

  True to search through nodes deeper than the immediate children

Returns

• Node

  The found child or null if none was found

private

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.

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to fire.

• args : Object...

  Variable number of parameters are passed to handlers.

Returns

• Boolean

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

Overrides: Ext.util.Observable.fireEvent

Returns depth of this node (the root node has a depth of 0)

Available since: 1.1.0

Returns

• Number

Returns the tree this node is in.

Available since: 1.1.0

Returns

• Tree

Returns the path for this node. The path can be used to expand or select this node programmatically.

Available since: 1.1.0

Parameters

• attr : String (optional)

  The attr to use for the path (defaults to the node's id)

Returns

• String

  The path

Returns true if this node has one or more child nodes, else false.

Available since: 2.3.0

Returns

• Boolean

Checks to see if this object has any listeners for a specified event

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to check for

Returns

• Boolean

  True if the event is being listened for, else false

Returns the index of a child node

Available since: 1.1.0

Parameters

• node : Node

Returns

• Number

  The index of the node or -1 if it was not found

Returns true if the passed node is an ancestor (at any point) of this node.

Available since: 1.1.0

Parameters

• node : Node

Returns

• Boolean

Returns true if this node has one or more child nodes, or if the expandable node attribute is explicitly specified as true (see attributes), otherwise returns false.

Available since: 2.3.0

Returns

• Boolean

Returns true if this node is the first child of its parent

Available since: 1.1.0

Returns

• Boolean

Returns true if this node is the last child of its parent

Available since: 1.1.0

Returns

• Boolean

Returns true if this node is a leaf

Available since: 1.1.0

Returns

• Boolean

Returns the child node at the specified index.

Available since: 1.1.0

Parameters

• index : Number

Returns

• Node

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

Available since: 1.1.0

Parameters

• eventName : String

  The type of event to listen for

• handler : Function

  The method the event invokes

• scope : Object (optional)

  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options : Object (optional)

  An object containing handler configuration.

Removes all listeners for this object

Available since: 1.1.0

Relays selected events from the specified Observable as if the events were fired by this.

Available since: 2.3.0

Parameters

• o : Object

  The Observable whose events this object is to relay.

• events : Array

  Array of event names to relay.

Removes this node from its parent

Available since: 2.3.0

Parameters

• destroy : Boolean

  true to destroy the node upon removal. Defaults to false.

Returns

• Node

  this

Removes all child nodes from this node.

Available since: Ext JS 3.4.0

Parameters

• destroy : Boolean

  true to destroy the node upon removal. Defaults to false.

Returns

• Node

  this

Removes an event handler.

Available since: 1.1.0

Parameters

• eventName : String

  The type of event the handler was associated with.

• handler : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

• scope : Object (optional)

  The scope originally specified for the handler.

Replaces one child node in this node with another.

Available since: 1.1.0

Parameters

• newChild : Node

  The replacement node

• oldChild : Node

  The node to replace

Returns

• Node

  The replaced node

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.

Available since: 2.3.0

Changes the id of this node.

Available since: Ext JS 3.4.0

Parameters

• id : String

  The new id for the node.

private

Available since: Ext JS 3.4.0

Parameters

• tree : Object
• destroy : Object

Suspend the firing of all events. (see resumeEvents)

Available since: 2.3.0

Parameters

• queueSuspended : Boolean

  Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

Available since: Ext JS 3.4.0

Removes an event handler (shorthand for removeListener.)

Available since: 1.1.0

Parameters

• eventName : String

  The type of event the handler was associated with.

• handler : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

• scope : Object (optional)

  The scope originally specified for the handler.

Fires before a new child is appended, return false to cancel the append.

Available since: 1.1.0

Parameters

• tree : Tree

  The owner tree

• this : Node

  This node

• node : Node

  The child node to be appended

Fires before a new child is inserted, return false to cancel the insert.

Available since: 1.1.0

Parameters

• tree : Tree

  The owner tree

• this : Node

  This node

• node : Node

  The child node to be inserted

• refNode : Node

  The child node the node is being inserted before

Fires before this node is moved to a new location in the tree. Return false to cancel the move.

Available since: 1.1.0

Parameters

• tree : Tree

  The owner tree

• this : Node

  This node

• oldParent : Node

  The parent of this node

• newParent : Node

  The new parent this node is moving to

• index : Number

  The index it is being moved to

Fires before a child is removed, return false to cancel the remove.

Available since: 1.1.0

Parameters

• tree : Tree

  The owner tree

• this : Node

  This node

• node : Node

  The child node to be removed

Fires when a new child node is inserted.

Available since: 1.1.0

Parameters

• tree : Tree

  The owner tree

• this : Node

  This node

• node : Node

  The child node inserted

• refNode : Node

  The child node the node was inserted before

Fires when this node is moved to a new location in the tree

Available since: 1.1.0

Parameters

• tree : Tree

  The owner tree

• this : Node

  This node

• oldParent : Node

  The old parent of this node

• newParent : Node

  The new parent of this node

• index : Number

  The index it was moved to

Fires when a child node is removed

Available since: 1.1.0

Parameters

• tree : Tree

  The owner tree

• this : Node

  This node

• node : Node

  The removed node