SortingCollator

套件	spark.globalization
類別	public class SortingCollator
繼承	SortingCollator CollatorBase GlobalizationBase AdvancedStyleClient EventDispatcher Object

語言版本:

ActionScript 3.0

產品版本:

Flex 4.5

執行階段版本:

Flash Player 10.1, AIR 2.5

The SortingCollator class provides locale-sensitve string comparison capabilities with inital settings suitable for linguistic sorting purposes such as sorting a list of text strings that are displayed to an end-user.

This class is a wrapper class around the flash.globalization.Collator. Therefore the locale-specific string comparison is provided by the flash.globalization.Collator. However, this SortingCollator class can be used in MXML declartions, uses the locale style for the requested Locale ID name, and has methods and properties that are bindable. Additionally, LastOperationStatus is set, if there is an error or warning generated by the flash.globalization class.

The flash.globalization.Collator class uses the underlying operating system for the formatting functionality and to supply the locale specific data. On some operating systems, the flash.globalization classes are unsupported, this wrapper class provides a fallback functionality.

檢視範例

更多範例

Localization

相關 API 元素

flash.globalization.Collator

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		SortingCollator() Constructs a new SortingCollator object to provide string comparisons according to the conventions of a specified locale.	SortingCollator
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。	EventDispatcher
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	AdvancedStyleClient
		compare(string1:String, string2:String):int 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
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		equals(string1:String, string2:String):Boolean Compares two strings and returns a Boolean value indicating whether the strings are equal.	CollatorBase
		getAvailableLocaleIDNames():Vector.<String> [靜態] Lists all of the locale ID names supported by this class.	CollatorBase
		getClassStyleDeclarations():Array Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.	AdvancedStyleClient
		getStyle(styleProp:String):* [覆寫] Gets a style property that has been set anywhere in this component's style lookup chain.	GlobalizationBase
		hasCSSState():Boolean Returns true if currentCSSState is not null.	AdvancedStyleClient
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		initialized(document:Object, id:String):void The initialized method is called when this class or a class that extends this class is used in an MXML declaration.	AdvancedStyleClient
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState.	AdvancedStyleClient
		matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type.	AdvancedStyleClient
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children of this style client instance.	AdvancedStyleClient
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		regenerateStyleCache(recursive:Boolean):void Sets up the internal style cache values so that the getStyle() method functions.	AdvancedStyleClient
		registerEffects(effects:Array):void Registers the EffectManager as one of the event listeners for each effect event.	AdvancedStyleClient
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	AdvancedStyleClient
		styleChanged(styleProp:String):void Detects changes to style properties.	AdvancedStyleClient
		stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized.	AdvancedStyleClient
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher

事件

按一下以瞭解事件的詳細資訊

隱藏繼承事件

顯示繼承事件

	摘要	定義自
activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
change	The change event is generated whenever the locale style is changed or another property is set that would cause the format of a number to change or cause updates to the other values available through this class.	GlobalizationBase
deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher

樣式

樣式可分為一般樣式及與特定主題關聯的樣式兩種。如果是一般樣式，可以與任何主題搭配使用。如果是與特定主題關聯的樣式，只有在您的應用程式使用特定主題時才能使用該樣式。

一般樣式

按一下以瞭解樣式的詳細資訊

隱藏繼承樣式

顯示繼承樣式

	樣式		說明	定義自
		locale	類型: String CSS 繼承: 是語言版本: ActionScript 3.0 產品版本: Flex 4.5 執行階段版本: Flash10.1, AIR 2.5 The locale identifier that specifies the language, region, script and optionally other related tags and keys.	GlobalizationBase

建構函式詳細資料

()

建構函式

public function SortingCollator()

語言版本:

ActionScript 3.0

產品版本:

Flex 4.5

執行階段版本:

Flash Player 10.1, AIR 2.5

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

This class sets the initial values of the various 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.

The comparison provided by an instance of this class is equivalent to constructing an instance of the flash.globalization.Collator with the initialMode paramater set to CollatorMode.SORTING. For more details and examples of this mode, 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 UIComponent by calling the UIComponent's addStyleClient method.
By using the class in an MXML declaration and inheriting the locale from the document that contains the declaration.
```
      Example:
      <fx:Declarations>
             <s:SortingCollator id="sc" />
      </fx:Declarations>
      
```

By using an MXML declaration and specifying the locale value in the list of assignments.

      Example:
      <fx:Declarations>
          <s:SortingCollator id="sc_France" locale="fr-FR" />
      </fx:Declarations>

Calling the setStyle method, e.g. sc.setStyle("locale", "fr-FR")

If the locale style is not set by one of the above techniques, the instance of this class will be added as a StyleClient to the topLevelApplication and will therefore inherit the locale style from the topLevelApplication object when the locale dependent property getter or locale dependent method is called.

相關 API 元素

flash.globalization.Collator

範例如何使用本範例

SortingCollatorExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
               xmlns:s="library://ns.adobe.com/flex/spark"
               xmlns:mx="library://ns.adobe.com/flex/mx"
               width="100%" height="100%">

    <fx:Declarations>
        <s:SortingCollator id="sortingCollator"/>
    </fx:Declarations>

    <fx:Script>
        <![CDATA[
            import mx.collections.ArrayCollection;
            import mx.events.ListEvent;

            [Bindable]
            private var localeList:ArrayCollection
                = new ArrayCollection([
                    { label:"English (en)", data:"en" },
                    { label:"French (fr)", data:"fr" },
                    { label:"German (de)", data:"de" },
                    { label:"Latvian (lt)", data:"lt" },
                    { label:"Sweedish (sv)", data:"sv" },
                    { label:"Chinese (zh)", data:"zh" }]);

            private static const wordList:ArrayCollection
                = new ArrayCollection([
                    "B", "b", "a", "A" ,
                    "y (lt)", "i (lt)", "k (lt)",
                    "n (sv)", "Ã¶ (sv)", "o (sv)", "z (sv)",
                    "vu (sv)", "wo (sv)",
                    "dÃ¤d (de)", "daed (de)",
                    "Ã¶f (de)", "of (de)",
                    "cÃ´te (fr)", "cotÃ© (fr)",
                    "æ‰‹ (zh)", "ä¸ (zh)", "åœŸ (zh)", "å²€ (zh)" ]);

            protected function localeSelector_changeHandler(
                                                        event:ListEvent):void
            {
                setStyle("locale", ComboBox(event.target).selectedItem.data);
                wordList.refresh();
            }
        ]]>
    </fx:Script>

    <mx:VBox>
        <mx:HBox>
            <s:Label text="Select Language"/>
            <mx:ComboBox id="localeSelector"
                change="localeSelector_changeHandler(event)"
                dataProvider="{localeList}"/>
        </mx:HBox>
        <mx:DataGrid id="dataGrid" width="100%"
            dataProvider="{wordList}" rowCount="{wordList.length}">
            <mx:columns>
                <mx:DataGridColumn headerText="Click here to sort"
                    sortCompareFunction="{sortingCollator.compare}"/>
            </mx:columns>
        </mx:DataGrid>
     </mx:VBox>
</s:Application>

法律聲明 | 線上隱私權政策

SortingCollator - AS3 Flex

類別 x

SortingCollator