mx.datacontrols.GroupItemGridColumn 类

全称	mx.datacontrols.GroupItemGridColumn
命名空间	mx.datacontrols
类	GroupItemGridColumn
继承层次结构	GroupItemGridColumnDataGridColumn
源文件	~\mx\scripts\datacontrols\GroupItemGrid.js

提供一个行分组列表控件（GroupItemGrid 类型）中列的类。

构造函数

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

初始化函数

名称	说明
init()

方法

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

字段

名称	说明
align	获取列文本的对齐方式。请使用 setAlign 方法设置该字段的值。
allowSorting	获取或设置一个值，表示该列是否允许排序（只有当 DataGrid.allowSorting 和 DataGridColumn.allowSorting 都为 true 时，列才允许排序）。
caption	获取列中显示的文本。请使用 setCaption 方法设置该字段的值。
cssStyle	设置列的 CSS 样式。该属性必须为 JSON 对象，如 { color:"blue", "background-color":"red" }。
dataAlign	获取列数据文本的对齐方式。请使用 setDataAlign 方法设置该字段的值。
dataType	获取或设置列的 caption 字段的数据类型。该字段必须在初始化前设置。该字段通常包括: string date number
editorOptions	一个 JSON 对象，表示数据列对应的编辑器选项，该值可以覆盖已有的 editorType 属性。
editorType	获取或设置编辑器的类型。该字段可选的值包括： CheckEditor TextEditor DateTimeEditor DropDownEditor LinkEditor NumberEditor TimeEditor
formatString	获取或设置格式说明符字符，指示如何显示值。当 dataType 的值为数字时，formatString 表示该数字显示的格式（如 “0.0”，表示小数点后保留一位）。当 dataType 字段为“date”时，详见 Calendar.formatString 字段；
isPrint	指示列是否打印。
isVirtual	指示字段是否虚拟，如果字段是虚拟的话，其数据将不会与服务器交互
items
locked	获取或设置一个 Boolean 值，表示该列是否固定。如果为 true，表示该列固定；反之则不固定。
name	获取或设置 DataGridColumn 的名称。
nullable	标示列是否可空，默认是可空的(true表示可以为空，false表示不可为空)
owner	获取该对象的父容器的对象，通常是一个 DataGrid 类的实例。
readOnly	获取或设置一个 Boolean 值，表示该列是否只读。如果为 true，表示不可编辑；反之则可编辑。
sortOrder	获取或设置一个 Boolean 值，该值表示是否按升序或降序对 DataGridColumn 进行排序。如果该值为 true，表示按升序排序；反之则降序。
statisticAlign	获取列统计行的对齐方式。请使用 setStatisticAlign 方法设置该字段的值。
statisticValue	获取或设置该列的统计值。请使用 setStatisticValue 方法设置该字段的值。使用该属性需要将 DataGrid.displayStatisticRow 属性设置为 true。
styleFormatter	一个函数引用，定义了列内单元格的样式设置。
textMember	数据字典中显示值对应的属性。
valueFormatter	一个函数引用，定义了列中单元格的实际值和显示值的之间的转换逻辑。
valueMember	数据字典中真实值对应的属性。
valueSeperator	数据字典中真实值对应的分隔符。
visible	获取和设置数据列是否显示。请使用 setVisible 方法设置该字段的值。
width	获取列的宽度。请使用 setWidth 方法设置该字段的值。

构造函数详细信息

GroupItemGridColumn() 方法

构建 GroupItemGridColumn 类的新实例。

初始化函数详细信息

init() 方法

继承自

mx.datacontrols.DataGridColumn.init

方法详细信息

formatValue(p_value) 方法

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

参数

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

继承自

mx.datacontrols.DataGridColumn.formatValue

getIndex() 方法

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

继承自

mx.datacontrols.DataGridColumn.getIndex

renderCell(p_item, $p_cell) 方法

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

参数

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

继承自

mx.datacontrols.DataGridColumn.renderCell

示例 1

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

JavaScript 代码

JavaScript 代码
`var column = dataGrid.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 = dataGrid.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();
         }
     }
});