| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The NumberFormatter class formats a valid number
by adjusting the decimal rounding and precision,
the thousands separator, and the negative sign.
If you use both the rounding and precision
properties, rounding is applied first, and then you set the decimal length
by using the specified precision value.
This lets you round a number and still have a trailing decimal;
for example, 303.99 = 304.00.
If an error occurs, an empty String is returned and a String
describing the error is saved to the error property.
The error property can have one of the following values:
-
"Invalid value" means an invalid numeric value is passed to
the format() method. The value should be a valid number in the
form of a Number or a String.
-
"Invalid format" means one of the parameters
contain an unusable setting.
Show MXML Syntax
Hide MXML Syntax
The <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"/>
decimalSeparatorFrom:String| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Decimal separator character to use
when parsing an input String.
When setting this property, ensure that the value of the
thousandsSeparatorFrom property does not equal this property.
Otherwise, an error occurs when formatting the value.
The default value is ".".
Implementation public function get decimalSeparatorFrom():String public function set decimalSeparatorFrom(value:String):voidSee also
decimalSeparatorTo:String| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Decimal separator character to use
when outputting formatted decimal numbers.
When setting this property, ensure that the value of the
thousandsSeparatorTo property does not equal this property.
Otherwise, an error occurs when formatting the value.
The default value is ".".
Implementation public function get decimalSeparatorTo():String public function set decimalSeparatorTo(value:String):voidSee also
precision:Object| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Number of decimal places to include in the output String.
You can disable precision by setting it to -1.
A value of -1 means do not change the precision. For example,
if the input value is 1.453 and rounding
is set to NumberBaseRoundType.NONE, return a value of 1.453.
If precision is -1 and you have set some form of
rounding, return a value based on that rounding type.
The default value is -1.
Implementation public function get precision():Object public function set precision(value:Object):voidrounding:String| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies how to round the number.
In ActionScript, you can use the following constants to set this property:
NumberBaseRoundType.NONE, NumberBaseRoundType.UP,
NumberBaseRoundType.DOWN, or NumberBaseRoundType.NEAREST.
Valid MXML values are "down", "nearest", "up", and "none".
The default value is NumberBaseRoundType.NONE.
Implementation public function get rounding():String public function set rounding(value:String):voidSee also
thousandsSeparatorFrom:String| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Character to use as the thousands separator
in the input String.
When setting this property, ensure that the value of the
decimalSeparatorFrom property does not equal this property.
Otherwise, an error occurs when formatting the value.
The default value is ",".
Implementation public function get thousandsSeparatorFrom():String public function set thousandsSeparatorFrom(value:String):voidSee also
thousandsSeparatorTo:String| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Character to use as the thousands separator
in the output String.
When setting this property, ensure that the value of the
decimalSeparatorTo property does not equal this property.
Otherwise, an error occurs when formatting the value.
The default value is ",".
Implementation public function get thousandsSeparatorTo():String public function set thousandsSeparatorTo(value:String):voidSee also
useNegativeSign:Object| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
If true, format a negative number
by preceding it with a minus "-" sign.
If false, format the number
surrounded by parentheses, for example (400).
The default value is true.
Implementation public function get useNegativeSign():Object public function set useNegativeSign(value:Object):voiduseThousandsSeparator:Object| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
If true, split the number into thousands increments
by using a separator character.
The default value is true.
Implementation public function get useThousandsSeparator():Object public function set useThousandsSeparator(value:Object):voidpublic function NumberFormatter()| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
override public function format(value:Object):String| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Formats the number as a String.
If value cannot be formatted, return an empty String
and write a description of the error to the error property.
Parameters
| value:Object — Value to format.
|
Returns | String — Formatted String. Empty if an error occurs.
|
Mon Dec 24 2012, 01:18 PM +11:00 
Formatter 
