spark.globalization.SortingCollator - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	spark.globalization
Class	public class SortingCollator
Inheritance	SortingCollator CollatorBase GlobalizationBase AdvancedStyleClient EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

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.

View the examples

More examples

Sorting and matching

Learn more

Localization

Related API Elements

flash.globalization.Collator

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		actualLocaleIDName : String [override] [read-only] The name of the actual locale ID used by this class object.	CollatorBase
		className : String [read-only] The name of the component class.	AdvancedStyleClient
		constructor : Object A reference to the class object or constructor function for a given object instance.	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 [override] [read-only] 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		styleDeclaration : CSSStyleDeclaration The style declaration that holds the inline styles declared by this object.	AdvancedStyleClient
		styleManager : IStyleManager2 [read-only] 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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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 Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	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 Dispatches an event into the event flow.	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> [static] 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):* [override] 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 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	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 Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	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 Indicates whether the specified property exists and is enumerable.	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 Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	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 Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	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	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles

Click for more information on styles

Hide Inherited Styles

Show Inherited Styles

	Style		Description	Defined By
		locale	Type: String CSS Inheritance: yes The locale identifier that specifies the language, region, script and optionally other related tags and keys.	GlobalizationBase

Constructor Detail

SortingCollator

()

Constructor

public function SortingCollator()

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

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.

Related API Elements

flash.globalization.Collator

Examples How to use this example

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>

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

SortingCollator