Package | flash.globalization |
Classe | public final class CurrencyFormatter |
Héritage | CurrencyFormatter Object |
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
La classe CurrencyFormatter utilise les données et les fonctionnalités fournies par le système d’exploitation, et est conçue pour formater les valeurs monétaires conformément aux conventions de paramètres régionaux spécifiques et au type de devise. La position du symbole de devise, le symbole négatif, le séparateur décimal, le séparateur de groupes, le séparateur décimal du modèle de groupement, ainsi que d’autres éléments peuvent varier selon les paramètres régionaux.
Si le système d’exploitation prend en charge les paramètres régionaux requis, les propriétés et le type de devise sont définis en fonction des conventions et des valeurs par défaut des paramètres régionaux requis. Si les paramètres régionaux requis ne sont pas disponibles, les propriétés sont définies en fonction de paramètres régionaux par défaut, pouvant être obtenus à l’aide de la propriété actualLocaleIDName
.
En raison de l’utilisation des paramètres définis par l’utilisateur, des modèles de formatage fournis par le système d’exploitation et des paramètres régionaux par défaut (lorsque les paramètres régionaux requis ne sont pas pris en charge), différents utilisateurs peuvent obtenir différents résultats de formatage, même s’ils ont recours au même ID de paramètres régionaux.
Propriété | Défini par | ||
---|---|---|---|
actualLocaleIDName : String [lecture seule]
Nom de l’identificateur de paramètres régionaux actuel utilisé par cet objet CurrencyFormatter. | CurrencyFormatter | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
currencyISOCode : String [lecture seule]
Les trois lettres du code de devise ISO 4217 correspondant aux paramètres régionaux actuellement spécifiés. | CurrencyFormatter | ||
currencySymbol : String [lecture seule]
Chaîne ou symbole de devise correspondant aux paramètres régionaux actuellement spécifiés. | CurrencyFormatter | ||
decimalSeparator : String
Séparateur décimal utilisé pour le formatage ou l’analyse des montants en devise à décimales. | CurrencyFormatter | ||
digitsType : uint
Définit le jeu de caractères numériques utilisé lors du formatage des montants en devise. | CurrencyFormatter | ||
fractionalDigits : int
Nombre maximal de chiffres pouvant apparaître après le séparateur décimal. | CurrencyFormatter | ||
groupingPattern : String
Décrit le placement de séparateurs de groupes au sein de la chaîne de montants en devise formatée. | CurrencyFormatter | ||
groupingSeparator : String
Caractère ou chaîne utilisé(e) pour le séparateur de groupes. | CurrencyFormatter | ||
lastOperationStatus : String [lecture seule]
Etat de la dernière opération que cet objet CurrencyFormatter a effectuée. | CurrencyFormatter | ||
leadingZero : Boolean
Indique si un montant en devise formaté est précédé d’un zéro lorsque celui-ci ne contient aucun nombre entier à gauche du séparateur décimal. | CurrencyFormatter | ||
negativeCurrencyFormat : uint
Valeur numérique qui indique un modèle de formatage pour les montants en devise négatifs. | CurrencyFormatter | ||
negativeSymbol : String
Symbole négatif utilisé lors du formatage des montants en devise négatifs. | CurrencyFormatter | ||
positiveCurrencyFormat : uint
Valeur numérique qui indique un modèle de formatage pour les montants en devise positifs. | CurrencyFormatter | ||
requestedLocaleIDName : String [lecture seule]
Nom de l’identificateur de paramètres régionaux requis ayant été transmis au constructeur de cet objet CurrencyFormatter. | CurrencyFormatter | ||
trailingZeros : Boolean
Indique si le montant en devise formaté est suivi de zéros. | CurrencyFormatter | ||
useGrouping : Boolean
Permet l’utilisation du séparateur de groupes lors du formatage des montants en devise. | CurrencyFormatter |
Méthode | Défini par | ||
---|---|---|---|
CurrencyFormatter(requestedLocaleIDName:String)
Construit un nouvel objet CurrencyFormatter pour formater les nombres représentant des montants en devise en fonction des conventions des paramètres régionaux en vigueur. | CurrencyFormatter | ||
Crée une chaîne représentant un montant en devise formaté selon les propriétés actuelles de cet objet CurrencyFormatter, à savoir le jeu de paramètres régionaux, le symbole de devise et le code ISO de la devise. | CurrencyFormatter | ||
Détermine si le symbole de devise actuellement spécifié peut être utilisé lors du formatage des montants en devise. | CurrencyFormatter | ||
[statique]
Répertorie tous les noms des ID de paramètres régionaux pris en charge par cette classe. | CurrencyFormatter | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
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 | ||
Analyse une chaîne en un montant en devise et un symbole de devise. | CurrencyFormatter | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Définit les propriétés currencyISOCode et currencySymbol de l’objet CurrencyFormatter. | CurrencyFormatter | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Renvoie la valeur primitive de l’objet spécifié. | Object |
actualLocaleIDName | propriété |
actualLocaleIDName:String
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Nom de l’identificateur de paramètres régionaux actuel utilisé par cet objet CurrencyFormatter.
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 CurrencyFormatter()
.
- 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
. - Si
LocaleID.DEFAULT
a été utilisée comme valeur pour le paramètrerequestedLocaleIDName
transmis au constructeur, le nom des paramètres régionaux spécifié par le système d’exploitation de l’utilisateur est utilisé. La valeurLocaleID.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ètrerequestedLocaleIDName
ne produit pas nécessairement le même résultat que l’utilisation deLocaleID.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’utiliserLocaleID.DEFAULT
, votre application ne récupérera pas ces paramètres personnalisés. - 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.
Implémentation
public function get actualLocaleIDName():String
Eléments de l’API associés
currencyISOCode | propriété |
currencyISOCode:String
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Les trois lettres du code de devise ISO 4217 correspondant aux paramètres régionaux actuellement spécifiés.
Ce code est utilisé pour déterminer le symbole ou la chaîne de devise lors du formatage des montants en devise à l’aide de la méthode format()
avec le paramètre withCurrencySymbol
défini sur false
.
Cette propriété est initialisée par le constructeur en fonction des paramètres régionaux actuellement spécifiés. En cas d’utilisation de paramètres régionaux par défaut, cette propriété indique le code de devise par défaut correspondant à ces paramètres.
La valeur par défaut est dependent on the actual locale and operating system.
Implémentation
public function get currencyISOCode():String
Eléments de l’API associés
currencySymbol | propriété |
currencySymbol:String
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Chaîne ou symbole de devise correspondant aux paramètres régionaux actuellement spécifiés.
Cette propriété est utilisée en tant que symbole de devise lors du formatage des montants en devise à l’aide de la méthode format()
avec le paramètre withCurrencySymbol
défini sur true
.
Cette propriété est initialisée par le constructeur en fonction des paramètres régionaux actuellement spécifiés. En cas d’utilisation de paramètres régionaux de substitution, cette propriété indique le code de devise par défaut correspondant à ces paramètres.
La valeur par défaut est dependent on the actual locale and operating system.
Implémentation
public function get currencySymbol():String
Eléments de l’API associés
decimalSeparator | propriété |
decimalSeparator:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Séparateur décimal utilisé pour le formatage ou l’analyse des montants en devise à décimales.
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 actual locale and operating system.
Implémentation
public function get decimalSeparator():String
public function set decimalSeparator(value:String):void
Valeur émise
TypeError — si cette propriété se voit attribuer une valeur null.
|
Eléments de l’API associés
digitsType | propriété |
digitsType:uint
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Définit le jeu de caractères numériques utilisé lors du formatage des montants en devise.
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 actual locale and operating system.
Implémentation
public function get digitsType():uint
public function set digitsType(value:uint):void
Valeur émise
TypeError — si cette propriété se voit attribuer une valeur null.
|
Eléments de l’API associés
fractionalDigits | propriété |
fractionalDigits:int
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
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.
Implémentation
public function get fractionalDigits():int
public function set fractionalDigits(value:int):void
Eléments de l’API associés
groupingPattern | propriété |
groupingPattern:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Décrit le placement de séparateurs de groupes au sein de la chaîne de montants en devise 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 montant en devise 123456789.12 avec divers modèles de groupement. Le séparateur de groupes est une virgule, le séparateur décimal est un point et le signe dollar ($) représente le symbole de devise.
Modèle de groupement | Exemple de format |
3;* | $123,456,789.12 |
3;2;* | $12,34,56,789.12 |
3 | $123456,789.12 |
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
.
Implémentation
public function get groupingPattern():String
public function set groupingPattern(value:String):void
Valeur émise
TypeError — si cette propriété se voit attribuer une valeur null.
|
Eléments de l’API associés
groupingSeparator | propriété |
groupingSeparator:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Caractère ou chaîne utilisé(e) pour le séparateur de groupes.
La valeur de cette propriété est utilisée en tant que séparateur de groupes lors du formatage de montants en devise 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 actual locale and operating system.
Implémentation
public function get groupingSeparator():String
public function set groupingSeparator(value:String):void
Valeur émise
TypeError — si cette propriété se voit attribuer une valeur null.
|
Eléments de l’API associés
lastOperationStatus | propriété |
lastOperationStatus:String
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Etat de la dernière opération que cet objet CurrencyFormatter 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.
Implémentation
public function get lastOperationStatus():String
Eléments de l’API associés
leadingZero | propriété |
leadingZero:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Indique si un montant en devise formaté 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 montant en devise 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 montants en devise sont formatés en fonction des valeurs de cette propriété, ainsi que des propriétés fractionalDigits
et trailingZeros
associées.
trailingZeros | leadingZero | fractionalDigits | 0.12 | 0 |
true | true | 3 | $0.120 | $0.000 |
false | true | 3 | $0.12 | $0 |
true | false | 3 | $.120 | $.000 |
false | false | 3 | $.12 | $0 |
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 actual locale and operating system.
Implémentation
public function get leadingZero():Boolean
public function set leadingZero(value:Boolean):void
Valeur émise
TypeError — si cette propriété se voit attribuer une valeur null.
|
Eléments de l’API associés
negativeCurrencyFormat | propriété |
negativeCurrencyFormat:uint
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Valeur numérique qui indique un modèle de formatage pour les montants en devise négatifs. Ce modèle définit l’emplacement du symbole de devise et du symbole négatif ou des parenthèses par rapport à la partie numérique du montant en devise.
La valeur de cette propriété doit être l’une des constantes définies dans le tableau ci-dessous.
Le tableau ci-dessous récapitule les modèles de formatage disponibles pour les montants en devise négatifs. Lorsqu’un montant en devise est formaté avec la méthode format()
:
- Le symbole « ¤ » est remplacé par la valeur de la propriété
currencyISOCode
oucurrencySymbol
, selon la valeur du paramètrewithCurrencySymbol
transmis à la méthodeformat()
; - Le caractère « - » est remplacé par la valeur de la propriété
negativeNumberSymbol
; - Le caractère « n » est remplacé par le montant en devise transmis à la méthode
format()
.
Type de format de devise négatif | Modèle de formatage |
0 | (¤n) |
1 | -¤n |
2 | ¤-n |
3 | ¤n- |
4 | (n¤) |
5 | -n¤ |
6 | n-¤ |
7 | n¤- |
8 | -n ¤ |
9 | -¤ n |
10 | n ¤- |
11 | ¤ n- |
12 | ¤ -n |
13 | n- ¤ |
14 | (¤ n) |
15 | (n ¤) |
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 actual locale and operating system.
Implémentation
public function get negativeCurrencyFormat():uint
public function set negativeCurrencyFormat(value:uint):void
Valeur émise
ArgumentError — si la valeur assignée n’est pas comprise entre 0 et 15.
|
Eléments de l’API associés
negativeSymbol | propriété |
negativeSymbol:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Symbole négatif utilisé lors du formatage des montants en devise négatifs.
Ce symbole est utilisé avec le format de devise négatif lors du formatage d’un montant en devise inférieur à zéro. Il n’est pas utilisé dans des formats de devise négatifs qui n’incluent pas de signe négatif (notamment lorsque des montants en devise négatifs se trouvent entre parenthèses).
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 actual locale and operating system.
Implémentation
public function get negativeSymbol():String
public function set negativeSymbol(value:String):void
Valeur émise
TypeError — si cette propriété se voit attribuer une valeur null.
|
Eléments de l’API associés
positiveCurrencyFormat | propriété |
positiveCurrencyFormat:uint
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Valeur numérique qui indique un modèle de formatage pour les montants en devise positifs. Ce format définit l’emplacement du symbole de devise par rapport à la partie numérique du montant en devise.
La valeur de cette propriété doit être l’une des constantes définies dans le tableau ci-dessous.
Le tableau ci-dessous récapitule les modèles de formatage disponibles pour les montants en devise positifs. Lorsqu’un montant en devise est formaté avec la méthode format()
:
- Le symbole « ¤ » est remplacé par la valeur de la propriété
currencyISOCode
oucurrencySymbol
, selon la valeur du paramètrewithCurrencySymbol
transmis à la méthodeformat()
; - Le caractère « n » est remplacé par le montant en devise transmis à la méthode
format()
.
Type de format de devise positif | Modèle de formatage |
0 | ¤n |
1 | n¤ |
2 | ¤ n |
3 | n ¤ |
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 actual locale and operating system.
Implémentation
public function get positiveCurrencyFormat():uint
public function set positiveCurrencyFormat(value:uint):void
Valeur émise
ArgumentError — si la valeur assignée n’est pas comprise entre 0 et 3.
|
Eléments de l’API associés
requestedLocaleIDName | propriété |
requestedLocaleIDName:String
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Nom de l’identificateur de paramètres régionaux requis ayant été transmis au constructeur de cet objet CurrencyFormatter.
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
.
Implémentation
public function get requestedLocaleIDName():String
Eléments de l’API associés
trailingZeros | propriété |
trailingZeros:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Indique si le montant en devise formaté est suivi 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 le montant en devise 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 des 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 (différents de zéro), comme suit : $123.4
.
Le tableau ci-dessous présente des exemples sur la façon dont les montants en devise sont formatés en fonction des valeurs de cette propriété, ainsi que des propriétés fractionalDigits
et leadingZero
associées.
trailingZeros | leadingZero | fractionalDigits | 0.12 | 0 |
true | true | 3 | $0.120 | $0.000 |
false | true | 3 | $0.12 | $0 |
true | false | 3 | $.120 | $.000 |
false | false | 3 | $.12 | $0 |
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 actual locale and operating system.
Implémentation
public function get trailingZeros():Boolean
public function set trailingZeros(value:Boolean):void
Valeur émise
TypeError — si cette propriété se voit attribuer une valeur null.
|
Eléments de l’API associés
useGrouping | propriété |
useGrouping:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Permet l’utilisation du séparateur de groupes lors du formatage des montants en devise.
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
Lorsque la propriété useGrouping
est définie sur false
, les chiffres ne sont ni groupés ni séparés. Par exemple : $123456789
La propriété groupingSeparator
définit le symbole à utiliser en tant que séparateur de groupes. La propriété groupingPattern
définit le nombre de chiffres entre les séparateurs de groupes.
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
.
Implémentation
public function get useGrouping():Boolean
public function set useGrouping(value:Boolean):void
Eléments de l’API associés
CurrencyFormatter | () | Constructeur |
public function CurrencyFormatter(requestedLocaleIDName:String)
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Construit un nouvel objet CurrencyFormatter pour formater les nombres représentant des montants en devise en fonction des conventions des paramètres régionaux en vigueur.
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. Si des paramètres régionaux de substitution sont utilisés, la propriété lastOperationStatus
indique le type de paramètres de substitution, et la propriété actualLocaleIDName
contient le nom de ces paramètres.
Certaines propriétés, telles que currencySymbol
et currencyISOCode
, sont automatiquement définies en fonction des paramètres régionaux.
REMARQUE : en cas d’utilisation d’un jeu de paramètres régionaux de substitution, les propriétés de devise sont définies sur des valeurs par défaut. Par conséquent, il est possible que la propriété currencySymbol
ou currencyISOCode
se voit attribuer des valeurs inattendues. Il est conseillé d’examiner les valeurs des propriétés currencySymbol
et currencyISOCode
avant de formater un montant en devise.
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 est appelé et que l’appel aboutit, 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
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
.
requestedLocaleIDName:String — Nom de l’identificateur de paramètres régionaux à utiliser lors de la spécification des formats de date ou d’heure.
|
Valeur émise
TypeError — si le paramètre requestedLocaleIDName est null .
|
Eléments de l’API associés
format | () | méthode |
public function format(value:Number, withCurrencySymbol:Boolean = false):String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Crée une chaîne représentant un montant en devise formaté selon les propriétés actuelles de cet objet CurrencyFormatter, à savoir le jeu de paramètres régionaux, le symbole de devise et le code ISO de la devise.
Par défaut, cette méthode a recours à la propriété currencyISOCode
pour déterminer le symbole de devise et d’autres paramètres utilisés lors du formatage.
De nombreux pays et régions utilisent les mêmes symboles de devise pour différentes devises. Par exemple, les Etats-Unis, l’Australie, la Nouvelle-Zélande, le Canada et le Mexique utilisent tous le même symbole du dollar ($) pour différentes valeurs monétaires. Lorsque la devise de formatage diffère de la devise locale de l’utilisateur, il est préférable d’utiliser le code ISO comme chaîne de devise. Vous pouvez utiliser la méthode formattingWithCurrencySymbolIsSafe()
pour vérifier si le code ISO de la devise à formater correspond à la propriété currencyISOCode
du formateur.
Cette méthode permet de formater les nombres de grandes et de petites amplitudes. Cependant, le nombre de chiffres est limité à la précision fournie par le type de données de l’objet Number.
Paramètres
value:Number — Valeur numérique devant être formatée dans une chaîne de devise.
| |
withCurrencySymbol:Boolean (default = false ) — Lorsqu’elle est définie sur false, la propriété currencyISOCode détermine la chaîne de devise ou le symbole de devise à utiliser dans la chaîne de sortie. Lorsqu’elle est définie sur true, la valeur actuelle de la propriété currencySymbol est utilisée dans la chaîne de sortie.
|
String — Chaîne contenant la valeur monétaire formatée.
|
Eléments de l’API associés
currencyISOCode
formattingWithCurrencySymbolIsSafe()
lastOperationStatus
LastOperationStatus
Exemple ( Comment utiliser cet exemple )
withCurrencySymbol
est défini sur true, la propriété currencySymbol
est utilisée pour formater le montant en devise.
var cf:CurrencyFormatter = new CurrencyFormatter("fr-CA"); trace(cf.actualLocaleIDName); // "fr-CA" trace(cf.currencyISOCode); // "CAD" trace(cf.currencySymbol); // "$" trace(cf.format(1254.56)); // "1 254,56 CAD" trace(cf.format(1254.56, true)); // "1 254,56 $"
Le deuxième exemple présente une méthode de formatage d’un montant en devise en dollars canadiens à l’aide des paramètres régionaux par défaut. La méthode formattingWithCurrencySymbolIsSafe()
permet de vérifier si la devise par défaut est le dollar canadien ; si tel est le cas, la méthode de formatage est utilisée avec le paramètre withCurrencySymbol
défini sur true. Dans le cas contraire, la devise est définie sur Dollars canadiens avec un symbole de devise plus descriptif. L’exemple suivant montre la façon dont serait formatée la devise si les paramètres régionaux par défaut étaient soit Français (Canada) soit Anglais (Etats-Unis).
var cf:CurrencyFormatter = new CurrencyFormatter(LocaleID.DEFAULT); if (cf.formattingWithCurrencySymbolIsSafe("CAD")) { trace(cf.actualLocaleIDName); // "fr-CA French (Canada)" trace(cf.format(1254.56, false)); // "1 254,56 $" } else { trace(cf.actualLocaleIDName); // "en-US English (USA)" cf.setCurrency("CAD", "C$") trace(cf.format(1254.56, true)); // "C$ 1,254.56" }
formattingWithCurrencySymbolIsSafe | () | méthode |
public function formattingWithCurrencySymbolIsSafe(requestedISOCode:String):Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Détermine si le symbole de devise actuellement spécifié peut être utilisé lors du formatage des montants en devise.
De nombreux pays et régions utilisent les mêmes symboles de devise. Il est possible d’utiliser cette méthode pour empêcher l’utilisation d’un symbole de devise ambigu, ou d’un symbole de devise ou d’un code ISO différent de celui attendu en raison de l’utilisation de paramètres régionaux par défaut.
Cette méthode est généralement utilisée pour déterminer s’il est nécessaire ou non d’afficher un symbole de devise local (si le montant est formaté en fonction de la devise par défaut de l’utilisateur) ou une chaîne de code ISO plus spécifique (si le montant est formaté en fonction d’une devise différente de la devise par défaut de l’utilisateur).
Cette méthode compare le paramètre requestedISOCode
à la propriété currencyISOCode
actuelle, et renvoie true
si les chaînes sont égales ou false
si elles ne sont pas. Lorsque les chaînes sont égales, si vous utilisez la méthode format()
avec le paramètre withCurrencySymbol
défini sur true
, vous obtenez une chaîne de valeurs monétaires formatée à l’aide d’un symbole de devise unique pour les paramètres régionaux. Si cette méthode renvoie false, le recours à la méthode format()
avec le paramètre withCurrencySymbol
défini sur true peut entraîner l’utilisation d’un symbole de devise incorrect ou ambigu.
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
requestedISOCode:String — Code de devise ISO 4217 de trois lettres (par exemple, USD pour dollars américains, EUR pour euros, etc.). Doit contenir trois lettres en majuscules, de A à Z.
|
Boolean — true si la propriété currencyISOCode correspond au paramètre requestedISOCode ; false dans le cas contraire.
|
Valeur émise
TypeError — si le paramètre requestedISOCode est null.
|
Eléments de l’API associés
getAvailableLocaleIDNames | () | méthode |
public static function getAvailableLocaleIDNames():Vector.<String>
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
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
.
Vector.<String> — Vecteur de chaînes contenant tous les noms des identificateurs de paramètres régionaux pris en charge par cette classe.
|
parse | () | méthode |
public function parse(inputString:String):CurrencyParseResult
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Analyse une chaîne en un montant en devise et un symbole de devise.
L’algorithme d’analyse utilise la valeur de la propriété decimalSeparator
pour déterminer la partie intégrale et fractionnaire du nombre. Il utilise les valeurs des propriétés negativeCurrencyFormat
et positiveCurrencyFormat
pour déterminer l’emplacement du symbole ou de la chaîne de devise par rapport au montant en devise. En cas de montants négatifs, la valeur de la propriété negativeCurrencyFormat
détermine l’emplacement du symbole négatif et indique si des parenthèses sont utilisées.
Si l’ordre du symbole de devise, le signe moins et le nombre dans la chaîne saisie ne correspondent pas au modèle identifié par les propriétés negativeCurrencyFormat
et positiveCurrencyFormat
, alors :
- La propriété
value
de l’objet CurrencyParseResult renvoyé est définie surNaN
. - La propriété
currencyString
de l’objet CurrencyParseResult renvoyé est définie surnull
. - La propriété
lastOperationStatus
est définie pour indiquer que l’analyse a échoué.
La chaîne saisie peut comporter des espaces, qui sont ignorés durant l’analyse.
L’analyse peut aboutir même en cas d’absence de symbole de devise. La partie de la chaîne correspondant au symbole de devise n’est pas validée. En cas d’absence de chaîne ou de symbole de devise, la propriété currencyString
de l’objet CurrencyParseResult renvoyé est définie sur une chaîne vide.
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
inputString:String — Chaîne d’entrée à analyser.
|
CurrencyParseResult — Objet CurrencyParseResult contenant la valeur numérique et le symbole ou la chaîne de devise.
|
Valeur émise
TypeError — si le paramètre inputString est null.
|
Eléments de l’API associés
setCurrency | () | méthode |
public function setCurrency(currencyISOCode:String, currencySymbol:String):void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10.1, AIR 2 |
Définit les propriétés currencyISOCode
et currencySymbol
de l’objet CurrencyFormatter.
Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus
est définie sur :
LastOperationStatus.NO_ERROR
Dans le cas contraire, les propriétés currencyISOCode
et currencySymbol
ne sont pas modifiées, et la propriété lastOperationStatus
est définie sur l’une des constantes définies dans la classe LastOperationStatus
.
Paramètres
currencyISOCode:String — Code de devise ISO 4217 de trois lettres (par exemple, USD pour dollars américains, EUR pour euros, etc.). Doit contenir trois lettres en majuscules, de A à Z.
| |
currencySymbol:String — Chaîne ou symbole de devise à utiliser lors du formatage des valeurs monétaires. Il peut s’agir d’une chaîne vide.
|
Valeur émise
TypeError — si le paramètre currencyISOCode ou currencySymbol est null.
|
Eléments de l’API associés
Cet exemple utilise les paramètres régionaux suivants :
- Jeu de paramètres régionaux par défaut du système d’exploitation pour le formatage des devises (
LocaleID.DEFAULT
) - Japonais (Japon)
- Anglais (Etats-Unis)
- Français (France)
Cet exemple effectue les opérations suivantes pour chaque jeu de paramètres régionaux dans la liste :
- Crée un objet CurrencyFormatter.
- Utilise la méthode
formattingWithCurrencySymbolIsSafe()
pour vérifier si la devise par défaut correspondant au jeu de paramètres régionaux est euros (« EUR ») et, si tel est le cas, formate la chaîne en utilisant le symbole de devise. Dans le cas contraire, la chaîne est formatée à l’aide du code ISO.
package { import flash.display.Sprite; import flash.globalization.CurrencyFormatter; import flash.globalization.LocaleID; public class CurrencyFormatterExample1 extends Sprite { public function CurrencyFormatterExample1():void { var cf:CurrencyFormatter; var amountWithSymbol:String; var amountWithISOCode:String var localeNames:Array = [LocaleID.DEFAULT, "ja-JP", "en-US", "fr-FR"]; for each (var localeName:String in localeNames) { cf = new CurrencyFormatter(localeName); trace('\n' + "LocaleID requested=" + cf.requestedLocaleIDName + "; actual=" + cf.actualLocaleIDName); trace("Last Operation Status: " + cf.lastOperationStatus ); trace("Currency ISO Code: " + cf.currencyISOCode); if (cf.formattingWithCurrencySymbolIsSafe("EUR")) { amountWithSymbol = cf.format(123456789.19, true); trace("Format using Symbol: "+ amountWithSymbol); } else { amountWithISOCode = cf.format(123456789.19); trace("Format using ISO Code: " + amountWithISOCode); } } } } }
Cet exemple suit la procédure ci-dessous :
- Crée un objet CurrencyFormatter pour le jeu de paramètres régionaux Anglais (Etats-Unis).
- Utilise la méthode
parse()
pour analyser la chaîne d’entrée. - Affiche les valeurs des chaînes de montant et devise de l’objet CurrencyParseResult résultant.
package { import flash.display.Sprite; import flash.globalization.CurrencyFormatter; import flash.globalization.CurrencyParseResult; import flash.globalization.LastOperationStatus; import flash.globalization.LocaleID; public class CurrencyFormatterParseExample extends Sprite { public function CurrencyFormatterParseExample() { var cf:CurrencyFormatter = new CurrencyFormatter( "en_US" ); trace("LocaleID requested=" + cf.requestedLocaleIDName + "; actual=" + cf.actualLocaleIDName); trace("Last Operation Status: " + cf.lastOperationStatus ); var inputString:String = "Dollar 123,567,89,0.254"; var result:CurrencyParseResult = cf.parse(inputString); if (cf.lastOperationStatus == LastOperationStatus.NO_ERROR ) { trace("Amount value: " + result.value); trace("Currency string: " + result.currencyString); } } } }
Tue Jun 12 2018, 09:30 AM Z