全称 mx.controls.TreeListView
命名空间 mx.controls
TreeListView
继承层次结构 TreeListViewPagedControlControl
源文件 ~\mx\scripts\controls\TreeListView.js
提供一个数据项以树结构显示的列表控件。

示例 1

以下是一个 TreeListView 控件的示例。
JavaScript 代码
var treeList = new mx.controls.TreeListView({ type: "local", images: [ { itemType: "folder", imageUrl: "$/icons/folder.png" }, { itemType: "role", imageUrl: "$/icons/role.png" } ], // 控件中所有使用的图片集合 itemMenu: { items: [ { name: "appendRoot", text: "添加根节点" }, { name: "append", text: "添加子节点" }, "-", { name: "remove", text: "删除" } ], onitemclick: _toolStrip_itemclick }, // 定义数据项的右键菜单 columns: [ { name: "name", text: "名称" }, { name: "value", text: "值" } ], // 定义列 items: [ { name: "Folder1", value: "folder1", itemType: "folder", // itemType 的值与 images 集合中对象的 name 属性值相对应,显示相应的图片 items: [ { name: "A1", value: "a1", itemType: "role" } ] // Folder1 的子数据项节点 }, { name: "Folder2", value: "folder2", itemType: "folder", expanded: true, // 设置默认展开节点 items: [ { name: "Folder2-1", value: "folder2-1", itemType: "folder", expanded: true, items: [ { name: "B1", value: "b1", itemType: "role" }, { name: "B2", value: "b2", itemType: "role" } ] } ] } ], // 定义数据项。可以嵌套,表示数据项子节点 onitemdoubleclick: _treeItem_doubleclick }); function _treeItem_doubleclick(e) { alert("您双击的项的名称为:" + e.item.getValue("name")); } function _toolStrip_itemclick(e) { if (e.item.name == "appendRoot") { treeList.appendItem({ name: "root", value: "根节点", itemType: "folder" }); } }

构造函数

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

初始化函数

名称 说明
init()

方法

名称 说明
appendColumn(p_column) TreeListViewcolumns 集合中添加一个列,并返回该 TreeListViewColumn 对象。
appendColumn(p_name, [p_text], [p_width], [p_align]) TreeListViewcolumns 集合中添加一个列,并返回该 TreeListViewColumn 对象。
appendColumns(p_columns) TreeListView 的 添加一组列集合。
appendImage(p_image) images 集合中添加图片。
appendImages(p_images) images 集合中添加一组图片。
appendItem(p_item) TreeListView 的数据项列表(items 集合)添加根数据项,并返回该 TreeListViewItem 对象。如果根数据项包含子数据项节点,那么子数据项节点也会添加到控件中。
appendItems(p_items) TreeListView 的数据项列表(items 集合)添加一组数据项节点。
checkAll() 全选
checkItem(p_item) 勾选一条记录。 p_item 一个数字,表示行号,或者一个 TreeListViewItem 对象,或者一个 TreeListViewItem 对象的 id。
clearImages() 清空 images 集合。
clearItems() items 集合中移除所有数据项节点。若要从 TreeListView 中移除单个数据项,请使用 TreeListViewItem.remove 方法。
commitChanges() 重置修改的记录。
contains($p_target) 返回一个 Boolean 值,该值表示控件的容器中是否包含该 JQuery 对象。
deselectItem(p_item, [p_triggerEvent]) 清除对 TreeListView 中指定数据项节点的选定。
dispose() 释放对象运行时动态生成的内容(属性、方法、事件)。
endEdit() 结束编辑。
expandAll() 展开所有节点。
getChanges() 获取修改的记录。
getCheckedIds() 获取选中的 TreeListViewItem 数据项的主键集合。
getContext() 获取控件当前所属 Weblet 的上下文信息( WebletContext 类型)。
getEl() 获取控件容器对应的 HTML DOM 元素对象。
getFirstItemIndex() 获取当前页第一条数据的索引值。
getImageUrlOfItem(p_item) 根据指定的 TreeListViewItem,获取 TreeListViewItem.imageUrl 字段的值。
getItem(p_expression) 返回一个数据项节点(TreeListViewItem 类型)。
getPageCount() 获取当前的总页数
getSelections() 获取选中的 TreeListViewItem 数据项
hide() 隐藏控件,设置控件不可见。
isCheckedAll(p_item) 判断 TreeListView的数据项是否全部选中,或者判断某一个 TreeListViewItem 数据项的子项是否全部选中。
isFirstPage() 获取一个 Boolean 值,表示当前是否是第一页。
isLastPage() 获取一个 Boolean 值,表示当前是否是最后一页。
load(p_callback) 数据加载。
load(p_data) 数据加载。
load(p_params) 数据加载。
load(p_data, p_callback) 数据加载。
load(p_data, p_params) 数据加载。
load(p_data, p_params, p_callback) 数据加载。
loadChildren(p_item) 加载子项。
loadChildren(p_item, p_callback) 加载子项。
loadChildren(p_item, p_params) 加载子项。
loadChildren(p_item, p_params, p_callback) 加载子项。
moveTo(p_left, p_top) 移动控件到指定位置。
moveToFirstPage() 跳转到第一页。
moveToLastPage() 跳转到最后一页。
moveToNextPage() 跳转到下一页。
moveToPage(p_index) 跳转到某一页。
moveToPreviousPage() 跳转到前一页。
rejectChanges() 撤销修改的记录。
removeItem(p_item) 删除指定数据项。
resizeTo(p_width, p_height) 重设控件的大小。
selectItem(p_item, [p_triggerEvent]) 选择 TreeListView 列表中的指定的数据项节点。
setBorder(p_border) 设置控件的边框样式。
setBottom(p_bottom) 设置 bottom 字段的值。
setColumnVisible(p_columnName, p_visible) 设置列的可见性。
setCss(p_css) 设置 css 字段的值。
setCssClass(p_cssClass) 设置 cssClass} 字段的值
setDisplay(p_display) 设置 display 字段的值。
setDisplayHead(p_displayHead) 设置 displayHead 的字段值。
setEnabled(p_enabled) 设置 enabled 字段的值。
setFilter(p_filter) 设置 filter 的字段属性。
setHeight(p_height) 设置 height 字段的值。
setImages(p_images) 设置 images 字段的值。该方法首先会清空 images 集合的值。
setItems(p_items) 设置 items 字段的值。该方法首先会清空 items 集合。
setLeft(p_left) 设置 left 字段的值。
setPadding(p_padding) 设置控件的内边距。
setPageSize(p_pageSize) 设置 pageSize 字段的值。同时跳转到第一页。
setPosition(p_position) 设置 position 字段的值。
setRight(p_right) 设置 right 字段的值。
setTop(p_top) 设置 top 字段的值。
setVisible(p_visible) 设置 visible 字段的值。
setWidth(p_width) 设置 width 字段的值。
show() 显示控件,设置控件可见。
startEdit(p_item, p_fieldName) 启动编辑表格单元。
uncheckAll() 清除对 TreeListView 当前所有通过 CheckBox 选中的数据项的选中状态。
unCheckedItem(p_item) 取消勾选一条记录。 p_item 一个数字,表示行号,或者一个 TreeListViewItem 对象,或者一个 TreeListViewItem 对象的 id。
$(p_expression) 该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj]) 返回一个 JQuery 对象。
_adjustSizeForIE6() 受保护的。IE6调整大小,为兼容IE6

字段

名称 说明
alias 获取或设置一个字符串,表示控件的别名。
allColumns 获取一个集合,包含控件中显示的所有 TreeListViewColumn 的集合。
allowDragging 获取一个 Boolean 值,表示数据项节点是否允许拖拽。该字段必须在初始化前设置。 暂未提供行拖拽功能,该属性设置无效,暂时保留。
allowEditing 获取和设置一个 Boolean 值, 该属性表示是否允许编辑。
allowPaging 获取和设置一个 Boolean 值,表示是否可以分页。
autoLoad 获取或设置一个 Boolean 值,该属性表示是否自动执行远程数据加载。
baseUrl 获取或者设置一个属性,表示数据加载的服务地址。请参见 RESTClient.baseUrl
border 获取控件的边框样式。如“1px solid red”,表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom 获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
client
columns 获取一个集合,包含控件中第一层列 TreeListViewColumn 与列分组 TreeListViewColumnGroup 的集合。
contextMenu 一个 ContextMenu 对象,表示控件的右键菜单。
cssClass 指定css伪类名称,设置控件显示样式
dicts 获取或者设置一个数组,该值表示数据项的数据字典。例如: [ {name: "gender", values:[{text: "女", value: "female"}, {text: "男", value: "male"}]}, {name: "fruit", values:[{text: "苹果", value: "appple"}, {text: "香蕉", value: "banana"}]}, ]
display 获取控件的显示样式值。如“none”,表示隐藏控件; “block”表示强制作为块对象呈递。请使用 setDisplay。注:该"block"值不能在ComplexGrid控件中使用。 方法设置该字段的值。
displayCheckBox 获取或者设置一个 Boolean 值,表示是否显示多选框。默认显示多选框。
displayHead 获取一个 Boolean 值,表示是否显示列标题。请使用 setDisplayHead 方法设置该字段的值。
displayImage 获取一个 Boolean 值,表示是否需要在 TreeListViewItem 中显示图标。该字段必须在初始化前设置。
displayRowNumber 获取或设置一个 Boolean 值,表示是否需要显示行序号。
enabled 获取控件是否可以对用户交互作出响应。如果该值为 true,则表示控件可以对用户交互作出响应;反之则不能。 请使用 setEnabled 方法设置该字段的值。
eTag 获取控件的标签。
filter 获取或设置一个 JSON 对象,该属性将用作数据加载的查询参数。
height
idField 获取或设置一个属性,该属性将用作 TreeListView 中数据项的 id 值。
images 获取一个集合,包含 TreeListView 中所有使用的图片。
imageSize 获取 TreeListViewItem 图片的大小。该字段必须在初始化前设置。
itemCount 获取和设置一个 Number 值,表示当前的总记录数。
itemMenu 一个 ContextMenu 对象,表示数据项节点的右键菜单。
items 获取一个集合,包含数据项列表中的根数据项(TreeListViewItem 类型)。请使用 setItems 方法设置该集合的值。
layoutConfigs 获取或者设置一个 JSON 对象,该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left 获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
padding 获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素; “4px 2px 3px 1px”则表示上边距为 4 像素,右边距为 2 像素,下边距为 3 像素,左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
pageIndex 获取和设置一个 Number 值,表示当前第几页。
pageSize 获取和设置一个 Number 值,表示当前每页允许显示的记录数。
pageSizeOptions 获取和设置一个数组值,表示分页记录数可设置的选项。
parent 获取控件所属的父对象。
permissionID 获取或设置一个字符串,表示控件的权限标识。
position 获取控件位置样式值。如“static”,表示无特殊定位,对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。

该字段的可选值包括:

  • static
  • relative
  • absolute
  • fixed

right 获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
searchBox 设置或者获取一个 DataGridSearchBox 对象。
searchParamType 获取或设置表格的查询条件类型。json 表示查询参数filter 的值采用 Json 对象的形式传递。string 表示查询参数 filter 的值采用字符串的形式传递。 该字段必须在初始化前设置。

该字段可选的值包括:

  • json
  • string

selection 获取一个对象,表示 TreeListView 中当前选中的数据项节点(TreeListViewItem 类型)。
singleSelect 获取或者设置一个 Boolean 值,表示是支持多选。该属性与 displayCheckBox 属性等价,建议使用 displayCheckBox属性。
top 获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
treeField 获取或设置一个属性,该属性将用作 TreeListView 中数据项以树型结构显示的字段值。
type 获取数据加载的类型。

该字段可选的值包括:

  • remote
  • local

visible 获取一个 Boolean 值,表示控件是否可见。如果该值为 true,则表示控件可见;反之则不可见。请使用 setVisible 方法设置该字段的值。
width
$body1
$body2
$bodyTable1
$e 获取该控件的占位符,该占位符为一个 JQuery 对象。
$grid
$head1
$headTable1
$view
$view1
$view2
_items 受保护的。

事件

名称 说明
oncelledited 编辑后事件。
oncellediting 编辑前事件。
ondeleted
ondeleting 数据项删除前事件。
onexpanded 数据项展开后事件。
onexpanding 数据项展开前事件。
onitemcountchanged 总记录数改变时触发该事件。
onitemdoubleclick 当双击数据项列表中项的时候,将触发该事件。
onload 数据加载事件。
onpageindexchanged 当前的页面索引变更时触发该事件。调用 moveToPage 方法是触发该事件。
onselectionchanged 当控件当前的选择项发生改变后,将触发该事件。通常调用 selectItemdeselectItemdeselectAll 等方法后会触发该事件。
onselectionchanging 当控件当前的选择项发生改变的时候,将触发该事件。通常调用 selectItem 方法时会触发该事件。

构造函数详细信息

TreeListView() 方法

构建 TreeListView 类的新实例。

初始化函数详细信息

init() 方法


方法详细信息

appendColumn(p_column) 方法

TreeListViewcolumns 集合中添加一个列,并返回该 TreeListViewColumn 对象。

参数

示例 1

请参见 ListView.appendColumn 方法的示例。

appendColumn(p_name, [p_text], [p_width], [p_align]) 方法

TreeListViewcolumns 集合中添加一个列,并返回该 TreeListViewColumn 对象。

参数

  • p_name
    一个 JSON 对象(如 { name:"class", text:"类", dataType:"string", width:150, align:"center" }),表示 TreeListViewColumn 的一组属性值;或一个字符串,表示 TreeListViewColumn 对象的 TreeListViewColumn.name 字段的值。
  • p_text
    可选的。一个字符串,表示 TreeListViewColumn 对象的 TreeListViewColumn.text 字段的值。
  • p_width
    可选的。一个数字(如 500)或字符串(如“500px”或“50%”),表示列的宽度。
  • p_align
    可选的。一个字符串,表示列中文本的对齐方式。可以为“left”左对齐、“right”右对齐、“center”居中对齐、“justify”两端对齐。

示例 1

请参见 ListView.appendColumn 方法的示例。

appendColumns(p_columns) 方法

TreeListView 的 添加一组列集合。

参数


appendImage(p_image) 方法

images 集合中添加图片。

参数

  • p_image
    一个 JSON 对象(如 { itemType: "role", imageUrl: "role" })。

appendImages(p_images) 方法

images 集合中添加一组图片。

参数

  • p_images
    一个数组,包含一组图片。

appendItem(p_item) 方法

TreeListView 的数据项列表(items 集合)添加根数据项,并返回该 TreeListViewItem 对象。如果根数据项包含子数据项节点,那么子数据项节点也会添加到控件中。

参数

示例 1

以下是为 TreeListView 添加一个 TreeListViewItem 的示例。
JavaScript 代码
treeList.appendItem({ name: "C", value: "c", itemType: "folder", items: [ { name: "C1", value: "c1", itemType: "role" }, { name: "C2", value: "c2", itemType: "role" } ] });

appendItems(p_items) 方法

TreeListView 的数据项列表(items 集合)添加一组数据项节点。

参数

示例 1

以下是为 TreeListView 添加一组 TreeListViewItem 的示例。
JavaScript 代码
treeList.appendItems([ { name: "C", value: "c", itemType: "folder", items: [ { name: "C1", value: "c1", itemType: "role" }, { name: "C2", value: "c2", itemType: "role" } ] }, { name: "D", value: "d", itemType: "folder", items: [ { name: "D1", value: "d1", itemType: "role" }, { name: "D2", value: "d2", itemType: "role" } ] } ]);

checkAll() 方法

全选

checkItem(p_item) 方法

勾选一条记录。 p_item 一个数字,表示行号,或者一个 TreeListViewItem 对象,或者一个 TreeListViewItem 对象的 id。

参数

  • p_item

clearImages() 方法

清空 images 集合。

clearItems() 方法

items 集合中移除所有数据项节点。若要从 TreeListView 中移除单个数据项,请使用 TreeListViewItem.remove 方法。

commitChanges() 方法

重置修改的记录。

contains($p_target) 方法

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

参数

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

继承自


deselectItem(p_item, [p_triggerEvent]) 方法

清除对 TreeListView 中指定数据项节点的选定。

参数

  • p_item
    一个 TreeListViewItem 对象,表示要清除对该项的选定。
  • p_triggerEvent
    可选的。默认值为“true”。一个 Boolean 值,表示是否要触发 onselectionchanged 事件。如果该值为 true,则触发事件;反之则不触发。

dispose() 方法

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

继承自


endEdit() 方法

结束编辑。

expandAll() 方法

展开所有节点。

getChanges() 方法

获取修改的记录。

getCheckedIds() 方法

获取选中的 TreeListViewItem 数据项的主键集合。

getContext() 方法

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

继承自


getEl() 方法

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

继承自


getFirstItemIndex() 方法

获取当前页第一条数据的索引值。

继承自


getImageUrlOfItem(p_item) 方法

根据指定的 TreeListViewItem,获取 TreeListViewItem.imageUrl 字段的值。

参数

  • p_item

getItem(p_expression) 方法

返回一个数据项节点(TreeListViewItem 类型)。

参数


getPageCount() 方法

获取当前的总页数

继承自


getSelections() 方法

获取选中的 TreeListViewItem 数据项

hide() 方法

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

继承自


isCheckedAll(p_item) 方法

判断 TreeListView的数据项是否全部选中,或者判断某一个 TreeListViewItem 数据项的子项是否全部选中。

参数


isFirstPage() 方法

获取一个 Boolean 值,表示当前是否是第一页。

继承自


isLastPage() 方法

获取一个 Boolean 值,表示当前是否是最后一页。

继承自


load(p_callback) 方法

数据加载。

参数

  • p_callback
    回调函数。

load(p_data) 方法

数据加载。

参数

  • p_data
    一个 JSON 数组 或者 一个字符串, 其中 JSON 数组表示本地数据集合;字符串表示数据加载的服务地址。

load(p_params) 方法

数据加载。

参数

  • p_params
    一个 JSON 对象,表示服务请求的参数。

load(p_data, p_callback) 方法

数据加载。

参数

  • p_data
    一个 JSON 数组 或者 一个字符串, 其中 JSON 数组表示本地数据集合;字符串表示数据加载的服务地址。
  • p_callback
    回调函数。

load(p_data, p_params) 方法

数据加载。

参数

  • p_data
    一个 JSON 数组 或者 一个字符串, 其中 JSON 数组表示本地数据集合;字符串表示数据加载的服务地址。
  • p_params
    一个 JSON 对象,表示服务请求的参数。

load(p_data, p_params, p_callback) 方法

数据加载。

参数

  • p_data
    一个 JSON 数组 或者 一个字符串, 其中 JSON 数组表示本地数据集合;字符串表示数据加载的服务地址。
  • p_params
    一个 JSON 对象,表示服务请求的参数。
  • p_callback
    回调函数。

loadChildren(p_item) 方法

加载子项。

参数


loadChildren(p_item, p_callback) 方法

加载子项。

参数

  • p_item
    一个 TreeListViewItem 数据或者数据项 id 。
  • p_callback
    表示回调函数。

loadChildren(p_item, p_params) 方法

加载子项。

参数

  • p_item
    一个 TreeListViewItem 数据或者数据项 id 。
  • p_params
    一个 JSON 对象,表示服务请求参数。

loadChildren(p_item, p_params, p_callback) 方法

加载子项。

参数

  • p_item
    一个 TreeListViewItem 数据或者数据项 id 。
  • p_params
    一个 JSON 对象,表示服务请求参数。
  • p_callback
    表示回调函数。

moveTo(p_left, p_top) 方法

移动控件到指定位置。

参数

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

继承自


moveToFirstPage() 方法

跳转到第一页。

继承自


moveToLastPage() 方法

跳转到最后一页。

继承自


moveToNextPage() 方法

跳转到下一页。

继承自


moveToPage(p_index) 方法

跳转到某一页。

参数

  • p_index
    一个 Number 值,表示要跳转到第几页。

继承自


moveToPreviousPage() 方法

跳转到前一页。

继承自


rejectChanges() 方法

撤销修改的记录。

removeItem(p_item) 方法

删除指定数据项。

参数

  • p_item

resizeTo(p_width, p_height) 方法

重设控件的大小。

参数

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

继承自


selectItem(p_item, [p_triggerEvent]) 方法

选择 TreeListView 列表中的指定的数据项节点。

参数

  • p_item
    一个数字(如 1),表示行号;或者一个 TreeListViewItem 对象;或者TreeListViewItem 对象的 id;
  • p_triggerEvent
    可选的。默认值为“true”。一个 Boolean 值,表示是否要触发 onselectionchanged 事件。如果该值为 true,则触发事件;反之则不触发。

setBorder(p_border) 方法

设置控件的边框样式。

参数

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

继承自


setBottom(p_bottom) 方法

设置 bottom 字段的值。

参数

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

继承自


setColumnVisible(p_columnName, p_visible) 方法

设置列的可见性。

参数

  • p_columnName
    表示列的名称。
  • p_visible
    一个 Boolean 值。

setCss(p_css) 方法

设置 css 字段的值。

参数

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

继承自


setCssClass(p_cssClass) 方法

设置 cssClass} 字段的值

参数

  • p_cssClass
    一个String 对象,样式classname

继承自


setDisplay(p_display) 方法

设置 display 字段的值。

参数

  • p_display
    css 样式的 display 属性。

继承自


setDisplayHead(p_displayHead) 方法

设置 displayHead 的字段值。

参数

  • p_displayHead

setEnabled(p_enabled) 方法

设置 enabled 字段的值。

参数

  • p_enabled

继承自


setFilter(p_filter) 方法

设置 filter 的字段属性。

参数

  • p_filter

setHeight(p_height) 方法

设置 height 字段的值。

参数

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

继承自


setImages(p_images) 方法

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

参数

  • p_images
    一个数组,包含一组图片。

setItems(p_items) 方法

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

参数


setLeft(p_left) 方法

设置 left 字段的值。

参数

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

继承自


setPadding(p_padding) 方法

设置控件的内边距。

参数

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

继承自


setPageSize(p_pageSize) 方法

设置 pageSize 字段的值。同时跳转到第一页。

参数

  • p_pageSize
    一个 Number 值,表示每页可以显示的记录数。

继承自


setPosition(p_position) 方法

设置 position 字段的值。

参数

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

继承自


setRight(p_right) 方法

设置 right 字段的值。

参数

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

继承自


setTop(p_top) 方法

设置 top 字段的值。

参数

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

继承自


setVisible(p_visible) 方法

设置 visible 字段的值。

参数

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

继承自


setWidth(p_width) 方法

设置 width 字段的值。

参数

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

继承自


show() 方法

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

继承自


startEdit(p_item, p_fieldName) 方法

启动编辑表格单元。

参数


uncheckAll() 方法

清除对 TreeListView 当前所有通过 CheckBox 选中的数据项的选中状态。

unCheckedItem(p_item) 方法

取消勾选一条记录。 p_item 一个数字,表示行号,或者一个 TreeListViewItem 对象,或者一个 TreeListViewItem 对象的 id。

参数

  • p_item

$(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 对象。

继承自


_adjustSizeForIE6() 方法

受保护的。IE6调整大小,为兼容IE6

字段详细信息

alias 字段

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

继承自


allColumns 字段

获取一个集合,包含控件中显示的所有 TreeListViewColumn 的集合。

集合

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

集合索引

列的名称(TreeListViewColumn.name)或列在集合中的序号(从 0 开始计数)。

allowDragging 字段

获取一个 Boolean 值,表示数据项节点是否允许拖拽。该字段必须在初始化前设置。 暂未提供行拖拽功能,该属性设置无效,暂时保留。

默认值

false

allowEditing 字段

获取和设置一个 Boolean 值, 该属性表示是否允许编辑。

默认值

false

allowPaging 字段

获取和设置一个 Boolean 值,表示是否可以分页。

继承自


autoLoad 字段

获取或设置一个 Boolean 值,该属性表示是否自动执行远程数据加载。

baseUrl 字段

获取或者设置一个属性,表示数据加载的服务地址。请参见 RESTClient.baseUrl

默认值

null

border 字段

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

继承自


bottom 字段

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

继承自


client 字段


columns 字段

获取一个集合,包含控件中第一层列 TreeListViewColumn 与列分组 TreeListViewColumnGroup 的集合。

contextMenu 字段

一个 ContextMenu 对象,表示控件的右键菜单。

默认值

null

cssClass 字段

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

继承自


dicts 字段

获取或者设置一个数组,该值表示数据项的数据字典。例如: [ {name: "gender", values:[{text: "女", value: "female"}, {text: "男", value: "male"}]}, {name: "fruit", values:[{text: "苹果", value: "appple"}, {text: "香蕉", value: "banana"}]}, ]

display 字段

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

继承自


displayCheckBox 字段

获取或者设置一个 Boolean 值,表示是否显示多选框。默认显示多选框。

默认值

true

displayHead 字段

获取一个 Boolean 值,表示是否显示列标题。请使用 setDisplayHead 方法设置该字段的值。

默认值

true

displayImage 字段

获取一个 Boolean 值,表示是否需要在 TreeListViewItem 中显示图标。该字段必须在初始化前设置。

默认值

true

displayRowNumber 字段

获取或设置一个 Boolean 值,表示是否需要显示行序号。

默认值

true

enabled 字段

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

继承自

默认值

true

eTag 字段

获取控件的标签。

继承自

默认值

<div/>

filter 字段

获取或设置一个 JSON 对象,该属性将用作数据加载的查询参数。

height 字段

继承自

默认值

100%

idField 字段

获取或设置一个属性,该属性将用作 TreeListView 中数据项的 id 值。

images 字段

获取一个集合,包含 TreeListView 中所有使用的图片。

集合

该字段是一个集合数组字段。

集合索引

JSON 对象在集合中的序号(从 0 开始计数)或 JSON 对象的 itemType 属性值。

imageSize 字段

获取 TreeListViewItem 图片的大小。该字段必须在初始化前设置。

默认值

16

itemCount 字段

获取和设置一个 Number 值,表示当前的总记录数。

继承自

默认值

0

itemMenu 字段

一个 ContextMenu 对象,表示数据项节点的右键菜单。

默认值

null

items 字段

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

集合

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

集合索引

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

layoutConfigs 字段

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

继承自


left 字段

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

继承自


padding 字段

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

继承自


pageIndex 字段

获取和设置一个 Number 值,表示当前第几页。

继承自

默认值

1

pageSize 字段

获取和设置一个 Number 值,表示当前每页允许显示的记录数。

继承自

默认值

20

pageSizeOptions 字段

获取和设置一个数组值,表示分页记录数可设置的选项。

继承自


parent 字段

获取控件所属的父对象。

继承自


permissionID 字段

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

继承自


position 字段

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

该字段的可选值包括:

  • static
  • relative
  • absolute
  • fixed

继承自


right 字段

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

继承自


searchBox 字段

设置或者获取一个 DataGridSearchBox 对象。

默认值

null

searchParamType 字段

获取或设置表格的查询条件类型。json 表示查询参数filter 的值采用 Json 对象的形式传递。string 表示查询参数 filter 的值采用字符串的形式传递。 该字段必须在初始化前设置。

该字段可选的值包括:

  • json
  • string


selection 字段

获取一个对象,表示 TreeListView 中当前选中的数据项节点(TreeListViewItem 类型)。

singleSelect 字段

获取或者设置一个 Boolean 值,表示是支持多选。该属性与 displayCheckBox 属性等价,建议使用 displayCheckBox属性。

默认值

false

top 字段

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

继承自


treeField 字段

获取或设置一个属性,该属性将用作 TreeListView 中数据项以树型结构显示的字段值。

type 字段

获取数据加载的类型。

该字段可选的值包括:

  • remote
  • local

默认值

remote

visible 字段

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

继承自

默认值

true

width 字段

继承自

默认值

auto

$body1 字段


$body2 字段


$bodyTable1 字段


$e 字段

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

继承自


$grid 字段


$head1 字段


$headTable1 字段


$view 字段


$view1 字段


$view2 字段


_items 字段

受保护的。

事件详细信息

oncelledited 事件

编辑后事件。

oncellediting 事件

编辑前事件。

ondeleted 事件


ondeleting 事件

数据项删除前事件。

onexpanded 事件

数据项展开后事件。

onexpanding 事件

数据项展开前事件。

onitemcountchanged 事件

总记录数改变时触发该事件。

继承自


onitemdoubleclick 事件

当双击数据项列表中项的时候,将触发该事件。

参数


onload 事件

数据加载事件。

onpageindexchanged 事件

当前的页面索引变更时触发该事件。调用 moveToPage 方法是触发该事件。

继承自


onselectionchanged 事件

当控件当前的选择项发生改变后,将触发该事件。通常调用 selectItemdeselectItemdeselectAll 等方法后会触发该事件。

onselectionchanging 事件

当控件当前的选择项发生改变的时候,将触发该事件。通常调用 selectItem 方法时会触发该事件。

参数

  • cancel
    可通过设置 cancel 参数为 true 来取消当前操作。默认为 false。
  • item
    一个 TreeListViewItem 对象,即将被选择的项。