| 套件 | spark.globalization.supportClasses |
| 類別 | public class CollatorBase |
| 繼承 | CollatorBase  GlobalizationBase AdvancedStyleClient EventDispatcher Object |
| 子類別 | MatchingCollator, SortingCollator |
| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 4.5 |
| 執行階段版本: | Flash Player 10.1, AIR 2.5 |
CollatorBase is a base class for the
SortingCollator and MatchingCollator classes.
This class is a wrapper class around the
flash.globalization.Collator class.
Therefore the locale-specific string comparison is provided by the
flash.globalization.Collator class.
However by using this class as a base class, the SortingCollator
and MatchingCollator classes can be used in MXML declartions.
In these classes, the locale style is used for the
requested Locale ID name and has methods and properties that are bindable.
The flash.globalization.Collator class uses the underlying operating system for the formatting functionality and to supply locale specific data. On some operating systems, the flash.globalization classes are unsupported. On these systems the wrapper class provides fallback functionality for string comparison.
相關 API 元素
隱藏繼承公用屬性
顯示繼承公用屬性| 屬性 | 定義自 | ||
|---|---|---|---|
| actualLocaleIDName : String [覆寫] [唯讀]
The name of the actual locale ID used by this class object. | CollatorBase | ||
 | className : String [唯讀]
The name of the component class. | AdvancedStyleClient | |
| constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | Object | |
| id : String
The identity of the component. | AdvancedStyleClient | |
| ignoreCase : Boolean
When this property is set to true, identical strings and strings that
differ only in the case of the letters are evaluated as equal. | CollatorBase | ||
| ignoreCharacterWidth : Boolean
When this property is true, full-width and half-width forms of some
Chinese and Japanese characters are evaluated as equal. | CollatorBase | ||
| ignoreDiacritics : Boolean
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. | CollatorBase | ||
| ignoreKanaType : Boolean
When this property is set to true, strings that differ only by the
type of kana character being used are treated as equal. | CollatorBase | ||
| ignoreSymbols : Boolean
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. | CollatorBase | ||
| inheritingStyles : Object
An object containing the inheritable styles for this non-visual
style client instance. | AdvancedStyleClient | |
| lastOperationStatus : String [覆寫] [唯讀]
The status of the most recent operation that this class object
performed. | CollatorBase | ||
| moduleFactory : IFlexModuleFactory
A module factory is used as context for
finding the style manager that controls the styles for this
non-visual style client instance. | AdvancedStyleClient | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | AdvancedStyleClient | |
| numericComparison : Boolean
Controls how numeric values embedded in strings are handled during
string comparison. | CollatorBase | ||
| styleDeclaration : CSSStyleDeclaration
The style declaration that holds the inline styles declared by this
object. | AdvancedStyleClient | |
| styleManager : IStyleManager2 [唯讀]
Returns the StyleManager instance used by this component. | AdvancedStyleClient | |
| styleName : Object
The source of this object's style values. | AdvancedStyleClient | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | AdvancedStyleClient | |
| 方法 | 定義自 | ||
|---|---|---|---|
CollatorBase(initialMode:String)
Constructs a new CollatorBase object to provide string comparisons
according to the conventions of a specified locale. | CollatorBase | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。 | EventDispatcher | |
|
Deletes a style property from this component instance. | AdvancedStyleClient | |
Compares two strings and returns an integer value indicating whether
the first string is less than, equal to, or greater than the second
string. | CollatorBase | ||
|
會將事件傳送到事件流程。 | EventDispatcher | |
Compares two strings and returns a Boolean value indicating whether
the strings are equal. | CollatorBase | ||
[靜態]
Lists all of the locale ID names supported by this class. | CollatorBase | ||
|
Returns an Array of CSSStyleDeclaration objects for the type selector
that applies to this component, or null if none exist. | AdvancedStyleClient | |
| [覆寫]
Gets a style property that has been set anywhere in this
component's style lookup chain. | GlobalizationBase | |
|
Returns true if currentCSSState is not null. | AdvancedStyleClient | |
|
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | EventDispatcher | |
|
指出物件是否有已定義的指定屬性。 | Object | |
|
The initialized method is called when this class or a class that
extends this class is used in an MXML declaration. | AdvancedStyleClient | |
|
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | |
|
Returns true if cssState matches currentCSSState. | AdvancedStyleClient | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | AdvancedStyleClient | |
|
Propagates style changes to the children of this style client
instance. | AdvancedStyleClient | |
|
指出指定的屬性是否存在，以及是否可列舉。 | Object | |
|
Sets up the internal style cache values so that the
getStyle()
method functions. | AdvancedStyleClient | |
|
Registers the EffectManager as one of the event listeners
for each effect event. | AdvancedStyleClient | |
|
會從 EventDispatcher 物件移除偵聽程式。 | EventDispatcher | |
|
為迴圈作業設定動態屬性的可用性。 | Object | |
|
Sets a style property on this component instance. | AdvancedStyleClient | |
|
Detects changes to style properties. | AdvancedStyleClient | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | AdvancedStyleClient | |
|
傳回代表此物件的字串，根據地區特定慣例進行格式化。 | Object | |
|
會傳回指定之物件的字串形式。 | Object | |
|
會傳回指定之物件的基本值。 | Object | |
|
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | EventDispatcher | |
actualLocaleIDName | 屬性 |
actualLocaleIDName:String [唯讀] [覆寫] | 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 4.5 |
| 執行階段版本: | Flash Player 10.1, AIR 2.5 |
The name of the actual locale ID used by this class object. This is the locale that is used to access the formatting data and functionality from the operating system.
If the locale that was set by the locale style is not available,
then the value of the actualLocaleIDName is different
from the value of the locale style.
It indicates the fallback locale that is being used.
If the locale style was set to LocaleID.DEFAULT the
name of the locale specified by the user's operating system is
used.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 change 事件。
實作
override public function get actualLocaleIDName():String相關 API 元素
CollatorBase()
ignoreCase | 屬性 |
ignoreCase:Boolean| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 4.5 |
| 執行階段版本: | Flash Player 10.1, AIR 2.5 |
When this property is set to true, identical strings and strings that differ only in the case of the letters are evaluated as equal.
The default value is true when the
CollatorBase() constructor's initialMode
parameter is set to Collator.MATCHING. false
when the CollatorBase() constructor's
initialMode parameter is set to
Collator.SORTING.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 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 |
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.
The default value is true when the
CollatorBase() constructor's initialMode
parameter is set to Collator.MATCHING.
false when the CollatorBase()
constructor's initialMode parameter is set to
Collator.SORTING.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 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 |
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.
The default value is true when the
CollatorBase() constructor's initialMode
parameter is set to Collator.MATCHING.
false when the CollatorBase()
constructor's initialMode parameter is set to
Collator.SORTING.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 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 |
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.
The default value is true when the
CollatorBase() constructor's initialMode
parameter is set to Collator.MATCHING.
false when the CollatorBase()
constructor's initialMode parameter is set to
Collator.SORTING.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 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 |
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.
The default value is true when the
CollatorBase() constructor's initialMode
parameter is set to Collator.MATCHING.
false when the CollatorBase()
constructor's initialMode parameter is set to
Collator.SORTING.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 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 |
The status of the most recent operation that this class 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.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 change 事件。
實作
override public function get lastOperationStatus():String相關 API 元素
numericComparison | 屬性 |
numericComparison:Boolean| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 4.5 |
| 執行階段版本: | Flash Player 10.1, AIR 2.5 |
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.
預設值為 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 |
Constructs a new CollatorBase object to provide string comparisons according to the conventions of a specified locale.
The initialMode parameter sets the initial collation
options for two use cases: sorting and matching.
It can be set to one of the two following values:
CollatorMode.SORTING: sets the collation options for general linguistic sorting uses 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 uses 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.
For more details and examples of using these two modes, please
see the documentation for the
flash.globalization.Collator class.
The locale for this class is supplied by the locale
style. The locale style can be set in several ways:
- Inheriting the style from a
UIComponentby calling the UIComponent'saddStyleClientmethod with an instance of this object as the parameter. - By using the class in an MXML declaration and inheriting the
localestyle from the document that contains the declaration.<fx:Declarations> <s:SortingCollator id="collator" /> </fx:Declarations> - By using an MXML declaration and specifying the
localevalue in the list of assignments.<fx:Declarations> <s:SortingCollator id="collator_german" locale="de-DE" /> </fx:Declarations> - Calling the setStyle method, e.g.
collator.setStyle("locale", "de-DE")
If the locale style is not set by one of the above
techniques, the
methods of this class that depend on the locale set the
lastOperationStatus property to
spark.globalization.LastOperationStatus.LOCALE_UNDEFINED_ERROR.
initialMode:String — Sets the initial collation options for two use
cases: sorting and matching.
|
相關 API 元素
compare | () | 方法 |
public function compare(string1:String, string2:String):int| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 4.5 |
| 執行階段版本: | Flash Player 10.1, AIR 2.5 |
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 sytle that is
in effect when the compare method is called.
參數
string1:String — First comparison string.
| |
string2:String — Second comparison string.
|
int — An integer value indicating whether the first string is less
than, equal to, or greater than the second string.
|
相關 API 元素
equals | () | 方法 |
public function equals(string1:String, string2:String):Boolean| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 4.5 |
| 執行階段版本: | Flash Player 10.1, AIR 2.5 |
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 CollatorBase() constructor.
參數
string1:String — First comparison string.
| |
string2:String — Second comparison string.
|
Boolean — A Boolean value indicating whether the strings are equal
(true) or unequal (false).
|
相關 API 元素
getAvailableLocaleIDNames | () | 方法 |
public static function getAvailableLocaleIDNames():Vector.<String>| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 4.5 |
| 執行階段版本: | Flash Player 10.1, AIR 2.5 |
Lists all of the locale ID names supported by this class.
傳回值Vector.<String> — A vector of strings containing all of the locale ID names
supported by this class and operating system.
|
Tue Jun 12 2018, 03:47 PM Z