包 | mx.controls.dataGridClasses |
类 | public class DataGridColumn |
继承 | DataGridColumn CSSStyleDeclaration EventDispatcher Object |
实现 | IIMESupport |
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
注意:
- DataGridColumn 只包含列的相关信息,它不是列中项呈示器的父项。
- 如果指定的 DataGridColumn 类没有
dataField
属性,则必须指定sortCompareFunction
属性。否则,排序操作可能导致运行时错误。
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" />
相关 API 元素
属性 | 由以下参数定义 | ||
---|---|---|---|
constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | ||
dataField : String
与列关联的数据提供程序项目中字段或属性的名称。 | DataGridColumn | ||
dataTipField : String
数据提供程序中显示为数据提示的字段名称。 | DataGridColumn | ||
dataTipFunction : Function
指定在数据提供程序每个项目上运行的回调函数,以确定其数据提示。 | DataGridColumn | ||
defaultFactory : Function
此函数(如果不是 null)通常由 MXML 编译器自动生成。 | CSSStyleDeclaration | ||
draggable : Boolean = true
一个标志,指示是否允许用户将列拖动到新位置。如果为 true,则用户可以将列标题拖动到新位置
| DataGridColumn | ||
editable : Boolean
指示列中的项目是否可进行编辑的标志。 | 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 | ||
enableIME : Boolean [只读]
一个标志,用于指示当组件获得焦点时是否应启用 IME。 | DataGridColumn | ||
factory : 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 | ||
overrides : Object
如果运行时在 UIComponent 或 CSSStyleDeclaration 上调用 setStyle() 方法,该对象将存储已设置的名称/值对;它们将覆盖由 defaultFactory 和 factory 属性指定的方法所生成的对象中的名称/值对。 | CSSStyleDeclaration | ||
rendererIsEditor : Boolean = false
指示项呈示器也是项目编辑器的标志。 | DataGridColumn | ||
resizable : Boolean = true
一个标志,指示是否允许用户调整列的宽度。 | DataGridColumn | ||
selector : CSSSelector
此属性是用于将 CSS 样式声明与组件进行匹配的可能选择器链和条件的基本选择器。 | CSSStyleDeclaration | ||
selectorIndex : int = 0
此 CSSStyleDeclaration 添加到其 StyleManager 的顺序。 | CSSStyleDeclaration | ||
showDataTips : *
一个标志,指示是否在列中显示数据提示。 | DataGridColumn | ||
sortable : Boolean = true
一个标志,指示用户是否能够通过单击此列的标题对数据提供程序进行排序。 | DataGridColumn | ||
sortCompareFunction : Function
对列中的数据进行排序时调用的回调函数。 | DataGridColumn | ||
sortDescending : Boolean = false
指示列排序是按升序排序(设置为 false),还是按降序排序(设置为 true)。 | DataGridColumn | ||
specificity : int [只读]
确定将多个样式声明应用于组件时的优先顺序。 | CSSStyleDeclaration | ||
subject : String [只读]
主题描述了可能是此样式声明的匹配项的组件的名称。 | CSSStyleDeclaration | ||
visible : Boolean
一个标志,指示列是否可见。 | DataGridColumn | ||
width : Number
列的宽度(以像素为单位)。 | DataGridColumn | ||
wordWrap : *
一个标志,指示当此列中各行的文本不能在一行中显示时,是否能够自动换行。 | DataGridColumn |
方法 | 由以下参数定义 | ||
---|---|---|---|
DataGridColumn(columnName:String = null)
构造函数。 | DataGridColumn | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。 | EventDispatcher | ||
清除该 CSSStyleDeclaration 上的样式属性。 | CSSStyleDeclaration | ||
将事件调度到事件流中。 | EventDispatcher | ||
返回相应的工厂;如果尚未指定,则使用默认工厂。 | DataGridColumn | ||
获取指定样式属性的值,它完全由该 CSSStyleDeclaration 确定。 | CSSStyleDeclaration | ||
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | EventDispatcher | ||
表示对象是否已经定义了指定的属性。 | Object | ||
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | ||
返回 String,表示项呈示器基于 dataTipField 和 dataTipFunction 属性显示的给定数据对象的数据提示。 | DataGridColumn | ||
返回项目渲染器为给定数据对象显示的字符串。 | DataGridColumn | ||
确定此样式声明是否基于选择器链的匹配性而应用于给定的组件。 | CSSStyleDeclaration | ||
表示指定的属性是否存在、是否可枚举。 | Object | ||
从 EventDispatcher 对象中删除侦听器。 | EventDispatcher | ||
设置循环操作动态属性的可用性。 | Object | ||
在该 CSSStyleDeclaration 上设置样式属性。 | CSSStyleDeclaration | ||
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。 | Object | ||
返回指定对象的字符串表示形式。 | Object | ||
返回指定对象的原始值。 | Object | ||
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。 | EventDispatcher |
样式为常见样式,或与特定主题关联。如果为常见样式,则可以用于任何主题。如果样式与特定主题关联,则只有应用程序使用该主题时才能使用该样式。
样式 | 说明 | 由以下参数定义 | ||
---|---|---|---|---|
backgroundColor | 类型: uint 格式: Color CSS 继承: 否 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 列的背景颜色。默认值为 undefined ,表示它使用关联 DataGrid 控件的 backgroundColor 样式值。DataGrid 控件的默认值为 0xFFFFFF 。
| DataGridColumn | ||
color | 类型: uint 格式: Color CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 组件中文本(包括组件标签)的颜色。Halo 主题的默认值为 0x0B333C 。Spark 主题的默认值为 0x000000 。
| DataGridColumn | ||
direction | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 4 运行时版本: Flash10, AIR 1.5 此组件显示的文本的方向性。 允许的值为 FTE 和 TLF 在其双向文本布局算法中使用此值,该算法会将 Unicode 字符顺序映射到字型顺序。 注意:仅当 MX 组件将 UIFTETextField 指定为其
"ltr" 。 | DataGridColumn | ||
disabledColor | 类型: uint 格式: Color CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 禁用时组件中文本的颜色。 默认值为 0xAAB3B3 。 | DataGridColumn | ||
fontAntiAliasType | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 设置内部 TextField 的 antiAliasType 属性。可能值为 "normal" (flash.text.AntiAliasType.NORMAL ) 和 "advanced" (flash.text.AntiAliasType.ADVANCED )。
默认值为 此样式对系统字体不起作用。 此样式适用于 TextField 子控件中的所有文本;但不能将其应用于部分字符。 默认值为 "advanced" 。相关 API 元素 | DataGridColumn | ||
fontFamily | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 使用的字体的名称。与在完全 CSS 实现中不同,这里不支持逗号分隔的列表。您可以使用任何字体系列名称。如果您指定通用字体名称,它将转换为相应的设备字体。Halo 主题的默认字体为 "Verdana" 。Spark 主题的默认字体为 "Arial" 。
| DataGridColumn | ||
fontGridFitType | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 设置用于表示 Flex 控件文本的内部 TextField 的 gridFitType 属性。可能值为 "none" (flash.text.GridFitType.NONE )、"pixel" (flash.text.GridFitType.PIXEL ) 和"subpixel" (flash.text.GridFitType.SUBPIXEL )。
仅当使用嵌入字体并将 此样式对系统字体不起作用。 此样式适用于 TextField 子控件中的所有文本;但不适用于部分字符。 默认值为 "pixel" 。相关 API 元素 | DataGridColumn | ||
fontSharpness | 类型: Number CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 设置用于表示 Flex 控件文本的内部 TextField 的 sharpness 属性。此属性指定字型边缘的清晰度。可能值为从 -400 到 400 之间的数字。
仅当使用嵌入字体并将 此样式对系统字体不起作用。 此样式适用于 TextField 子控件中的所有文本;但不适用于部分字符。 默认值为 0 。相关 API 元素 | DataGridColumn | ||
fontSize | 类型: Number 格式: Length CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 文本的高度,以像素为单位。在 Halo 主题中,除 ColorPicker 控件外,所有其它控件的默认值均为 10。对于 Halo 主题的 ColorPicker 控件,默认值为 11。在 Spark 主题中,除 ColorPicker 控件外,所有其它控件的默认值均为 12。对于 Spark 主题的 ColorPicker 控件,默认值为 11。 | DataGridColumn | ||
fontStyle | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 确定文本是否使用斜体。可识别的值为 "normal" 和 "italic" 。
默认值为 "normal" 。 | DataGridColumn | ||
fontThickness | 类型: Number CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 设置用于表示 Flex 控件文本的内部 TextField 的 thickness 属性。此属性指定字型边缘的粗细。可能值为从 -200 到 200 之间的数字。
仅当使用嵌入字体并将 此样式对系统字体不起作用。 此样式适用于 TextField 子控件中的所有文本;但不适用于部分字符。 默认值为 0 。相关 API 元素 | DataGridColumn | ||
fontWeight | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 确定文本是否使用粗体。可识别的值为 normal 和 bold 。Button 控件的默认值为 bold 。所有其它控件的默认值为 normal 。
| DataGridColumn | ||
headerStyleName | 类型: String CSS 继承: 否 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 用于控制列标题外观其他方面的 CSS 样式声明的名称。默认值为 undefined ,表示它使用关联 DataGrid 控件的 headerStyleName 样式值。DataGrid 控件的默认值为 ".dataGridStyles" 。
| DataGridColumn | ||
kerning | 类型: Boolean CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 一个布尔值,表示是启用 ( true ) 还是禁用 (false ) 字距调整。字距调整会调整某些字符对之间的间隔以提高可读性,并应只在必要时(例如使用大字体标题时)使用。仅嵌入字体支持字距调整。某些字体(如宋体)和等宽字体(如 Courier New)不支持字距调整。
默认值为 false 。 | DataGridColumn | ||
letterSpacing | 类型: Number CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 各字符之间显示的附加像素数。如果为正值,则会在正常间距的基础上增加字符间距;如果为负值,则减小此间距。 默认值为 0 。 | DataGridColumn | ||
locale | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 4 运行时版本: Flash10, AIR 1.5 此组件显示的文本的区域设置。 FTE 和 TLF 使用此区域设置将 Unicode 字符映射到字体字型并查找后备字体。 注意:仅当 MX 组件将 UIFTETextField 指定为其 "en" 。 | DataGridColumn | ||
paddingLeft | 类型: Number 格式: Length CSS 继承: 否 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 容器的左边界与其内容区域之间的像素数目。 默认值为 0 。 | DataGridColumn | ||
paddingRight | 类型: Number 格式: Length CSS 继承: 否 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 容器的右边界与其内容区域之间的像素数目。 默认值为 0 。 | DataGridColumn | ||
textAlign | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 容器内文本的对齐方式。可能值有: "left" 、"right" 或 "center" 。
大多数组件的默认值为 | DataGridColumn | ||
textDecoration | 类型: String CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 确定文本是否加下划线。可能值有: "none" 和 "underline" 。
默认值为 "none" 。 | DataGridColumn | ||
textFieldClass | 类型: Class CSS 继承: 否 语言版本: ActionScript 3.0 产品版本: Flex 4 运行时版本: Flash10, AIR 1.5 实现此组件用来呈示文本的 IUITextField 的类。 它可以设置为 mx.core.UITextField 类(以使用 Flash Player 内置经典 TextField 类)或 mx.core.UIFTETextField 类(以使用 Text Layout Framework 改进文本呈示,包括双向布局)。 默认值为 mx.core.UITextField 。 | DataGridColumn | ||
textIndent | 类型: Number 格式: Length CSS 继承: 是 语言版本: ActionScript 3.0 产品版本: Flex 3 运行时版本: Flash9, AIR 1.1 文本第一行偏离容器左侧的距离(以像素为单位)。 默认值为 0 。 | DataGridColumn |
dataField | 属性 |
dataField:String
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
与列关联的数据提供程序项目中字段或属性的名称。需要对每个 DataGridColumn 控件设置此属性和/或 labelFunction
属性以计算项呈示器的可显示文本。如果设置了 dataField
和 labelFunction
属性,则使用 labelFunction
显示数据并使用 dataField
对数据排序。如果名为 dataField
的属性不存在,则必须设置 sortCompareFunction
以正确进行排序。
此属性的值不一定是列标题中显示的 String。此属性只用于访问数据提供程序中的数据。有关详细信息,请参阅 headerText
属性。
实现
public function get dataField():String
public function set dataField(value:String):void
相关 API 元素
dataTipField | 属性 |
dataTipField:String
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
数据提供程序中显示为数据提示的字段名称。默认情况下,DataGrid 控件在每个数据提供程序项目上查找命名为 label
的属性,然后显示该属性。然而,如果数据提供程序不包含 label
属性,您可以设置 dataTipField
属性来指定其他属性。例如,在用户查看数据库中包含的一组用户名时,可以将值设置为“FullName”。
此属性可用作数据绑定的源。修改此属性后,将调度 dataTipFieldChanged
事件。
实现
public function get dataTipField():String
public function set dataTipField(value:String):void
dataTipFunction | 属性 |
dataTipFunction:Function
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
指定在数据提供程序每个项目上运行的回调函数,以确定其数据提示。此属性由 itemToDataTip
方法使用。
默认情况下,该控件将在每个数据提供程序项目上查找名为 label
的属性,然后将其显示为它的数据提示。不过,某些数据提供程序没有 label
属性或其他可用于显示行中数据的属性。例如,您可能具有包含 lastName 和 firstName 字段的数据提供程序,但您希望将全名显示为数据提示。可以为 dataTipFunction
属性指定一个函数,该函数返回包含这两个字段值的单个 String。还可以使用 dataTipFunction
属性来处理格式和本地化。
此函数必须采用一个 Object 参数(包含数据提供程序元素)并返回一个字符串。
此属性可用作数据绑定的源。修改此属性后,将调度 dataTipFunctionChanged
事件。
实现
public function get dataTipFunction():Function
public function set dataTipFunction(value:Function):void
draggable | 属性 |
public var draggable:Boolean = true
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
一个标志,指示是否允许用户将列拖动到新位置。如果为 true
,则用户可以将列标题拖动到新位置
默认值为 true。
editable | 属性 |
editorDataField | 属性 |
public var editorDataField:String = "text"
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器的属性名称,其中包含列表项目的新数据。例如,默认的 itemEditor
为 TextInput,因此,editorDataField
属性的默认值为 "text"
,此值指定 TextInput 控件的 text
属性。
默认值为 "text"。
editorHeightOffset | 属性 |
public var editorHeightOffset:Number = 0
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器相对于项呈示器大小的高度(以像素为单位)。使用此属性可以使编辑器与项呈示器产生几个像素的重叠,以补偿编辑器周围的边框。请注意,在显示编辑器时,更改这些值不会对当前编辑器产生任何作用,但会影响下一个打开编辑器的项呈示器。
默认值为 0。
editorUsesEnterKey | 属性 |
public var editorUsesEnterKey:Boolean = false
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
指示项目编辑器是否使用 Enter 键的标志。如果为 true
,则项目编辑器将使用 Enter 键,而 DataGrid 不会相应地查找 Enter 键和移动编辑器。请注意,在显示编辑器时,更改此值不会对当前编辑器产生任何作用,但将影响下一个打开编辑器的项呈示器。
默认值为 false.。
editorWidthOffset | 属性 |
public var editorWidthOffset:Number = 0
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器相对于项呈示器大小的宽度(以像素为单位)。使用此属性可以使编辑器与项呈示器产生几个像素的重叠,以补偿编辑器周围的边框。请注意,在显示编辑器时,更改这些值不会对当前编辑器产生任何作用,但会影响下一个打开编辑器的项呈示器。
默认值为 0。
editorXOffset | 属性 |
public var editorXOffset:Number = 0
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器左上角相对于项目左上角的 x 位置(以像素为单位)。使用此属性可以使编辑器与项呈示器产生几个像素的重叠,以补偿编辑器周围的边框。请注意,在显示编辑器时,更改这些值不会对当前编辑器产生任何作用,但会影响下一个打开编辑器的项呈示器。
默认值为 0。
editorYOffset | 属性 |
public var editorYOffset:Number = 0
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器左上角相对于项目左上角的 y 位置(以像素为单位)。使用此属性可以使编辑器与项呈示器产生几个像素的重叠,以补偿编辑器周围的边框。请注意,在显示编辑器时,更改这些值不会对当前编辑器产生任何作用,但会影响下一个打开编辑器的项呈示器。
默认值为 0。
enableIME | 属性 |
headerRenderer | 属性 |
headerRenderer:IFactory
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
显示列标题的项呈示器实例的类工厂。您可以指定嵌入式项呈示器、内嵌项呈示器或自定义项呈示器组件作为此属性的值。
默认项呈示器为 DataGridItemRenderer 类,用于将项目数据显示为文本。
此属性可用作数据绑定的源。修改此属性后,将调度 headerRendererChanged
事件。
实现
public function get headerRenderer():IFactory
public function set headerRenderer(value:IFactory):void
headerText | 属性 |
headerWordWrap | 属性 |
imeMode | 属性 |
imeMode:String
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
指定 IME(输入法编辑器)模式。IME 使用户能够用中文、日文和韩文输入文本。发生 itemFocusIn
事件时,Flex 将设置 IME 模式;发生 itemFocusOut
事件时,将它重新设置回先前的值。flash.system.IMEConversionMode 类定义此属性的有效值的常量。
默认值为空,在这种情况下,它将使用 DataGrid 控件的 imeMode
属性值。
实现
public function get imeMode():String
public function set imeMode(value:String):void
相关 API 元素
itemEditor | 属性 |
public var itemEditor:IFactory
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
列可编辑时,用于列的项目编辑器实例的类工厂。
默认值为 new ClassFactory(mx.controls.TextInput)。
itemRenderer | 属性 |
itemRenderer:IFactory
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
显示列中每个项目数据的项呈示器实例的类工厂。您可以指定嵌入式项呈示器、内嵌项呈示器或自定义项呈示器组件作为此属性的值。
默认项呈示器为 DataGridItemRenderer 类,用于将项目数据显示为文本。
此属性可用作数据绑定的源。修改此属性后,将调度 itemRendererChanged
事件。
实现
public function get itemRenderer():IFactory
public function set itemRenderer(value:IFactory):void
labelFunction | 属性 |
labelFunction:Function
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
确定此列中显示文本的函数。默认情况下,列显示与列名称匹配的数据字段的文本。不过,有时您希望显示基于多个数据字段的文本,或显示不具备自己想要格式的文本。在这种情况下,可使用 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 | 属性 |
nullItemRenderer | 属性 |
nullItemRenderer:IFactory
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
显示列中每个项目数据的项呈示器实例的类工厂。您可以指定嵌入式项呈示器、内嵌项呈示器或自定义项呈示器组件作为此属性的值。
默认项呈示器为 DataGridItemRenderer 类,用于将项目数据显示为文本。
此属性可用作数据绑定的源。修改此属性后,将调度 nullItemRendererChanged
事件。
实现
public function get nullItemRenderer():IFactory
public function set nullItemRenderer(value:IFactory):void
rendererIsEditor | 属性 |
public var rendererIsEditor:Boolean = false
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
指示项呈示器也是项目编辑器的标志。如果此属性为 true
,则 Flex 将忽略 itemEditor
属性并使用该项目的项呈示器作为编辑器。
默认值为 false。
resizable | 属性 |
public var resizable:Boolean = true
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
一个标志,指示是否允许用户调整列的宽度。如果为 true
,则用户可以拖动列标题之间的网格线以调整列大小。
默认值为 true。
showDataTips | 属性 |
sortable | 属性 |
public var sortable:Boolean = true
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
一个标志,指示用户是否能够通过单击此列的标题对数据提供程序进行排序。如果此属性和 DataGridsortableColumns
属性均为 true
,则当用户在列标题上释放鼠标按键时,DataGrid 控件将调度 headerRelease
事件。如果没有其他处理函数调用 headerRelease
事件的 preventDefault()
方法,则列中的 dataField
属性或 sortCompareFunction
将用于重新排序 dataProvider 中的项目。
默认值为 true。
sortCompareFunction | 属性 |
sortCompareFunction:Function
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
对列中的数据进行排序时调用的回调函数。如果未指定此属性,则排序将尝试按基本字符串或数字顺序对数据排序。如果数据不是字符串或数字,或者 dataField
属性不是数据提供程序的有效属性,则排序将不起作用或将生成异常。如果指定 labelFunction
属性的值,通常还会为 sortCompareFunction
属性提供一个函数,否则不允许对此列排序。这意味着当列的 dataField
中的值的排序方式与 labelFunction
属性中的计算值的排序方式不相同时指定一个函数。
DataGrid 控件使用此函数对数据提供程序集合的元素排序。回调函数的函数签名采用两个参数并具有以下格式:
mySortCompareFunction(obj1:Object, obj2:Object):int
obj1
— 要比较的数据元素。
obj2
- 与 obj1 比较的另一个数据元素。
函数应该基于对象比较结果返回值:
- 如果按升序顺序 obj1 应出现在 obj2 前面,则返回 -1。
- 如果 obj1 = obj2,则返回 0。
- 如果按升序顺序 obj1 应出现在 obj2 后面,则返回 1。
注意:obj1
和 obj2
参数是整个数据提供程序元素,而不只是项目数据。
默认值为 null。
此属性可用作数据绑定的源。修改此属性后,将调度 sortCompareFunctionChanged
事件。
实现
public function get sortCompareFunction():Function
public function set sortCompareFunction(value:Function):void
sortDescending | 属性 |
public var sortDescending:Boolean = false
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
指示列排序是按升序排序(设置为 false
),还是按 descending
排序(设置为 true)。
设置此属性不会开始进行排序;这只是在设置排序方向。单击列标题执行排序。
默认值为 false;。
visible | 属性 |
width | 属性 |
width:Number
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
列的宽度(以像素为单位)。如果 DataGrid 的 horizontalScrollPolicy
属性为 false
,则所有可见列必须适合可显示区域;如果列的总宽度对于可显示区域而言太小或太大,则 DataGrid 将不会始终保持列的宽度。
默认值为 100。
此属性可用作数据绑定的源。修改此属性后,将调度 widthChanged
事件。
实现
public function get width():Number
public function set width(value:Number):void
wordWrap | 属性 |
DataGridColumn | () | 构造函数 |
getItemRendererFactory | () | 方法 |
itemToDataTip | () | 方法 |
public function itemToDataTip(data:Object):String
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
返回 String,表示项呈示器基于 dataTipField
和 dataTipFunction
属性显示的给定数据对象的数据提示。如果该方法无法将参数转换为字符串,则会返回一个空格。
此方法供创建 DataGridColumn 类的子类的开发人员使用。它不适用于应用程序开发人员。
参数
data:Object — 要呈示的对象。
|
String — 基于数据的可显示 String。
|
itemToLabel | () | 方法 |
public function itemToLabel(data:Object):String
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
返回项目渲染器为给定数据对象显示的字符串。如果 DataGridColumn 或其 DataGrid 控件具有非空 labelFunction
属性,则它会将该函数应用于数据对象。否则,此方法会提取由 dataField
属性指定的字段的内容,或者获取数据对象的字符串值。如果该方法无法将参数转换为字符串,则会返回一个空格。
参数
data:Object — 要呈示的对象。
|
String — 基于数据的可显示 String。
|
Tue Jun 12 2018, 11:04 AM Z