全称 mx.datacontrols.DataTreeNode
命名空间 mx.datacontrols
类 DataTreeNode
继承层次结构 DataTreeNode
源文件 ~\mx\scripts\datacontrols\DataTreeNode.js
提供一个 DataTree 控件中节点的类。

构造函数

名称 说明
DataTreeNode() 构建 DataTreeNode 类的新实例。

初始化函数

名称 说明
init()

方法

名称 说明
appendNode(p_node) 添加一个子节点（该节点为最后一个子节点），并返回该 DataTreeNode 节点。
appendNodes(p_nodes) 添加一组子节点，并以数组的形式返回添加的这些 DataTreeNode 节点。
childNodesCheckedStatus() 返回一个字符串值，表示该节点所有子节点的选中状态。包括三种“checked”、“unchecked”、“checkedPart”，分别表示全选、全部未选中、选中部分节点。
collapse([p_callback]) 隐藏子节点。
equals(p_node) 返回一个值，表示该节点与做比较的节点是否相同。
expand([p_callback]) 展开子节点。
findNode(p_expression) 返回当前节点下复合 p_expression 条件的树节点（DataTreeNode 类型）。请参见 DataTree.findNode 示例 2。
getLevel() 获取当前节点的层数。
getNextNode() 返回一个 DataTreeNode 对象，表示该节点的后一个节点。
getParentNode() 返回一个 DataTreeNode 对象，表示该节点的父节点。
getPrevNode() 返回一个 DataTreeNode 对象，表示该节点的前一个节点。
getValue(p_name) 返回该对象的属性值或节点的 HTML DOM 元素的属性值。
hasLoaded() 返回一个 Boolean 值，表示该节点是否已加载子节点。如果该值为 true，则表示已加载；反之则没有。
insertNodeAfter(p_node, $after) 将节点插入到指定的 JQuery 对象的后面，并返回该 DataTreeNode 节点。
insertNodeBefore(p_node, $before) 将节点插入到指定的 JQuery 对象的前面，并返回该 DataTreeNode 节点。
isChecked() 返回一个 Boolean 值，表示该节点是否选中。
isSelected() 返回一个 Boolean 值，表示该节点是否选中。
markAsCut([p_isCut]) 将该节点标记为“已剪切”节点。
markAsSelected([p_selected]) 将该节点标记为选中的节点。
moveDown() 将当前节点往下移动一格。如果是最后一个节点则位置不变。
moveTo(p_index) 将当前节点移动到指定的位置。
moveUp() 将当前节点向上移动一格。如果是第一个节点则位置不变。
prependNode(p_node) 添加一个子节点（该节点为第一个子节点），并返回该 DataTreeNode 节点。
refresh([p_callback]) 刷新子节点。
refreshSelf() 刷新自身文本或图标信息。
removeNode([p_removeRemote], [p_callback]) 移除该节点的 DOM 元素。所有绑定的事件、附加的数据等都会保留下来。
select() 请参见 DataTree.selectNode 方法。该方法仅在 owner 字段不为空时有效。
setChecked(p_checked, p_checkCascade) 设置树节点的选中状态。
setID(p_id) 设置 id 字段的值。
setImageKey([p_imageKey]) 设置 imageKey 字段的值。该方法会在 $/icons 目录中查找相应的 png 图片。
setImageUrl([p_imageUrl]) 设置 imageUrl 字段的值。
setItemType(p_type) 设置 itemType 字段的值。
setText(p_text) 设置 text 字段的值。
setValue(p_name, p_value) 根据字段名称设置该字段的值。
toggleChecked(p_checkCascade) 切换选中状态。
toggleExpand() 切换子节点展开的状态。如果子节点隐藏，使用该方法后就展开；反之则隐藏。
_createNode(p_node) 受保护的。根据指定的条件创建并返回节点（DataTreeNode 类型）。

字段

名称 说明
childNodes 获取同步树中当前节点的子节点集合。
displayMode 获取一个字符串值，表示该节点的显示方式。

该字段的可选值包括:

  • entityNode - 实体节点。表示节点是一个实体对象节点。
  • propGroup - 属性分组节点。表示节点是属性分组。
  • virtualNode - 虚拟节点。表示节点是一个静态节点。
  • enumNode - 枚举节点。节点的值来源于枚举项
expanded 获取一个 Boolean 值，表示该节点的子节点是否展开。如果该值为 true，表示子节点展开；反之则隐藏。
hasChildren 获取一个 Boolean 值，表示该节点是否有子节点。如果该值为 true，则表示有子节点；反之则没有。
id 获取一个字符串，表示节点的唯一标识。请使用 setID 方法设置该字段的值。
imageKey 获取一个字符串，表示 DataTreeNode 图像的名称。请使用 setImageKey 方法设置该字段的值。
imageUrl 获取一个字符串，表示 DataTreeNode 图像的 URL（如“$/icons/role.png”）。请使用 setImageUrl 方法设置该字段的值。
isLasyLoad 获取或设置一个 Boolean 值，表示树的节点是否懒加载。
itemType 获取一个字符串，表示说明节点的类型（如“folder”，“role”，“job”等）。请使用 setItemType 方法设置该字段的值。
owner 获取该对象的父容器的对象，通常是一个 DataTree 类的实例。
parent 获取该对象的父节点对象，通常是一个 DataTreeNode 类的实例。
queryParams 一个 JSON 对象，通常在加载子节点时需要一些请求参数时，可以使用字段。 使用时可以订购 DataTree.onexpanding 事件，在树节点展开之前为该字段赋值。 该请求参数会与默认的请求参数合并后一起传到服务端。
text 获取节点显示的文本。请使用 setText 方法设置该字段的值。

构造函数详细信息

DataTreeNode() 方法

构建 DataTreeNode 类的新实例。

初始化函数详细信息

init() 方法

方法详细信息

appendNode(p_node) 方法

添加一个子节点（该节点为最后一个子节点），并返回该 DataTreeNode 节点。

参数

  • p_node
    要插入的节点，详见 _createNode 方法的参数 p_node。

appendNodes(p_nodes) 方法

添加一组子节点，并以数组的形式返回添加的这些 DataTreeNode 节点。

参数

  • p_nodes
    一个数组，数组中的元素请参见 appendNode 方法的参数 p_nodes。

childNodesCheckedStatus() 方法

返回一个字符串值，表示该节点所有子节点的选中状态。包括三种“checked”、“unchecked”、“checkedPart”，分别表示全选、全部未选中、选中部分节点。

collapse([p_callback]) 方法

隐藏子节点。

参数

  • p_callback
    可选的。一个 Function 对象，表示节点隐藏后的回调方法。

equals(p_node) 方法

返回一个值，表示该节点与做比较的节点是否相同。

参数

expand([p_callback]) 方法

展开子节点。

参数

  • p_callback
    可选的。默认值为“null”。展开节点后的回调函数。

findNode(p_expression) 方法

返回当前节点下复合 p_expression 条件的树节点（DataTreeNode 类型）。请参见 DataTree.findNode 示例 2。

参数

  • p_expression
    一个 JQuery 表达式，该表达式应明确指向唯一的 LI 元素。

getLevel() 方法

获取当前节点的层数。

getNextNode() 方法

返回一个 DataTreeNode 对象，表示该节点的后一个节点。

getParentNode() 方法

返回一个 DataTreeNode 对象，表示该节点的父节点。

getPrevNode() 方法

返回一个 DataTreeNode 对象，表示该节点的前一个节点。

getValue(p_name) 方法

返回该对象的属性值或节点的 HTML DOM 元素的属性值。

参数

  • p_name
    一个字符串，表示该对象的属性名称（如“text”、“imageUrl”）或者表示节点的 HTML DOM 元素的属性名称（如“class”、“itemType”）。

hasLoaded() 方法

返回一个 Boolean 值，表示该节点是否已加载子节点。如果该值为 true，则表示已加载；反之则没有。

insertNodeAfter(p_node, $after) 方法

将节点插入到指定的 JQuery 对象的后面，并返回该 DataTreeNode 节点。

参数

  • p_node
    要插入的节点，详见 _createNode 方法的参数 p_node。
  • $after
    一个 JQuery 对象，表示要插入到该 JQuery 对象对应的节点之后。

insertNodeBefore(p_node, $before) 方法

将节点插入到指定的 JQuery 对象的前面，并返回该 DataTreeNode 节点。

参数

  • p_node
    要插入的节点，详见 _createNode 方法的参数 p_node。
  • $before
    一个 JQuery 对象，表示要插入到该 JQuery 对象对应的节点之前。

isChecked() 方法

返回一个 Boolean 值，表示该节点是否选中。

isSelected() 方法

返回一个 Boolean 值，表示该节点是否选中。

markAsCut([p_isCut]) 方法

将该节点标记为“已剪切”节点。

参数

  • p_isCut
    可选的。默认值为“true”。一个 Boolean 值，表示将该节点标记为已剪切。已剪切的节点图标会处于半透明状态。

markAsSelected([p_selected]) 方法

将该节点标记为选中的节点。

参数

  • p_selected
    可选的。默认值为“true”。一个 Boolean 值，表示是否将该节点标记为选中的节点。

moveDown() 方法

将当前节点往下移动一格。如果是最后一个节点则位置不变。

moveTo(p_index) 方法

将当前节点移动到指定的位置。

参数

  • p_index
    一个 Number 值，表示节点的索引（0 表示第一个节点）。

moveUp() 方法

将当前节点向上移动一格。如果是第一个节点则位置不变。

prependNode(p_node) 方法

添加一个子节点（该节点为第一个子节点），并返回该 DataTreeNode 节点。

参数

  • p_node
    要插入的节点，详见 _createNode 方法的参数 p_node。

refresh([p_callback]) 方法

刷新子节点。

参数

  • p_callback
    可选的。刷新展开节点后的回调函数。

refreshSelf() 方法

刷新自身文本或图标信息。

removeNode([p_removeRemote], [p_callback]) 方法

移除该节点的 DOM 元素。所有绑定的事件、附加的数据等都会保留下来。

参数

  • p_removeRemote
    可选的。默认值为“false”。一个 Boolean 值，表示是否需要删除服务端树节点。
  • p_callback
    可选的。默认值为“false”。一个 Function 对象，表示节点删除后的回调函数。

select() 方法

请参见 DataTree.selectNode 方法。该方法仅在 owner 字段不为空时有效。

setChecked(p_checked, p_checkCascade) 方法

设置树节点的选中状态。

参数

  • p_checked
  • p_checkCascade

setID(p_id) 方法

设置 id 字段的值。

参数

  • p_id

setImageKey([p_imageKey]) 方法

设置 imageKey 字段的值。该方法会在 $/icons 目录中查找相应的 png 图片。

参数

  • p_imageKey
    可选的。一个字符串，表示图片的名称。如 $/icons 目录中有一张图片为“role_48.png”或“role.png”的图片，那么该参数都是“role”。

setImageUrl([p_imageUrl]) 方法

设置 imageUrl 字段的值。

参数

  • p_imageUrl
    可选的。默认值为“$/images/space.png”。一个字符串，表示图像的 URL。

setItemType(p_type) 方法

设置 itemType 字段的值。

参数

  • p_type

setText(p_text) 方法

设置 text 字段的值。

参数

  • p_text

setValue(p_name, p_value) 方法

根据字段名称设置该字段的值。

参数

  • p_name
    一个字符串，表示字段名称（如“text”、“imageUrl”）或表示节点的 HTML DOM 元素的属性名称（如“class”、“itemType”）。

    该参数作为字段名称时的值可以为：

    • id
    • itemType
    • text
    • imageUrl
    • imageKey

  • p_value
    一个字符串，表示要设置的值。

toggleChecked(p_checkCascade) 方法

切换选中状态。

参数

  • p_checkCascade

toggleExpand() 方法

切换子节点展开的状态。如果子节点隐藏，使用该方法后就展开；反之则隐藏。

_createNode(p_node) 方法

受保护的。根据指定的条件创建并返回节点（DataTreeNode 类型）。

参数

字段详细信息

childNodes 字段

获取同步树中当前节点的子节点集合。

默认值

null

displayMode 字段

获取一个字符串值，表示该节点的显示方式。

该字段的可选值包括:

  • entityNode - 实体节点。表示节点是一个实体对象节点。
  • propGroup - 属性分组节点。表示节点是属性分组。
  • virtualNode - 虚拟节点。表示节点是一个静态节点。
  • enumNode - 枚举节点。节点的值来源于枚举项

默认值

null

expanded 字段

获取一个 Boolean 值，表示该节点的子节点是否展开。如果该值为 true，表示子节点展开；反之则隐藏。

默认值

false

hasChildren 字段

获取一个 Boolean 值，表示该节点是否有子节点。如果该值为 true，则表示有子节点；反之则没有。

默认值

false

id 字段

获取一个字符串，表示节点的唯一标识。请使用 setID 方法设置该字段的值。

imageKey 字段

获取一个字符串，表示 DataTreeNode 图像的名称。请使用 setImageKey 方法设置该字段的值。

imageUrl 字段

获取一个字符串，表示 DataTreeNode 图像的 URL（如“$/icons/role.png”）。请使用 setImageUrl 方法设置该字段的值。

isLasyLoad 字段

获取或设置一个 Boolean 值，表示树的节点是否懒加载。

默认值

true

itemType 字段

获取一个字符串，表示说明节点的类型（如“folder”，“role”，“job”等）。请使用 setItemType 方法设置该字段的值。

默认值

item

owner 字段

获取该对象的父容器的对象，通常是一个 DataTree 类的实例。

parent 字段

获取该对象的父节点对象，通常是一个 DataTreeNode 类的实例。

queryParams 字段

一个 JSON 对象，通常在加载子节点时需要一些请求参数时，可以使用字段。 使用时可以订购 DataTree.onexpanding 事件，在树节点展开之前为该字段赋值。 该请求参数会与默认的请求参数合并后一起传到服务端。

text 字段

获取节点显示的文本。请使用 setText 方法设置该字段的值。