Collator  - AS3

此 Collator 物件所使用的實際地區設定 ID 名稱。

根據作業系統與 requestedLocaleIDName 參數傳送到 Collator() 建構函式的值，此值有三種可能性。

1. 若要求的地區設定不是 LocaleID.DEFAULT，而且作業系統支援要求的地區設定，則傳回的名稱會與 requestedLocaleIDName 屬性相同。
2. 若使用 LocaleID.DEFAULT 當作建構函式 requestedLocaleIDName 參數的值，則會使用使用者作業系統指定的目前地區設定名稱。LocaleID.DEFAULT 值會將使用者的自訂設定保留於作業系統中。即使兩個地區設定 ID 名稱是相同的，傳送明確的值作為 requestedLocaleIDName 參數所得的結果，也未必與使用 LocaleID.DEFAULT 相同。使用者可能在自己的電腦上已有自訂的地區設定，若要求明確的地區設定 ID 名稱而不是使用 LocaleID.DEFAULT 的話，您的應用程式不會擷取這些自訂設定。
3. 若系統不支援建構函式所指定的 requestedLocaleIDName，則會提供後援地區設定 ID 名稱。

相關 API 元素

若此屬性設為 true，表示若字串間只有字母大小寫不同，會視為相同。例如，若 ignoreCase 屬性設為 true，compare("ABC", "abc") 會傳回 true。

字串的大小寫轉換會遵循所指定的地區設定規則。

若 ignoreCase 屬性為 false，則會將大小寫字元視為不同。

若將某值指派給此屬性，而且沒有錯誤或警告，則 lastOperationStatus 屬性會被設為：

• LastOperationStatus.NO_ERROR

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

當 Collator() 建構函式的 initialMode 參數設定為 Collator.MATCHING 時，預設值為 true。當 Collator() 建構函式的 initialMode 參數設定為 Collator.SORTING 時，預設值為 false。

相關 API 元素

若此屬性為 true，會將某些中文和日文的全形和半形字元視為相同。

為與目前中文和日文字元集標準相容，Unicode 對一些字元提供了全形與半形字元代碼。例如，若 ignoreCharacterWidth 屬性設為 true，compare("Ａｱ", "Aア") 會傳回 true。

若 ignoreCharacterWidth 屬性設為 false，則會將全形與半形字元視為不同。

若將某值指派給此屬性，而且沒有錯誤或警告，則 lastOperationStatus 屬性會被設為：

• LastOperationStatus.NO_ERROR

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

預設值為 false。

相關 API 元素

若此屬性設為 true，使用相同基礎字元但重音不同或區別發音符號不同者，會視為相同。例如，若 ignoreDiacritics 屬性設為 true，compare("coté", "côte") 會傳回 true。

若 ignoreDiacritics 設為 false，會將具有不同區別發音符號或重音的基礎字元視為不同。

若將某值指派給此屬性，而且沒有錯誤或警告，則 lastOperationStatus 屬性會被設為：

• LastOperationStatus.NO_ERROR

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

預設值為 false。

相關 API 元素

將此屬性設為 true 時，若字串間的差異只因為所用假名字元的類型不同，則會將字串視為相同。例如，ignoreKanaType 屬性設為 true 時，compare("カナ", "かな") 會傳回 true。

若將 ignoreKanaType 設為 false，表示會將相同音節的平假名和片假名字元會視為不同。

若將某值指派給此屬性，而且沒有錯誤或警告，則 lastOperationStatus 屬性會被設為：

• LastOperationStatus.NO_ERROR

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

預設值為 false。

相關 API 元素

若此屬性設為 true，會在排序或比對時忽略空白、貨幣符號、數學符號和其他類型的符號。例如，若 ignoreSymbols 屬性設為 true，「Obrian」、「O'Brian」和「O Brian」都會被視為相同。

若 ignoreSymbols 屬性為 false，則比較字串時會考量符號字元。

若將某值指派給此屬性，而且沒有錯誤或警告，則 lastOperationStatus 屬性會被設為：

• LastOperationStatus.NO_ERROR

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

預設值為 false。

相關 API 元素

此 Collator 物件執行的最近作業狀態。只要呼叫此類別的建構函式或方法，或設定屬性，就會設定 lastOperationStatus。如需可能的值，請參閱各方法下的說明。

相關 API 元素

控制字串比較過程中，如何處理內嵌於字串中的數值。

若 numericComparison 屬性設為 true，比較方法會將字串中出現的數字轉換為數值以進行比較。

若此屬性設為 false，比較時會將數字視為字元代碼，並根據特定地區設定中的字元排序規則進行比較。

例如，若地區設定 "en-US" 的此屬性設為 true，則 "version1"、 "version10" 和 "version2" 會以下列順序排序：version1 < version2 < version10。

若地區設定 "en-US" 的此屬性設為 false，這些相同字串會以下列順序排序：version1 < version10 < version2。

若將某值指派給此屬性，而且沒有錯誤或警告，則 lastOperationStatus 屬性會被設為：

• LastOperationStatus.NO_ERROR

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

預設值為 false。

相關 API 元素

傳送到此 Collator 物件建構函式的所要求地區設定 ID 名稱。

若使用 LocaleID.DEFAULT 值，則傳回的名稱會是 "i-default"。若採用後援地區設定，則所用的實際地區設定可能與要求的地區設定不同。您可以使用 actualLocaleIDName 屬性擷取實際地區設定名稱。

相關 API 元素

建構新 Collator 物件，以根據特定地區設定的慣例，提供字串比較。

若目前的作業系統不支援傳送到 requestedLocaleIDName 參數的地區設定 ID，則會決定後援地區設定。若使用後援，則會設定 lastOperationStatus 屬性，以指示後援類型。

initialMode 參數設定多種定序選項，供一般用途之用。可設為下列值之一：

• CollatorMode.SORTING：設定一般語言排序用途的定序選項，如排序要對使用者顯示的文字字串清單。在此模式中，比較字串時會區分大小寫字母、重音字元，和其他地區設定特有的差異。
• CollatorMode.MATCHING：設定一般用途的定序選項，如判斷兩個字串是否相等。在此模式中，比較字串時會忽略大小寫字母、重音字元等差異。

以下範例是使用 Collator 與地區設定 ID「en-US」(美國英文) 和 CollatorMode.SORTING 選項建立的排序清單：

如上所示，所有字元會被視為具有不同值，但使用語言上的順序。

以下範例是使用 Collator 與地區設定 ID「en-US」(美國英文) 和 CollatorMode.MATCHING 選項建立的排序清單：

如上所示，有些字元可能依語言上的順序排列，並視為具有相同的字元值。

若要更精準地控制排序順序，可變更 collator 屬性，如 Collator.ignoreCase 或 Collator.ignoreDiacritics。

如需參考資料，請見下列使用標準 Array.sort() 的對應排序範例，此方式不區分地區設定：

如您所見，僅會根據 Unicode 數值順序排序所有字元。這在語言上並沒有太大意義。

若要使用使用者目前作業系統的偏好設定進行格式化，請將 requestedLocaleIDName 參數中的 LocaleID.DEFAULT 靜態值傳送到建構函式。

有些地區設定具有多種不同的排序順序變體。例如，在德文中，電話簿使用一種排序順序，而字典則使用另一種排序。在中文字裡，通常支援將字元音譯為拼音進行排序。您可以在以 requestedLocaleIDName 參數傳送至建構函式的字串中包含「collation」關鍵字，選用不同的排序順序。

         var germanPhonebook:LocaleID = new LocaleID("de-DE@collation=phonebook");
         var chinesePinyin:LocaleID = new LocaleID("zh-Hant@collation=pinyin");
         

此定序字串的可能值如下，括弧中顯示受影響的語言：

若主機平台不支援要求的定序類型，會使用後援，且會設定 lastOperationStatus 屬性，以指示已選取後援類型。您可以使用 actualLocaleIDName 屬性來判斷被當做後援使用的值，如以下範例所示：

         var collator:Collator = new Collator("fr-FR");
         if (collator.lastOperationStatus == LastOperationStatus.USING_FALLBACK_WARNING)
         {
           trace ("Using fallback locale: " + collator.actualLocaleIDName);
         }
         

若建構函式成功完成，lastOperationStatus 屬性就會被設為：

• LastOperationStatus.NO_ERROR

若要求的地區設定 ID 無法使用，則 lastOperationStatus 屬性會被設為下列之一：

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

如需有關上方列出的警告以及 lastOperationStatus 的其他可能值的詳細資訊，請參閱 LastOperationStatus 類別的說明。

相關 API 元素

比較兩個字串並傳回整數值，表示第一個字串小於、等於或大於第二個字串。會使用 Collator() 建構函式中指定的地區設定 ID 的排序規則進行比較。

當此方法被呼叫並成功完成時，lastOperationStatus 屬性會被設為：

• LastOperationStatus.NO_ERROR

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

參數

相關 API 元素

比較兩字串並傳回 Boolean 值，表示字串是否相同。會使用 Collator() 建構函式中指定的地區設定 ID 的排序規則進行比較。

當此方法被呼叫並成功完成時，lastOperationStatus 屬性會被設為：

• LastOperationStatus.NO_ERROR

否則，lastOperationStatus 屬性會被設為 LastOperationStatus 類別中定義的常數之一。

參數

相關 API 元素

列出此類別支援的所有地區設定 ID 名稱。

若目前的作業系統完全不支援此類別，此方法會傳回 null 值。

1. 重複排列各個地區設定 ID 名稱，包括作業系統的預設地區設定 ID (由 LocaleID.DEFAULT 指定)
2. 使用「排序」模式 (預設值) 為每一個地區設定 ID 名稱建立一個 Collator 物件。
3. 顯示要求的與實際的地區設定 ID 名稱以及 lastOperationStatus 屬性的值，藉此瞭解是否使用後援地區設定。
4. 使用每一個 collator 來排序資料陣列，並顯示結果。每個地區設定所產生的順序會不相同。

package {
    import flash.globalization.Collator;
    import flash.globalization.LocaleID;

    public class CollatorExample1
    {
        public var col:Collator;
        
        public function CollatorExample1():void
        {        
            var localeNames:Array = [LocaleID.DEFAULT,
                                     "de-DE", "sv-SE",
                                     "fr-FR", "lt-LT",
                                     "es-ES"];
            
            var testSortData:Array = [
                "y ", "i ", "k ", // Latvian
                "acxa ", "acha ", "adxa ", // es_traditional
                "n ", "ö ", "o ", "z ", "vu ", "wo ", // sw
                "däd ", "daed ", // de
                "öf ", "of ", // de_dictionary
                "côte ", "coté " // fr
            ];
            
            for each (var localeName:String in localeNames) {
            
                col = new Collator(localeName);
                
                trace("LocaleID requested: " + col.requestedLocaleIDName 
                       + "; actual: " + col.actualLocaleIDName);
                       
                trace("Last Operation Status: " + col.lastOperationStatus );
                
                var result:Array = testSortData.sort(col.compare);
                        
                trace ("sorted data: " + result); 
            }
        }      
    }
}

1. 使用「相符」模式，為使用者的預設地區設定建立一個 Collator 物件。
2. 另一種方法是將 Collator.ignoreDiacritics 屬性設定成 false 和 true
3. 比較一組包含讀音符號以及大小寫字元的字串。
4. 顯示當 Collator.ignoreDiacritics 和 Collator.ignoreCase 屬性變更後，比較方式會如何變更。

package {
    import flash.display.Sprite;
    import flash.globalization.Collator;
    import flash.globalization.CollatorMode;
    import flash.globalization.LocaleID;
    
    public class CollatorExample2 extends Sprite
    {
        public var col:Collator;
        public var testMatchData:Array = ["cote", "Cote", "côte", "coté"];
        public var wordToMatch:String = "Cote";
        
        public function CollatorExample2()
        {
            col = new Collator( LocaleID.DEFAULT, CollatorMode.MATCHING );

            trace("LocaleID requested: " + col.requestedLocaleIDName 
                    + "; actual: " + col.actualLocaleIDName);
                    
            trace("Last Operation Status: " + col.lastOperationStatus );

            trace('\n' + "ignoreCase = " + col.ignoreCase);
            trace("ignoreDiacritics = " + col.ignoreDiacritics);

            compareString(testMatchData, wordToMatch) // All variations of the word cote match

            col.ignoreDiacritics = false;
            trace('\n' + "ignoreDiacritics = false");

            compareString(testMatchData, wordToMatch) // Variations with different diacritics will not match

            col.ignoreCase = false;
            trace('\n' + "ignoreCase = false");

            compareString(testMatchData, wordToMatch) // Variations with different case will not match
        }
    
        private function compareString(stringArray:Array, keyword:String):void
        {
            for each(var s:String in stringArray)
            {
                if(col.equals(s, keyword))    
                {
                    trace(keyword + " = " + s);
                }
            }
        }
    }
}