(Preview)
Package | mx.formatters |
Class | public class NumberFormatter |
Inheritance | NumberFormatter ![]() ![]() |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
![]() | Starting with Flex 4.5, Adobe recommends that you use the spark.formatters.NumberFormatter class as an alternative to this class. |
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 theformat()
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.

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"/>
More examples
Formatting Data
MX formatters
Writing an error handler function for an MX formatter
Formatting numbers with an MX formatter
MX formatters
Writing an error handler function for an MX formatter
Formatting numbers with an MX formatter
Related API Elements
Public Properties
Property | Defined By | ||
---|---|---|---|
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object |
Protected Properties
Public Methods
Method | Defined By | ||
---|---|---|---|
![]() |
Indicates whether an object has a specified property defined. | Object | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
![]() |
Indicates whether the specified property exists and is enumerable. | Object | |
![]() |
Sets the availability of a dynamic property for loop operations. | Object | |
![]() |
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
![]() |
Returns the string representation of the specified object. | Object | |
![]() |
Returns the primitive value of the specified object. | Object |
Protected Methods
Property Detail
Constructor Detail
Method Detail
Examples How to use this example
NumberFormatterExample.mxml
<?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>
Wed Nov 21 2018, 06:34 AM -08:00