The name of the actual locale ID used by this Collator object.

There are three possibilities for the value of the name, depending on operating system and the value of the requestedLocaleIDName parameter passed to the Collator() constructor.

1. If the requested locale was not LocaleID.DEFAULT and the operating system provides support for the requested locale, then the name returned is the same as the requestedLocaleIDName property.
2. If LocaleID.DEFAULT was used as the value for the requestedLocaleIDName parameter to the constructor, then the name of the current locale specified by the user's operating system is used. The LocaleID.DEFAULT value preserves user's customized setting in the OS. Passing an explicit value as the requestedLocaleIDName parameter does not necessarily give the same result as using the LocaleID.DEFAULT even if the two locale ID names are the same. The user might have customized the locale settings on their machine, and by requesting an explicit locale ID name rather than using LocaleID.DEFAULT your application would not retrieve those customized settings.
3. If the system does not support the requestedLocaleIDName specified in the constructor then a fallback locale ID name is provided.

See also

When this property is set to true, identical strings and strings that differ only in the case of the letters are evaluated as equal. For example, compare("ABC", "abc") returns true when the ignoreCase property is set to true.

The case conversion of the string follows the rules for the specified locale.

When the ignoreCase property is false then upper- and lowercase characters are not equal to one another.

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise, the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

The default value is true when the Collator() constructor's initialMode parameter is set to Collator.MATCHING. false when the Collator() constructor's initialMode parameter is set to Collator.SORTING..

See also

When this property is true, full-width and half-width forms of some Chinese and Japanese characters are evaluated as equal.

For compatibility with existing standards for Chinese and Japanese character sets, Unicode provides character codes for both full-width and half width-forms of some characters. For example, when the ignoreCharacterWidth property is set to true, compare("Ａｱ", "Aア") returns true.

If the ignoreCharacterWidth property is set to false, then full-width and half-width forms are not equal to one another.

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

The default value is false.

See also

When this property is set to true, strings that use the same base characters but different accents or other diacritic marks are evaluated as equal. For example compare("coté", "côte") returns true when the ignoreDiacritics property is set to true.

When the ignoreDiacritics is set to false then base characters with diacritic marks or accents are not considered equal to one another.

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

The default value is false.

See also

When this property is set to true, strings that differ only by the type of kana character being used are treated as equal. For example, compare("カナ", "かな") returns true when the ignoreKanaType property is set to true.

If the ignoreKanaType is set to false then hiragana and katakana characters that refer to the same syllable are not equal to one another.

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

The default value is false.

See also

When this property is set to is true, symbol characters such as spaces, currency symbols, math symbols, and other types of symbols are ignored when sorting or matching. For example the strings "OBrian", "O'Brian", and "O Brian" would all be treated as equal when the ignoreSymbols property is set to true.

If the ignoreSymbols property is false then symbol characters are considered in string comparisons.

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

The default value is false.

See also

The status of the most recent operation that this Collator object performed. The lastOperationStatus is set whenever the constructor or a method of this class is called, or when a property is set. For the possible values see the description under each method.

See also

Controls how numeric values embedded in strings are handled during string comparison.

When the numericComparison property is set to true, the compare method converts numbers that appear in strings to numerical values for comparison.

When this property is set to false, the comparison treats numbers as character codes and sort them according to the rules for sorting characters in the specified locale.

For example, when this property is true for the locale ID "en-US", then the strings "version1", "version10", and "version2" are sorted into the following order: version1 < version2 < version10.

When this property is false for "en-US", those same strings are sorted into the following order: version1 < version10 < version2.

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

The default value is false.

See also

The name of the requested locale ID that was passed to the constructor of this Collator object.

If the LocaleID.DEFAULT value was used then the name returned is "i-default". The actual locale used can differ from the requested locale when a fallback locale is applied. The name of the actual locale can be retrieved using the actualLocaleIDName property.

See also

Constructs a new Collator object to provide string comparisons according to the conventions of a specified locale.

If the current operating system does not support the locale ID that is passed in the requestedLocaleIDName parameter, then a fallback locale is determined. If a fallback is used then the lastOperationStatus property is set to indicate the type of fallback.

The initialMode parameter sets various collation options for general uses. It can be set to one of the following values:

• CollatorMode.SORTING: sets collation options for general linguistic sorting usages such as sorting a list of text strings that are displayed to an end user. In this mode, differences in uppercase and lowercase letters, accented characters, and other differences specific to the locale are considered when doing string comparisons.
• CollatorMode.MATCHING: sets collation options for general usages such as determining if two strings are equivalent. In this mode, differences in uppercase and lower case letters, accented characters, and so on are ignored when doing string comparisons.

Here is an example of a sorted list created using a Collator with the locale ID "en-US" (English in US) and the CollatorMode.SORTING option:

As shown above, all characters are treated as if they have different values, but in linguistic order.

Here is an example of a sorted list created using Collator with the locale ID "en-US" (English in US) and the CollatorMode.MATCHING option:

As shown above, some characters are in linguistic order and are treated as if they have the same character value.

For finer control over sorting order, you can change collator properties such as Collator.ignoreCase or Collator.ignoreDiacritics.

For reference, here is a corresponding sorting example done using the standard Array.sort(), which is not locale-aware:

As you can see above, all characters are sorted simply in Unicode numeric value order. It does not make much sense linguistically.

To use the user's current operating system preferences, pass the static value LocaleID.DEFAULT in the requestedLocaleIDName parameter to the constructor.

Some locales have several sort order variants. For example, in German one sort order is used for phone books and another sort order is used for dictionaries. In Chinese, words are commonly supported by transliteration of the characters into the pinyin. These different sort orders can be selected by including the "collation" keyword in the string that is passed in the requestedLocaleIDName parameter to the constructor.

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

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

         

Possible values for the collation string are as follows, with the affected languages shown in parentheses:

If the host platform does not support the requested collation type, then a fallback is used and the lastOperationStatus property is set to indicate that a fallback was selected. You can use the actualLocaleIDName property to determine the value that was used as a fallback, as shown in the following example:

         var collator:Collator = new Collator("fr-FR");

         if (collator.lastOperationStatus == LastOperationStatus.USING_FALLBACK_WARNING)

         {

           trace ("Using fallback locale: " + collator.actualLocaleIDName);

         }

         

When the constructor completes successfully, then the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

When the requested locale ID is not available, then the lastOperationStatus property is set to one of the following:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

For details on the warnings listed above and other possible values of lastOperationStatus, see the descriptions in the LastOperationStatus class.

See also

Compares two strings and returns an integer value indicating whether the first string is less than, equal to, or greater than the second string. The comparison uses the sort order rules for the locale ID that was specified in the Collator() constructor.

When this method is called and it completes successfully, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

Parameters

See also

Compares two strings and returns a Boolean value indicating whether the strings are equal. The comparison uses the sort order rules for the locale ID that was specified in the Collator() constructor.

When this method is called and it completes successfully, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

Parameters

See also

Lists all of the locale ID names supported by this class.

If this class is not supported at all on the current operating system, this method returns a null value.