mx.controls.dataGridClasses
public class DataGridColumn
继承DataGridColumn Inheritance CSSStyleDeclaration Inheritance EventDispatcher Inheritance Object
实现 IIMESupport

DataGridColumn 类描述 DataGrid 控件中的列。每个可显示的列都有一个 DataGridColumn,即使该列被隐藏或不在屏幕范围内。DataGrid 控件的数据提供程序项目可以包含不显示的属性,因此无需 DataGridColumn。DataGridColumn 允许指定以下方面的内容:列中文本的颜色和字体;显示列中数据的组件类型;是否可对列进行编辑、排序或调整大小;以及列标题的文本。

注意:

MXML 语法expanded隐藏 MXML 语法

You use the <mx.DataGridColumn> tag to configure a column of a DataGrid control. You specify the <mx.DataGridColumn> tag as a child of the columns property in MXML. The <mx.DataGridColumn> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:DataGridColumn
  Properties 
    dataField="No default"
    dataTipField="No default"
    dataTipFunction="No default"
    editable="true|false"
    editorDataField="text"
    editorHeightOffset="0"
    editorUsesEnterKey="false|true"
    editorWidthOffset="0"
    editorXOffset="0"
    editorYOffset="0"
    headerRenderer="DataGridItemRenderer"
    headerText="No default"
    headerWordWrap="undefined"
    imeMode="null"
    itemEditor="TextInput"
    itemRenderer="DataGridItemRenderer"
    labelFunction="No default"
    minWidth="20"
    rendererIsEditor="false|true"
    resizable="true|false"
    showDataTips="false|true"
    sortable="true|false"
    sortCompareFunction="No default"
    sortDescending="false|true"
    visible="true|false"
    width="100"
    wordWrap="false|true"
 
  Styles
    backgroundColor="0xFFFFFF"
    color="No default."
    disabledColor="0xAAB3B3"
    fontAntiAliasType="advanced"
    fontFamily="No default"
    fontGridFitType="pixel"
    fontSharpness="0"
    fontSize="No default"
    fontStyle="normal|italic"
    fontThickness="0"
    fontWeight="normal|bold"
    headerStyleName="No default"
    paddingLeft="0"
    paddingRight="0"
    textAlign="right|center|left"
    textDecoration="none|underline"
    textIndent="0"
  />
  

另请参见

mx.controls.DataGrid
mx.styles.CSSStyleDeclaration


公共属性
 属性定义方
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  dataField : String
与列关联的数据提供程序项目中字段或属性的名称。
DataGridColumn
  dataTipField : String
数据提供程序中显示为数据提示的字段名称。
DataGridColumn
  dataTipFunction : Function
指定在数据提供程序每个项目上运行的回调函数,以确定其数据提示。
DataGridColumn
 InheriteddefaultFactory : Function
此函数(如果不是 null)通常由 MXML 编译器自动生成。
CSSStyleDeclaration
  draggable : Boolean = true
一个标志,指示是否允许用户将列拖动到新位置。如果为 true,则用户可以将列标题拖动到新位置
DataGridColumn
  editable : Boolean = true
指示列中的项目是否可进行编辑的标志。
DataGridColumn
  editorDataField : String = "text"
项目编辑器的属性名称,其中包含列表项目的新数据。
DataGridColumn
  editorHeightOffset : Number = 0
项目编辑器相对于项目渲染器大小的高度(以像素为单位)。
DataGridColumn
  editorUsesEnterKey : Boolean = false
指示项目编辑器是否使用 Enter 键的标志。
DataGridColumn
  editorWidthOffset : Number = 0
项目编辑器相对于项目渲染器大小的宽度(以像素为单位)。
DataGridColumn
  editorXOffset : Number = 0
项目编辑器左上角相对于项目左上角的 x 位置(以像素为单位)。
DataGridColumn
  editorYOffset : Number = 0
项目编辑器左上角相对于项目左上角的 y 位置(以像素为单位)。
DataGridColumn
 Inheritedfactory : Function
此函数(如果不是 null)通常由 MXML 编译器自动生成。
CSSStyleDeclaration
  headerRenderer : IFactory
显示列标题的项目渲染器实例的类工厂。
DataGridColumn
  headerText : String
此列的标题文本。
DataGridColumn
  headerWordWrap : *
一个标志,指示当标题中的文本不能在一行中显示时,是否能够自动换行。
DataGridColumn
  imeMode : String
指定 IME(输入法编辑器)模式。
DataGridColumn
  itemEditor : IFactory
列可编辑时,用于列的项目编辑器实例的类工厂。
DataGridColumn
  itemRenderer : IFactory
显示列中每个项目数据的项目渲染器实例的类工厂。
DataGridColumn
  labelFunction : Function
确定此列中显示文本的函数。
DataGridColumn
  minWidth : Number
列的最小宽度。
DataGridColumn
  nullItemRenderer : IFactory
显示列中每个项目数据的项目渲染器实例的类工厂。
DataGridColumn
 Inheritedprototype : Object
[静态] 对类或函数对象的原型对象的引用。
Object
  rendererIsEditor : Boolean = false
指示项目渲染器也是项目编辑器的标志。
DataGridColumn
  resizable : Boolean = true
一个标志,指示是否允许用户调整列的宽度。
DataGridColumn
  showDataTips : *
一个标志,指示是否在列中显示数据提示。
DataGridColumn
  sortable : Boolean = true
一个标志,指示用户是否能够通过单击此列的标题对数据提供程序进行排序。
DataGridColumn
  sortCompareFunction : Function
对列中的数据进行排序时调用的回调函数。
DataGridColumn
  sortDescending : Boolean = false
指示列排序是按升序排序(设置为 false),还是按降序排序(设置为 true)。
DataGridColumn
  visible : Boolean
一个标志,指示列是否可见。
DataGridColumn
  width : Number
列的宽度(以像素为单位)。
DataGridColumn
  wordWrap : *
一个标志,指示当此列中各行的文本不能在一行中显示时,是否能够自动换行。
DataGridColumn
受保护的属性
 属性定义方
 Inheritedoverrides : Object
如果运行时在 UIComponent 或 CSSStyleDeclaration 上调用 setStyle() 方法,该对象将存储已设置的名称/值对;它们将覆盖由 defaultFactory 和 factory 属性指定的方法所生成的对象中的名称/值对。
CSSStyleDeclaration
公共方法
 方法定义方
  
DataGridColumn(columnName:String = null)
构造函数。
DataGridColumn
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。
EventDispatcher
 Inherited
清除该 CSSStyleDeclaration 上的样式属性。
CSSStyleDeclaration
 Inherited
将事件调度到事件流中。
EventDispatcher
  
返回相应的工厂;如果尚未指定,则使用默认工厂。
DataGridColumn
 Inherited
getStyle(styleProp:String):*
获取指定样式属性的值,它完全由该 CSSStyleDeclaration 确定。
CSSStyleDeclaration
 Inherited
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
EventDispatcher
 Inherited
指示对象是否已经定义了指定的属性。
Object
 Inherited
指示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
  
返回 String,表示项目渲染器基于 dataTipField 和 dataTipFunction 属性显示的给定数据对象的数据提示。
DataGridColumn
  
返回项目渲染器针对给定数据对象显示的 String。
DataGridColumn
 Inherited
指示指定的属性是否存在、是否可枚举。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
EventDispatcher
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
在该 CSSStyleDeclaration 上设置样式属性。
CSSStyleDeclaration
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
 Inherited
检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。
EventDispatcher
事件
 事件 摘要 定义方
 Inherited[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。EventDispatcher
 Inherited[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。EventDispatcher
样式
 样式 说明 定义方
  
backgroundColor
类型: uint 格式: Color CSS 继承: no
列的背景颜色。默认值为 undefined,表示它使用关联 DataGrid 控件的 backgroundColor 样式值。DataGrid 控件的默认值为 0xFFFFFF
DataGridColumn
  
color
类型: uint 格式: Color CSS 继承: yes
组件中文本(包括组件标签)的颜色。 默认值为 0x0B333C.
DataGridColumn
  
disabledColor
类型: uint 格式: Color CSS 继承: yes
禁用时组件中文本的颜色。 默认值为 0xAAB3B3.
DataGridColumn
  
fontAntiAliasType
类型: String CSS 继承: yes
设置内部 TextField 的 antiAliasType 属性。可能值为 "normal" (flash.text.AntiAliasType.NORMAL) 和 "advanced" (flash.text.AntiAliasType.ADVANCED)。

默认值为 "advanced",该值将启用字体的高级消除锯齿功能。设置为 "normal" 可禁用高级消除锯齿功能。

此样式对系统字体不起作用。

此样式适用于 TextField 子控件中的所有文本;但不能将其应用于部分字符。

默认值为 "advanced".

另请参见

DataGridColumn
  
fontFamily
类型: String CSS 继承: yes
使用的字体的名称。与在完全 CSS 实现中不同,这里不支持逗号分隔的列表。您可以使用任何字体系列名称。如果您指定通用字体名称,它将转换为相应的设备字体。 默认值为 "Verdana".
DataGridColumn
  
fontGridFitType
类型: String CSS 继承: yes
设置用于表示 Flex 控件文本的内部 TextField 的 gridFitType 属性。可能值为 "none" (flash.text.GridFitType.NONE)、"pixel" (flash.text.GridFitType.PIXEL) 和"subpixel" (flash.text.GridFitType.SUBPIXEL)。

仅当使用嵌入字体并将 fontAntiAliasType 属性设置为 "advanced" 时,才应用此属性。

此样式对系统字体不起作用。

此样式适用于 TextField 子控件中的所有文本;但不适用于部分字符。

默认值为 "pixel".

另请参见

DataGridColumn
  
fontSharpness
类型: Number CSS 继承: yes
设置用于表示 Flex 控件文本的内部 TextField 的 sharpness 属性。此属性指定字型边缘的清晰度。可能值为从 -400 到 400 之间的数字。

仅当使用嵌入字体并将 fontAntiAliasType 属性设置为 "advanced" 时,才应用此属性。

此样式对系统字体不起作用。

此样式适用于 TextField 子控件中的所有文本;但不适用于部分字符。

默认值为 0.

另请参见

DataGridColumn
  
fontSize
类型: Number 格式: Length CSS 继承: yes
文本的高度,以像素为单位。除 ColorPicker 控件之外,所有控件的默认值都为 10。ColorPicker 控件的默认值为 11。
DataGridColumn
  
fontStyle
类型: String CSS 继承: yes
确定文本是否使用斜体。可识别的值为 "normal""italic"。 默认值为 "normal".
DataGridColumn
  
fontThickness
类型: Number CSS 继承: yes
设置用于表示 Flex 控件文本的内部 TextField 的 thickness 属性。此属性指定字型边缘的粗细。可能值为从 -200 到 200 之间的数字。

仅当使用嵌入字体并将 fontAntiAliasType 属性设置为 "advanced" 时,才应用此属性。

此样式对系统字体不起作用。

此样式适用于 TextField 子控件中的所有文本;但不适用于部分字符。

默认值为 0.

另请参见

DataGridColumn
  
fontWeight
类型: String CSS 继承: yes
确定文本是否使用粗体。可识别的值为 normalbold。Button 控件的默认值为 bold。所有其它控件的默认值为 normal
DataGridColumn
  
headerStyleName
类型: String CSS 继承: no
用于控制列标题外观其它方面的 CSS 样式声明的名称。默认值为 undefined,表示它使用关联 DataGrid 控件的 headerStyleName 样式值。DataGrid 控件的默认值为 ".dataGridStyles"
DataGridColumn
  
kerning
类型: Boolean CSS 继承: yes
一个布尔值,指示是启用 (true) 还是禁用 (false) 字距调整。字距调整会调整某些字符对之间的间隔以提高可读性,并应只在必要时(例如使用大字体标题时)使用。仅嵌入字体支持字距调整。某些字体(如宋体)和等宽字体(如 Courier New)不支持字距调整。 默认值为 false.
DataGridColumn
  
letterSpacing
类型: Number CSS 继承: yes
各字符之间显示的附加像素数。如果为正值,则会在正常间距的基础上增加字符间距;如果为负值,则减小此间距。 默认值为 0.
DataGridColumn
  
paddingLeft
类型: Number 格式: Length CSS 继承: no
容器的左边界与其内容区域之间的像素数目。 默认值为 0.
DataGridColumn
  
paddingRight
类型: Number 格式: Length CSS 继承: no
容器的右边界与其内容区域之间的像素数目。 默认值为 0.
DataGridColumn
  
textAlign
类型: String CSS 继承: yes
容器内文本的对齐情况。可能值有:"left""right""center"

大多数组件的默认值为 "left"。对于 FormItem 组件,默认值为 "right"。对于 Button、LinkButton 和 AccordionHeader 组件,默认值为 "center",且仅当将 labelPlacement 属性设置为 "left""right" 时,才能识别此属性。如果将 labelPlacement 设置为 "top""bottom",将居中文本及所有图标。

DataGridColumn
  
textDecoration
类型: String CSS 继承: yes
确定文本是否加下划线。可能值有:"none""underline"。 默认值为 "none".
DataGridColumn
  
textIndent
类型: Number 格式: Length CSS 继承: yes
文本第一行偏离容器左侧的距离(以像素为单位)。 默认值为 0.
DataGridColumn
属性详细信息
dataField属性
public var dataField:String

与列关联的数据提供程序项目中字段或属性的名称。需要对每个 DataGridColumn 控件设置此属性和/或 labelFunction 属性以计算项目渲染器的可显示文本。如果设置了 dataFieldlabelFunction 属性,则使用 labelFunction 显示数据并使用 dataField 对数据排序。如果名为 dataField 的属性不存在,则必须设置 sortCompareFunction 以正确进行排序。

此属性的值不一定是列标题中显示的 String。此属性只用于访问数据提供程序中的数据。有关详细信息,请参阅 headerText 属性。

另请参见

dataTipField属性 
dataTipField:String  [读写]

数据提供程序中显示为数据提示的字段名称。默认情况下,DataGrid 控件在每个数据提供程序项目上查找命名为 label 的属性,然后显示该属性。然而,如果数据提供程序不包含 label 属性,您可以设置 dataTipField 属性来指定其它属性。例如,在用户查看数据库中包含的一组用户名时,可以将值设置为“FullName”。

此属性可用作数据绑定的源。修改此属性后,将调度 dataTipFieldChanged 事件。



实现
    public function get dataTipField():String
    public function set dataTipField(value:String):void
dataTipFunction属性 
dataTipFunction:Function  [读写]

指定在数据提供程序每个项目上运行的回调函数,以确定其数据提示。此属性由 itemToDataTip 方法使用。

默认情况下,该控件将在每个数据提供程序项目上查找名为 label 的属性,然后将其显示为它的数据提示。不过,某些数据提供程序没有 label 属性或其它可用于显示行中数据的属性。例如,您可能具有包含 lastName 和 firstName 字段的数据提供程序,但您希望将全名显示为数据提示。可以为 dataTipFunction 属性指定一个函数,该函数返回包含这两个字段值的单个 String。还可以使用 dataTipFunction 属性来处理格式和本地化。

此函数必须采用一个 Object 参数(包含数据提供程序元素)并返回一个 String。

此属性可用作数据绑定的源。修改此属性后,将调度 dataTipFunctionChanged 事件。



实现
    public function get dataTipFunction():Function
    public function set dataTipFunction(value:Function):void
draggable属性 
public var draggable:Boolean = true

一个标志,指示是否允许用户将列拖动到新位置。如果为 true,则用户可以将列标题拖动到新位置

默认值为 true.

editable属性 
public var editable:Boolean = true

指示列中的项目是否可进行编辑的标志。如果为 true,并且 DataGrid 的 editable 属性也为 true,则列中的项目是可编辑的且可以编辑单个项目,具体方法是:单击某个项目或使用 Tab 和箭头键导航到该项目。

默认值为 true.

editorDataField属性 
public var editorDataField:String = "text"

项目编辑器的属性名称,其中包含列表项目的新数据。例如,默认的 itemEditor 为 TextInput,因此,editorDataField 属性的默认值为 "text",此值指定 TextInput 控件的 text 属性。

默认值为 "text".

editorHeightOffset属性 
public var editorHeightOffset:Number = 0

项目编辑器相对于项目渲染器大小的高度(以像素为单位)。使用此属性可以使编辑器与项目渲染器产生几个像素的重叠,以补偿编辑器周围的边框。请注意,在显示编辑器时,更改这些值不会对当前编辑器产生任何作用,但会影响下一个打开编辑器的项目渲染器。

默认值为 0.

editorUsesEnterKey属性 
public var editorUsesEnterKey:Boolean = false

指示项目编辑器是否使用 Enter 键的标志。如果为 true,则项目编辑器将使用 Enter 键,而 DataGrid 不会相应地查找 Enter 键和移动编辑器。请注意,在显示编辑器时,更改此值不会对当前编辑器产生任何作用,但将影响下一个打开编辑器的项目渲染器。

默认值为 false..

editorWidthOffset属性 
public var editorWidthOffset:Number = 0

项目编辑器相对于项目渲染器大小的宽度(以像素为单位)。使用此属性可以使编辑器与项目渲染器产生几个像素的重叠,以补偿编辑器周围的边框。请注意,在显示编辑器时,更改这些值不会对当前编辑器产生任何作用,但会影响下一个打开编辑器的项目渲染器。

默认值为 0.

editorXOffset属性 
public var editorXOffset:Number = 0

项目编辑器左上角相对于项目左上角的 x 位置(以像素为单位)。使用此属性可以使编辑器与项目渲染器产生几个像素的重叠,以补偿编辑器周围的边框。请注意,在显示编辑器时,更改这些值不会对当前编辑器产生任何作用,但会影响下一个打开编辑器的项目渲染器。

默认值为 0.

editorYOffset属性 
public var editorYOffset:Number = 0

项目编辑器左上角相对于项目左上角的 y 位置(以像素为单位)。使用此属性可以使编辑器与项目渲染器产生几个像素的重叠,以补偿编辑器周围的边框。请注意,在显示编辑器时,更改这些值不会对当前编辑器产生任何作用,但会影响下一个打开编辑器的项目渲染器。

默认值为 0.

headerRenderer属性 
headerRenderer:IFactory  [读写]

显示列标题的项目渲染器实例的类工厂。您可以指定嵌入式项目渲染器、内嵌项目渲染器或自定义项目渲染器组件作为此属性的值。

默认项目渲染器为 DataGridItemRenderer 类,用于将项目数据显示为文本。

此属性可用作数据绑定的源。修改此属性后,将调度 headerRendererChanged 事件。



实现
    public function get headerRenderer():IFactory
    public function set headerRenderer(value:IFactory):void
headerText属性 
headerText:String  [读写]

此列的标题文本。默认情况下,DataGrid 控件使用 dataField 属性的值作为标题文本。

此属性可用作数据绑定的源。修改此属性后,将调度 headerTextChanged 事件。



实现
    public function get headerText():String
    public function set headerText(value:String):void
headerWordWrap属性 
headerWordWrap:*  [读写]

一个标志,指示当标题中的文本不能在一行中显示时,是否能够自动换行。如果为 undefined,则使用 DataGrid 控件的 wordWrap 属性。

默认值为 undefined.



实现
    public function get headerWordWrap():*
    public function set headerWordWrap(value:any):void
imeMode属性 
imeMode:String  [读写]

指定 IME(输入法编辑器)模式。IME 使用户能够用中文、日文和韩文输入文本。发生 itemFocusIn 事件时,Flex 将设置 IME 模式;发生 itemFocusOut 事件时,将它重新设置回先前的值。flash.system.IMEConversionMode 类定义此属性的有效值的常量。

默认值为空,在这种情况下,它将使用 DataGrid 控件的 imeMode 属性值。



实现
    public function get imeMode():String
    public function set imeMode(value:String):void

另请参见

itemEditor属性 
public var itemEditor:IFactory

列可编辑时,用于列的项目编辑器实例的类工厂。

默认值为 new ClassFactory(mx.controls.TextInput).

另请参见

itemRenderer属性 
itemRenderer:IFactory  [读写]

显示列中每个项目数据的项目渲染器实例的类工厂。您可以指定嵌入式项目渲染器、内嵌项目渲染器或自定义项目渲染器组件作为此属性的值。

默认项目渲染器为 DataGridItemRenderer 类,用于将项目数据显示为文本。

此属性可用作数据绑定的源。修改此属性后,将调度 itemRendererChanged 事件。



实现
    public function get itemRenderer():IFactory
    public function set itemRenderer(value:IFactory):void
labelFunction属性 
labelFunction:Function  [读写]

确定此列中显示文本的函数。默认情况下,列显示与列名称匹配的数据字段的文本。不过,有时您希望显示基于多个数据字段的文本,或显示不具备自己想要格式的文本。在这种情况下,可使用 labelFunction 指定一个回调函数。

对于 DataGrid 控件,方法签名具有以下格式:

labelFunction(item:Object, column:DataGridColumn):String

其中,item 包含 DataGrid 项目对象,并且 column 指定 DataGrid 列。

回调函数可能会连接数据中的 firstName 和 lastName 字段,或者对 Date 设置某些自定义格式,也可能将月的数字形式转换为字符串形式。

此属性可用作数据绑定的源。修改此属性后,将调度 labelFunctionChanged 事件。



实现
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void
minWidth属性 
minWidth:Number  [读写]

列的最小宽度。

默认值为 20.

此属性可用作数据绑定的源。修改此属性后,将调度 minWidthChanged 事件。



实现
    public function get minWidth():Number
    public function set minWidth(value:Number):void
nullItemRenderer属性 
nullItemRenderer:IFactory  [读写]

显示列中每个项目数据的项目渲染器实例的类工厂。您可以指定嵌入式项目渲染器、内嵌项目渲染器或自定义项目渲染器组件作为此属性的值。

默认项目渲染器为 DataGridItemRenderer 类,用于将项目数据显示为文本。

此属性可用作数据绑定的源。修改此属性后,将调度 nullItemRendererChanged 事件。



实现
    public function get nullItemRenderer():IFactory
    public function set nullItemRenderer(value:IFactory):void
rendererIsEditor属性 
public var rendererIsEditor:Boolean = false

指示项目渲染器也是项目编辑器的标志。如果此属性为 true,则 Flex 将忽略 itemEditor 属性并使用该项目的项目渲染器作为编辑器。

默认值为 false.

resizable属性 
public var resizable:Boolean = true

一个标志,指示是否允许用户调整列的宽度。如果为 true,则用户可以拖动列标题之间的网格线以调整列大小。

默认值为 true.

showDataTips属性 
showDataTips:*  [读写]

一个标志,指示是否在列中显示数据提示。如果为 true,则显示行中文本的数据提示。数据提示是设计用来显示文本太长而无法在行中显示的文本的工具提示。

默认值为 false.



实现
    public function get showDataTips():*
    public function set showDataTips(value:any):void
sortable属性 
public var sortable:Boolean = true

一个标志,指示用户是否能够通过单击此列的标题对数据提供程序进行排序。如果此属性和 DataGridsortableColumns 属性均为 true,则当用户在列标题上释放鼠标按键时,DataGrid 控件将调度 headerRelease 事件。如果没有其它处理函数调用 headerRelease 事件的 preventDefault() 方法,则列中的 dataField 属性或 sortCompareFunction 将用于重新排序 dataProvider 中的项目。

默认值为 true.

sortCompareFunction属性 
sortCompareFunction:Function  [读写]

对列中的数据进行排序时调用的回调函数。如果未指定此属性,则排序将尝试按基本字符串或数字顺序对数据排序。如果数据不是字符串或数字,或者 dataField 属性不是数据提供程序的有效属性,则排序将不起作用或将生成异常。如果为 labelFunction 属性指定了值,则还必须对 sortCompareFunction 属性提供一个函数,除非此列不允许排序。

DataGrid 控件使用此函数对数据提供程序集合的元素排序。回调函数的函数签名采用两个参数并具有以下格式:

mySortCompareFunction(obj1:Object, obj2:Object):int

obj1 — 要比较的数据元素。

obj2 - 与 obj1 比较的另一个数据元素。

函数应该基于对象比较结果返回值:

注意:obj1obj2 参数是整个数据提供程序元素,而不只是项目数据。

默认值为 null.

此属性可用作数据绑定的源。修改此属性后,将调度 sortCompareFunctionChanged 事件。



实现
    public function get sortCompareFunction():Function
    public function set sortCompareFunction(value:Function):void
sortDescending属性 
public var sortDescending:Boolean = false

指示列排序是按升序排序(设置为 false),还是按 descending 排序(设置为 true)。

设置此属性不会开始进行排序;这只是在设置排序方向。单击列标题执行排序。

默认值为 false;.

visible属性 
visible:Boolean  [读写]

一个标志,指示列是否可见。如果为 true,则列可见。

默认值为 true.



实现
    public function get visible():Boolean
    public function set visible(value:Boolean):void
width属性 
width:Number  [读写]

列的宽度(以像素为单位)。如果 DataGrid 的 horizontalScrollPolicy 属性为 false,则所有可见列必须适合可显示区域;如果列的总宽度对于可显示区域而言太小或太大,则 DataGrid 将不会始终保持列的宽度。

默认值为 100.

此属性可用作数据绑定的源。修改此属性后,将调度 widthChanged 事件。



实现
    public function get width():Number
    public function set width(value:Number):void
wordWrap属性 
wordWrap:*  [读写]

一个标志,指示当此列中各行的文本不能在一行中显示时,是否能够自动换行。如果为 undefined,则使用 DataGrid 控件的 wordWrap 属性。

仅当 DataGrid.variableRowHeight 也为 true 时才能生效。

默认值为 undefined.



实现
    public function get wordWrap():*
    public function set wordWrap(value:any):void
构造函数详细信息
DataGridColumn()构造函数
public function DataGridColumn(columnName:String = null)

构造函数。

参数
columnName:String (default = null) — 与列相关联的数据提供程序中的字段名称以及此列标题单元格的文本。这等效于设置 dataFieldheaderText 属性。
方法详细信息
getItemRendererFactory()方法
public function getItemRendererFactory(forHeader:Boolean, data:Object):IFactory

返回相应的工厂;如果尚未指定,则使用默认工厂。

参数

forHeader:Boolean — 如果是标题渲染器,则为 true
 
data:Object — 供项目渲染器显示的数据。

返回
IFactory — 如果 data 为空,则返回默认的项目渲染器;否则,返回自定义的项目渲染器。
itemToDataTip()方法 
public function itemToDataTip(data:Object):String

返回 String,表示项目渲染器基于 dataTipFielddataTipFunction 属性显示的给定数据对象的数据提示。如果该方法无法将参数转换为 String,则会返回一个空格。

此方法供创建 DataGridColumn 类的子类的开发人员使用。它不适用于应用程序开发人员。

参数

data:Object — 要呈现的对象。

返回
String — 基于数据的可显示 String。
itemToLabel()方法 
public function itemToLabel(data:Object):String

返回项目渲染器针对给定数据对象显示的 String。如果 DataGridColumn 或其 DataGrid 控件具有非空 labelFunction 属性,则它会将该函数应用于数据对象。否则,此方法会提取由 dataField 属性指定的字段的内容,或者获取数据对象的字符串值。如果该方法无法将参数转换为 String,则会返回一个空格。

参数

data:Object — 要呈现的对象。

返回
String — 基于数据的可显示 String。