Collator  - AS3

Nom de l’identificateur de paramètres régionaux actuel utilisé par cet objet Collator.

Il existe trois possibilités pour la valeur du nom, en fonction du système d’exploitation et de la valeur du paramètre requestedLocaleIDName transmis au constructeur Collator().

1. Si les paramètre régionaux requis n’étaient pas définis sur LocaleID.DEFAULT et que le système d’exploitation les prend en charge, le nom renvoyé est identique à la propriété requestedLocaleIDName.
2. Si LocaleID.DEFAULT a été utilisée comme valeur pour le paramètre requestedLocaleIDName transmis au constructeur, le nom des paramètres régionaux spécifié par le système d’exploitation de l’utilisateur est utilisé. La valeur LocaleID.DEFAULT préserve le paramètre personnalisé de l’utilisateur dans le système d’exploitation. La transmission d’une valeur explicite en tant que paramètre requestedLocaleIDName ne produit pas nécessairement le même résultat que l’utilisation de LocaleID.DEFAULT, même si le nom des deux identificateurs de paramètres régionaux est identique. Il est possible que l’utilisateur ait personnalisé les paramètres régionaux sur son ordinateur ; or, si vous demandez un identificateur de paramètres régionaux explicite au lieu d’utiliser LocaleID.DEFAULT, votre application ne récupérera pas ces paramètres personnalisés.
3. Si le système ne prend pas en charge le paramètre requestedLocaleIDName spécifié dans le constructeur, un nom d’ID de paramètres régionaux par défaut est fourni.

Eléments de l’API associés

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. Par exemple, compare("ABC", "abc") renvoie true lorsque la propriété ignoreCase est définie sur true.

La conversion de casse de la chaîne suit les règles des paramètres régionaux spécifiés.

Lorsque la propriété ignoreCase est définie sur false, les caractères majuscules et minuscules ne sont pas égaux.

Lorsque cette propriété se voit attribuer une valeur et en l’absence d’erreurs ou d’avertissements, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

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

Eléments de l’API associés

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.

Lorsque cette propriété se voit attribuer une valeur et en l’absence d’erreurs ou d’avertissements, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

La valeur par défaut est false.

Eléments de l’API associés

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.

Lorsque cette propriété se voit attribuer une valeur et en l’absence d’erreurs ou d’avertissements, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

La valeur par défaut est false.

Eléments de l’API associés

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.

Lorsque cette propriété se voit attribuer une valeur et en l’absence d’erreurs ou d’avertissements, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

La valeur par défaut est false.

Eléments de l’API associés

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.

Si la propriété ignoreSymbols est définie sur false, les caractères de symboles sont pris en compte lors des comparaisons de chaînes.

Lorsque cette propriété se voit attribuer une valeur et en l’absence d’erreurs ou d’avertissements, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

La valeur par défaut est false.

Eléments de l’API associés

Etat de la dernière opération que cet objet Collator 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.

Eléments de l’API associés

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.

Lorsque cette propriété se voit attribuer une valeur et en l’absence d’erreurs ou d’avertissements, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

La valeur par défaut est false.

Eléments de l’API associés

Nom de l’identificateur de paramètres régionaux ayant été transmis au constructeur de cet objet Collator.

Si la valeur LocaleID.DEFAULT a été utilisée, le nom renvoyé est "i-default". Les paramètres régionaux actuels peuvent différer des paramètres régionaux requis lorsque des paramètres régionaux par défaut sont appliqués. Il est possible de récupérer le nom du paramètre régional actuel à l’aide de la propriété actualLocaleIDName.

Eléments de l’API associés

Construit un nouvel objet Collator en vue d’effectuer des comparaisons de chaînes en fonction des paramètres régionaux spécifiés.

Si le système d’exploitation en cours ne prend pas en charge l’identificateur de paramètres régionaux transmis au paramètre requestedLocaleIDName, des paramètres régionaux de substitution sont spécifiés. Dans ce cas, la propriété lastOperationStatus est définie pour indiquer le type de paramètres de substitution.

Le paramètre initialMode définit plusieurs options de classement destinées à un usage général. Les valeurs définies peuvent être les suivantes :

• CollatorMode.SORTING : définit des options de classement à des fins de tri linguistique généraux, par exemple le tri d’une liste de chaînes de texte 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 des options de classement pour un usage général, notamment pour 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.

Voici un exemple d’une liste triée créée à l’aide d’un objet Collator, dont l’identificateur de paramètres régionaux est "en-US", c’est-à-dire Anglais (Etats-Unis), et dont le mode est défini sur CollatorMode.SORTING :

Comme indiqué ci-dessus, tous les caractères sont traités comme ayant des valeurs différentes, mais en ordre linguistique.

Voici un exemple d’une liste triée créée à l’aide d’un objet Collator, dont l’identificateur de paramètres régionaux est "en-US", c’est-à-dire Anglais (Etats-Unis), et dont le mode est défini sur CollatorMode.MATCHING :

Comme indiqué ci-dessus, certains caractères sont en ordre linguistique et sont traités comme ayant la même valeur de caractère.

Pour un contrôle plus précis sur l’ordre de tri, vous pouvez modifier les propriétés de l’objet Collator, telles que Collator.ignoreCase ou Collator.ignoreDiacritics.

Pour référence, voici un exemple de tri effectué à l’aide de la méthode standard Array.sort(), qui n’est pas basée sur les paramètres régionaux :

Comme vous pouvez le voir ci-dessus, tous les caractères sont triés simplement dans l’ordre des valeurs numériques Unicode. Ce classement n’a pas beaucoup de sens d’un point de vue linguistique.

Pour utiliser les préférences du systèmes d’exploitation de l’utilisateur, transmettez la valeur statique LocaleID.DEFAULT du paramètre requestedLocaleIDName au constructeur.

Certains paramètres régionaux prennent en charge plusieurs variantes d’ordre de tri. Par exemple, la langue allemande utilise un ordre de tri pour les répertoires téléphoniques et un ordre de tri différent pour les dictionnaires. En chinois, les mots sont généralement pris en charge par la translittération des caractères dans le pinyin. Il est possible de sélectionner ces divers ordres de tri en incluant mot-clé "collation" dans la chaîne transmise dans le paramètre requestedLocaleIDName au constructeur.

         var germanPhonebook:LocaleID = new LocaleID("de-DE@collation=phonebook");
         var chinesePinyin:LocaleID = new LocaleID("zh-Hant@collation=pinyin");
         

Les valeurs possibles de la chaîne de classement sont les suivantes (les langues correspondantes sont indiquées entre parenthèses) :

Si la plate-forme hôte ne prend pas en charge le type de classement requis, un classement de substitution est utilisé et la propriété lastOperationStatus est définie pour indiquer le recours à une valeur de substitution. Vous pouvez utiliser la propriété actualLocaleIDName pour déterminer la valeur ayant été utilisée comme valeur de secours, comme indiqué dans l’exemple suivant :

         var collator:Collator = new Collator("fr-FR");
         if (collator.lastOperationStatus == LastOperationStatus.USING_FALLBACK_WARNING)
         {
           trace ("Using fallback locale: " + collator.actualLocaleIDName);
         }
         

Lorsque le constructeur se termine avec succès, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Lorsque l’identificateur de paramètres régionaux requis n’est pas disponible, la propriété lastOperationStatus est définie sur l’une des valeurs suivantes :

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Pour plus d’informations sur les avertissements répertoriés ci-dessus et d’autres valeurs possibles de la propriété lastOperationStatus, voir les descriptions de la classe LastOperationStatus.

Eléments de l’API associés

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 de l’identificateur de paramètres régionaux spécifié dans le constructeur Collator().

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Paramètres

Eléments de l’API associés

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 Collator().

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Paramètres

Eléments de l’API associés

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

Si cette classe n’est pas prise en charge sur le système d’exploitation, cette méthode renvoie une valeur nulle.

1. Effectue une itération sur un tableau de noms d’ID de paramètres régionaux, y compris l’ID de paramètres régionaux par défaut correspondant au système d’exploitation (comme spécifié par LocaleID.DEFAULT)
2. Crée un objet Collator pour chaque nom d’ID de paramètres régionaux en utilisant le mode de « tri » (valeur par défaut).
3. Affiche les noms d’ID de paramètres régionaux requis et actuel, ainsi que la valeur de la propriété lastOperationStatus afin que vous sachiez si un jeu de paramètres régionaux par défaut a été utilisé.
4. Trie un tableau de données à l’aide de chaque objet Collator et affiche les résultats. L’ordre est différent pour chaque jeu de paramètres régionaux.

package {
    import flash.globalization.Collator;
    import flash.globalization.LocaleID;

    public class CollatorExample1
    {
        public var col:Collator;
        
        public function CollatorExample1():void
        {        
            var localeNames:Array = [LocaleID.DEFAULT,
                                     "de-DE", "sv-SE",
                                     "fr-FR", "lt-LT",
                                     "es-ES"];
            
            var testSortData:Array = [
                "y ", "i ", "k ", // Latvian
                "acxa ", "acha ", "adxa ", // es_traditional
                "n ", "ö ", "o ", "z ", "vu ", "wo ", // sw
                "däd ", "daed ", // de
                "öf ", "of ", // de_dictionary
                "côte ", "coté " // fr
            ];
            
            for each (var localeName:String in localeNames) {
            
                col = new Collator(localeName);
                
                trace("LocaleID requested: " + col.requestedLocaleIDName 
                       + "; actual: " + col.actualLocaleIDName);
                       
                trace("Last Operation Status: " + col.lastOperationStatus );
                
                var result:Array = testSortData.sort(col.compare);
                        
                trace ("sorted data: " + result); 
            }
        }      
    }
}

1. Crée un objet Collator pour le jeu de paramètres régionaux par défaut de l’utilisateur à l’aide du mode de « mise en correspondance ».
2. Définit également la propriété Collator.ignoreDiacritics sur false et true.
3. Compare les jeux de chaînes qui contiennent des signes diacritiques, ainsi que des majuscules et des minuscules.
4. Indique la façon dont changent les comparaisons à mesure que les propriétés Collator.ignoreDiacritics et Collator.ignoreCase changent.

package {
    import flash.display.Sprite;
    import flash.globalization.Collator;
    import flash.globalization.CollatorMode;
    import flash.globalization.LocaleID;
    
    public class CollatorExample2 extends Sprite
    {
        public var col:Collator;
        public var testMatchData:Array = ["cote", "Cote", "côte", "coté"];
        public var wordToMatch:String = "Cote";
        
        public function CollatorExample2()
        {
            col = new Collator( LocaleID.DEFAULT, CollatorMode.MATCHING );

            trace("LocaleID requested: " + col.requestedLocaleIDName 
                    + "; actual: " + col.actualLocaleIDName);
                    
            trace("Last Operation Status: " + col.lastOperationStatus );

            trace('\n' + "ignoreCase = " + col.ignoreCase);
            trace("ignoreDiacritics = " + col.ignoreDiacritics);

            compareString(testMatchData, wordToMatch) // All variations of the word cote match

            col.ignoreDiacritics = false;
            trace('\n' + "ignoreDiacritics = false");

            compareString(testMatchData, wordToMatch) // Variations with different diacritics will not match

            col.ignoreCase = false;
            trace('\n' + "ignoreCase = false");

            compareString(testMatchData, wordToMatch) // Variations with different case will not match
        }
    
        private function compareString(stringArray:Array, keyword:String):void
        {
            for each(var s:String in stringArray)
            {
                if(col.equals(s, keyword))    
                {
                    trace(keyword + " = " + s);
                }
            }
        }
    }
}