パッケージmx.collections
public class SortField
継承SortField Inheritance EventDispatcher Inheritance 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;
  
コレクションに StringDateBoolean などの単純なアイテムが含まれている場合があります。この場合は、これらの単純型に直接ソートを適用します。この場合のソートを設定するときは、単一のソートフィールドだけを指定し、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 シンタックスexpandedMXML シンタックスの非表示

<mx:SortField> タグには、以下の属性があります。

 <mx:SortField プロパティ caseInsensitive="false" compareFunction="内部比較関数" descending="false" name="null" numeric="false" /> 


パブリックプロパティ
 プロパティ定義
  caseInsensitive : Boolean
このフィールドのソートでは大文字と小文字を区別しないかどうかを指定します。
SortField
  compareFunction : Function
関連付けられたコレクションのアイテムをソート中に 2 つのアイテムを比較する関数です。
SortField
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  descending : Boolean
このフィールドを降順でソートするかどうかを指定します。
SortField
  name : String
ソートするフィールドの名前です。
SortField
  numeric : Boolean
ソート対象のフィールドに数値 (number/int/uint) か、または数値のストリング表現が含まれている場合に、コンパレータに数値比較を実行させるように指定します。
SortField
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
パブリックメソッド
 メソッド定義
  SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Boolean = false)
コンストラクタ。
SortField
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  reverse():void
このソートフィールドの条件を逆順にします。
SortField
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
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

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

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

実装
    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() メソッドを呼び出します。