Class Ext.data.Node

Package:	Ext.data
Class:	Node
Extends:	Observable
Subclasses:	TreeNode
Defined In:	Tree.js

属性 - 方法 - 事件 - 设置选项

公共属性

属性		定义对象
	attributes : Object	Node
	The attributes supplied for the node. You can use this property to access any custom attributes you supplied.	Node
	childNodes : Array	Node
	All child nodes of this node.	Node
	firstChild : Node	Node
	The first direct child node of this node, or null if this node has no child nodes.	Node
	id : String	Node
	The node id.	Node
	lastChild : Node	Node
	The last direct child node of this node, or null if this node has no child nodes.	Node
	nextSibling : Node	Node
	The node immediately following this node in the tree, or null if there is no sibling node.	Node
	parentNode : Node	Node
	The parent node for this node.	Node
	previousSibling : Node	Node
	The node immediately preceding this node in the tree, or null if there is no sibling node.	Node

公共方法

方法		定义对象
	Node(`Object attributes`)	Node
		Node
	addEvents(`Object object`) : void	Observable
	将对象中没有的事件从给出的对象中复制过来。	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	为该组件加入事件处理器函数	Observable
	appendChild(`Node/Array node`) : Node	Node
	Insert node(s) as the last child node of this node.	Node
	bubble(`Function fn`, [`Object scope`], [`Array args`]) : void	Node
	Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of function call...	Node
	cascade(`Function fn`, [`Object scope`], [`Array args`]) : void	Node
	Cascades down the tree from this node, calling the specified function with each node. The scope (this) of function c...	Node
	contains(`Node node`) : Boolean	Node
	Returns true if this node is an ancestor (at any point) of the passed node.	Node
	eachChild(`Function fn`, [`Object scope`], [`Array args`]) : void	Node
	Interates the child nodes of this node, calling the specified function with each node. The scope (this) of function ...	Node
	findChild(`String attribute`, `Mixed value`) : Node	Node
	Finds the first child that has the attribute with the specified value.	Node
	findChildBy(`Function fn`, [`Object scope`]) : Node	Node
	Finds the first child by a custom function. The child matches if the function passed returns true.	Node
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	触发指定的事件, 并将参数传入（至少要有事件名称）。	Observable
	getDepth() : Number	Node
	Returns depth of this node (the root node has a depth of 0)	Node
	getOwnerTree() : Tree	Node
	Returns the tree this node is in.	Node
	getPath([`String attr`]) : String	Node
	Returns the path for this node. The path can be used to expand or select this node programmatically.	Node
	hasListener(`String eventName`) : Boolean	Observable
	检查该对象是否拥有指定事件的侦听器	Observable
	indexOf(`Node node`) : Number	Node
	Returns the index of a child node	Node
	insertBefore(`Node node`, `Node refNode`) : Node	Node
	Inserts the first node before the second node in this nodes childNodes collection.	Node
	isAncestor(`Node node`) : Boolean	Node
	Returns true if the passed node is an ancestor (at any point) of this node.	Node
	isFirst() : Boolean	Node
	Returns true if this node is the first child of its parent	Node
	isLast() : Boolean	Node
	Returns true if this node is the last child of its parent	Node
	isLeaf() : Boolean	Node
	Returns true if this node is a leaf	Node
	item(`Number index`) : Node	Node
	Returns the child node at the specified index.	Node
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	为该组件加入事件处理器函数, addListener 的简写方式	Observable
	purgeListeners() : void	Observable
	从对象身上移除所有的侦听器	Observable
	removeChild(`Node node`) : Node	Node
	Removes a child node from this node.	Node
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器	Observable
	replaceChild(`Node newChild`, `Node oldChild`) : Node	Node
	Replaces one child node in this node with another.	Node
	sort(`Function fn`, [`Object scope`]) : void	Node
	Sorts this nodes children using the supplied sort function	Node
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器, removeListener 的简写方式	Observable

公共事件

事件		定义对象
	append : (`Tree tree`, `Node this`, `Node node`, `Number index`)	Node
	Fires when a new child node is appended	Node
	beforeappend : (`Tree tree`, `Node this`, `Node node`)	Node
	Fires before a new child is appended, return false to cancel the append.	Node
	beforeinsert : (`Tree tree`, `Node this`, `Node node`, `Node refNode`)	Node
	Fires before a new child is inserted, return false to cancel the insert.	Node
	beforemove : (`Tree tree`, `Node this`, `Node oldParent`, `Node newParent`, `Number index`)	Node
	Fires before this node is moved to a new location in the tree. Return false to cancel the move.	Node
	beforeremove : (`Tree tree`, `Node this`, `Node node`)	Node
	Fires before a child is removed, return false to cancel the remove.	Node
	insert : (`Tree tree`, `Node this`, `Node node`, `Node refNode`)	Node
	Fires when a new child node is inserted.	Node
	move : (`Tree tree`, `Node this`, `Node oldParent`, `Node newParent`, `Number index`)	Node
	Fires when this node is moved to a new location in the tree	Node
	remove : (`Tree tree`, `Node this`, `Node node`)	Node
	Fires when a child node is removed	Node

设置选项

设置选项		定义对象
	id : String	Node
	The id for this node. If one is not specified, one is generated.	Node
	leaf : Boolean	Node
	true if this node is a leaf and does not have children	Node

属性详情

attributes

public Object attributes

The attributes supplied for the node. You can use this property to access any custom attributes you supplied.

This property is defined by Node.

childNodes

public Array childNodes

All child nodes of this node.

This property is defined by Node.

firstChild

public Node firstChild

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

This property is defined by Node.

id

public String id

The node id.

This property is defined by Node.

lastChild

public Node lastChild

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

This property is defined by Node.

nextSibling

public Node nextSibling

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

This property is defined by Node.

parentNode

public Node parentNode

The parent node for this node.

This property is defined by Node.

previousSibling

public Node previousSibling

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

This property is defined by Node.

构造函数

Node

public function Node(Object attributes)

参数：

attributes : Object
The attributes/config for the 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.

appendChild

public function appendChild(Node/Array node)

Insert node(s) as the last child node of this node.

参数：

node : Node/Array
The node or Array of nodes to append

返回：

Node
The appended node if single append, or null if an array was passed

This method is defined by Node.

bubble

public function bubble(Function fn, [Object scope], [Array args])

Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of function call will be the scope provided or the current 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.

参数：

fn : Function
The function to call
scope : Object
（可选） The scope of the function (defaults to current node)
args : Array
（可选） The args to call the function with (default to passing the current node)

返回：

void

This method is defined by Node.

cascade

public function cascade(Function fn, [Object scope], [Array args])

Cascades down the tree from this node, calling the specified function with each node. The scope (this) of function call will be the scope provided or the current 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.

参数：

fn : Function
The function to call
scope : Object
（可选） The scope of the function (defaults to current node)
args : Array
（可选） The args to call the function with (default to passing the current node)

返回：

void

This method is defined by Node.

contains

public function contains(Node node)

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

参数：

node : Node

返回：

Boolean

This method is defined by Node.

eachChild

public function eachChild(Function fn, [Object scope], [Array args])

Interates the child nodes of this node, calling the specified function with each node. The scope (this) of function call will be the scope provided or the current 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.

参数：

fn : Function
The function to call
scope : Object
（可选） The scope of the function (defaults to current node)
args : Array
（可选） The args to call the function with (default to passing the current node)

返回：

void

This method is defined by Node.

findChild

public function findChild(String attribute, Mixed value)

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

参数：

attribute : String
The attribute name
value : Mixed
The value to search for

返回：

Node
The found child or null if none was found

This method is defined by Node.

findChildBy

public function findChildBy(Function fn, [Object scope])

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

参数：

fn : Function
scope : Object
（可选）

返回：

Node
The found child or null if none was found

This method is defined by Node.

fireEvent

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

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

参数：

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

返回：

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

This method is defined by Observable.

getDepth

public function getDepth()

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

参数：

无。

返回：

Number

This method is defined by Node.

getOwnerTree

public function getOwnerTree()

Returns the tree this node is in.

参数：

无。

返回：

Tree

This method is defined by Node.

getPath

public function getPath([String attr])

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

参数：

attr : String
（可选） The attr to use for the path (defaults to the node's id)

返回：

String
The path

This method is defined by Node.

hasListener

public function hasListener(String eventName)

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

参数：

eventName : String
查询事件之名称

返回：

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

This method is defined by Observable.

indexOf

public function indexOf(Node node)

Returns the index of a child node

参数：

node : Node

返回：

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

This method is defined by Node.

insertBefore

public function insertBefore(Node node, Node refNode)

Inserts the first node before the second node in this nodes childNodes collection.

参数：

node : Node
The node to insert
refNode : Node
The node to insert before (if null the node is appended)

返回：

Node
The inserted node

This method is defined by Node.

isAncestor

public function isAncestor(Node node)

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

参数：

node : Node

返回：

Boolean

This method is defined by Node.

isFirst

public function isFirst()

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

参数：

无。

返回：

Boolean

This method is defined by Node.

isLast

public function isLast()

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

参数：

无。

返回：

Boolean

This method is defined by Node.

isLeaf

public function isLeaf()

Returns true if this node is a leaf

参数：

无。

返回：

Boolean

This method is defined by Node.

item

public function item(Number index)

Returns the child node at the specified index.

参数：

index : Number

返回：

Node

This method is defined by Node.

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.

removeChild

public function removeChild(Node node)

Removes a child node from this node.

参数：

node : Node
The node to remove

返回：

Node
The removed node

This method is defined by Node.

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.

replaceChild

public function replaceChild(Node newChild, Node oldChild)

Replaces one child node in this node with another.

参数：

newChild : Node
The replacement node
oldChild : Node
The node to replace

返回：

Node
The replaced node

This method is defined by Node.

sort

public function sort(Function fn, [Object scope])

Sorts this nodes children using the supplied sort function

参数：

fn : Function
scope : Object
（可选）

返回：

void

This method is defined by Node.

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

Subscribers will be called with the following parameters:

tree : Tree
The owner tree
this : Node
This node
node : Node
The newly appended node
index : Number
The index of the newly appended node

This event is defined by Node.

beforeappend

public event beforeappend

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

Subscribers will be called with the following parameters:

tree : Tree
The owner tree
this : Node
This node
node : Node
The child node to be appended

This event is defined by Node.

beforeinsert

public event beforeinsert

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

Subscribers will be called with the following 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

This event is defined by Node.

beforemove

public event beforemove

Fires before this 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
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

This event is defined by Node.

beforeremove

public event beforeremove

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

Subscribers will be called with the following parameters:

tree : Tree
The owner tree
this : Node
This node
node : Node
The child node to be removed

This event is defined by Node.

insert

public event insert

Fires when a new child node is inserted.

Subscribers will be called with the following 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

This event is defined by Node.

move

public event move

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

Subscribers will be called with the following 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

This event is defined by Node.

remove

public event remove

Fires when a child node is removed

Subscribers will be called with the following parameters:

tree : Tree
The owner tree
this : Node
This node
node : Node
The removed node

This event is defined by Node.

设置详情

id

id : String

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

This config option is defined by Node.

leaf

leaf : Boolean

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

This config option is defined by Node.