NumberFormatter  - AS3

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

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

Le séparateur décimal utilisé pour le formatage ou l’analyse des nombres ayant une partie décimale.

Cette propriété est initialement définie en fonction des paramètres régionaux sélectionnés lors de la construction de l’objet formatter.

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 dependent on the locale and operating system..

Eléments de l’API associés

Définit le jeu de caractères numériques à utiliser lors du formatage des nombres.

Selon les langues et les régions, différents jeux de caractères sont utilisés pour représenter les chiffres de 0 à 9. Cette propriété définit le jeu de chiffres à utiliser.

La valeur de cette propriété représente la valeur Unicode pour le chiffre zéro d’un jeu de chiffres décimaux. Les valeurs valides de cette propriété sont définies dans la classe NationalDigitsType.

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 dependent on the locale and operating system..

Eléments de l’API associés

Nombre maximal de chiffres pouvant apparaître après le séparateur décimal.

Les numéros sont arrondis au nombre de chiffres spécifié par cette propriété. Le modèle d’arrondi varie selon le système d’exploitation de l’utilisateur.

Lorsque la propriété trailingZeros est définie sur true, la partie fractionnaire du nombre (après le point décimal) est suivie de zéros (à droite) jusqu’à ce que sa longueur corresponde à la valeur de cette propriété fractionalDigits.

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 0.

Eléments de l’API associés

Décrit le placement des séparateurs de groupes dans la chaîne de nombres formatée.

Lorsque la propriété useGrouping est définie sur true, la propriété groupingPattern permet de définir le placement et le modèle utilisé pour le séparateur de groupes.

Le modèle de groupement est défini en tant que chaîne contenant des numéros séparés par des points-virgules et pouvant se terminer par un astérisque. Par exemple : "3;2;*". Chaque numéro dans la chaîne représente le nombre de chiffres dans un groupe. Le séparateur de groupes est placé avant chaque groupe de chiffres. Un astérisque à la fin de la chaîne indique que les groupes avec ce nombre de chiffres doivent être répétés pour le reste de la chaîne formatée. S’il n’y a pas d’astérisque, il n’y a aucun groupe ou séparateur supplémentaire pour le reste de la chaîne formatée.

Le premier nombre dans la chaîne correspond au premier groupe de chiffres à gauche du séparateur décimal. Les nombres suivants définissent le nombre de chiffres dans les groupes suivants se trouvant à gauche. Ainsi, la chaîne "3;2;*" indique qu’un séparateur de groupes est placé après le premier groupe de 3 chiffres, suivi par des groupes de 2 chiffres. Par exemple : 98,76,54,321

Le tableau ci-dessous présente des exemples de formatage du nombre 123456789.12 avec divers modèles de groupement. Le séparateur de groupes est une virgule et le séparateur décimal est un point.

Seul un nombre limité de tailles de groupement peut être défini. Sur certains systèmes d’exploitation, les modèles de groupement ne peuvent contenir que deux nombres et un astérisque. D’autres systèmes d’exploitation peuvent prendre en charge jusqu’à quatre nombres et un astérisque. Pour les modèles sans astérisque, certains systèmes d’exploitation ne prennent en charge qu’un seul nombre, alors que d’autres prennent en charge jusqu’à trois nombres. Si le nombre maximum d’éléments de modèles de groupement est dépassé, d’autres éléments sont ignorés et la propriété lastOperationStatus est définie comme indiqué ci-dessous.

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.

Eléments de l’API associés

Caractère ou chaîne utilisé(e) pour le séparateur de groupes.

La valeur de cette propriété est utilisée comme séparateur de groupes lors du formatage des nombres lorsque la propriété useGrouping est définie sur true. Cette propriété est initialement définie en fonction des paramètres régionaux sélectionnés lors de la construction de l’objet formatter.

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 dependent on the locale and operating system..

Eléments de l’API associés

Etat de dernière opération que cet objet NumberFormatter a effectuée. La propriété lastOperationStatus est définie chaque fois que le constructeur ou une méthode de cette classe est appelé(e), 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

Indique si un nombre est précédé d’un zéro lorsque celui-ci ne contient aucun nombre entier à gauche du séparateur décimal.

Lorsque cette propriété est définie sur true, un zéro est inséré à gauche du séparateur décimal lors du formatage des valeurs numériques comprises entre -1.0 et 1.0. Lorsque cette propriété est définie sur false, aucun zéro n’est inséré.

Par exemple si le nombre est 0.321 et que cette propriété est définie sur true, le zéro est inclus dans la chaîne formatée. Si la propriété est définie sur false, le zéro n’est inclus. Dans ce cas, la chaîne inclut uniquement le séparateur décimal, suivi des chiffres décimaux, comme .321.

Le tableau ci-dessous présente des exemples sur la façon dont les nombres sont formatés en fonction des valeurs de cette propriété, ainsi que des propriétés fractionalDigits et trailingZeros associées.

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 dependent on the locale and operating system..

Eléments de l’API associés

Valeur numérique qui indique un modèle de formatage pour les nombres négatifs. Ce modèle définit l’emplacement du symbole négatif ou des parenthèses par rapport à la partie numérique du nombre formaté.

Le tableau suivant récapitule les formats disponibles pour les nombres négatifs. Lorsqu’un nombre négatif est formaté, le signe moins est remplacé par la valeur de la propriété negativeSymbol et le caractère « n » par la valeur numérique formatée.

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 dependent on the locale and operating system..

Eléments de l’API associés

Symbole négatif à utiliser lors du formatage des valeurs négatives.

Ce symbole est utilisé avec le format de nombre négatif lors du formatage d’un nombre inférieur à zéro. Il n’est pas utilisé dans des formats de nombre négatif qui n’incluent pas de signe négatif (notamment lorsque des nombres négatifs se trouvent entre parenthèses).

Cette propriété est définie sur une valeur par défaut pour les paramètres régionaux sélectionnés lors de la construction de cette classe de formatage. Elle peut être définie sur une valeur de façon à remplacer le paramètre par défaut.

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.

Eléments de l’API associés

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

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

Indique si un nombre formaté est précédé de zéros.

Lorsque cette propriété est définie sur true, des zéros sont insérés à droite de la partie fractionnaire du nombre formaté, en respectant la limite spécifiée par la propriété fractionalDigits. Lorsque cette propriété est définie sur false, aucun zéro n’est inséré.

Par exemple, si la valeur numérique est 123.4, si cette propriété est définie sur true et si la propriété fractionalDigits est définie sur 3, la chaîne formatée affiche les zéros, comme suit : 123.400. Si cette propriété est définie sur false, aucun zéro n’est inclus et la chaîne affiche uniquement le séparateur décimal, suivi des chiffres décimaux (autres que zéro), comme suit : 123.4.

Le tableau ci-dessous présente des exemples sur la façon dont les valeurs numériques sont formatées en fonction des valeurs de cette propriété, ainsi que des propriétés fractionalDigits et trailingZeros associées.

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 dependent on the locale and operating system..

Eléments de l’API associés

Permet l’utilisation du séparateur de groupes lors du formatage des nombres.

Lorsque la propriété useGrouping est définie sur true, les chiffres sont groupés et délimités par le caractère de séparation de groupes. Par exemple : 123,456,789.22

Lorsque la propriété useGrouping est définie sur false, les chiffres ne sont ni groupés ni séparés. Par exemple : 123456789.22

Le symbole à utiliser en tant que séparateur de groupes est défini par la propriété groupingSeparator. Le nombre de chiffres compris entre les séparateurs de groupes est défini par la propriété groupingPattern.

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.

Eléments de l’API associés

Construit un nouvel objet NumberFormatter pour formater les numéros en fonction des conventions de paramètres régionaux donnés.

Ce constructeur détermine si le système d’exploitation actuel prend en charge le nom de l’identificateur de paramètres régionaux requis. Si ce n’est pas le cas, des paramètres régionaux de substitution sont utilisés. En cas d’utilisation de paramètres régionaux de substitution, la propriété lastOperationStatus indique le type de paramètres de substitution, et la propriété actualLocaleIDName contient le nom de ces paramètres.

Pour effectuer un formatage en fonction des préférences de l’utilisateur du système d’exploitation actuel, transmettez la valeur LocaleID.DEFAULT du paramètre requestedLocaleIDName au constructeur.

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

• LastOperationStatus.NO_ERROR

Lorsque le nom de 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

Si cette classe n’est pas prise en charge sur le système d’exploitation, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.UNSUPPORTED_ERROR

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

Formate une valeur int. Cette fonction équivaut à la méthode formatNumber(), sauf qu’elle prend une valeur int. Si la valeur transmise est trop grande ou trop petite, c’est le cas notamment d’une valeur supérieure à 1.72e308 ou inférieure à 1.72e-308, cette fonction renvoie la valeur 0.

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

Formate une valeur Number.

Cette fonction formate le nombre en fonction des valeurs de propriété de l’outil de formatage. Si les propriétés ne sont pas modifiées après la création de l’objet numberFormatter, les nombres sont formatés en fonction des paramètres régionaux en vigueur fournis par le système d’exploitation correspondant aux paramètres régionaux identifiés par actualLocaleIDName. Pour personnaliser le format, les propriétés peuvent être modifiées en vue de contrôler certains aspects de formatage d’un nombre.

Les très grands nombres et les nombres à très petite amplitude peuvent être formatés avec cette fonction. Cependant, le nombre de chiffres est limité à la précision fournie par l’objet Number. La notation scientifique n’est pas pris en charge.

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

Formate une valeur uint. Cette fonction équivaut à la méthode formatNumber(), sauf qu’elle prend une valeur uint. Si la valeur transmise est trop volumineuse, notamment si une valeur est supérieure à 1.72e308, cette fonction renvoie la valeur 0.

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 actuel, cette méthode renvoie une valeur nulle.

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.

Analyse une chaîne et renvoie un objet NumberParseResult contenant les éléments analysés.

L’objet NumberParseResult contient la valeur du premier nombre détecté dans la chaîne saisie, l’index de début correspondant au nombre dans la chaîne, et l’index du premier caractère après le nombre de la chaîne.

Si la chaîne ne contient pas de nombre, la propriété value de l’objet NumberParseResult est définie sur NaN, et les propriétés startIndex et endIndex sont définies sur la valeur hexadécimale 0x7fffffff.

Cette fonction utilise la valeur de la propriété decimalSeparator pour déterminer la partie du nombre contenant les chiffres fractionnaires, la propriété groupingSeparator pour identifier les caractères autorisés dans les chiffres d’un nombre, ainsi que la propriété negativeNumberFormat pour gérer le mode de représentation des valeurs négatives.

Le tableau suivant identifie le résultat des chaînes analysées pour les différentes valeurs de la propriété NegativeNumberFormat :

Un seul espace blanc est autorisé entre le numéro et le signe moins ou la parenthèse.

D’autres propriétés sont ignorées pour déterminer si un nombre est valide. Concrètement, la valeur de la propriété digitsType est ignorée et les chiffres peuvent provenir de l’un des jeux de chiffres énumérés dans la classe NationalDigitsType. Les valeurs des propriétés groupingPattern et useGrouping n’ont aucune incidence sur l’analyse du nombre.

Dans la chaîne, si les nombres sont précédés ou suivis d’un signe plus (+), ce signe est traité comme un caractère ne faisant pas partie du nombre.

Cette fonction n’analyse pas les chaînes contenant des nombres en notation scientifique (par exemple, 1.23e40).

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

 
         var nf:NumberFormatter = new NumberFormatter("fr-FR"); 
         var str:String = "1,56 mètre"
         var result:NumberParseResult = nf.parse(str);
         trace(result.value) // 1.56
         trace(str.substr(0,result.startIndex));                // ""
         trace(str.substr(result.startIndex, result.endIndex)); // "1,56"
         trace(str.substr(result.endIndex));                    // " mètre"
         

Analyse une chaîne qui contient uniquement des chiffres et des espaces facultatifs, et renvoie un nombre. Si la chaîne ne commence pas par un nombre ou contient des caractères autres que des espaces qui ne font pas partie du nombre, cette méthode renvoie NaN. Une espace blanc avant ou après les chiffres numériques est ignoré. Un espace blanc est un caractère disposant d’une propriété de séparateur d’espace (Zs) dans la base de données des caractères Unicode (voir http://www.unicode.org/ucd/).

Si le chiffre est précédé ou suivi d’un signe plus « + », il est considéré comme un caractère autre qu’un espace blanc. La valeur renvoyée est NaN.

Voir la description de la fonction d’analyse pour plus d’informations sur l’analyse des nombres et les caractéristiques d’un numéro valide.

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

Cet exemple utilise les paramètres régionaux suivants : paramètres régionaux par défaut du système d’exploitation pour le formatage des numéros, Japonais (Japon), Anglais (Etats-Unis) et Français (France). Cet exemple utilise le membre statique LocaleID.DEFAULT pour solliciter le jeu de paramètres régionaux par défaut du système d’exploitation.

Notez que les résultats de cet exemple peuvent varier en fonction du système d’exploitation et des préférences de l’utilisateur.

Cet exemple suit la procédure suivante pour chaque jeu de paramètres régionaux dans la liste :

1. Crée un objet NumberFormatter.
2. Formate la même valeur qu’un nombre, un entier et un entier non signé, et affiche les résultats.

 
package {
    import flash.globalization.NumberFormatter;
    import flash.globalization.LocaleID;
    
    public class NumberFormatterExample extends Sprite
    {
        public function NumberFormatterExample():void
        {
            var localeNames:Array = [LocaleID.DEFAULT,"ja_JP","en_US","fr_FR"];
            
            for ( var i:int = 0; i < localeNames.length; i++ ) 
            {
                var nf:NumberFormatter = new NumberFormatter( localeNames[i] as String );
                trace('\n\n' + "LocaleID requested: " + nf.requestedLocaleIDName 
                    + "; actual: " + nf.actualLocaleIDName);
                trace( "Last Operation Status:" + nf.lastOperationStatus );   
            
                var numberString:String = nf.formatNumber(123456789.19); 
                trace( "Formatted Number:" + numberString);
                numberString = nf.formatInt(-123456789); 
                trace( "Formatted Int:" + numberString);
                numberString = nf.formatUint(123456789); 
                trace( "Formatted UInt:" + numberString);
            }
        }
    }
}

Notez que les résultats de cet exemple peuvent varier en fonction du système d’exploitation et des préférences de l’utilisateur.

Cet exemple effectue les opérations suivantes :

1. Crée un objet NumberFormatter.
2. Appelle la méthode NumberFormatter.parse() pour analyser la chaîne et renvoie un objet NumberParseResult.
3. Appelle la méthode NumberFormatter.parseNumber() pour analyser la chaîne et renvoie une valeur numérique.

 
package {
      import flash.globalization.NumberFormatter;
      import flash.globalization.NumberParseResult;
      import flash.globalization.LastOperationStatus;
      import flash.globalization.LocaleID;

      public class NumberFormatterParseExample
      {
            public function NumberFormatterParseExample():void
            {
                var nf:NumberFormatter = new NumberFormatter( "en_US" );
                trace("LocaleID requested: " + nf.requestedLocaleIDName 
                    + "; actual: " + nf.actualLocaleIDName);
                trace( "Last Operation Status:" + nf.lastOperationStatus );  

                var inputNumberString:String = "123,567,89,0.254";
                var parseResult:NumberParseResult = nf.parse(inputNumberString);
                if ( nf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Parsed value:" + parseResult.value);
                }
                inputNumberString = "-123,567,89,0.254";
                var parsedNumber:Number = nf.parseNumber(inputNumberString);
                if ( nf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Parsed value:" + parsedNumber);
                }
            }
      }
}