套件 | spark.events |
類別 | public class GridSortEvent |
繼承 | GridSortEvent Event Object |
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4.5 |
執行階段版本: | Flash Player 10, AIR 2.5 |
相關 API 元素
spark.components.gridClasses.GridColumn
spark.components.GridColumnHeaderGroup
屬性 | 定義自 | ||
---|---|---|---|
bubbles : Boolean [唯讀]
指出事件是否為反昇事件。 | Event | ||
cancelable : Boolean [唯讀]
指出是否可避免與事件相關聯的行為指令。 | Event | ||
columnIndices : Vector.<int>
The vector of column indices of the sorted columns. | GridSortEvent | ||
constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | Object | ||
currentTarget : Object [唯讀]
正主動使用事件偵聽程式處理 Event 物件的物件。 | Event | ||
eventPhase : uint [唯讀]
事件流程中的目前階段。 | Event | ||
newSortFields : Array
The array of ISortFields for this sort. | GridSortEvent | ||
oldSortFields : Array [唯讀]
The array of ISortFields for the last sort. | GridSortEvent | ||
target : Object [唯讀]
事件目標。 | Event | ||
type : String [唯讀]
事件類型。 | Event |
方法 | 定義自 | ||
---|---|---|---|
GridSortEvent(type:String, bubbles:Boolean, cancelable:Boolean, columnIndices:Vector.<int>, oldSortFields:Array, newSortFields:Array)
Constructor. | GridSortEvent | ||
複製 Event 子類別的實體。 | Event | ||
公用程式函數,可用來實作自訂 ActionScript 3.0 Event 類別中的 toString() 方法。 | Event | ||
指出物件是否有已定義的指定屬性。 | Object | ||
檢查是否已經對事件呼叫 preventDefault() 方法。 | Event | ||
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | ||
如果可以取消事件的預設行為指令,則取消該行為指令。 | Event | ||
指出指定的屬性是否存在,以及是否可列舉。 | Object | ||
為迴圈作業設定動態屬性的可用性。 | Object | ||
避免處理事件流程中,目前節點以及任何後續節點中的任何事件偵聽程式。 | Event | ||
避免處理接續在事件流程中的目前節點之後,後續節點中的任何事件偵聽程式。 | Event | ||
傳回代表此物件的字串,根據地區特定慣例進行格式化。 | Object | ||
傳回包含 Event 物件所有屬性的字串。 | Event | ||
會傳回指定之物件的基本值。 | Object |
常數 | 定義自 | ||
---|---|---|---|
SORT_CHANGE : String = "sortChange" [靜態]
The GridSortEvent.SORT_CHANGE constant defines
the value of the type property of the event object for a
sortChange event, which indicates that a sort filter has just been
applied to the grid's dataProvider collection. | GridSortEvent | ||
SORT_CHANGING : String = "sortChanging" [靜態]
The GridSortEvent.SORT_CHANGING constant defines
the value of the type property of the event object for a
sortChanging event, which indicates that a sort filter is about to be
applied to the grid's dataProvider collection. | GridSortEvent |
columnIndices | 屬性 |
public var columnIndices:Vector.<int>
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4.5 |
執行階段版本: | Flash Player 10, AIR 2.5 |
The vector of column indices of the sorted columns.
If type
is GridSelectionEvent.SORT_CHANGING
this value
can be modified and it will be used to update the grid's columnHeaderGroup
visibleSortIndicatorIndices
.
相關 API 元素
newSortFields | 屬性 |
public var newSortFields:Array
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4.5 |
執行階段版本: | Flash Player 10, AIR 2.5 |
The array of ISortFields for this sort.
If type
is GridSelectionEvent.SORT_CHANGING
this value
can be modified and it will be used to sort the dataProvider
of the grid.
相關 API 元素
oldSortFields | 屬性 |
GridSortEvent | () | 建構函式 |
public function GridSortEvent(type:String, bubbles:Boolean, cancelable:Boolean, columnIndices:Vector.<int>, oldSortFields:Array, newSortFields:Array)
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4.5 |
執行階段版本: | Flash Player 10, AIR 2.5 |
Constructor.
參數type:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean — Specifies whether the event can bubble
up the display list hierarchy.
| |
cancelable:Boolean — Specifies whether the behavior
associated with the event can be prevented.
| |
columnIndices:Vector.<int> — The vector of column indices of the sorted columns.
| |
oldSortFields:Array — The array of ISortFields for the last sort.
| |
newSortFields:Array — The array of ISortFields for this sort.
|
SORT_CHANGE | 常數 |
public static const SORT_CHANGE:String = "sortChange"
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4.5 |
執行階段版本: | Flash Player 10, AIR 2.5 |
The GridSortEvent.SORT_CHANGE
constant defines
the value of the type
property of the event object for a
sortChange
event, which indicates that a sort filter has just been
applied to the grid's dataProvider
collection.
Typically, if a column header mouse click triggered the sort, then the last index of
columnIndices
is the column's index.
Note that interactive sorts are not necessarily triggered by a mouse click.
This event is dispatched when the user interacts with the control.
When you sort the data provider's collection programmatically,
the component does not dispatch the sortChange
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
columnIndices | The vector of column indices of the sorted columns. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myDataGrid.addEventListener() to register an event listener,
myDataGrid is the value of the currentTarget . |
newSortFields | The array of ISortFields for this sort. |
oldSortFields | The array of ISortFields for the last sort. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GridSelectionEvent.SORT_CHANGE |
相關 API 元素
SORT_CHANGING | 常數 |
public static const SORT_CHANGING:String = "sortChanging"
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4.5 |
執行階段版本: | Flash Player 10, AIR 2.5 |
The GridSortEvent.SORT_CHANGING
constant defines
the value of the type
property of the event object for a
sortChanging
event, which indicates that a sort filter is about to be
applied to the grid's dataProvider
collection.
Call preventDefault() on this event to prevent the sort from occurring
or you modify columnIndices
and newSortFields
if you want to
change the default behavior of the sort.
Typically, if a column header mouse click triggered the sort, then the last index of
columnIndices
is the column's index.
Note that interactive sorts are not necessarily triggered by a mouse click.
This event is dispatched when the user interacts with the control.
When you sort the data provider's collection programmatically,
the component does not dispatch the sortChanging
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
columnIndices | The vector of column indices of the columns to be sorted. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myDataGrid.addEventListener() to register an event listener,
myDataGrid is the value of the currentTarget . |
newSortFields | The array of ISortFields for this sort. |
oldSortFields | The array of ISortFields for the last sort. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | GridSelectionEvent.SORT_CHANGING |
相關 API 元素
Tue Jun 12 2018, 03:47 PM Z