Print Friendly

Class Ext.data.Tree

Package:Ext.data
Class:Tree
Extends:Observable
Subclasses:TreePanel
Defined In:Tree.js
Represents a tree data structure and bubbles all the events for its nodes. The nodes in the tree have most standard DOM functionality.

Properties   -  Methods   -  Events

Public Properties

Property Defined By
  root : Node Tree
The root node for this tree

Public Methods

Method Defined By
  Tree([Node root]) Tree
  addListener(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this component
  fireEvent(String eventName, Object... args) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  getNodeById(String id) : Node Tree
Gets a node in this tree by its id
  getRootNode() : Node Tree
Returns this root node for this tree
  on(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this element (shorthand for addListener)
  purgeListeners() : void Observable
Removes all listeners for this object
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener
  setRootNode(Node node) : Node Tree
Sets the root node for this tree
  un(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener (shorthand for removeListener)

Public Events

Event Defined By
  append : (Tree tree, Node parent, Node node, Number index) Tree
Fires when a new child node is appended to a node in this tree.
  beforeappend : (Tree tree, Node parent, Node node) Tree
Fires before a new child is appended to a node in this tree, return false to cancel the append.
  beforeinsert : (Tree tree, Node parent, Node node, Node refNode) Tree
Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
  beforemove : (Tree tree, Node node, Node oldParent, Node newParent, Number index) Tree
Fires before a node is moved to a new location in the tree. Return false to cancel the move.
  beforeremove : (Tree tree, Node parent, Node node) Tree
Fires before a child is removed from a node in this tree, return false to cancel the remove.
  insert : (Tree tree, Node parent, Node node, Node refNode) Tree
Fires when a new child node is inserted in a node in this tree.
  move : (Tree tree, Node node, Node oldParent, Node newParent, Number index) Tree
Fires when a node is moved to a new location in the tree
  remove : (Tree tree, Node parent, Node node) Tree
Fires when a child node is removed from a node in this tree.

Property Details

root

public Node root
The root node for this tree
This property is defined by Tree.

Constructor Details

Tree

public function Tree([Node root])
Parameters:
  • root : Node
    (optional) The root node

Method Details

addListener

public function addListener(String eventName, Function handler, [Object options])
Appends an event handler to this component
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • options : Object
    (optional)
Returns:
  • void
This method is defined by Observable.

fireEvent

public function fireEvent(String eventName, Object... args)
Fires the specified event with the passed parameters (minus the event name).
Parameters:
  • eventName : String
  • 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
This method is defined by Observable.

getNodeById

public function getNodeById(String id)
Gets a node in this tree by its id
Parameters:
  • id : String
Returns:
  • Node
This method is defined by Tree.

getRootNode

public function getRootNode()
Returns this root node for this tree
Parameters:
  • None.
Returns:
  • Node
This method is defined by Tree.

on

public function on(String eventName, Function handler, [Object options])
Appends an event handler to this element (shorthand for addListener)
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • options : Object
    (optional)
Returns:
  • void
This method is defined by Observable.

purgeListeners

public function purgeListeners()
Removes all listeners for this object
Parameters:
  • None.
Returns:
  • void
This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])
Removes a listener
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The handler to remove
  • scope : Object
    (optional) The scope (this object) for the handler
Returns:
  • void
This method is defined by Observable.

setRootNode

public function setRootNode(Node node)
Sets the root node for this tree
Parameters:
  • node : Node
Returns:
  • Node
This method is defined by Tree.

un

public function un(String eventName, Function handler, [Object scope])
Removes a listener (shorthand for removeListener)
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The handler to remove
  • scope : Object
    (optional) The scope (this object) for the handler
Returns:
  • void
This method is defined by Observable.

Event Details

append

public event append
Fires when a new child node is appended to a node in this tree.
Subscribers will be called with the following parameters:
  • tree : Tree
    The owner tree
  • parent : Node
    The parent node
  • node : Node
    The newly appended node
  • index : Number
    The index of the newly appended node
This event is defined by Tree.

beforeappend

public event beforeappend
Fires before a new child is appended to a node in this tree, return false to cancel the append.
Subscribers will be called with the following parameters:
  • tree : Tree
    The owner tree
  • parent : Node
    The parent node
  • node : Node
    The child node to be appended
This event is defined by Tree.

beforeinsert

public event beforeinsert
Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
Subscribers will be called with the following parameters:
  • tree : Tree
    The owner tree
  • parent : Node
    The parent node
  • node : Node
    The child node to be inserted
  • refNode : Node
    The child node the node is being inserted before
This event is defined by Tree.

beforemove

public event beforemove
Fires before a node is moved to a new location in the tree. Return false to cancel the move.
Subscribers will be called with the following parameters:
  • tree : Tree
    The owner tree
  • node : Node
    The node being moved
  • oldParent : Node
    The parent of the node
  • newParent : Node
    The new parent the node is moving to
  • index : Number
    The index it is being moved to
This event is defined by Tree.

beforeremove

public event beforeremove
Fires before a child is removed from a node in this tree, return false to cancel the remove.
Subscribers will be called with the following parameters:
  • tree : Tree
    The owner tree
  • parent : Node
    The parent node
  • node : Node
    The child node to be removed
This event is defined by Tree.

insert

public event insert
Fires when a new child node is inserted in a node in this tree.
Subscribers will be called with the following parameters:
  • tree : Tree
    The owner tree
  • parent : Node
    The parent node
  • node : Node
    The child node inserted
  • refNode : Node
    The child node the node was inserted before
This event is defined by Tree.

move

public event move
Fires when a node is moved to a new location in the tree
Subscribers will be called with the following parameters:
  • tree : Tree
    The owner tree
  • node : Node
    The node moved
  • oldParent : Node
    The old parent of this node
  • newParent : Node
    The new parent of this node
  • index : Number
    The index it was moved to
This event is defined by Tree.

remove

public event remove
Fires when a child node is removed from a node in this tree.
Subscribers will be called with the following parameters:
  • tree : Tree
    The owner tree
  • parent : Node
    The parent node
  • node : Node
    The child node removed
This event is defined by Tree.

yui-ext - Copyright © 2006 Jack Slocum. | Yahoo! UI - Copyright © 2006 Yahoo! Inc.
All rights reserved.