TreeListViewColumn 类

全称	mx.controls.TreeListViewColumn
命名空间	mx.controls
类	TreeListViewColumn
继承层次结构	TreeListViewColumn
源文件	~\mx\scripts\controls\TreeListViewColumn.js

提供一个数据项列表控件（TreeListView 类型）中列的类。

构造函数

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

初始化函数

名称	说明
init()	初始化列。

方法

名称	说明
formatValue(p_value)	将指定的值按照 formatString 字段进行格式化后返回。
getIndex()	返回该列在 TreeListView 的 TreeListView.columns 集合中的序号（0 代表第一个）。如果该对象的 owner 字段为空，则返回 -1。
renderCell(p_item, $p_cell)	将 p_item 中该列的值渲染到 $p_cell 指定的单元格中。在列表渲染每一个 ListItem 时，会按照 columns 属性中的顺序依次调用此方法对每一个单元格进行渲染。该方法默认会从 p_item 中选取 p_item[name] 字段的值，并调用 formatValue 方法将该值转换为文本并填充至 $p_cell 中。可通过重写该方法实现自定义渲染的效果，详见示例。
setAlign(p_align)	设置 align 字段的值。
setLinkUrl(p_item, $link)	自定义设置链接地址。
setText(p_text)	设置 text 字段的值。
setVisible(p_visible)	设置 visible 字段的值
setWidth(p_width)	设置 width 字段的值。

字段

名称	说明
align	获取列文本的对齐方式。请使用 setAlign 方法设置该字段的值。
allowSorting	获取或设置一个值，表示该列是否允许排序（只有当 TreeListView.allowSorting 和 TreeListViewColumn.allowSorting 都为 true 时，列才允许排序）。
dataType	获取或设置列的 text 字段的数据类型。该字段必须在初始化前设置。该字段通常包括: string date number
editor	设置和获取编辑器。该属性可以使字符串，可以使 JSON 对象，或者是编辑器对象实例。
editorOption	设置和获取一个 JSON 对象，该属性表示编辑器初始化参数。
formatString	获取或设置格式说明符字符，指示如何显示值。该字段必须在初始化前设置（通常在 dataType 字段为“date”或 text的值为数字时，设置该字段的值）。当 text 的值为数字时，formatString 表示该数字显示的格式（如 “0.0”，表示小数点后保留一位）。当 dataType 字段为“date”时，详见 Calendar.formatString 字段；
isLink	设置或者获取一个 Boolean 值, 该属性表示是否将单元格的文本值以链接形式渲染。
linkUrl	设置或者获取一个字符串, 该属性表示链接地址。该属性只有在 isLink 为 true 时生效。
name	获取或设置 TreeListViewColumn 的名称。
owner	获取该对象的父容器的对象，通常是一个 TreeListView 类的实例。
parent	获取该对象的数据列分组对象，通常是一个 TreeListViewColumnGroup。
readOnly	获取或者设置一个Boolean值，该属性表示列是否只读。
text	获取列中显示的文本。请使用 setText 方法设置该字段的值。
visible	获取和设置一个 Boolean 值，该值表示列的可见性。
width	获取列的宽度。请使用 setWidth 方法设置该字段的值。

构造函数详细信息

TreeListViewColumn() 方法

构建 TreeListViewColumn 类的新实例。

初始化函数详细信息

init() 方法

初始化列。

方法详细信息

formatValue(p_value) 方法

将指定的值按照 formatString 字段进行格式化后返回。

参数

p_value
一个日期格式，如 “2011-4-1”；或一个数字格式，如 “100.00”。

getIndex() 方法

返回该列在 TreeListView 的 TreeListView.columns 集合中的序号（0 代表第一个）。如果该对象的 owner 字段为空，则返回 -1。

renderCell(p_item, $p_cell) 方法

将 p_item 中该列的值渲染到 $p_cell 指定的单元格中。在列表渲染每一个 ListItem 时，会按照 columns 属性中的顺序依次调用此方法对每一个单元格进行渲染。该方法默认会从 p_item 中选取 p_item[name] 字段的值，并调用 formatValue 方法将该值转换为文本并填充至 $p_cell 中。 可通过重写该方法实现自定义渲染的效果，详见示例。

参数

p_item
由外界传入需要渲染的 ListItem 对象。
$p_cell
由外界传入的一个 TD 的 JQuery 对象，表示 TreeListView 控件中 table 的一个单元格。

示例 1

下列代码重写了默认的 renderCell 逻辑，当该字段的值为 M 时，显示为男子图标；当值为 F 时则显示为女子图标。

JavaScript 代码

JavaScript 代码
`var column = listView.appendColumn( { name: "GENDER", caption: "性别", renderCell: function(p_item, $p_cell) { var value = p_item.getValue("GENDER"); // 获取 GENDER 字段的值。 if (value != null) { // 根据 value 的值，决定 $p_cell 中的 HTML 内容。 var icon = (value == 'M' ? "male" : "female"); $p_cell.html("<img src='" + $mappath("~/icons/" + icon + ".png") + "'>"); } else { // 如果该值为空，则清空单元格的内容。 $p_cell.empty(); } } });`

var column = listView.appendColumn(
{
     name: "GENDER",
     caption: "性别",

     renderCell: function(p_item, $p_cell)
     {
         var value = p_item.getValue("GENDER");   // 获取 GENDER 字段的值。
         if (value != null)
         {
             // 根据 value 的值，决定 $p_cell 中的 HTML 内容。
             var icon = (value == 'M' ? "male" : "female");
             $p_cell.html("<img src='" + $mappath("~/icons/" + icon + ".png") + "'>");
         }
         else
         {
             // 如果该值为空，则清空单元格的内容。
             $p_cell.empty();
         }
     }
});

setAlign(p_align) 方法

设置 align 字段的值。

参数

p_align

setLinkUrl(p_item, $link) 方法

自定义设置链接地址。

参数

p_item
$link

setText(p_text) 方法

设置 text 字段的值。

参数

p_text

setVisible(p_visible) 方法

设置 visible 字段的值

参数

p_visible

setWidth(p_width) 方法

设置 width 字段的值。

参数

p_width

字段详细信息

align 字段

获取列文本的对齐方式。请使用 setAlign 方法设置该字段的值。

allowSorting 字段

获取或设置一个值，表示该列是否允许排序（只有当 TreeListView.allowSorting 和 TreeListViewColumn.allowSorting 都为 true 时，列才允许排序）。

默认值

true

dataType 字段

获取或设置列的 text 字段的数据类型。该字段必须在初始化前设置。

该字段通常包括:

string
date
number

默认值

string

editor 字段

设置和获取编辑器。该属性可以使字符串，可以使 JSON 对象，或者是编辑器对象实例。

默认值

TextEditor

editorOption 字段

设置和获取一个 JSON 对象，该属性表示编辑器初始化参数。

formatString 字段

获取或设置格式说明符字符，指示如何显示值。该字段必须在初始化前设置（通常在 dataType 字段为“date”或 text的值为数字时，设置该字段的值）。当 text 的值为数字时，formatString 表示该数字显示的格式（如 “0.0”，表示小数点后保留一位）。当 dataType 字段为“date”时，详见 Calendar.formatString 字段；

默认值

null

isLink 字段

设置或者获取一个 Boolean 值, 该属性表示是否将单元格的文本值以链接形式渲染。

默认值

false。

linkUrl 字段

设置或者获取一个字符串, 该属性表示链接地址。该属性只有在 isLink 为 true 时生效。

name 字段

获取或设置 TreeListViewColumn 的名称。

owner 字段

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

默认值

null

parent 字段

获取该对象的数据列分组对象，通常是一个 TreeListViewColumnGroup。

默认值

null

readOnly 字段

获取或者设置一个Boolean值，该属性表示列是否只读。

默认值

false

text 字段

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

visible 字段

获取和设置一个 Boolean 值，该值表示列的可见性。

默认值

true

width 字段

获取列的宽度。请使用 setWidth 方法设置该字段的值。