CollatorBase

Package	spark.globalization.supportClasses
Classe	public class CollatorBase
Héritage	CollatorBase GlobalizationBase AdvancedStyleClient EventDispatcher Object
Sous-classes	MatchingCollator, SortingCollator

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

CollatorBase est une classe de base pour les classes SortingCollator et MatchingCollator.

Cette classe est une classe d’enveloppe autour de la classe flash.globalization.Collator. Par conséquent, la comparaison de chaînes spécifiques aux paramètres régionaux est fournie par la classe flash.globalization.Collator. Toutefois, en utilisant cette classe comme classe de base, les classes SortingCollator et MatchingCollator peuvent être utilisées dans les déclarations MXML. Dans ces classes, le style locale est utilisé pour le nom d’identificateur de paramètres régionaux demandé et possède des méthodes et des propriétés qui sont liables.

La classe flash.globalization.Collator utilise le système d’exploitation sous-jacent pour la fonctionnalité de formatage et pour fournir les données spécifiques aux paramètres régionaux. Sur certains systèmes d’exploitation, les classes flash.globalization ne sont pas prises en charge. Sur ces systèmes, la classe d’enveloppe fournit des fonctionnalités de secours pour la comparaison des chaînes.

Eléments de l’API associés

flash.globalization.Collator

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		actualLocaleIDName : String [override] [lecture seule] Nom de l’identificateur de paramètres régionaux utilisé par cet objet de classe.	CollatorBase
		className : String [lecture seule] Nom de la classe du composant.	AdvancedStyleClient
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		id : String Identité du composant.	AdvancedStyleClient
		ignoreCase : Boolean Lorsque cette propriété est définie sur true, les chaînes identiques, ainsi que les chaînes dont l’unique différence réside dans la casse typographique, sont considérées comme égales.	CollatorBase
		ignoreCharacterWidth : Boolean Lorsque cette propriété est définie sur true, les formes à pleine chasse et à demi-chasse de certains caractères chinois et japonais sont considérées comme égales.	CollatorBase
		ignoreDiacritics : Boolean Lorsque cette propriété est définie sur true, les chaînes qui utilisent les mêmes caractères de base, mais des accents différents ou d’autres signes diacritiques, sont considérées comme égales.	CollatorBase
		ignoreKanaType : Boolean Lorsque cette propriété est définie sur true, les chaînes dont l’unique différence réside dans le type de caractères kana utilisés sont considérées comme égales.	CollatorBase
		ignoreSymbols : Boolean Lorsque cette propriété est définie sur true, les caractères de symbole, tels qu’espaces, symboles de devises, symboles mathématiques et autres types de symboles, ne sont pas pris en compte lors du tri ou de la correspondance.	CollatorBase
		inheritingStyles : Object Objet contenant les styles héritables de cette instance de client de style non visuel.	AdvancedStyleClient
		lastOperationStatus : String [override] [lecture seule] Etat de la dernière opération que cet objet de classe a effectuée.	CollatorBase
		moduleFactory : IFlexModuleFactory Une fabrique de modules est utilisée comme contexte pour la recherche du gestionnaire de style qui contrôle les styles de cette instance de client de style non visuel.	AdvancedStyleClient
		nonInheritingStyles : Object Début de la chaîne de styles non hérités de ce composant.	AdvancedStyleClient
		numericComparison : Boolean Contrôle la manière dont les valeurs numériques intégrées aux chaînes sont gérées lors de la comparaison des chaînes.	CollatorBase
		styleDeclaration : CSSStyleDeclaration Déclaration de style contenant les styles en ligne déclarés par cet objet.	AdvancedStyleClient
		styleManager : IStyleManager2 [lecture seule] Renvoie l’instance SystemManager utilisée par ce composant.	AdvancedStyleClient
		styleName : Object Source des valeurs de style de cet objet.	AdvancedStyleClient
		styleParent : IAdvancedStyleClient Le parent d’un composant permet d’évaluer les sélecteurs descendants.	AdvancedStyleClient

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		CollatorBase(initialMode:String) Construit un nouvel objet CollatorBase en vue d’effectuer des comparaisons de chaînes conformément aux conventions des paramètres régionaux spécifiés.	CollatorBase
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.	EventDispatcher
		clearStyle(styleProp:String):void Supprime une propriété de style de cette instance de composant.	AdvancedStyleClient
		compare(string1:String, string2:String):int Compare deux chaînes et renvoie un nombre entier indiquant si la première chaîne est inférieure, égale ou supérieure à la deuxième chaîne.	CollatorBase
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		equals(string1:String, string2:String):Boolean Compare deux chaînes et renvoie une valeur booléenne indiquant si les chaînes sont égales.	CollatorBase
		getAvailableLocaleIDNames():Vector.<String> [statique] Répertorie tous les noms des ID de paramètres régionaux pris en charge par cette classe.	CollatorBase
		getClassStyleDeclarations():Array Renvoie un tableau d’objets CSSStyleDeclaration pour le sélecteur de type qui s’applique à ce composant. Renvoie la valeur null si aucun n’existe.	AdvancedStyleClient
		getStyle(styleProp:String):* [override] Extrait une propriété de style ayant été définie n’importe où dans la chaîne de recherche de style de ce composant.	GlobalizationBase
		hasCSSState():Boolean Renvoie true si la valeur currentCSSState n’est pas nulle.	AdvancedStyleClient
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		initialized(document:Object, id:String):void La méthode initialized est appelée lorsque cette classe ou une classe qui étend cette classe est utilisée dans une déclaration MXML.	AdvancedStyleClient
		isPrototypeOf(theClass:Object):Boolean Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.	Object
		matchesCSSState(cssState:String):Boolean Renvoie la valeur true si cssState correspond à currentCSSState.	AdvancedStyleClient
		matchesCSSType(cssType:String):Boolean Détermine si l’instance est identique au, ou est une sous-classe du, type donné.	AdvancedStyleClient
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propage les changements de style aux enfants de cette instance du client de style.	AdvancedStyleClient
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		regenerateStyleCache(recursive:Boolean):void Configure les valeurs de cache du style interne afin que la méthode getStyle() fonctionne.	AdvancedStyleClient
		registerEffects(effects:Array):void Enregistre le gestionnaire EffectManager comme l’un des écouteurs d’événement pour chaque événement d’effet.	AdvancedStyleClient
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		setStyle(styleProp:String, newValue:*):void Définit une propriété de style pour cette instance de composant.	AdvancedStyleClient
		styleChanged(styleProp:String):void Détecte les modifications apportées aux propriétés de style.	AdvancedStyleClient
		stylesInitialized():void Flex() appelle la méthode stylesInitialized() lorsque les styles d’un composant sont d’abord initialisés.	AdvancedStyleClient
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.	EventDispatcher

Evénements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Synthèse	Défini par
activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
change	L’événement change est généré chaque fois que le style de paramètres régionaux est modifié ou qu’une autre propriété est définie qui entraînerait la modification du format d’un nombre ou la mise à jour des autres valeurs disponibles par le biais de cette classe.	GlobalizationBase
deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher

Styles

Les styles sont soit communs soit associés à un thème spécifique. Si le style est commun, il peut être utilisé avec n’importe quel thème. Si un style est associé à un thème spécifique, il ne peut être utilisé que si votre application utilise ce thème.

Styles communs

Cliquez pour plus d’informations sur les styles

Masquer les styles hérités

Afficher les styles hérités

	Style		Description	Défini par
		locale	Type: String Héritage CSS: Oui Version du langage: ActionScript 3.0 Version du produit: Flex 4.5 Versions du moteur d’exécution: Flash10.1, AIR 2.5 Identificateur de paramètres régionaux qui spécifie la langue, la région, le script et éventuellement d’autres balises et touches associées.	GlobalizationBase

Détails de la propriété

actualLocaleIDName

propriété

actualLocaleIDName:String [lecture seule] [override]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Nom de l’identificateur de paramètres régionaux utilisé par cet objet de classe. Il s’agit des paramètres régionaux qui sont utilisés pour accéder à la fonctionnalité et aux données de formatage à partir du système d’exploitation.

Si les paramètres régionaux définis par le style des paramètres régionaux ne sont pas disponibles, la valeur de la propriété actualLocaleIDName est différente de la valeur du style des paramètres régionaux. Elle indique les paramètres régionaux de secours qui sont utilisés. Si le style de paramètres régionaux a été défini sur LocaleID.DEFAULT, le nom des paramètres régionaux spécifié par le système d’exploitation de l’utilisateur est utilisé.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Implémentation
override public function get actualLocaleIDName():String

Eléments de l’API associés

flash.globalization.Collator.actualLocaleIDName
CollatorBase()

ignoreCase

propriété

ignoreCase:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Lorsque cette propriété est définie sur true, les chaînes identiques, ainsi que les chaînes dont l’unique différence réside dans la casse typographique, sont considérées comme égales.

La valeur par défaut est true lorsque le paramètre initialMode du constructeur CollatorBase() est défini sur Collator.MATCHING. La valeur est false lorsque le paramètre initialMode du constructeur CollatorBase() est défini sur Collator.SORTING.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Implémentation
public function get ignoreCase():Boolean
public function set ignoreCase(value:Boolean):void

Eléments de l’API associés

compare()
equals()

ignoreCharacterWidth

propriété

ignoreCharacterWidth:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Lorsque cette propriété est définie sur true, les formes à pleine chasse et à demi-chasse de certains caractères chinois et japonais sont considérées comme égales.

Pour assurer la compatibilité avec les normes existantes relatives aux jeux de caractères chinois et japonais, Unicode fournit des codes de caractères pour certains caractères à pleine chasse et à demi-chasse. Par exemple, lorsque la propriété ignoreCharacterWidth est définie sur true, compare("Ａｱ", "Aア") renvoie true.

Si la propriété ignoreCharacterWidth est définie sur false, les caractères à pleine chasse et à demi-chasse ne sont pas égaux.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Implémentation
public function get ignoreCharacterWidth():Boolean
public function set ignoreCharacterWidth(value:Boolean):void

Eléments de l’API associés

compare()
equals()

ignoreDiacritics

propriété

ignoreDiacritics:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Lorsque cette propriété est définie sur true, les chaînes qui utilisent les mêmes caractères de base, mais des accents différents ou d’autres signes diacritiques, sont considérées comme égales. Par exemple, compare("coté", "côte") renvoie true lorsque la propriété ignoreDiacritics est définie sur true.

Lorsque la propriété ignoreDiacritics est définie sur false, les caractères de base possédant des signes diacritiques ou des accents ne sont pas considérés comme égaux.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Implémentation
public function get ignoreDiacritics():Boolean
public function set ignoreDiacritics(value:Boolean):void

Eléments de l’API associés

compare()
equals()

ignoreKanaType

propriété

ignoreKanaType:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Lorsque cette propriété est définie sur true, les chaînes dont l’unique différence réside dans le type de caractères kana utilisés sont considérées comme égales. Par exemple, compare("カナ", "かな") renvoie true lorsque la propriété ignoreKanaType est définie sur true.

Si la propriété ignoreKanaType est définie sur false, les caractères hiragana et katakana qui font référence à la même syllabe ne sont pas égaux.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Implémentation
public function get ignoreKanaType():Boolean
public function set ignoreKanaType(value:Boolean):void

Eléments de l’API associés

compare()
equals()

ignoreSymbols

propriété

ignoreSymbols:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Lorsque cette propriété est définie sur true, les caractères de symbole, tels qu’espaces, symboles de devises, symboles mathématiques et autres types de symboles, ne sont pas pris en compte lors du tri ou de la correspondance. Par exemple, les chaînes "OBrian", "O’Brian" et "o Brian" sont toutes considérées comme égales lorsque la propriété ignoreSymbols est définie sur true.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Implémentation
public function get ignoreSymbols():Boolean
public function set ignoreSymbols(value:Boolean):void

Eléments de l’API associés

compare()
equals()

lastOperationStatus

propriété

lastOperationStatus:String [lecture seule] [override]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Etat de la dernière opération que cet objet de classe a effectuée. La propriété lastOperationStatus est définie chaque fois que le constructeur ou une méthode de cette classe est appelé, ou qu’une autre propriété est définie. Pour les valeurs disponibles, voir la description de chaque méthode.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Implémentation
override public function get lastOperationStatus():String

Eléments de l’API associés

spark.globalization.LastOperationStatus

numericComparison

propriété

numericComparison:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Contrôle la manière dont les valeurs numériques intégrées aux chaînes sont gérées lors de la comparaison des chaînes.

Lorsque la propriété numericComparison est définie sur true, la méthode de comparaison convertit les nombres figurant dans les chaînes en valeurs numériques en vue de le comparaison.

Lorsque cette propriété est définie sur false, la comparaison considère les nombres en tant que codes de caractères et les classe conformément aux règles de tri des caractères des paramètres régionaux spécifiés.

Par exemple, lorsque cette propriété est définie sur true pour l’identificateur de paramètres régionaux "en-US", les chaînes "version1", "version10" et "version2" sont classées dans l’ordre suivant : version1 < version2 < version10.

Lorsque cette propriété est définie sur false pour "en-US", ces mêmes chaînes sont classées dans l’ordre suivant : version1 < version10 < version2.

La valeur par défaut est false.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement change .

Implémentation
public function get numericComparison():Boolean
public function set numericComparison(value:Boolean):void

Eléments de l’API associés

compare()
equals()

Détails du constructeur

()

Constructeur

public function CollatorBase(initialMode:String)

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Construit un nouvel objet CollatorBase en vue d’effectuer des comparaisons de chaînes conformément aux conventions des paramètres régionaux spécifiés.

Le paramètre initialMode définit les options de classement initial pour deux cas d’utilisation : le tri et la mise en correspondance. Il peut lui être affectée l’une des deux valeurs suivantes :

CollatorMode.SORTING : définit les options de classement à des fins de tri linguistique général, comme par exemple le tri d’une liste de chaînes de caractères présentées à un utilisateur final. Dans ce mode, les différences entre majuscules et minuscules, caractères accentués et autres différences spécifiques aux paramètres régionaux sont prises en compte lors de la comparaison de chaînes.
CollatorMode.MATCHING : définit les options de classement à des fins telles que le fait de déterminer si deux chaînes sont équivalentes. Dans ce mode, les différences entre majuscules et minuscules, caractères accentués, etc., sont ignorées lors de la comparaison de chaînes.

Pour plus de détails et des exemples d’utilisation de ces deux modes, veuillez consulter la documentation relative à la classe flash.globalization.Collator.

Les paramètres régionaux pour cette classe sont fournis par le style locale. Le style locale peut être défini de plusieurs manières :

En héritant le style à partir d’un composant UIComponent en appelant la méthode addStyleClient du composant UIComponent avec une instance de cet objet comme paramètre.

En utilisant la classe dans une déclaration MXML et en héritant le style locale à partir du document qui contient la déclaration.

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

En utilisant une déclaration MXML et en spécifiant la valeur locale dans la liste des affectations.

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

En appelant la méthode setStyle, par ex. collator.setStyle("locale", "de-DE").

Si le style locale n’est pas défini selon l’une des techniques ci-dessus, les méthodes de cette classe qui dépendent du style locale définissent la propriété lastOperationStatus sur spark.globalization.LastOperationStatus.LOCALE_UNDEFINED_ERROR.

Paramètres

initialMode:String — Définit les options de classement initial pour deux cas d’utilisation : le tri et la mise en correspondance.

Eléments de l’API associés

flash.globalization.Collator
spark.globalization.LastOperationStatus

Détails de la méthode

compare

()

méthode

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

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Compare deux chaînes et renvoie un nombre entier indiquant si la première chaîne est inférieure, égale ou supérieure à la deuxième chaîne. La comparaison utilise les règles de tri du style locale qui est en vigueur lorsque la méthode compare est appelée.

Paramètres

	`string1:String` — Première chaîne de comparaison.

	`string2:String` — Deuxième chaîne de comparaison.

Valeur renvoyée

int — Nombre entier indiquant si la première chaîne est inférieure, égale ou supérieure à la deuxième chaîne.

Si la valeur renvoyée est négative, string1 est inférieure à string2 ou string2 a la valeur null.
Si la valeur renvoyée est zéro, string1 est égale à string2.
Si la valeur renvoyée est positive, string1 est supérieure à string2 ou string1 a la valeur null.

Eléments de l’API associés

CollatorBase()
equals()

equals

()

méthode

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

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Compare deux chaînes et renvoie une valeur booléenne indiquant si les chaînes sont égales. La comparaison utilise les règles de tri de l’identificateur de paramètres régionaux spécifié dans le constructeur CollatorBase().

Paramètres

	`string1:String` — Première chaîne de comparaison.

	`string2:String` — Deuxième chaîne de comparaison.

Valeur renvoyée

Boolean — Valeur booléenne indiquant si les chaînes sont égales (true) ou ne le sont pas (false).

Eléments de l’API associés

CollatorBase()
compare

getAvailableLocaleIDNames

()

méthode

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

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4.5

Versions du moteur d’exécution:

Flash Player 10.1, AIR 2.5

Répertorie tous les noms des ID de paramètres régionaux pris en charge par cette classe.

Valeur renvoyée

Vector.<String> — Vecteur de chaînes contenant tous les noms des identificateurs de paramètres régionaux pris en charge par cette classe et ce système d’exploitation.

Informations juridiques | Politique de confidentialité en ligne

CollatorBase - AS3 Flex

Package spark.globalization.supportClasses

actualLocaleIDName

ignoreCase

ignoreCharacterWidth

ignoreDiacritics

ignoreKanaType

ignoreSymbols

lastOperationStatus

numericComparison

CollatorBase

compare

equals

getAvailableLocaleIDNames