CollatorBase

包	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 是 SortingCollator 和 MatchingCollator 类的基类。

此类是包装 flash.globalization.Collator 类的包装器类。因此，特定于区域设置的字符串比较是由 flash.globalization.Collator 类提供的。但是，将此类作为基类来使用，就可以在 MXML 声明中使用 SortingCollator 和 MatchingCollator 类。在这些类中，为请求的区域设置 ID 名称使用区域设置样式，并具有可绑定的方法与属性。

flash.globalization.Collator 类使用基础操作系统来实现格式化功能并提供特定于区域设置的数据。某些操作系统不支持 flash.globalization 类。在这些操作系统中，由包装器类为字符串比较提供回退功能。

相关 API 元素

flash.globalization.Collator

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		actualLocaleIDName : String [覆盖] [只读] 由该类对象使用的实际区域设置 ID 的名称。	CollatorBase
		className : String [只读] 组件类的名称。	AdvancedStyleClient
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		id : String 组件的标识。	AdvancedStyleClient
		ignoreCase : Boolean 当此属性设置为 true 时，完全相同的字符串和仅字母大小写不同的字符串比较结果为相等。	CollatorBase
		ignoreCharacterWidth : Boolean 当此属性为 true 时，某些全角和半角形式的中文和日文字符比较结果为相等。	CollatorBase
		ignoreDiacritics : Boolean 当此属性设置为 true 时，使用相同基本字符，但重音符号或其它音调符号不同的字符串，比较结果为相等。	CollatorBase
		ignoreKanaType : Boolean 当此属性设置为 true 时，会将区别仅在于使用了不同的 kana 字符类型的字符串视为相等。	CollatorBase
		ignoreSymbols : Boolean 当此属性设置为 true 时，排序或匹配时将忽略空格、货币符号、数学符号和其它类型符号等符号字符。	CollatorBase
		inheritingStyles : Object 包含该非可视样式客户端实例的可继承样式的对象。	AdvancedStyleClient
		lastOperationStatus : String [覆盖] [只读] 此类对象执行的最近操作的状态。	CollatorBase
		moduleFactory : IFlexModuleFactory 模块工厂作为用于查找样式管理器（控制此非可视样式客户端实例的样式）的上下文使用。	AdvancedStyleClient
		nonInheritingStyles : Object 此组件的非继承样式链的开头内容。	AdvancedStyleClient
		numericComparison : Boolean 控制如何在进行字符串比较期间处理嵌入到字符串的数值。	CollatorBase
		styleDeclaration : CSSStyleDeclaration 具有此对象声明的内嵌样式的样式声明。	AdvancedStyleClient
		styleManager : IStyleManager2 [只读] 返回此组件使用的 StyleManager 实例。	AdvancedStyleClient
		styleName : Object 该对象的样式值的源。	AdvancedStyleClient
		styleParent : IAdvancedStyleClient 组件的父项用于评估后代选择器。	AdvancedStyleClient

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		CollatorBase(initialMode:String) 构造新的 CollatorBase 对象，以根据指定的区域设置的约定提供字符串比较。	CollatorBase
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		clearStyle(styleProp:String):void 删除此组件实例的样式属性。	AdvancedStyleClient
		compare(string1:String, string2:String):int 比较两个字符串并返回一个整数值，表示第一个字符串是小于、等于还是大于第二个字符串。	CollatorBase
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		equals(string1:String, string2:String):Boolean 比较两个字符串并返回表示字符串是否相等的布尔值。	CollatorBase
		getAvailableLocaleIDNames():Vector.<String> [静态] 列出此类支持的所有区域设置 ID 名称。	CollatorBase
		getClassStyleDeclarations():Array 为应用于该组件的类型选择器返回 CSSStyleDeclaration 对象数组，如果不存在则返回 null。	AdvancedStyleClient
		getStyle(styleProp:String):* [覆盖] 获取已在此组件的样式查找链中的某个位置设置过的样式属性。	GlobalizationBase
		hasCSSState():Boolean 如果 currentCSSState 不为 null，则返回 true。	AdvancedStyleClient
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		initialized(document:Object, id:String):void 该类或扩展该类的类在 MXML 声明中使用时，调用 initialized 方法。	AdvancedStyleClient
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		matchesCSSState(cssState:String):Boolean 如果 cssState 与 currentCSSState 匹配，则返回 true。	AdvancedStyleClient
		matchesCSSType(cssType:String):Boolean 确定此实例与给定类型相同，还是属于给定类型的子类。	AdvancedStyleClient
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void 将样式更改传播到此样式客户端实例的子项。	AdvancedStyleClient
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		regenerateStyleCache(recursive:Boolean):void 设置内部样式缓存值，以便 getStyle() 方法可以起作用。	AdvancedStyleClient
		registerEffects(effects:Array):void 将 EffectManager 注册为每个效果事件的事件侦听器之一。	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 对此组件实例设置样式属性。	AdvancedStyleClient
		styleChanged(styleProp:String):void 检测对样式属性的更改。	AdvancedStyleClient
		stylesInitialized():void 首次初始化组件样式时，Flex 会调用 stylesInitialized() 方法。	AdvancedStyleClient
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
change	当区域设置样式发生改变，或设置了其它属性，导致改变数字的格式或更新到此类中所允许的其它值时，将生成更改事件。	GlobalizationBase
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher

样式

样式为常见样式，或与特定主题关联。如果为常见样式，则可以用于任何主题。如果样式与特定主题关联，则只有应用程序使用该主题时才能使用该样式。

常见样式

单击此处了解有关样式的更多信息

隐藏继承的样式

显示继承的样式

	样式		说明	由以下参数定义
		locale	类型: String CSS 继承: 是语言版本: ActionScript 3.0 产品版本: Flex 4.5 运行时版本: Flash10.1, AIR 2.5 区域设置标识符，用于指定语言、区域、脚本，还可以指定其它相关的标签和键.	GlobalizationBase

属性详细信息

actualLocaleIDName

属性

actualLocaleIDName:String [只读] [覆盖]

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

由该类对象使用的实际区域设置 ID 的名称。这是用于从操作系统访问格式化数据和功能的区域设置。

如果由 locale 样式所设置的区域设置不可用，则 actualLocaleIDName 的值将不同于 locale 样式的值。它指明正在使用的回退区域设置。如果区域设置样式设置为 LocaleID.DEFAULT，将使用由用户的操作系统指定的区域设置的名称。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

实现
override public function get actualLocaleIDName():String

相关 API 元素

flash.globalization.Collator.actualLocaleIDName
CollatorBase()

ignoreCase

属性

ignoreCase:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

当此属性设置为 true 时，完全相同的字符串和仅字母大小写不同的字符串比较结果为相等。

当 CollatorBase() 构造函数的 initialMode 参数设置为 Collator.MATCHING 时，默认值为 true。当 CollatorBase() 构造函数的 initialMode 参数设置为 Collator.SORTING 时，则为 false。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

实现
public function get ignoreCase():Boolean
public function set ignoreCase(value:Boolean):void

相关 API 元素

compare()
equals()

ignoreCharacterWidth

属性

ignoreCharacterWidth:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

当此属性为 true 时，某些全角和半角形式的中文和日文字符比较结果为相等。

为与中文和日文字符集的现有标准兼容，Unicode 为某些全角和半角形式的字符提供字符代码。例如，当 ignoreCharacterWidth 属性设置为 true 时，compare("Ａｱ", "Aア") 返回 true。

如果将 ignoreCharacterWidth 属性设置为 false，则全角和半角形式的字符不相等。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

实现
public function get ignoreCharacterWidth():Boolean
public function set ignoreCharacterWidth(value:Boolean):void

相关 API 元素

compare()
equals()

ignoreDiacritics

属性

ignoreDiacritics:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

当此属性设置为 true 时，使用相同基本字符，但重音符号或其它音调符号不同的字符串，比较结果为相等。例如，当 ignoreDiacritics 属性设置为 true 时，compare("coté", "côte") 返回 true。

当 ignoreDiacritics 设置为 false 时，带有音调符号或重音符号的基本字符被视为不相等。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

实现
public function get ignoreDiacritics():Boolean
public function set ignoreDiacritics(value:Boolean):void

相关 API 元素

compare()
equals()

ignoreKanaType

属性

ignoreKanaType:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

当此属性设置为 true 时，会将区别仅在于使用了不同的 kana 字符类型的字符串视为相等。例如，当 ignoreKanaType 属性设置为 true 时，compare("カナ", "かな") 返回 true。

如果将 ignoreKanaType 设置为 false，则引用相同音节的平假名和片假名字符不相等。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

实现
public function get ignoreKanaType():Boolean
public function set ignoreKanaType(value:Boolean):void

相关 API 元素

compare()
equals()

ignoreSymbols

属性

ignoreSymbols:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

当此属性设置为 true 时，排序或匹配时将忽略空格、货币符号、数学符号和其它类型符号等符号字符。例如，当 ignoreSymbols 属性设置为 true 时，“OBrian”、“O'Brian”和“O Brian”字符串都被视为相等。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

实现
public function get ignoreSymbols():Boolean
public function set ignoreSymbols(value:Boolean):void

相关 API 元素

compare()
equals()

lastOperationStatus

属性

lastOperationStatus:String [只读] [覆盖]

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

此类对象执行的最近操作的状态。只要调用构造函数或此类的一个方法，或设置一个属性，都会设置 lastOperationStatus。有关可能值的信息，请参阅每种方法下的说明。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

实现
override public function get lastOperationStatus():String

相关 API 元素

spark.globalization.LastOperationStatus

numericComparison

属性

numericComparison:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

控制如何在进行字符串比较期间处理嵌入到字符串的数值。

当 numericComparison 属性设置为 true 时，比较方法将出现在字符串中的数字转换为数值以供比较。

当此属性设置为 false 时，比较时会将数字视为字符代码，并根据指定区域设置中对字符排序所用的规则对它们进行排序。

例如，对于区域设置 ID“en-US”，当此属性为 true 时，字符串“version1”、“version10”和“version2”按以下顺序排序：version1 < version2 < version10。

对于“en-US”，当此属性为 false 时，上述同样的字符串按以下顺序排序：version1 < version10 < version2。

默认值为 false。

此属性可用作数据绑定的源。修改此属性后，将调度 change 事件。

实现
public function get numericComparison():Boolean
public function set numericComparison(value:Boolean):void

相关 API 元素

compare()
equals()

构造函数详细信息

()

构造函数

public function CollatorBase(initialMode:String)

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

构造新的 CollatorBase 对象，以根据指定的区域设置的约定提供字符串比较。

initialMode 参数为两种用例（排序和匹配）设置初始排序规则选项。它可以设置为下列两个值之一：

CollatorMode.SORTING：设置用于常规语言排序（例如对显示给最终用户的文本字符串列表进行排序）的排序规则选项。在此模式下，进行字符串比较时考虑大写和小写字母、重音符号及其它特定于区域设置的区别。
CollatorMode.MATCHING：设置供使用（例如确定两个字符串是否相等）的排序规则选项。在此模式下，进行字符串比较时忽略大写和小写字母、重音符号等区别。

有关这两种模式的用法的详细信息和示例，请参阅有关 flash.globalization.Collator 类的文档。

此类的区域设置由区域设置样式提供。可以使用下列方法来设置区域设置样式：

调用 UIComponent 的 addStyleClient 方法并将此对象的实例用作参数，从 UIComponent 继承样式。

在 MXML 声明中使用该类，并从包含该声明的文档中继承区域设置样式。

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

使用 MXML 声明并在赋值列表中指定区域设置值。

          <fx:Declarations>
              <s:SortingCollator id="collator_german" locale="de-DE" />
          </fx:Declarations>

调用 setStyle 方法，如 collator.setStyle("locale", "de-DE")。

如果未按照以上方法之一来设置 locale 样式，则基于 locale 的此类的方法会将 lastOperationStatus 属性设置为 spark.globalization.LastOperationStatus.LOCALE_UNDEFINED_ERROR。

参数

initialMode:String — 为两种用例（排序和匹配）设置初始排序规则选项。

方法详细信息

compare

()

方法

public function compare(string1:String, string2:String):int

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

比较两个字符串并返回一个整数值，表示第一个字符串是小于、等于还是大于第二个字符串。针对在调用比较方法时生效的区域设置样式，比较将使用该排序顺序规则。

参数

	`string1:String` — 第一个比较字符串。

	`string2:String` — 第二个比较字符串。

int — 一个整数值，表示第一个字符串是小于、等于或大于第二个字符串。

如果返回值是负数，则 string1 小于 string2 或 string2 是 null。
如果返回值是零，则表示 string1 等于 string2。
如果返回值是正数，则 string1 大于 string2 或 string1 是 null。

相关 API 元素

CollatorBase()
equals()

equals

()

方法

public function equals(string1:String, string2:String):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

比较两个字符串并返回表示字符串是否相等的布尔值。针对在 CollatorBase() 构造函数中指定的区域设置 ID，比较将使用该排序顺序规则。

参数

	`string1:String` — 第一个比较字符串。

	`string2:String` — 第二个比较字符串。

Boolean — 一个布尔值，表示字符串相等 (true) 还是不相等 (false)。

相关 API 元素

CollatorBase()
compare

getAvailableLocaleIDNames

()

方法

public static function getAvailableLocaleIDNames():Vector.<String>

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10.1, AIR 2.5

列出此类支持的所有区域设置 ID 名称。

Vector.<String> — 一个字符串矢量，其中包含此类和操作系统所支持的所有区域设置 ID 名称。

法律声明 | 在线隐私策略

CollatorBase - AS3 Flex

类 x

actualLocaleIDName

ignoreCase

ignoreCharacterWidth

ignoreDiacritics

ignoreKanaType

ignoreSymbols

lastOperationStatus

numericComparison

CollatorBase

compare

equals

getAvailableLocaleIDNames