| Package | mx.formatters |
| Classe | public class NumberFormatter |
| Héritage | NumberFormatter  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.NumberFormatter comme alternative à cette classe. |
La classe NumberFormatter formate un nombre valide en ajustant l’arrondi et la précision des nombres décimaux, le séparateur des milliers et le signe négatif.
Si vous utilisez simultanément les propriétés rounding et precision, l’arrondi est appliqué en premier et le nombre de décimales peut ensuite être défini par le biais de la valeur precision. Vous pouvez ainsi arrondir un nombre et conserver quand même des décimales. Exemple : 303,99 = 304,00.
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:NumberFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:NumberFormatter
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 | ||
|---|---|---|---|
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| decimalSeparatorFrom : String
Séparateur décimal à utiliser lors de l’analyse d’une chaîne d’entrée. | NumberFormatter | ||
| decimalSeparatorTo : String
Séparateur décimal à utiliser lors de la génération des nombres décimaux formatés. | NumberFormatter | ||
| 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. | NumberFormatter | ||
| rounding : String
Spécifie comment arrondir le nombre. | NumberFormatter | ||
| thousandsSeparatorFrom : String
Caractère à utiliser comme séparateur des milliers dans la chaîne d’entrée. | NumberFormatter | ||
| thousandsSeparatorTo : String
Caractère à utiliser comme séparateur des milliers dans la chaîne de sortie. | NumberFormatter | ||
| useNegativeSign : Object
Si la valeur est true, un signe « - » est placé devant les nombres négatifs. | NumberFormatter | ||
| useThousandsSeparator : Object
Si la valeur est true, le nombre est séparé en incréments de milliers par un caractère de séparation. | NumberFormatter | ||
| Méthode | Défini par | ||
|---|---|---|---|
Constructeur. | NumberFormatter | ||
[override]
Formate le nombre sous forme de chaîne. | NumberFormatter | ||
|
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 | |
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.
Lorsque vous définissez la valeur de cette propriété, faites en sorte qu’elle ne soit pas identique à la valeur de la propriété thousandsSeparatorFrom. Si les valeurs sont identiques, une erreur se produit lors du formatage de la valeur.
La valeur par défaut est ".".
Implémentation
public function get decimalSeparatorFrom():String public function set decimalSeparatorFrom(value:String):voidEléments de l’API associés
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.
Lorsque vous définissez la valeur de cette propriété, faites en sorte qu’elle ne soit pas identique à la valeur de la propriété thousandsSeparatorTo. Si les valeurs sont identiques, une erreur se produit lors du formatage de la valeur.
La valeur par défaut est ".".
Implémentation
public function get decimalSeparatorTo():String public function set decimalSeparatorTo(value:String):voidEléments de l’API associés
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):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 |
Spécifie comment arrondir le nombre.
Dans le langage ActionScript, vous pouvez utiliser les constantes suivantes pour définir cette propriété : NumberBaseRoundType.NONE, NumberBaseRoundType.UP, NumberBaseRoundType.DOWN ou NumberBaseRoundType.NEAREST. Les valeurs MXML valides sont "down", "nearest", "up" et "none".
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.
Lorsque vous définissez la valeur de cette propriété, faites en sorte qu’elle ne soit pas identique à la valeur de la propriété decimalSeparatorFrom. Si les valeurs sont identiques, une erreur se produit lors du formatage de la valeur.
La valeur par défaut est ",".
Implémentation
public function get thousandsSeparatorFrom():String public function set thousandsSeparatorFrom(value:String):voidEléments de l’API associés
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.
Lorsque vous définissez la valeur de cette propriété, faites en sorte qu’elle ne soit pas identique à la valeur de la propriété decimalSeparatorTo. Si les valeurs sont identiques, une erreur se produit lors du formatage de la valeur.
La valeur par défaut est ",".
Implémentation
public function get thousandsSeparatorTo():String public function set thousandsSeparatorTo(value:String):voidEléments de l’API associés
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):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):voidNumberFormatter | () | Constructeur |
public function NumberFormatter()| 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 le nombre sous forme de chaîne. 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 NumberFormatter. -->
<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) {
formattedNumber.text = numberFormatter.format(inputVal.text);
} else {
formattedNumber.text = "";
}
}
]]>
</fx:Script>
<fx:Declarations>
<mx:NumberFormatter id="numberFormatter" precision="4"
useThousandsSeparator="true" useNegativeSign="true"/>
<mx:NumberValidator id="numVal" source="{inputVal}" property="text"
allowNegative="true" domain="real"/>
</fx:Declarations>
<s:Panel title="NumberFormatter Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter number:">
<s:TextInput id="inputVal" text="" width="50%"/>
</mx:FormItem>
<mx:FormItem label="Formatted number (precision=4): ">
<s:TextInput id="formattedNumber" editable="false" width="50%"/>
</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