GridSortEvent

包	spark.events
类	public class GridSortEvent
继承	GridSortEvent Event Object

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

GridSortEvent 类表示 Spark DataGrid 控件的数据提供程序按用户单击 DataGrid 中列标题的结果进行排序时调度的事件。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		bubbles : Boolean [只读] 表示事件是否为冒泡事件。	Event
		cancelable : Boolean [只读] 表示是否可以阻止与事件相关联的行为。	Event
		columnIndices : Vector.<int> 已排序列的列索引矢量。	GridSortEvent
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		currentTarget : Object [只读] 当前正在使用某个事件侦听器处理 Event 对象的对象。	Event
		eventPhase : uint [只读] 事件流中的当前阶段。	Event
		newSortFields : Array 此次排序的 ISortFields 数组。	GridSortEvent
		oldSortFields : Array [只读] 上一次排序的 ISortFields 数组。	GridSortEvent
		target : Object [只读] 事件目标。	Event
		type : String [只读] 事件的类型。	Event

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		GridSortEvent(type:String, bubbles:Boolean, cancelable:Boolean, columnIndices:Vector.<int>, oldSortFields:Array, newSortFields:Array) 构造函数。	GridSortEvent
		clone():Event 复制 Event 子类的实例。	Event
		formatToString(className:String, ... arguments):String 用于在自定义 ActionScript 3.0 Event 类中实现 toString() 方法的实用程序函数。	Event
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isDefaultPrevented():Boolean 检查是否已对事件调用 preventDefault() 方法。	Event
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		preventDefault():void 如果可以取消事件的默认行为，则取消该行为。	Event
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		stopImmediatePropagation():void 防止对事件流中当前节点中和所有后续节点中的事件侦听器进行处理。	Event
		stopPropagation():void 防止对事件流中当前节点的后续节点中的所有事件侦听器进行处理。	Event
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回一个字符串，其中包含 Event 对象的所有属性。	Event
		valueOf():Object 返回指定对象的原始值。	Object

公共常量

隐藏继承的公共常量

显示继承的公共常量

	常量		由以下参数定义
		SORT_CHANGE : String = "sortChange" [静态] GridSortEvent.SORT_CHANGE 常量为 sortChange 事件定义事件对象的 type 属性值，其指示排序过滤器已应用于网格的 dataProvider 集合。	GridSortEvent
		SORT_CHANGING : String = "sortChanging" [静态] GridSortEvent.SORT_CHANGING 常量为 sortChanging 事件定义事件对象的 type 属性值，其指示排序过滤器将应用于网格的 dataProvider 集合。	GridSortEvent

属性详细信息

columnIndices

属性

public var columnIndices:Vector.<int>

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

已排序列的列索引矢量。如果 type 为 GridSelectionEvent.SORT_CHANGING，则可以修改该值，且会将其用于更新网格的 columnHeaderGroup visibleSortIndicatorIndices。

newSortFields

属性

public var newSortFields:Array

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

此次排序的 ISortFields 数组。如果 type 为 GridSelectionEvent.SORT_CHANGING，则可以修改该值，且会将其用于对网格的 dataProvider 进行排序。

oldSortFields

属性

oldSortFields:Array [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

上一次排序的 ISortFields 数组。这可能是 null。不应修改该数组中的元素。

实现
public function get oldSortFields():Array

相关 API 元素

构造函数详细信息

()

构造函数

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

构造函数。

参数

	`type:String` — 事件类型；指示引发事件的动作。

	`bubbles:Boolean` — 指定该事件是否可以在显示列表层次结构得到冒泡处理。

	`cancelable:Boolean` — 指定是否可以防止与事件相关联的行为。

	`columnIndices:Vector.<int>` — 已排序列的列索引矢量。

	`oldSortFields:Array` — 上一次排序的 ISortFields 数组。

	`newSortFields:Array` — 此次排序的 ISortFields 数组。

常量详细信息

SORT_CHANGE

常量

public static const SORT_CHANGE:String = "sortChange"

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

GridSortEvent.SORT_CHANGE 常量为 sortChange 事件定义事件对象的 type 属性值，其指示排序过滤器已应用于网格的 dataProvider 集合。

通常，如果列标题鼠标单击触发了该排序，则 columnIndices 的上一个索引是列索引。请注意，交互式排序不需要由鼠标单击触发。

当用户与此控件交互时，将调度此事件。通过编程方式对数据提供程序的集合进行排序时，此组件不会调度 sortChange 事件。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`cancelable`	false
`columnIndices`	已排序列的列索引矢量。
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myDataGrid.addEventListener()` 注册某个事件侦听器，则 myDataGrid 为 `currentTarget` 的值。
`newSortFields`	此次排序的 ISortFields 数组。
`oldSortFields`	上一次排序的 ISortFields 数组。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。
`type`	GridSelectionEvent.SORT_CHANGE

SORT_CHANGING

常量

public static const SORT_CHANGING:String = "sortChanging"

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

GridSortEvent.SORT_CHANGING 常量为 sortChanging 事件定义事件对象的 type 属性值，其指示排序过滤器将应用于网格的 dataProvider 集合。对该事件调用 preventDefault() 可防止排序发生，或者如果要更改排序的默认行为，可以修改 columnIndices 和 newSortFields。

通常，如果列标题鼠标单击触发了该排序，则 columnIndices 的上一个索引是列索引。请注意，交互式排序不需要由鼠标单击触发。

当用户与此控件交互时，将调度此事件。通过编程方式对数据提供程序的集合进行排序时，此组件不会调度 sortChanging 事件。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`cancelable`	false
`columnIndices`	要排序列的列索引矢量。
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myDataGrid.addEventListener()` 注册某个事件侦听器，则 myDataGrid 为 `currentTarget` 的值。
`newSortFields`	此次排序的 ISortFields 数组。
`oldSortFields`	上一次排序的 ISortFields 数组。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。
`type`	GridSelectionEvent.SORT_CHANGING

法律声明 | 在线隐私策略

GridSortEvent - AS3 Flex

类 x

columnIndices

newSortFields

oldSortFields

GridSortEvent

SORT_CHANGE

SORT_CHANGING