CurrencyFormatter

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éthode format(). 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.

Syntaxe MXML expanded

Masquer la syntaxe MXML

The <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"
 />

Consulter les exemples

Eléments de l’API associés

mx.formatters.NumberBase
mx.formatters.NumberBaseRoundType

Propriétés publiques

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

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

	Propriété		Défini par
		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

Propriétés protégées

Masquer les propriétés protégées héritées

Afficher les propriétés protégées héritées

	Propriété		Défini par
		resourceManager : IResourceManager [lecture seule] Référence à l’objet qui gère toutes les ressources localisées de l’application.	Formatter

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		CurrencyFormatter() Constructeur.	CurrencyFormatter
		format(value:Object):String [override] Formate la valeur sous forme de devise.	CurrencyFormatter
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.	Object
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object

Méthodes protégées

Masquer les méthodes protégées héritées

Afficher les méthodes protégées héritées

	Méthode		Défini par
		resourcesChanged():void Cette méthode est appelée lors de la construction d’une classe Formatter, puis chaque fois que ResourceManager envoie un événement "change" pour indiquer que les ressources localisées ont subi une modification.	Formatter

Détails de la propriété

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):void

currencySymbol

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):void

decimalSeparatorFrom

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):void

decimalSeparatorTo

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):void

precision

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):void

rounding

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):void

Eléments de l’API associés

mx.formatters.NumberBaseRoundType

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):void

thousandsSeparatorTo

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):void

useNegativeSign

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):void

useThousandsSeparator

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):void

Détails du constructeur

()

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.

Détails de la méthode

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.

Valeur renvoyée

String — Chaîne formatée. Vide si une erreur se produit.

Exemples Comment utiliser cet exemple

CurrencyFormatterExample.mxml

<?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>

Informations juridiques | Politique de confidentialité en ligne

CurrencyFormatter - AS3 Flex

Packagesx

Eléments du langage

Annexes

Package mx.formatters

alignSymbol

currencySymbol

decimalSeparatorFrom

decimalSeparatorTo

precision

rounding

thousandsSeparatorFrom

thousandsSeparatorTo

useNegativeSign

useThousandsSeparator

CurrencyFormatter

format