全称 mx.controls.TreeListViewItem
命名空间 mx.controls
TreeListViewItem
继承层次结构 TreeListViewItemControl
源文件 ~\mx\scripts\controls\TreeListViewItem.js
提供一个数据项列表控件(TreeListView 类型)中的数据项节点的类。该数据项容器的 HTML 元素为 <TR>

构造函数

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

初始化函数

名称 说明
init() 初始化数据项节点。

方法

名称 说明
appendItem(p_item) 添加一个子数据项节点,并返回该节点。
appendItems(p_items) 添加一组数据项子节点。
clearItems() 移除所有的子数据项节点。
collapse() 隐藏子节点。
commitChanges() 确认修改。
contains($p_target) 返回一个 Boolean 值,该值表示控件的容器中是否包含该 JQuery 对象。
dispose() 释放对象运行时动态生成的内容(属性、方法、事件)。
expand() 展开子节点。
getChanges() 返回修改后的字段。
getContext() 获取控件当前所属 Weblet 的上下文信息( WebletContext 类型)。
getEl() 获取控件容器对应的 HTML DOM 元素对象。
getValue(p_index) 返回指定列序号或列名对应的数据项的值。
getValues() 获取 {@values}。
hide() 隐藏控件,设置控件不可见。
insertCell(p_col, p_value)
insertItemAfter(p_item) 将节点插入到指定的 JQuery 对象的后面,并返回该 TreeListViewItem 节点。
insertItemBefore(p_item) 将节点插入到指定的 JQuery 对象的前面,并返回该 TreeListViewItem 节点。
isChanged() 判断记录是否修改。
isFolder() 返回一个 Boolean 值,表示该数据项节点是否为文件夹节点。
isSelected() 返回一个 Boolean 值,表示该节点是否选中。
markAsFolder([p_isFolder]) 将该数据项节点标记为“folder”或“item”节点。
markAsSelected([p_selected]) 将该数据项节点标记为选中的节点。
moveTo(p_left, p_top) 移动控件到指定位置。
refresh() 更新当前项所有字段的显示值。
rejectChanges() 撤销修改。
remove(p_isTriggerEvent) 移除该节点以及所有的子节点的 DOM 元素。所有绑定的事件、附加的数据等都会保留下来。
removeItem(p_Item) 移除指定的子数据项节点。
resizeTo(p_width, p_height) 重设控件的大小。
select(p_triggerEvent) 请参见 TreeListView.selectItem 方法。该方法仅在 owner 字段不为空时有效。
setBorder(p_border) 设置控件的边框样式。
setBottom(p_bottom) 设置 bottom 字段的值。
setCss(p_css) 设置 css 字段的值。
setCssClass(p_cssClass) 设置 cssClass} 字段的值
setDisplay(p_display) 设置 display 字段的值。
setEnabled(p_enabled) 设置 enabled 字段的值。
setHeight(p_height) 设置 height 字段的值。
setImageUrl([p_imageUrl]) 设置 imageUrl 字段的值。
setItems(p_items) 设置 items 字段的值。该方法首先会清空 items 集合。
setItemType(p_type) 设置 itemType 字段的值。
setLeft(p_left) 设置 left 字段的值。
setPadding(p_padding) 设置控件的内边距。
setPosition(p_position) 设置 position 字段的值。
setRight(p_right) 设置 right 字段的值。
setTop(p_top) 设置 top 字段的值。
setValue(p_index, p_value) 设置指定列序号或列名对应的数据项节点的值。
setValues(p_values) 设置 values 字段的值。
setVisible(p_visible) 设置 visible 字段的值。
setWidth(p_width) 设置 width 字段的值。
show() 显示控件,设置控件可见。
toggleExpand() 切换节点展开的状态。如果节点隐藏,使用该方法后就展开;反之则隐藏。
$(p_expression) 该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj]) 返回一个 JQuery 对象。
_hideChildren() 受保护的。
_setItemPathAndDepth() 受保护的。
_showChildren() 受保护的。

字段

名称 说明
alias 获取或设置一个字符串,表示控件的别名。
border 获取控件的边框样式。如“1px solid red”,表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom 获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
checked 获取一个 Boolean 值,表示数据项是否被选中。
cssClass 指定css伪类名称,设置控件显示样式
depth 获取一个数字,表示该数据项节点的深度(如 0,表示第一层节点)。
display 获取控件的显示样式值。如“none”,表示隐藏控件; “block”表示强制作为块对象呈递。请使用 setDisplay。注:该"block"值不能在ComplexGrid控件中使用。 方法设置该字段的值。
enabled 获取控件是否可以对用户交互作出响应。如果该值为 true,则表示控件可以对用户交互作出响应;反之则不能。 请使用 setEnabled 方法设置该字段的值。
eTag 获取控件的标签。
expanded 获取一个 Boolean 值,表示该数据项节点的子节点是否展开。如果该值为 true,表示子节点展开;反之则隐藏。
hasChildren 获取一个 Boolean 值,表示数据项是否具有子数据项。
hasLoad 获取一个 Boolean 值,表示数据项的子数据项是否已经加载。
height 获取控件的高度。可以是数字(如 500)、字符串(如“500px”或“50%”)。请使用 setHeight 方法设置该字段的值。
id 获取一个字符串,表示数据项节点的唯一标识。
imageUrl 获取一个字符串,表示 TreeListViewItem 图像的 URL(如“$/icons/role.png”)。请使用 setImageUrl 方法设置该字段的值。
items 获取一个集合,包含该数据项节点的子节点(TreeListViewItem 类型)。请使用 setItems 方法设置该集合的值。
itemType 获取一个字符串,表示说明数据项节点的类型(如“folder”,“role”,“job”等)。该属性的值如果与 TreeListView.images 集合中的索引值相同,则会显示对应的图片。 请使用 setItemType 方法设置该字段的值。
layoutConfigs 获取或者设置一个 JSON 对象,该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left 获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
owner 获取该对象的父容器的对象,通常是一个 TreeListView 类的实例。
padding 获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素; “4px 2px 3px 1px”则表示上边距为 4 像素,右边距为 2 像素,下边距为 3 像素,左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
parent 获取控件所属的父对象。
parentItem 获取一个对象(TreeListViewItem 类型),表示该数据项节点的父节点。
path 获取一个字符串,表示数据项节点的完整 id。该属性的值为父数据项节点的 path 属性值加该节点的 id 属性的值。
permissionID 获取或设置一个字符串,表示控件的权限标识。
position 获取控件位置样式值。如“static”,表示无特殊定位,对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。

该字段的可选值包括:

  • static
  • relative
  • absolute
  • fixed

right 获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
top 获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
values 获取一个 JSON 对象,表示数据项的所有的值(当构造函数的参数不为空时,该字段与构造函数的参数相同)。请使用 setValues 方法设置该字段的值。
visible 获取一个 Boolean 值,表示控件是否可见。如果该值为 true,则表示控件可见;反之则不可见。请使用 setVisible 方法设置该字段的值。
width 获取控件的宽度。可以是数字(如 500)、字符串(如“500px”或“50%”)。请使用 setWidth 方法设置该字段的值。
$e 获取该控件的占位符,该占位符为一个 JQuery 对象。

构造函数详细信息

TreeListViewItem() 方法

构建 TreeListViewItem 类的新实例。

初始化函数详细信息

init() 方法

初始化数据项节点。

继承自


方法详细信息

appendItem(p_item) 方法

添加一个子数据项节点,并返回该节点。

参数

  • p_item
    要插入的数据项节点,详见 _createItem 方法的参数 p_item。

appendItems(p_items) 方法

添加一组数据项子节点。

参数

  • p_items
    一个数组,数组中的元素请参见 appendItem 方法的参数 p_item。

clearItems() 方法

移除所有的子数据项节点。

collapse() 方法

隐藏子节点。

commitChanges() 方法

确认修改。

contains($p_target) 方法

返回一个 Boolean 值,该值表示控件的容器中是否包含该 JQuery 对象。

参数

  • $p_target
    一个 JQuery 对象,或 JQuery 选择器对应的字符串(如“#container”),或 HTML DOM 元素。

继承自


dispose() 方法

释放对象运行时动态生成的内容(属性、方法、事件)。

继承自


expand() 方法

展开子节点。

getChanges() 方法

返回修改后的字段。

getContext() 方法

获取控件当前所属 Weblet 的上下文信息( WebletContext 类型)。

继承自


getEl() 方法

获取控件容器对应的 HTML DOM 元素对象。

继承自


getValue(p_index) 方法

返回指定列序号或列名对应的数据项的值。

参数

  • p_index
    一个数字(如 0),表示列的序号;或一个字符串,表示列的名称(TreeListViewColumn.name 字段的值)。

getValues() 方法

获取 {@values}。

hide() 方法

隐藏控件,设置控件不可见。

继承自


insertCell(p_col, p_value) 方法

参数

  • p_col
  • p_value

insertItemAfter(p_item) 方法

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

参数


insertItemBefore(p_item) 方法

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

参数


isChanged() 方法

判断记录是否修改。

isFolder() 方法

返回一个 Boolean 值,表示该数据项节点是否为文件夹节点。

isSelected() 方法

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

markAsFolder([p_isFolder]) 方法

将该数据项节点标记为“folder”或“item”节点。

参数

  • p_isFolder
    可选的。默认值为“true”。一个 Boolean 值,表示将该节点标记为“folder”节点还是“item”节点。当该值为 true 时,标记为“folder”;反之则标记为“item”。

markAsSelected([p_selected]) 方法

将该数据项节点标记为选中的节点。

参数

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

moveTo(p_left, p_top) 方法

移动控件到指定位置。

参数

  • p_left
    一个数字,表示 css 样式的 left 属性。
  • p_top
    一个数字,表示 css 样式的 top 属性。

继承自


refresh() 方法

更新当前项所有字段的显示值。

rejectChanges() 方法

撤销修改。

remove(p_isTriggerEvent) 方法

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

参数

  • p_isTriggerEvent

removeItem(p_Item) 方法

移除指定的子数据项节点。

参数

  • p_Item

resizeTo(p_width, p_height) 方法

重设控件的大小。

参数

  • p_width
    控件的宽度,可以是数字(如 100),也可以是字符串(如 “100%”)。
  • p_height
    控件的高度,可以是数字(如 100),也可以是字符串(如 “100%”)。

继承自


select(p_triggerEvent) 方法

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

参数

  • p_triggerEvent

setBorder(p_border) 方法

设置控件的边框样式。

参数

  • p_border
    一个字符串,表示css样式的 border 属性。

继承自


setBottom(p_bottom) 方法

设置 bottom 字段的值。

参数

  • p_bottom
    控件的下边界与父容器下边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

继承自


setCss(p_css) 方法

设置 css 字段的值。

参数

  • p_css
    一个 JSON 对象,表示控件的 CSS 样式。

继承自


setCssClass(p_cssClass) 方法

设置 cssClass} 字段的值

参数

  • p_cssClass
    一个String 对象,样式classname

继承自


setDisplay(p_display) 方法

设置 display 字段的值。

参数

  • p_display
    css 样式的 display 属性。

继承自


setEnabled(p_enabled) 方法

设置 enabled 字段的值。

参数

  • p_enabled

继承自


setHeight(p_height) 方法

设置 height 字段的值。

参数

  • p_height
    控件的高度,可以是数字(如 100),也可以是字符串(如 “100%”)。

继承自


setImageUrl([p_imageUrl]) 方法

设置 imageUrl 字段的值。

参数

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

setItems(p_items) 方法

设置 items 字段的值。该方法首先会清空 items 集合。

参数


setItemType(p_type) 方法

设置 itemType 字段的值。

参数

  • p_type

setLeft(p_left) 方法

设置 left 字段的值。

参数

  • p_left
    控件的左边界与父容器左边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

继承自


setPadding(p_padding) 方法

设置控件的内边距。

参数

  • p_padding
    一个字符串,表示css样式的 padding 属性。

继承自


setPosition(p_position) 方法

设置 position 字段的值。

参数

  • p_position
    一个字符串,表示 css 样式的 position 属性。

继承自


setRight(p_right) 方法

设置 right 字段的值。

参数

  • p_right
    控件的右边界与父容器右边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

继承自


setTop(p_top) 方法

设置 top 字段的值。

参数

  • p_top
    控件的上边界与父容器上边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

继承自


setValue(p_index, p_value) 方法

设置指定列序号或列名对应的数据项节点的值。

参数

  • p_index
    一个数字(如 0),表示列的在集合中的序号;或一个字符串,表示列的名称。
  • p_value
    一个字符串,表示要设置的值。

setValues(p_values) 方法

设置 values 字段的值。

参数

  • p_values

setVisible(p_visible) 方法

设置 visible 字段的值。

参数

  • p_visible
    一个 Boolean 值,表示控件是否可见。

继承自


setWidth(p_width) 方法

设置 width 字段的值。

参数

  • p_width
    控件的高度,可以是数字(如 500)、字符串(如“500px”或“50%”).

继承自


show() 方法

显示控件,设置控件可见。

继承自


toggleExpand() 方法

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

$(p_expression) 方法

该方法与 me.$e.find(p_expression) 等同。

参数

  • p_expression

继承自


$wrap([p_obj]) 方法

返回一个 JQuery 对象。

参数

  • p_obj
    可选的。默认值为“me.$e”。一个 JQuery 对象,或继承自 Control 的控件,或字符串,或 HTML DOM 元素。如果参数为 JQuery 对象,则返回本身;如果参数为继承自 Control 的控件,则返回控件的 $e 对象;如果参数为字符串,则返回以字符串为选择器的 JQuery 对象;如果参数为空,则返回控件本身的 $e 对象。

继承自


_hideChildren() 方法

受保护的。

_setItemPathAndDepth() 方法

受保护的。

_showChildren() 方法

受保护的。

字段详细信息

alias 字段

获取或设置一个字符串,表示控件的别名。

继承自


border 字段

获取控件的边框样式。如“1px solid red”,表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。

继承自


bottom 字段

获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。

继承自


checked 字段

获取一个 Boolean 值,表示数据项是否被选中。

cssClass 字段

指定css伪类名称,设置控件显示样式

继承自


depth 字段

获取一个数字,表示该数据项节点的深度(如 0,表示第一层节点)。

display 字段

获取控件的显示样式值。如“none”,表示隐藏控件; “block”表示强制作为块对象呈递。请使用 setDisplay。注:该"block"值不能在ComplexGrid控件中使用。 方法设置该字段的值。

继承自


enabled 字段

获取控件是否可以对用户交互作出响应。如果该值为 true,则表示控件可以对用户交互作出响应;反之则不能。 请使用 setEnabled 方法设置该字段的值。

继承自

默认值

true

eTag 字段

获取控件的标签。

继承自

默认值

<div/>

expanded 字段

获取一个 Boolean 值,表示该数据项节点的子节点是否展开。如果该值为 true,表示子节点展开;反之则隐藏。

默认值

false

hasChildren 字段

获取一个 Boolean 值,表示数据项是否具有子数据项。

hasLoad 字段

获取一个 Boolean 值,表示数据项的子数据项是否已经加载。

height 字段

获取控件的高度。可以是数字(如 500)、字符串(如“500px”或“50%”)。请使用 setHeight 方法设置该字段的值。

继承自


id 字段

获取一个字符串,表示数据项节点的唯一标识。

imageUrl 字段

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

默认值

null

items 字段

获取一个集合,包含该数据项节点的子节点(TreeListViewItem 类型)。请使用 setItems 方法设置该集合的值。

集合

该字段是一个集合数组字段。 集合中成员的类型为 mx.controls.TreeListViewItem

集合索引

数据项节点在集合中的序号(从 0 开始计数)。

itemType 字段

获取一个字符串,表示说明数据项节点的类型(如“folder”,“role”,“job”等)。该属性的值如果与 TreeListView.images 集合中的索引值相同,则会显示对应的图片。 请使用 setItemType 方法设置该字段的值。

默认值

item

layoutConfigs 字段

获取或者设置一个 JSON 对象,该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。

继承自


left 字段

获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。

继承自


owner 字段

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

默认值

null

padding 字段

获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素; “4px 2px 3px 1px”则表示上边距为 4 像素,右边距为 2 像素,下边距为 3 像素,左边距为 1 像素。请使用 setPadding 方法设置该字段的值。

继承自


parent 字段

获取控件所属的父对象。

继承自


parentItem 字段

获取一个对象(TreeListViewItem 类型),表示该数据项节点的父节点。

默认值

null

path 字段

获取一个字符串,表示数据项节点的完整 id。该属性的值为父数据项节点的 path 属性值加该节点的 id 属性的值。

permissionID 字段

获取或设置一个字符串,表示控件的权限标识。

继承自


position 字段

获取控件位置样式值。如“static”,表示无特殊定位,对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。

该字段的可选值包括:

  • static
  • relative
  • absolute
  • fixed

继承自


right 字段

获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。

继承自


top 字段

获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。

继承自


values 字段

获取一个 JSON 对象,表示数据项的所有的值(当构造函数的参数不为空时,该字段与构造函数的参数相同)。请使用 setValues 方法设置该字段的值。

visible 字段

获取一个 Boolean 值,表示控件是否可见。如果该值为 true,则表示控件可见;反之则不可见。请使用 setVisible 方法设置该字段的值。

继承自

默认值

true

width 字段

获取控件的宽度。可以是数字(如 500)、字符串(如“500px”或“50%”)。请使用 setWidth 方法设置该字段的值。

继承自


$e 字段

获取该控件的占位符,该占位符为一个 JQuery 对象。

继承自