套件 | mx.controls.dataGridClasses |
類別 | public class DataGridColumn |
繼承 | DataGridColumn CSSStyleDeclaration EventDispatcher Object |
實作 | IIMESupport |
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
Notes:
- A DataGridColumn only holds information about a column; it is not the parent of the item renderers in the column.
- If you specify a DataGridColumn class without a
dataField
property, you must specify asortCompareFunction
property. Otherwise, sort operations may cause run-time errors.
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
The name of the field or property in the data provider item associated
with the column. | DataGridColumn | ||
dataTipField : String
The name of the field in the data provider to display as the datatip. | DataGridColumn | ||
dataTipFunction : Function
Specifies a callback function to run on each item of the data provider
to determine its dataTip. | DataGridColumn | ||
defaultFactory : Function
This function, if it isn't null,
is usually autogenerated by the MXML compiler. | CSSStyleDeclaration | ||
draggable : Boolean = true
A flag that indicates whether the user is allowed to drag
the column to a new position
If true, the user can drag the
the column headers to a new position
| DataGridColumn | ||
editable : Boolean
A flag that indicates whether the items in the column are editable. | DataGridColumn | ||
editorDataField : String = "text"
The name of the property of the item editor that contains the new
data for the list item. | DataGridColumn | ||
editorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the
item renderer. | DataGridColumn | ||
editorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key. | DataGridColumn | ||
editorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the
item renderer. | DataGridColumn | ||
editorXOffset : Number = 0
The x location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item. | DataGridColumn | ||
editorYOffset : Number = 0
The y location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item. | DataGridColumn | ||
enableIME : Boolean [唯讀]
A flag that indicates whether the IME should
be enabled when the component receives focus. | DataGridColumn | ||
factory : Function
This function, if it isn't null,
is usually autogenerated by the MXML compiler. | CSSStyleDeclaration | ||
headerRenderer : IFactory
The class factory for item renderer instances that display the
column header for the column. | DataGridColumn | ||
headerText : String
Text for the header of this column. | DataGridColumn | ||
headerWordWrap : *
A flag that indicates whether text in the header will be
word wrapped if it doesn't fit on one line. | DataGridColumn | ||
imeMode : String
Specifies the IME (input method editor) mode. | DataGridColumn | ||
itemEditor : IFactory
A class factory for the instances of the item editor to use for the
column, when it is editable. | DataGridColumn | ||
itemRenderer : IFactory
The class factory for item renderer instances that display the
data for each item in the column. | DataGridColumn | ||
labelFunction : Function
A function that determines the text to display in this column. | DataGridColumn | ||
minWidth : Number
The minimum width of the column. | DataGridColumn | ||
nullItemRenderer : IFactory
The class factory for item renderer instances that display the
data for each item in the column. | DataGridColumn | ||
overrides : Object
If the setStyle() method is called on a UIComponent or CSSStyleDeclaration
at run time, this object stores the name/value pairs that were set;
they override the name/value pairs in the objects produced by
the methods specified by the defaultFactory and
factory properties. | CSSStyleDeclaration | ||
rendererIsEditor : Boolean = false
A flag that indicates that the item renderer is also an item editor. | DataGridColumn | ||
resizable : Boolean = true
A flag that indicates whether the user is allowed to resize
the width of the column. | DataGridColumn | ||
selector : CSSSelector
This property is the base selector of a potential chain of selectors
and conditions that are used to match CSS style declarations to
components. | CSSStyleDeclaration | ||
selectorIndex : int = 0
The order this CSSStyleDeclaration was added to its StyleManager. | CSSStyleDeclaration | ||
showDataTips : *
A flag that indicates whether the datatips are shown in the column. | DataGridColumn | ||
sortable : Boolean = true
A flag that indicates whether the user can click on the
header of this column to sort the data provider. | DataGridColumn | ||
sortCompareFunction : Function
A callback function that gets called when sorting the data in
the column. | DataGridColumn | ||
sortDescending : Boolean = false
Indicates whether the column sort is
in ascending order, false,
or descending order, true. | DataGridColumn | ||
specificity : int [唯讀]
Determines the order of precedence when applying multiple style
declarations to a component. | CSSStyleDeclaration | ||
subject : String [唯讀]
The subject describes the name of a component that may be a potential
match for this style declaration. | CSSStyleDeclaration | ||
visible : Boolean
A flag that indicates whethe the column is visible. | DataGridColumn | ||
width : Number
The width of the column, in pixels. | DataGridColumn | ||
wordWrap : *
A flag that indicates whether the text in a row of this column
is word wrapped if it doesn't fit on one line. | DataGridColumn |
方法 | 定義自 | ||
---|---|---|---|
DataGridColumn(columnName:String = null)
Constructor. | DataGridColumn | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式,以便讓偵聽程式收到事件的通知。 | EventDispatcher | ||
Clears a style property on this CSSStyleDeclaration. | CSSStyleDeclaration | ||
會將事件傳送到事件流程。 | EventDispatcher | ||
Return the appropriate factory, using the default factory if none specified. | DataGridColumn | ||
Gets the value for a specified style property,
as determined solely by this CSSStyleDeclaration. | CSSStyleDeclaration | ||
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | EventDispatcher | ||
指出物件是否有已定義的指定屬性。 | Object | ||
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | ||
Returns a String that the item renderer displays as the datatip for the given data object,
based on the dataTipField and dataTipFunction properties. | DataGridColumn | ||
Returns the String that the item renderer displays for the given data object. | DataGridColumn | ||
Determines whether this style declaration applies to the given component
based on a match of the selector chain. | CSSStyleDeclaration | ||
指出指定的屬性是否存在,以及是否可列舉。 | Object | ||
會從 EventDispatcher 物件移除偵聽程式。 | EventDispatcher | ||
為迴圈作業設定動態屬性的可用性。 | Object | ||
Sets a style property on this CSSStyleDeclaration. | CSSStyleDeclaration | ||
傳回代表此物件的字串,根據地區特定慣例進行格式化。 | Object | ||
會傳回指定之物件的字串形式。 | Object | ||
會傳回指定之物件的基本值。 | Object | ||
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式,或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | EventDispatcher |
樣式可分為一般樣式及與特定主題關聯的樣式兩種。如果是一般樣式,可以與任何主題搭配使用。如果是與特定主題關聯的樣式,只有在您的應用程式使用特定主題時才能使用該樣式。
樣式 | 說明 | 定義自 | ||
---|---|---|---|---|
backgroundColor | 類型: uint 格式: Color CSS 繼承: 否 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 The Background color of the column. The default value is undefined , which means it uses the value of the
backgroundColor style of the associated DataGrid control.
The default value for the DataGrid control is 0xFFFFFF .
| DataGridColumn | ||
color | 類型: uint 格式: Color CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Color of text in the component, including the component label. The default value for the Halo theme is 0x0B333C .
The default value for the Spark theme is 0x000000 .
| DataGridColumn | ||
direction | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 4 執行階段版本: Flash10, AIR 1.5 The directionality of the text displayed by the component. The allowed values are FTE and TLF use this value in their bidirectional text layout algorithm, which maps Unicode character order to glyph order. Note: This style only applies when an MX component
specifies UIFTETextField as its The "ltr" 。 | DataGridColumn | ||
disabledColor | 類型: uint 格式: Color CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Color of text in the component if it is disabled. 預設值為 0xAAB3B3 。 | DataGridColumn | ||
fontAntiAliasType | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Sets the antiAliasType property of internal TextFields. The possible values are
"normal" (flash.text.AntiAliasType.NORMAL )
and "advanced" (flash.text.AntiAliasType.ADVANCED ).
The default value is This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others. 預設值為 "advanced" 。相關 API 元素 | DataGridColumn | ||
fontFamily | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default font for the Halo theme is "Verdana" .
The default font for the Spark theme is "Arial" .
| DataGridColumn | ||
fontGridFitType | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Sets the gridFitType property of internal TextFields that represent text in Flex controls.
The possible values are "none" (flash.text.GridFitType.NONE ),
"pixel" (flash.text.GridFitType.PIXEL ),
and "subpixel" (flash.text.GridFitType.SUBPIXEL ).
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. 預設值為 "pixel" 。相關 API 元素 | DataGridColumn | ||
fontSharpness | 類型: Number CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Sets the sharpness property of internal TextFields that represent text in Flex controls.
This property specifies the sharpness of the glyph edges. The possible values are Numbers
from -400 through 400.
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. 預設值為 0 。相關 API 元素 | DataGridColumn | ||
fontSize | 類型: Number 格式: Length CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Height of the text, in pixels. In the Halo theme, the default value is 10 for all controls except the ColorPicker control. For the Halo themed ColorPicker control, the default value is 11. In the Spark theme, the default value is 12 for all controls except the ColorPicker control. For the Spark themed ColorPicker control, the default value is 11. | DataGridColumn | ||
fontStyle | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Determines whether the text is italic font. Recognized values are "normal" and "italic" .
預設值為 "normal" 。 | DataGridColumn | ||
fontThickness | 類型: Number CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Sets the thickness property of internal TextFields that represent text in Flex controls.
This property specifies the thickness of the glyph edges.
The possible values are Numbers from -200 to 200.
This property only applies when you are using an embedded font
and the This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. 預設值為 0 。相關 API 元素 | DataGridColumn | ||
fontWeight | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Determines whether the text is boldface. Recognized values are normal and bold .
The default value for Button controls is bold .
The default value for all other controls is normal .
| DataGridColumn | ||
headerStyleName | 類型: String CSS 繼承: 否 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 The name of a CSS style declaration for controlling other aspects of the appearance of the column headers. The default value is undefined , which means it uses the value of the
headerStyleName style of the associated DataGrid control.
The default value for the DataGrid control is
".dataGridStyles" .
| DataGridColumn | ||
kerning | 類型: Boolean CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 A Boolean value that indicates whether kerning is enabled ( true ) or disabled (false ).
Kerning adjusts the gap between certain character pairs
to improve readability, and should be used only when necessary,
such as with headings in large fonts.
Kerning is supported for embedded fonts only.
Certain fonts, such as Verdana, and monospaced fonts,
such as Courier New, do not support kerning.
預設值為 false 。 | DataGridColumn | ||
letterSpacing | 類型: Number CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. 預設值為 0 。 | DataGridColumn | ||
locale | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 4 執行階段版本: Flash10, AIR 1.5 The locale of the text displayed by this component. FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts. Note: This style only applies when an MX component
specifies UIFTETextField as its "en" 。 | DataGridColumn | ||
paddingLeft | 類型: Number 格式: Length CSS 繼承: 否 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 The number of pixels between the container's left border and its content area. 預設值為 0 。 | DataGridColumn | ||
paddingRight | 類型: Number 格式: Length CSS 繼承: 否 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 The number of pixels between the container's right border and its content area. 預設值為 0 。 | DataGridColumn | ||
textAlign | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Alignment of text within a container. Possible values are "left" , "right" ,
or "center" .
The default value for most components is | DataGridColumn | ||
textDecoration | 類型: String CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Determines whether the text is underlined. Possible values are "none" and "underline" .
預設值為 "none" 。 | DataGridColumn | ||
textFieldClass | 類型: Class CSS 繼承: 否 語言版本: ActionScript 3.0 產品版本: Flex 4 執行階段版本: Flash10, AIR 1.5 The class implementing IUITextField that is used by this component to render text. It can be set to either the mx.core.UITextField class (to use the classic TextField class built into Flash Player) or the mx.core.UIFTETextField class (to use the Text Layout Framework to get improved text rendering, including bidirectional layout). 預設值為 mx.core.UITextField 。 | DataGridColumn | ||
textIndent | 類型: Number 格式: Length CSS 繼承: 是 語言版本: ActionScript 3.0 產品版本: Flex 3 執行階段版本: Flash9, AIR 1.1 Offset of first line of text from the left side of the container, in pixels. 預設值為 0 。 | DataGridColumn |
dataField | 屬性 |
dataField:String
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The name of the field or property in the data provider item associated
with the column.
Each DataGridColumn control
requires this property and/or the labelFunction
property
to be set in order to calculate the displayable text for the item
renderer.
If the dataField
and labelFunction
properties are set,
the data is displayed using the labelFunction
and sorted
using the dataField
. If the property named in the
dataField
does not exist, the
sortCompareFunction
must be set for the sort to work
correctly.
This value of this property is not necessarily the String that
is displayed in the column header. This property is
used only to access the data in the data provider.
For more information, see the headerText
property.
實作
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 |
The name of the field in the data provider to display as the datatip.
By default, the DataGrid control looks for a property named
label
on each data provider item and displays it.
However, if the data provider does not contain a label
property, you can set the dataTipField
property to
specify a different property.
For example, you could set the value to "FullName" when a user views a
set of people's names included from a database.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 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 |
Specifies a callback function to run on each item of the data provider
to determine its dataTip.
This property is used by the itemToDataTip
method.
By default the control looks for a property named label
on each data provider item and displays it as its dataTip.
However, some data providers do not have a label
property
nor do they have another property that you can use for displaying data
in the rows.
For example, you might have a data provider that contains a lastName
and firstName fields, but you want to display full names as the dataTip.
You can specify a function to the dataTipFunction
property
that returns a single String containing the value of both fields. You
can also use the dataTipFunction
property for handling
formatting and localization.
The function must take a single Object parameter, containing the data provider element, and return a String.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 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 |
A flag that indicates whether the user is allowed to drag
the column to a new position
If true
, the user can drag the
the column headers to a new position
預設值為 true。
editable | 屬性 |
editable:Boolean
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the items in the column are editable.
If true
, and the DataGrid's editable
property is also true
, the items in a column are
editable and can be individually edited
by clicking on an item or by navigating to the item by using the
Tab and Arrow keys.
預設值為 true。
實作
public function get editable():Boolean
public function set editable(value:Boolean):void
editorDataField | 屬性 |
public var editorDataField:String = "text"
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The name of the property of the item editor that contains the new
data for the list item.
For example, the default itemEditor
is
TextInput, so the default value of the editorDataField
property is "text"
, which specifies the
text
property of the TextInput control.
預設值為 "text"。
editorHeightOffset | 屬性 |
public var editorHeightOffset:Number = 0
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The height of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
預設值為 0。
editorUsesEnterKey | 屬性 |
public var editorUsesEnterKey:Boolean = false
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the item editor uses Enter key.
If true
the item editor uses the Enter key and the
DataGrid will not look for the Enter key and move the editor in
response.
Note that changing this value while the editor is displayed
will have no effect on the current editor, but will affect the next
item renderer that opens an editor.
預設值為 false.。
editorWidthOffset | 屬性 |
public var editorWidthOffset:Number = 0
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The width of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
預設值為 0。
editorXOffset | 屬性 |
public var editorXOffset:Number = 0
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The x location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
預設值為 0。
editorYOffset | 屬性 |
public var editorYOffset:Number = 0
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The y location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor. Note that changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
預設值為 0。
enableIME | 屬性 |
headerRenderer | 屬性 |
headerRenderer:IFactory
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The class factory for item renderer instances that display the column header for the column. You can specify a drop-in item renderer, an inline item renderer, or a custom item renderer component as the value of this property.
The default item renderer is the DataGridItemRenderer class, which displays the item data as text.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 headerRendererChanged
事件。
實作
public function get headerRenderer():IFactory
public function set headerRenderer(value:IFactory):void
headerText | 屬性 |
headerText:String
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
Text for the header of this column. By default, the DataGrid
control uses the value of the dataField
property
as the header text.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 headerTextChanged
事件。
實作
public function get headerText():String
public function set headerText(value:String):void
headerWordWrap | 屬性 |
headerWordWrap:*
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
A flag that indicates whether text in the header will be
word wrapped if it doesn't fit on one line.
If undefined
, the DataGrid control's wordWrap
property
is used.
預設值為 undefined。
實作
public function get headerWordWrap():*
public function set headerWordWrap(value:any):void
imeMode | 屬性 |
imeMode:String
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
Specifies the IME (input method editor) mode.
The IME enables users to enter text in Chinese, Japanese, and Korean.
Flex sets the IME mode when the itemFocusIn
event occurs,
and sets it back
to the previous value when the itemFocusOut
event occurs.
The flash.system.IMEConversionMode class defines constants for
the valid values for this property.
The default value is null, in which case it uses the value of the
DataGrid control's imeMode
property.
實作
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 |
A class factory for the instances of the item editor to use for the column, when it is editable.
預設值為 new ClassFactory(mx.controls.TextInput)。
更多範例
itemRenderer | 屬性 |
itemRenderer:IFactory
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The class factory for item renderer instances that display the data for each item in the column. You can specify a drop-in item renderer, an inline item renderer, or a custom item renderer component as the value of this property.
The default item renderer is the DataGridItemRenderer class, which displays the item data as text.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 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 |
A function that determines the text to display in this column. By default
the column displays the text for the field in the data that matches the
column name. However, sometimes you want to display text based on
more than one field in the data, or display something that does not
have the format that you want.
In such a case you specify a callback function using labelFunction
.
For the DataGrid control, the method signature has the following form:
labelFunction(item:Object, column:DataGridColumn):String
Where item
contains the DataGrid item object, and
column
specifies the DataGrid column.
A callback function might concatenate the firstName and lastName fields in the data, or do some custom formatting on a Date, or convert a number for the month into the string for the month.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 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 |
The class factory for item renderer instances that display the data for each item in the column. You can specify a drop-in item renderer, an inline item renderer, or a custom item renderer component as the value of this property.
The default item renderer is the DataGridItemRenderer class, which displays the item data as text.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 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 |
A flag that indicates that the item renderer is also an item editor.
If this property is true
, Flex
ignores the itemEditor
property and uses the item
renderer for that item as the editor.
預設值為 false。
resizable | 屬性 |
public var resizable:Boolean = true
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the user is allowed to resize
the width of the column.
If true
, the user can drag the grid lines between
the column headers to resize
the column.
預設值為 true。
showDataTips | 屬性 |
showDataTips:*
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the datatips are shown in the column.
If true
, datatips are displayed for text in the rows. Datatips
are tooltips designed to show the text that is too long for the row.
預設值為 false。
實作
public function get showDataTips():*
public function set showDataTips(value:any):void
sortable | 屬性 |
public var sortable:Boolean = true
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the user can click on the
header of this column to sort the data provider.
If this property and the DataGrid sortableColumns
property
are both true
, the DataGrid control dispatches a
headerRelease
event when a user releases the mouse button
on this column's header.
If no other handler calls the preventDefault()
method on
the headerRelease
event, the dataField
property or sortCompareFunction
in the column is used
to reorder the items in the dataProvider.
預設值為 true。
sortCompareFunction | 屬性 |
sortCompareFunction:Function
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
A callback function that gets called when sorting the data in
the column. If this property is not specified, the sort tries
to use a basic string or number sort on the data.
If the data is not a string or number or if the dataField
property is not a valid property of the data provider, the sort does
not work or will generate an exception.
If you specify a value of the labelFunction
property,
you typically also provide a function to the sortCompareFunction
property,
unless sorting is not allowed on this column.
That means you specify a function when the value from the column's dataField
does not sort in the same way as the computed value from the labelFunction
property.
The DataGrid control uses this function to sort the elements of the data provider collection. The function signature of the callback function takes two parameters and have the following form:
mySortCompareFunction(obj1:Object, obj2:Object):int
obj1
— A data element to compare.
obj2
— Another data element to compare with obj1.
The function should return a value based on the comparison of the objects:
- -1 if obj1 should appear before obj2 in ascending order.
- 0 if obj1 = obj2.
- 1 if obj1 should appear after obj2 in ascending order.
Note: The obj1
and
obj2
parameters are entire data provider elements and not
just the data for the item.
預設值為 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 |
Indicates whether the column sort is
in ascending order, false
,
or descending
order, true.
Setting this property does not start a sort; it only sets the sort direction. Click on the column header to perform the sort.
預設值為 false;。
visible | 屬性 |
width | 屬性 |
width:Number
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The width of the column, in pixels.
If the DataGrid's horizontalScrollPolicy
property
is false
, all visible columns must fit in the displayable
area, and the DataGrid will not always honor the width of
the columns if the total width of the columns is too
small or too large for the displayable area.
預設值為 100。
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 widthChanged
事件。
實作
public function get width():Number
public function set width(value:Number):void
wordWrap | 屬性 |
wordWrap:*
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the text in a row of this column
is word wrapped if it doesn't fit on one line.
If undefined
, the DataGrid control's wordWrap
property
is used.
Only takes effect if the DataGrid.variableRowHeight
property is also
true
.
預設值為 undefined。
實作
public function get wordWrap():*
public function set wordWrap(value:any):void
DataGridColumn | () | 建構函式 |
public function DataGridColumn(columnName:String = null)
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
Constructor.
參數columnName:String (default = null ) — The name of the field in the data provider
associated with the column, and the text for the header cell of this
column. This is equivalent to setting the dataField
and headerText properties.
|
getItemRendererFactory | () | 方法 |
public function getItemRendererFactory(forHeader:Boolean, data:Object):IFactory
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
Return the appropriate factory, using the default factory if none specified.
參數
forHeader:Boolean — true if this is a header renderer.
| |
data:Object — The data to be presented by the item renderer.
|
IFactory — if data is null, the default item renderer,
otherwis it returns the custom item renderer.
|
itemToDataTip | () | 方法 |
public function itemToDataTip(data:Object):String
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
Returns a String that the item renderer displays as the datatip for the given data object,
based on the dataTipField
and dataTipFunction
properties.
If the method cannot convert the parameter to a String, it returns a
single space.
This method is for use by developers who are creating subclasses of the DataGridColumn class. It is not for use by application developers.
參數
data:Object — Object to be rendered.
|
String — Displayable String based on the data.
|
itemToLabel | () | 方法 |
public function itemToLabel(data:Object):String
語言版本: | ActionScript 3.0 |
產品版本: | Flex 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
Returns the String that the item renderer displays for the given data object.
If the DataGridColumn or its DataGrid control
has a non-null labelFunction
property, it applies the function to the data object.
Otherwise, the method extracts the contents of the field specified by the
dataField
property, or gets the string value of the data object.
If the method cannot convert the parameter to a String, it returns a
single space.
參數
data:Object — Object to be rendered.
|
String — Displayable String based on the data.
|
Tue Jun 12 2018, 03:47 PM Z