TreeNode 节点类

显示对象的基类,拥有父子节点的特性,树结构
支持事件:
EventObject.DISPLAY 加入到显示列表中时(即该对象加入stage的显示列表里,从不需要被渲染到需要渲染的状态改变时触发)
EventObject.UNDISPLAY 从显示列表中移除时(即该对象从stage的显示列表移除时,从需要被渲染到不需要渲染的状态改变时触发)
EventObject.REMOVED 从父节点中移除时触发(无需在显示列表中)
EventObject.ADDED 加入到某个节点时触发(无需在显示列表中)

维护人员:黑暗之神KDS
创建时间:2017-01-01

继承 →EventDispatcher
子类 Sprite

Public 属性

属性
name : string;
节点名称
disposed : boolean;
只读是否已经销毁。对象销毁后不能再使用
numChildren : number;
只读子对象数量。
parent : TreeNode;
父节点

Public 方法

方法
dispose(): void
销毁此对象。destroy对象默认会把自己从父节点移除,并且清理自身引用关系,等待js自动垃圾回收机制回收。destroy后不能再使用。
addChild(node : TreeNode): TreeNode
添加子节点。
addChildren(...args : any): void
批量增加子节点
addChildAt(node : TreeNode, index : number): TreeNode
添加子节点到指定的索引位置。
getChildIndex(node : TreeNode): number
根据子节点对象,获取子节点的索引位置。
getChildByName(name : string): TreeNode
根据子节点的名字,获取子节点对象。
getChildAt(index : number): TreeNode
根据子节点的索引位置,获取子节点对象。
setChildIndex(node : TreeNode, index : number): TreeNode
设置子节点的索引位置。
removeChild(node : TreeNode): TreeNode
删除子节点。
removeSelf(): TreeNode
从父容器删除自己,如已经被删除不会抛出异常。
removeChildByName(name : string): TreeNode
根据子节点名字删除对应的子节点对象,如果找不到不会抛出异常。
removeChildAt(index : number): TreeNode
根据子节点索引位置,删除对应的子节点对象。
removeChildren(beginIndex? : number, endIndex? : number): TreeNode
删除指定索引区间的所有子对象。
contains(node : TreeNode): boolean
当前容器是否包含指定的 TreeNode 节点对象 。

详情

dispose

dispose(): void :

销毁此对象。destroy对象默认会把自己从父节点移除,并且清理自身引用关系,等待js自动垃圾回收机制回收。destroy后不能再使用。
destroy时会移除自身的事情监听,自身的timer监听,移除子对象及从父节点移除自己。

addChild

addChild(node : TreeNode): TreeNode :

添加子节点。
@param node 节点对象
@return 返回添加的节点

addChildren

addChildren(...args : any): void :

批量增加子节点
@param ...args 无数子节点。

addChildAt

addChildAt(node : TreeNode, index : number): TreeNode :

添加子节点到指定的索引位置。
@param node 节点对象。
@param index 索引位置。
@return 返回添加的节点。

getChildIndex

getChildIndex(node : TreeNode): number :

根据子节点对象,获取子节点的索引位置。
@param node 子节点。
@return 子节点所在的索引位置。

getChildByName

getChildByName(name : string): TreeNode :

根据子节点的名字,获取子节点对象。
@param name 子节点的名字。
@return 节点对象。

getChildAt

getChildAt(index : number): TreeNode :

根据子节点的索引位置,获取子节点对象。
@param index 索引位置
@return 子节点

setChildIndex

setChildIndex(node : TreeNode, index : number): TreeNode :

设置子节点的索引位置。
@param node 子节点。
@param index 新的索引。
@return 返回子节点本身。

removeChild

removeChild(node : TreeNode): TreeNode :

删除子节点。
@param node 子节点
@return 被删除的节点

removeSelf

removeSelf(): TreeNode :

从父容器删除自己,如已经被删除不会抛出异常。

返回

当前节点( TreeNode )对象。

removeChildByName

removeChildByName(name : string): TreeNode :

根据子节点名字删除对应的子节点对象,如果找不到不会抛出异常。
@param name 对象名字。

返回

查找到的节点( TreeNode )对象。

removeChildAt

removeChildAt(index : number): TreeNode :

根据子节点索引位置,删除对应的子节点对象。
@param index 节点索引位置。
@return 被删除的节点。

removeChildren

removeChildren(beginIndex? : number, endIndex? : number): TreeNode :

删除指定索引区间的所有子对象。
@param beginIndex 开始索引。默认值=0
@param endIndex 结束索引。默认值=0x7fffffff

返回

当前节点对象。

contains

contains(node : TreeNode): boolean :

当前容器是否包含指定的 TreeNode 节点对象 。
@param node 指定的 TreeNode 节点对象 。
@return 一个布尔值表示是否包含指定的 TreeNode 节点对象 。


Copyright © 2021 - 2025