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.

属性 - 方法 - 事件

公共属性

属性		定义对象
	root : Node	Tree
	The root node for this tree	Tree

公共方法

方法		定义对象
	Tree([`Node root`])	Tree
		Tree
	addEvents(`Object object`) : void	Observable
	将对象中没有的事件从给出的对象中复制过来。	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	为该组件加入事件处理器函数	Observable
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	触发指定的事件, 并将参数传入（至少要有事件名称）。	Observable
	getNodeById(`String id`) : Node	Tree
	Gets a node in this tree by its id	Tree
	getRootNode() : Node	Tree
	Returns this root node for this tree	Tree
	hasListener(`String eventName`) : Boolean	Observable
	检查该对象是否拥有指定事件的侦听器	Observable
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	为该组件加入事件处理器函数, addListener 的简写方式	Observable
	purgeListeners() : void	Observable
	从对象身上移除所有的侦听器	Observable
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器	Observable
	setRootNode(`Node node`) : Node	Tree
	Sets the root node for this tree	Tree
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器, removeListener 的简写方式	Observable

公共事件

事件		定义对象
	append : (`Tree tree`, `Node parent`, `Node node`, `Number index`)	Tree
	Fires when a new child node is appended to a node in this tree.	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.	Tree
	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.	Tree
	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.	Tree
	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.	Tree
	insert : (`Tree tree`, `Node parent`, `Node node`, `Node refNode`)	Tree
	Fires when a new child node is inserted in a node in this tree.	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	Tree
	remove : (`Tree tree`, `Node parent`, `Node node`)	Tree
	Fires when a child node is removed from a node in this tree.	Tree

属性详情

root

public Node root

The root node for this tree

This property is defined by Tree.

构造函数

Tree

public function Tree([Node root])

参数：

root : Node
（可选） The root node

方法详情

addEvents

public function addEvents(Object object)

将对象中没有的事件从给出的对象中复制过来。给出的对象必须也继承于 Observable 对象此方法才会有效果。

参数：

object : Object
要复制事件的源对象

返回：

void

This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object scope], [Object options])

为组件添加一个事件监听器

参数：

eventName : String
侦听事件的类型
handler : Function
事件调用的方法
scope : Object
（可选）处理函数执行的作用域。处理函数 "this" 的内容。
options : Object
（可选）一个包含处理设置属性的对象。可以包含下列的属性：
- scope {Object} 处理函数执行的作用域。处理函数 "this" 的内容。
- delegate {String} 一个简单的选择器用来过滤目标或查找目标的子节点。
- stopEvent {Boolean} 值为 True 时用来中止事件。那样将中止传播，并防止缺省动作。
- preventDefault {Boolean} 值为 True 时用来防止缺省动作。
- stopPropagation {Boolean} 值为 True 时用来中止事件传播。
- normalized {Boolean} 值为 False 时向处理函数传递浏览器事件用以代替 Ext.EventObject 对象。
- delay {Number} 当事件触发后启用处理函数的延迟微秒数。
- single {Boolean} 值为 True 时将添加一个处理函数用来处理下个触发的事件，并在处理完后移除。
- buffer {Number} 使处理函数计划在由 Ext.util.DelayedTask 指定的微秒数后执行。如果事件在延迟期间再次触发，原来的处理函数将不再启动，而是由新的计划代替。
组合选项
使用选项参数可以组合不同类型的监听器：

下面是一个标准的、延迟执行的、一次性的监听器，将会自动停止事件并传递一个自定义的参数(forumId)
代码：
```
el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });
```
这个方法也允许传递的单个参数是一个包含多个指定处理函数的设置对象。

一次调用多个处理函数
代码：
```
el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });
```
或者简写为：
代码：
```
el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
```

返回：

void

This method is defined by Observable.

fireEvent

public function fireEvent(String eventName, Object... args)

触发指定的事件并给出参数（至少要有事件名称）。

参数：

eventName : String
args : Object...
传入处理函数的参数

返回：

Boolean
如果任何处理函数返回 false 则返回值为 false, 否则返回 true。

This method is defined by Observable.

getNodeById

public function getNodeById(String id)

Gets a node in this tree by its id

参数：

id : String

返回：

Node

This method is defined by Tree.

getRootNode

public function getRootNode()

Returns this root node for this tree

参数：

无。

返回：

Node

This method is defined by Tree.

hasListener

public function hasListener(String eventName)

检查该对象是否拥有指定事件的侦听器

参数：

eventName : String
查询事件之名称

返回：

Boolean
值为 True 值表示事件监听器存在, 否则值为 false。

This method is defined by Observable.

on

public function on(String eventName, Function handler, [Object options])

为该组件加入事件处理器函数, addListener 的简写方式

参数：

eventName : String
侦听事件的类型
handler : Function
事件调用的方法
options : Object
（可选）

返回：

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

从对象身上移除所有的侦听器

参数：

无。

返回：

void

This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])

移除侦听器

参数：

eventName : String
侦听事件的类型
handler : Function
删除的处理函数
scope : Object
（可选） The scope (this object) for the handler

返回：

void

This method is defined by Observable.

setRootNode

public function setRootNode(Node node)

Sets the root node for this tree

参数：

node : Node

返回：

Node

This method is defined by Tree.

un

public function un(String eventName, Function handler, [Object scope])

移除侦听器, removeListener 的简写方式

参数：

eventName : String
侦听事件的类型
handler : Function
删除的处理函数
scope : Object
（可选） The scope (this object) for the handler

返回：

void

This method is defined by Observable.

事件详情

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.