mx.collections.SortField (Flex™ 2 リファレンスガイド)

パッケージ	mx.collections
	public class SortField
継承	SortField EventDispatcher Object

既存のビュー内でフィールドまたはプロパティに対してソートを設定するために必要なソート情報を提供します。通常、ソートは複雑なアイテム、つまりオブジェクトのプロパティに対してソートが実行されるアイテムのコレクションに対して設定します。次に例を示します。


     var col:ICollectionView = new ArrayCollection();
     col.addItem({first:"Anders", last:"Dickerson"});
     var sort:Sort = new Sort();
     sort.fields = [new SortField("first", true)];
     col.sort = sort;

コレクションに String、Date、Boolean などの単純なアイテムが含まれている場合があります。この場合は、これらの単純型に直接ソートを適用します。この場合のソートを設定するときは、単一のソートフィールドだけを指定し、name を指定することはできません。たとえば、次のようになります。


     var col:ICollectionView = new ArrayCollection();
     col.addItem("California");
     col.addItem("Arizona");
     var sort:Sort = new Sort();
     sort.fields = [new SortField(null, true)];
     col.sort = sort;

MXML シンタックス expanded

MXML シンタックスの非表示

The <mx:SortField> tag has the following attributes:

 <mx:SortField Properties caseInsensitive="false" compareFunction="Internal compare function" descending="false" name="null" numeric="false" />

	プロパティ	定義
		caseInsensitive : Boolean このフィールドのソートでは大文字と小文字を区別しないかどうかを指定します。	SortField
		compareFunction : Function 関連付けられたコレクションのアイテムをソート中に 2 つのアイテムを比較する関数です。	SortField
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		descending : Boolean このフィールドを降順でソートするかどうかを指定します。	SortField
		name : String ソートするフィールドの名前です。	SortField
		numeric : Boolean ソート対象のフィールドに数値 (number/int/uint) か、または数値のストリング表現が含まれている場合に、コンパレータに数値比較を実行させるように指定します。	SortField
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object

パブリック Methods

継承されるパブリックメソッドの非表示

継承されるパブリックメソッドの表示

	メソッド		定義
		SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Boolean = false) コンストラクタです。	SortField
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void リスナーがイベントの通知を受け取るように、イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録します。	EventDispatcher
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指定されたプロパティがオブジェクトに定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		reverse():void このソートフィールドの条件を逆順にします。	SortField
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

	イベント	一覧	定義
		activate	Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
		deactivate	Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher

プロパティの詳細

caseInsensitive

プロパティ

caseInsensitive:Boolean [read-write]

このフィールドのソートでは大文字と小文字を区別しないかどうかを指定します。

デフォルト値false.

このプロパティはデータバインディングのソースとして使用できます。

実装
public function get caseInsensitive():Boolean
public function set caseInsensitive(value:Boolean):void

compareFunction

プロパティ

compareFunction:Function [read-write]

関連付けられたコレクションのアイテムをソート中に 2 つのアイテムを比較する関数です。Sort オブジェクトの compareFunction プロパティを指定した場合は、Sort の SortField オブジェクトの compareFunction プロパティはすべて無視されます。

比較関数には次のシグネチャが必要です。

function myCompare(a:Object, b:Object):int

この関数では、次の値が返される必要があります。

a が b の前に表示されるソート順の場合は -1
a = b の場合は 0
a が b の後に表示されるソート順の場合は 1

デフォルト値は、ストリング、数値、日付を比較できる内部比較関数です。この比較関数では、昇順または降順での比較が可能で、ストリングの比較に関しては大文字と小文字の区別の有無を指定できます。カスタム比較アルゴリズムが必要な場合にのみ、独自の関数を指定します。このことは、通常、計算フィールドが表示で使用されている場合にのみ該当します。

実装
public function get compareFunction():Function
public function set compareFunction(value:Function):void

descending

プロパティ

descending:Boolean [read-write]

このフィールドを降順でソートするかどうかを指定します。

デフォルト値は false (昇順) です。

このプロパティはデータバインディングのソースとして使用できます。

実装
public function get descending():Boolean
public function set descending(value:Boolean):void

name

プロパティ

name:String [read-write]

ソートするフィールドの名前です。

デフォルト値ヌル (null).

このプロパティはデータバインディングのソースとして使用できます。

実装
public function get name():String
public function set name(value:String):void

numeric

プロパティ

numeric:Boolean [read-write]

ソート対象のフィールドに数値 (number/int/uint) か、または数値のストリング表現が含まれている場合に、コンパレータに数値比較を実行させるように指定します。このプロパティが false の場合は、数値のストリング表現が含まれるフィールドは、ストリング比較によってソートされます。たとえば、"1" は "9" よりも小さいストリング値であるため、100 は 99 よりも先に来ます。

デフォルト値false.

このプロパティはデータバインディングのソースとして使用できます。

実装
public function get numeric():Boolean
public function set numeric(value:Boolean):void

コンストラクタの詳細

SortField

()

コンストラクタ

public 関数 SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Boolean = false)

コンストラクタです。

パラメータ

	`name:String` (default = `null`) — このフィールドが比較に使用するプロパティの名前です。オブジェクトが単純型の場合、`null` を渡します。

	`caseInsensitive:Boolean` (default = `false`) — ストリングをソートする場合は、値の大文字小文字を無視するかどうかをコンパレータに指示します。

	`descending:Boolean` (default = `false`) — アイテムを降順に配置するかどうかをコンパレータに指示します。

	`numeric:Boolean` (default = `false`) — ソートアイテムをアルファベット順ではなく数字として比較するかどうかをコンパレータに指示します。

メソッドの詳細

reverse

()

メソッド

public function reverse():void

このソートフィールドの条件を逆順にします。たとえば、フィールドが降順でソートされた場合は昇順でソートされます。

メモ : ICollectionView は、SortFields が変更されても自動的に更新されません。ビューを更新するには、refresh() メソッドを呼び出します。

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class SortField	プロパティ \| メソッド \| イベント