GridSortEvent

パッケージ	spark.events
クラス	public class GridSortEvent
継承	GridSortEvent Event Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

GridSortEvent クラスは、DataGrid の列の見出しをユーザーがクリックした結果、Spark の 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 定数は、イベントオブジェクトの type プロパティ値を sortChange イベント用に定義し、ソートフィルターがグリッドの dataProvider コレクションに適用されたところであることを示します。	GridSortEvent
		SORT_CHANGING : String = "sortChanging" [静的] GridSortEvent.SORT_CHANGING 定数は、イベントオブジェクトの type プロパティ値を sortChanging イベント用に定義し、ソートフィルターがグリッドの 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 定数は、イベントオブジェクトの type プロパティ値を sortChange イベント用に定義し、ソートフィルターがグリッドの dataProvider コレクションに適用されたところであることを示します。

一般に、列ヘッダーのマウスクリックによってソートがトリガーされると、columnIndices の最後のインデックスが列のインデックスになります。インタラクティブソートは必ずしもマウスクリックによってトリガーされるとは限らないことに注意してください。

このイベントは、ユーザーがコントロールを操作したときに送出されます。データプロバイダーのコレクションをプログラムでソートすると、コンポーネントは sortChange イベントを送出しません。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
`bubbles`	false
`cancelable`	false
`columnIndices`	ソートされた列の列インデックスのベクトルです。
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myDataGrid.addEventListener()` を使用すると、myDataGrid の値は `currentTarget` となります。
`newSortFields`	このソートの ISortFields の配列です。
`oldSortFields`	最後のソートの ISortFields の配列です。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。
`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 定数は、イベントオブジェクトの type プロパティ値を sortChanging イベント用に定義し、ソートフィルターがグリッドの dataProvider コレクションに適用されようとしていることを示します。ソートされないようにするには、このイベントに対して preventDefault() を呼び出します。ソートのデフォルトの動作を変更する場合は、columnIndices と newSortFields を変更します。

このイベントは、ユーザーがコントロールを操作したときに送出されます。データプロバイダーのコレクションをプログラムでソートすると、コンポーネントは sortChanging イベントを送出しません。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
`bubbles`	false
`cancelable`	false
`columnIndices`	ソートされる列の列インデックスのベクトルです。
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myDataGrid.addEventListener()` を使用すると、myDataGrid の値は `currentTarget` となります。
`newSortFields`	このソートの ISortFields の配列です。
`oldSortFields`	最後のソートの ISortFields の配列です。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。
`type`	GridSelectionEvent.SORT_CHANGING

法律上の注意 | プライバシーポリシー

GridSortEvent - AS3 Flex

クラス x

columnIndices

newSortFields

oldSortFields

GridSortEvent

SORT_CHANGE

SORT_CHANGING