Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
mx.collections 

ISortField  - AS3 Flex

パッケージmx.collections
インターフェイスpublic interface ISortField
実装者 SortField, SortField

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

ISortField インターフェイスは、コレクションビューの特定のフィールドまたはプロパティをソートするために必要なソート情報を提供するために、ISort クラスで使用されるクラスのインターフェイスを定義します。



パブリックプロパティ
 プロパティ定義元
  arraySortOnOptions : int
[読み取り専用] このヘルパープロパティは、findItem() メソッドおよび sort() メソッドによって内部的に使用されます。
ISortField
  compareFunction : Function
関連付けられたコレクションのアイテムをソートするときに 2 つのアイテムを比較する関数です。
ISortField
  descending : Boolean
このフィールドを降順でソートするかどうかを指定します。
ISortField
  name : String
ソートするフィールドの名前です。
ISortField
  numeric : Object
ソート対象のフィールドに数値(number/int/uint)、または数値のストリング表現が含まれている場合、コンパレータが数値比較を実行するように指定します。
ISortField
  usingCustomCompareFunction : Boolean
[読み取り専用] この ISortField がカスタムコンパレータ関数を使用している場合は True です。
ISortField
パブリックメソッド
 メソッド定義元
  
カスタム比較関数が設定されているかどうか、指定されたフィールドのデータ型、numeric プロパティの値のいずれかに基づいて、比較を実行するためのデフォルト比較関数を設定するために、Sort クラスによって呼び出されるヘルパー関数です。
ISortField
  
このソートフィールドの条件を逆順にします。
ISortField
プロパティの詳細

arraySortOnOptions

プロパティ
arraySortOnOptions:int  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

このヘルパープロパティは、findItem() メソッドおよび sort() メソッドによって内部的に使用されます。 これ以外の使用方法はサポートされていません。フィールドのソートに Sort クラスでこの ISortField を使用しないようにする(compareFunction や name がない)場合は、-1 を返します。 それ以外の場合は、ソートオプションのビットマスクを返します。



実装
    public function get arraySortOnOptions():int

compareFunction

プロパティ 
compareFunction:Function

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

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

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

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

この関数は、次の値を返します。

  • ab の前に現れるソート順の場合は -1 です。
  • ab と等しい場合は 0 です。
  • ab の後に表示されるソート順の場合は 1 です。



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

descending

プロパティ 
descending:Boolean

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

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

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



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

name

プロパティ 
name:String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

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



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

numeric

プロパティ 
numeric:Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

ソート対象のフィールドに数値(number/int/uint)、または数値のストリング表現が含まれている場合、コンパレータが数値比較を実行するように指定します。

このプロパティは、カスタム比較関数が指定されていない場合に、SortField クラスで使用されます。

このプロパティが true の場合、組み込みの数値比較関数が使用されます。各データアイテムは Number() 関数にキャストされてから比較されます。

このプロパティが false の場合、組み込みの文字列比較関数が使用されます。各データアイテムは String() 関数にキャストされてから比較されます。

このプロパティが null の場合は、最初のデータアイテムを内観してそれが数字とストリングのどちらであるかを判定し、その内観に基づいてソートが実行されます。

デフォルト値: null。



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

usingCustomCompareFunction

プロパティ 
usingCustomCompareFunction:Boolean  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

この ISortField がカスタムコンパレータ関数を使用している場合は True です。



実装
    public function get usingCustomCompareFunction():Boolean
メソッドの詳細

initializeDefaultCompareFunction

()メソッド
public function initializeDefaultCompareFunction(obj:Object):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

カスタム比較関数が設定されているかどうか、指定されたフィールドのデータ型、numeric プロパティの値のいずれかに基づいて、比較を実行するためのデフォルト比較関数を設定するために、Sort クラスによって呼び出されるヘルパー関数です。numeric プロパティが true の場合は、ソート時に数値比較が実行されます。

パラメーター

obj:Object — データを含むオブジェクトです。 name プロパティでフィールド名が設定されている場合は、その名前を使用して、このオブジェクトのデータ値にアクセスされます。 設定されていない場合は、オブジェクト自身がデータ値として使用されます。

reverse

()メソッド 
public function reverse():void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 9, AIR 1.1

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

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





[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。