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

CollatorBase  - AS3 Flex

パッケージspark.globalization.supportClasses
クラスpublic class CollatorBase
継承CollatorBase Inheritance GlobalizationBase Inheritance AdvancedStyleClient Inheritance EventDispatcher Inheritance Object
サブクラス MatchingCollator, SortingCollator

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

CollatorBase は SortingCollator および MatchingCollator クラスの基本クラスです。

このクラスは flash.globalization.Collator のラッパークラスです。 したがって、ロケール固有のストリングの比較が flash.globalization.Collator クラスによって提供されます。 ただし、このクラスを基本クラスとして使用することによって、SortingCollator および MatchingCollator クラスを MXML 宣言で使用できます。 これらのクラスでは、要求されたロケール ID 名に locale スタイルが使用され、バインド可能なメソッドおよびプロパティを持ちます。

flash.globalization.Collator クラスでは、フォーマット機能と、ロケール固有データの提供用に、基盤となるオペレーティングシステムを使用します。 一部のオペレーティングシステムでは、flash.globalization クラスがサポートされていません。 これらのシステムでは、ラッパークラスがストリング比較の代替機能を提供します。

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
  actualLocaleIDName : String
[オーバーライド] [読み取り専用] このクラスオブジェクトで使用される実際のロケール ID の名前。
CollatorBase
 InheritedclassName : String
[読み取り専用] コンポーネントクラスの名前です。
AdvancedStyleClient
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
 Inheritedid : String
コンポーネントの ID です。
AdvancedStyleClient
  ignoreCase : Boolean
このプロパティが true に設定されている場合、同一のストリングおよび大文字と小文字の区別だけが違うストリングが、等しいストリングとして評価されます。
CollatorBase
  ignoreCharacterWidth : Boolean
このプロパティが true に設定されている場合、一部の中国語および日本語の文字の全角と半角の形が、等しい形として評価されます。
CollatorBase
  ignoreDiacritics : Boolean
このプロパティが true に設定されている場合、ストリングで使用されている基本文字が同じであれば、アクセントやその他の識別記号の違いがあっても、同じストリングと評価されます。
CollatorBase
  ignoreKanaType : Boolean
このプロパティが true に設定されている場合、カナ文字の種類のみが異なる文字列は、等しい文字列として扱われます。
CollatorBase
  ignoreSymbols : Boolean
このプロパティが true に設定されている場合、スペース、通貨記号、数学記号およびその他の種類の記号などの記号文字はソート時または照合時に無視されます。
CollatorBase
 InheritedinheritingStyles : Object
このビジュアルでないスタイルクライアントのインスタンスの継承可能なスタイルを含むオブジェクトです。
AdvancedStyleClient
  lastOperationStatus : String
[オーバーライド] [読み取り専用] このクラスオブジェクトが実行した最新の操作のステータス。
CollatorBase
 InheritedmoduleFactory : IFlexModuleFactory
モジュールファクトリは、このビジュアルでないスタイルクライアントのインスタンスのスタイルを制御するスタイルマネージャーを検索するためのコンテキストとして使用されます。
AdvancedStyleClient
 InheritednonInheritingStyles : Object
このコンポーネントの非継承スタイルのチェーンの始まりです。
AdvancedStyleClient
  numericComparison : Boolean
ストリングに埋め込まれた数値の、ストリングの比較時の取扱方法を制御します。
CollatorBase
 InheritedstyleDeclaration : CSSStyleDeclaration
このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。
AdvancedStyleClient
 InheritedstyleManager : IStyleManager2
[読み取り専用] このコンポーネントで使用する StyleManager インスタンスを返します。
AdvancedStyleClient
 InheritedstyleName : Object
オブジェクトのスタイル値のソースです。
AdvancedStyleClient
 InheritedstyleParent : IAdvancedStyleClient
コンポーネントの親は、下位要素のセレクターを評価するために使用されます。
AdvancedStyleClient
パブリックメソッド
 メソッド定義元
  
CollatorBase(initialMode:String)
指定されたロケールの規則に従ってストリング比較を提供する新しい CollatorBase オブジェクトを作成します。
CollatorBase
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
このコンポーネントインスタンスからスタイルプロパティを削除します。
AdvancedStyleClient
  
compare(string1:String, string2:String):int
2 つの文字列を比較して、1 番目の文字列が 2 番目の文字列と比べて小さいか、等しいか、大きいかを示す整数値を返します。
CollatorBase
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
  
equals(string1:String, string2:String):Boolean
2 つの文字列を比較して、文字列が等しいかどうかを示すブール値を返します。
CollatorBase
  
[静的] このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。
CollatorBase
 Inherited
このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。
AdvancedStyleClient
 Inherited
getStyle(styleProp:String):*
[オーバーライド] このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。
GlobalizationBase
 Inherited
currentCSSState が null でない場合、true を返します。
AdvancedStyleClient
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
initialized メソッドは、このクラスまたはこのクラスを拡張するクラスが MXML 宣言で使用されると呼び出されます。
AdvancedStyleClient
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
cssState が currentCSSState に一致した場合は、true を返します。
AdvancedStyleClient
 Inherited
このインスタンスが、指定されたタイプと同じであるのか、それともそのサブクラスであるのかを判別します。
AdvancedStyleClient
 Inherited
スタイルの変更を、このスタイルクライアントのインスタンスの子に通知します。
AdvancedStyleClient
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。
AdvancedStyleClient
 Inherited
各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。
AdvancedStyleClient
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
このコンポーネントインスタンスのスタイルプロパティを設定します。
AdvancedStyleClient
 Inherited
スタイルプロパティの変更を検出します。
AdvancedStyleClient
 Inherited
コンポーネントのスタイルを初めて初期化するとき、Flex は stylesInitialized() メソッドを呼び出します。
AdvancedStyleClient
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント 概要 定義元
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited変更イベントは、ロケールスタイルが変更された場合、および、別のプロパティが設定されたことによって、数値のフォーマットが変更されたり、このクラスを通じて使用可能な他の値が更新されたりした場合に、常に生成されます。GlobalizationBase
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
スタイル

スタイルには共通スタイルと特定のテーマに関連するスタイルがあります。共通スタイルは、任意のテーマと共に使用できます。特定のテーマに関連するスタイルは、アプリケーションがそのテーマを使用する場合にのみ使用できます。

共通スタイル
 スタイル 説明 定義元
 Inherited型: String CSS 継承: はい
言語バージョン: ActionScript 3.0  製品バージョン: Flex 4.5  ランタイムバージョン: Flash10.1, AIR 2.5

言語、地域、スクリプトおよびオプションで他の関連するタグおよびキーを指定するロケール識別子です.
GlobalizationBase
プロパティの詳細

actualLocaleIDName

プロパティ
actualLocaleIDName:String  [読み取り専用] [オーバーライド]

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

このクラスオブジェクトで使用される実際のロケール ID の名前。これはフォーマットするデータと機能にオペレーティングシステムからアクセスするために使用されるロケールです。

locale スタイルによって設定されたロケールが使用できない場合、actualLocaleIDName の値は locale スタイルの値とは異なります。 この値は使用中の代替ロケールを示します。 locale スタイルが LocaleID.DEFAULT に設定された場合、ユーザーのオペレーティングシステムによって指定されたロケールの名前が使用されます。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。



実装
    override public function get actualLocaleIDName():String

関連する API エレメント

flash.globalization.Collator.actualLocaleIDName
CollatorBase()

ignoreCase

プロパティ 
ignoreCase:Boolean

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

このプロパティが true に設定されている場合、同一のストリングおよび大文字と小文字の区別だけが違うストリングが、等しいストリングとして評価されます。

CollatorBase() コンストラクターの initialMode パラメーターが Collator.MATCHING に設定されるとき、デフォルト値は true です。 CollatorBase() コンストラクターの initialMode パラメーターが Collator.SORTING に設定されるときは false です。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。



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

関連する API エレメント

ignoreCharacterWidth

プロパティ 
ignoreCharacterWidth:Boolean

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

このプロパティが true に設定されている場合、一部の中国語および日本語の文字の全角と半角の形が、等しい形として評価されます。

中国語と日本語の文字セットの既存の標準との互換性を保つために、Unicode では、一部の文字の全角と半角の両方に対応する文字コードを提供しています。例えば、ignoreCharacterWidth プロパティが true に設定されている場合、compare("Aア", "Aア")true を返します。

ignoreCharacterWidth プロパティが false に設定されている場合、全角文字と半角文字はそれぞれ異なります。

CollatorBase() コンストラクターの initialMode パラメーターが Collator.MATCHING に設定されるとき、デフォルト値は true です。 CollatorBase() コンストラクターの initialMode パラメーターが Collator.SORTING に設定されるときは false です。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。



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

関連する API エレメント

ignoreDiacritics

プロパティ 
ignoreDiacritics:Boolean

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

このプロパティが true に設定されている場合、ストリングで使用されている基本文字が同じであれば、アクセントやその他の識別記号の違いがあっても、同じストリングと評価されます。例えば、ignoreDiacritics プロパティが true に設定されている場合、compare("coté", "côte")true を返します。

ignoreDiacriticsfalse に設定されている場合、アクセントやその他の識別記号の違いがある基本文字は同じとは見なされません。

CollatorBase() コンストラクターの initialMode パラメーターが Collator.MATCHING に設定されるとき、デフォルト値は true です。 CollatorBase() コンストラクターの initialMode パラメーターが Collator.SORTING に設定されるときは false です。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。



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

関連する API エレメント

ignoreKanaType

プロパティ 
ignoreKanaType:Boolean

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

このプロパティが true に設定されている場合、カナ文字の種類のみが異なる文字列は、等しい文字列として扱われます。例えば、ignoreKanaType プロパティが true に設定されている場合、compare("カナ", "かな")true を返します。

ignoreKanaTypefalse に設定されている場合、同じ音節のひらがな文字とカタカナ文字とは同じものになりません。

CollatorBase() コンストラクターの initialMode パラメーターが Collator.MATCHING に設定されるとき、デフォルト値は true です。 CollatorBase() コンストラクターの initialMode パラメーターが Collator.SORTING に設定されるときは false です。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。



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

関連する API エレメント

ignoreSymbols

プロパティ 
ignoreSymbols:Boolean

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

このプロパティが true に設定されている場合、スペース、通貨記号、数学記号およびその他の種類の記号などの記号文字はソート時または照合時に無視されます。例えば、「OBrian」、「O'Brian」および「O Brian」などの文字列は、ignoreSymbols プロパティが true に設定されている場合、同じ文字列として扱われます。

CollatorBase() コンストラクターの initialMode パラメーターが Collator.MATCHING に設定されるとき、デフォルト値は true です。 CollatorBase() コンストラクターの initialMode パラメーターが Collator.SORTING に設定されるときは false です。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。



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

関連する API エレメント

lastOperationStatus

プロパティ 
lastOperationStatus:String  [読み取り専用] [オーバーライド]

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

このクラスオブジェクトが実行した最新の操作のステータス。コンストラクターまたはこのクラスのメソッドが呼び出されたり、プロパティが設定されたりすると、必ず lastOperationStatus が設定されます。有効な値については、各メソッドの説明を参照してください。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。



実装
    override public function get lastOperationStatus():String

関連する API エレメント

numericComparison

プロパティ 
numericComparison:Boolean

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

ストリングに埋め込まれた数値の、ストリングの比較時の取扱方法を制御します。

numericComparison プロパティが true に設定されている場合、compare メソッドはストリング中の数字を比較用の数値に変換します。

このプロパティが false に設定されている場合、比較は数字を文字コードとして扱い、指定された locale の文字ソートのルールに従ってソートします。

例えば、このプロパティがロケール ID「en-US」に対して true の場合、ストリング「version1」、「version10」および「version2」は version1 < version2 < version10 の順でソートされます。

このプロパティが「en-US」に対して false の場合、同じストリングが version1 < version10 < version2 の順でソートされます。

デフォルト値: false

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。



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

関連する API エレメント

コンストラクターの詳細

CollatorBase

()コンストラクター
public function CollatorBase(initialMode:String)

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

指定されたロケールの規則に従ってストリング比較を提供する新しい CollatorBase オブジェクトを作成します。

initialMode パラメーターは、ソートおよび照合という 2 つの使用例の初期照合オプションを設定します。 これは次の 2 つのいずれかの値に設定できます。

  • CollatorMode.SORTING:エンドユーザーに表示されるテキストストリングのリストをソートするなどの汎用の言語的なソートを使用するための照合オプションを設定します。 このモードでは、ストリングの比較を行うときに、大文字と小文字の違いやアクセント付き文字など、ロケール固有の違いが考慮されます。
  • CollatorMode.MATCHING:2 つのストリングが等しいかどうかの判断などに使用するための照合オプションを設定します。 このモードでは、ストリングの比較を行うときに、大文字と小文字の違い、アクセント付き文字などが無視されます。

これらの 2 つのモードの使用の詳細および例については、flash.globalization.Collator クラスのマニュアルを参照してください。

このクラスのロケールは locale スタイルによって提供されます。 locale スタイルは、次のいくつかの方法で設定できます。

  • UIComponent の addStyleClient メソッドを呼び出すことによって UIComponent からスタイルを継承する(このオブジェクトのインスタンスをパラメーターとして使用する)。
  • MXML 宣言内でクラスを使用し、宣言を格納するドキュメントから locale スタイルを継承する。
              <fx:Declarations>
                     <s:SortingCollator id="collator" />
              </fx:Declarations>
              
  • MXML 宣言を使用し、代入のリスト内で locale 値を指定する。
              <fx:Declarations>
                  <s:SortingCollator id="collator_german" locale="de-DE" />
              </fx:Declarations>
              
  • setStyle メソッド(collator.setStyle("locale", "de-DE") など)を呼び出す。

上記のいずれかの手法によって locale スタイルが設定されない場合、locale に依存するこのクラスのメソッドは、lastOperationStatus プロパティを spark.globalization.LastOperationStatus.LOCALE_UNDEFINED_ERROR に設定します。

パラメーター
initialMode:String — ソートおよび照合という 2 つの使用例の初期照合オプションを設定します。

関連する API エレメント

メソッドの詳細

compare

()メソッド
public function compare(string1:String, string2:String):int

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

2 つの文字列を比較して、1 番目の文字列が 2 番目の文字列と比べて小さいか、等しいか、大きいかを示す整数値を返します。この比較では、compare メソッドが呼び出されるときに有効になる locale スタイルのソート順ルールを使用します。

パラメーター

string1:String — 最初の比較ストリング。
 
string2:String — 2 番目の比較ストリング。

戻り値
int — 1 番目の文字列が 2 番目の文字列と比べて小さいか、等しいか、大きいかを示す整数値。
  • 戻り値が負の場合、string1string2 未満か、string2null であることを示します。
  • 戻り値が 0 の場合、string1string2 と等しいことを示します。
  • 戻り値が正の場合、string1string2 より大きいか、string1null であることを示します。

関連する API エレメント

equals

()メソッド 
public function equals(string1:String, string2:String):Boolean

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

2 つの文字列を比較して、文字列が等しいかどうかを示すブール値を返します。この比較では、CollatorBase() コンストラクターで指定されたロケール ID のソート順ルールを使用します。

パラメーター

string1:String — 最初の比較ストリング。
 
string2:String — 2 番目の比較ストリング。

戻り値
Boolean — 文字列が等しい(true)か等しくない(false)かを示すブール値。

関連する API エレメント

getAvailableLocaleIDNames

()メソッド 
public static function getAvailableLocaleIDNames():Vector.<String>

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

このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。

戻り値
Vector.<String> — このクラスおよびオペレーティングシステムでサポートされているすべてのロケール ID 名を含む文字列のベクトル。




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

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