| Package | mx.formatters |
| Classe | public class CurrencyFormatter |
| Héritage | CurrencyFormatter  Formatter Object |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
 | A partir de Flex 4.5, Adobe vous recommande d’utiliser la classe spark.formatters.CurrencyFormatter comme alternative à cette classe. |
La classe CurrencyFormatter formate un nombre valide sous forme de valeur monétaire. Elle ajuste l’arrondi et la précision des nombres décimaux, le séparateur des milliers et le signe négatif, et ajoute un symbole de devise. Vous pouvez placer le symbole de devise à gauche ou à droite de la valeur par le biais de la propriété
alignSymbol. Le symbole de devise peut contenir plusieurs caractères, y compris des espaces.
Si une erreur se produit, une chaîne vide est renvoyée et une chaîne décrivant l’erreur est enregistrée dans la propriété error. La propriété error peut prendre l’une des valeurs suivantes :
-
"Invalid value"signifie qu’une valeur numérique non valide a été transmise à la méthodeformat(). La valeur doit être un nombre valide sous forme de nombre ou de chaîne. -
"Invalid format"signifie que l’un des paramètres contient une valeur inutilisable.
Afficher la syntaxe MXML
Masquer la syntaxe MXMLThe <mx:CurrencyFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:CurrencyFormatter
alignSymbol="left|right"
currencySymbol="$"
decimalSeparatorFrom="."
decimalSeparatorTo="."
precision="-1"
rounding="none|up|down|nearest"
thousandsSeparatorFrom=","
thousandsSeparatorTo=","
useNegativeSign="true|false"
useThousandsSeparator="true|false"
/>
Eléments de l’API associés
| Propriété | Défini par | ||
|---|---|---|---|
| alignSymbol : String
Place le symbole de devise à gauche ou à droite du nombre formaté. | CurrencyFormatter | ||
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| currencySymbol : String
Caractère à utiliser comme symbole de devise pour un nombre formaté. | CurrencyFormatter | ||
| decimalSeparatorFrom : String
Séparateur décimal à utiliser lors de l’analyse d’une chaîne d’entrée. | CurrencyFormatter | ||
| decimalSeparatorTo : String
Séparateur décimal à utiliser lors de la génération des nombres décimaux formatés. | CurrencyFormatter | ||
| error : String
Description enregistrée par la classe de formatage lorsqu’une erreur survient. | Formatter | |
| precision : Object
Nombre de décimales à inclure dans la chaîne de sortie. | CurrencyFormatter | ||
| rounding : String
Mode d’arrondi. | CurrencyFormatter | ||
| thousandsSeparatorFrom : String
Caractère à utiliser comme séparateur des milliers dans la chaîne d’entrée. | CurrencyFormatter | ||
| thousandsSeparatorTo : String
Caractère à utiliser comme séparateur des milliers dans la chaîne de sortie. | CurrencyFormatter | ||
| useNegativeSign : Object
Si la valeur est true, un signe « - » est placé devant les nombres négatifs. | CurrencyFormatter | ||
| useThousandsSeparator : Object
Si la valeur est true, le nombre est séparé en incréments de milliers par un caractère de séparation. | CurrencyFormatter | ||
| Méthode | Défini par | ||
|---|---|---|---|
Constructeur. | CurrencyFormatter | ||
[override]
Formate la valeur sous forme de devise. | 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 | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
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 | |
alignSymbol | propriété |
alignSymbol:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Place le symbole de devise à gauche ou à droite du nombre formaté. Valeurs autorisées: "left" et "right".
La valeur par défaut est "left".
Implémentation
public function get alignSymbol():String public function set alignSymbol(value:String):voidcurrencySymbol | propriété |
currencySymbol:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Caractère à utiliser comme symbole de devise pour un nombre formaté. Vous pouvez utiliser un ou plusieurs caractères pour représenter le symbole de devise, par exemple « $ » ou « YEN ». Vous pouvez également utiliser des espaces vides pour ajouter des espaces entre le caractère de devise et le nombre mis formaté. Lorsque le nombre est une valeur négative, le symbole de devise est placé entre le nombre et le signe moins, ou entre parenthèses.
La valeur par défaut est "$".
Implémentation
public function get currencySymbol():String public function set currencySymbol(value:String):voiddecimalSeparatorFrom | propriété |
decimalSeparatorFrom:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Séparateur décimal à utiliser lors de l’analyse d’une chaîne d’entrée.
La valeur par défaut est ".".
Implémentation
public function get decimalSeparatorFrom():String public function set decimalSeparatorFrom(value:String):voiddecimalSeparatorTo | propriété |
decimalSeparatorTo:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Séparateur décimal à utiliser lors de la génération des nombres décimaux formatés.
La valeur par défaut est ".".
Implémentation
public function get decimalSeparatorTo():String public function set decimalSeparatorTo(value:String):voidprecision | propriété |
precision:Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Nombre de décimales à inclure dans la chaîne de sortie. Vous pouvez désactiver la précision en utilisant la valeur -1. La valeur -1 indique que la précision ne doit pas être modifiée. Par exemple, si la valeur d’entrée est 1,453 et que la valeur de rounding est NumberBaseRoundType.NONE, la valeur renvoyée est 1,453. Si la valeur de la propriété precision est -1 et que vous avez défini un arrondi, la valeur renvoyée dépend de ce type d’arrondi.
La valeur par défaut est -1.
Implémentation
public function get precision():Object public function set precision(value:Object):voidrounding | propriété |
rounding:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Mode d’arrondi. Dans le langage ActionScript, la valeur peut être NumberBaseRoundType.NONE, NumberBaseRoundType.UP, NumberBaseRoundType.DOWN ou NumberBaseRoundType.NEAREST. Dans le langage MXML, la valeur peut être "none", "up", "down" ou "nearest".
La valeur par défaut est NumberBaseRoundType.NONE.
Implémentation
public function get rounding():String public function set rounding(value:String):voidEléments de l’API associés
thousandsSeparatorFrom | propriété |
thousandsSeparatorFrom:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Caractère à utiliser comme séparateur des milliers dans la chaîne d’entrée.
La valeur par défaut est ",".
Implémentation
public function get thousandsSeparatorFrom():String public function set thousandsSeparatorFrom(value:String):voidthousandsSeparatorTo | propriété |
thousandsSeparatorTo:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Caractère à utiliser comme séparateur des milliers dans la chaîne de sortie.
La valeur par défaut est ",".
Implémentation
public function get thousandsSeparatorTo():String public function set thousandsSeparatorTo(value:String):voiduseNegativeSign | propriété |
useNegativeSign:Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si la valeur est true, un signe « - » est placé devant les nombres négatifs. Si la valeur est false, des parenthèses sont placées autour du nombre, par exemple (400).
La valeur par défaut est true.
Implémentation
public function get useNegativeSign():Object public function set useNegativeSign(value:Object):voiduseThousandsSeparator | propriété |
useThousandsSeparator:Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si la valeur est true, le nombre est séparé en incréments de milliers par un caractère de séparation.
La valeur par défaut est true.
Implémentation
public function get useThousandsSeparator():Object public function set useThousandsSeparator(value:Object):voidCurrencyFormatter | () | Constructeur |
public function CurrencyFormatter()| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Constructeur.
format | () | méthode |
override public function format(value:Object):String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Formate la valeur value sous forme de devise. Si la valeur value ne peut pas être formatée, une chaîne vide est renvoyée et une description de l’erreur est écrite dans la propriété error.
Paramètres
value:Object — Valeur à formater.
|
String — Chaîne formatée. Vide si une erreur se produit.
|
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CurrencyFormatter. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Script>
<![CDATA[
import mx.events.ValidationResultEvent;
private var vResult:ValidationResultEvent;
// Event handler to validate and format input.
private function Format():void {
vResult = numVal.validate();
if (vResult.type==ValidationResultEvent.VALID) {
var temp:Number = Number(priceUS.text);
formattedUSPrice.text = usdFormatter.format(temp);
} else {
formattedUSPrice.text = "";
}
}
]]>
</fx:Script>
<fx:Declarations>
<mx:CurrencyFormatter id="usdFormatter" precision="2"
currencySymbol="$" decimalSeparatorFrom="."
decimalSeparatorTo="." useNegativeSign="true"
useThousandsSeparator="true" alignSymbol="left"/>
<mx:NumberValidator id="numVal" source="{priceUS}" property="text"
allowNegative="true" domain="real"/>
</fx:Declarations>
<s:Panel title="CurrencyFormatter Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter U.S. dollar amount:">
<s:TextInput id="priceUS" text="" width="50%"/>
</mx:FormItem>
<mx:FormItem label="Formatted amount: ">
<s:TextInput id="formattedUSPrice" text="" width="50%" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<s:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 09:30 AM Z