| Package | mx.formatters |
| Class | public class CurrencyFormatter |
| Inheritance | CurrencyFormatter  Formatter Object |
alignSymbol property.
The currency symbol can contain multiple characters,
including blank spaces.
If an error occurs, an empty String is returned and a String that describes
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 contains an unusable setting.
Hide MXML Syntax
The <mx:CurrencyFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
Show MXML Syntax
<mx:CurrencyFormatter
alignSymbol="left|right"
currencySymbol="$"
decimalSeparatorFrom="."
decimalSeparatorTo="."
precision="-1"
rounding="none|up|down|nearest"
thousandsSeparatorFrom=","
thousandsSeparatorTo=","
useNegativeSign="true|false"
useThousandsSeparator="true|false"
/>
See also
| Property | Defined by | ||
|---|---|---|---|
| alignSymbol : String
Aligns currency symbol to the left side or the right side
of the formatted number.
| CurrencyFormatter | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| currencySymbol : String
Character to use as a currency symbol for a formatted number.
| CurrencyFormatter | ||
| decimalSeparatorFrom : String
Decimal separator character to use
when parsing an input string.
| CurrencyFormatter | ||
| decimalSeparatorTo : String
Decimal separator character to use
when outputting formatted decimal numbers.
| CurrencyFormatter | ||
| error : String
Description saved by the formatter when an error occurs.
| Formatter | |
| precision : int
Number of decimal places to include in the output String.
| CurrencyFormatter | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| rounding : String
How to round the number.
| CurrencyFormatter | ||
| thousandsSeparatorFrom : String
Character to use as the thousands separator
in the input String.
| CurrencyFormatter | ||
| thousandsSeparatorTo : String
Character to use as the thousands separator
in the output string.
| CurrencyFormatter | ||
| useNegativeSign : Boolean
If
true, format a negative number
by preceding it with a minus "-" sign. | CurrencyFormatter | ||
| useThousandsSeparator : Boolean
If
true, split the number into thousands increments
by using a separator character. | CurrencyFormatter | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| CurrencyFormatter | ||
|
Formats
value as currency. | CurrencyFormatter | ||
|
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 the specified object.
| Object | |
|
Returns the primitive value of the specified object.
| Object | |
| alignSymbol | property |
public var alignSymbol:String
Aligns currency symbol to the left side or the right side
of the formatted number.
Permitted values are "left" and "right".
The default value is "left".
| currencySymbol | property |
public var currencySymbol:StringCharacter to use as a currency symbol for a formatted number. You can use one or more characters to represent the currency symbol; for example, "$" or "YEN". You can also use empty spaces to add space between the currency character and the formatted number. When the number is a negative value, the currency symbol appears between the number and the minus sign or parentheses.
The default value is "$".
| decimalSeparatorFrom | property |
public var decimalSeparatorFrom:StringDecimal separator character to use when parsing an input string.
The default value is ".".
| decimalSeparatorTo | property |
public var decimalSeparatorTo:StringDecimal separator character to use when outputting formatted decimal numbers.
The default value is ".".
| precision | property |
public var precision:int
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 1.453.
If precision is -1 and you set some form of
rounding, return a value based on that rounding type.
The default value is -1.
| rounding | property |
public var rounding:String
How to round the number.
In ActionScript, the value can be NumberBaseRoundType.NONE,
NumberBaseRoundType.UP,
NumberBaseRoundType.DOWN, or NumberBaseRoundType.NEAREST.
In MXML, the value can be "none",
"up", "down", or "nearest".
The default value is NumberBaseRoundType.NONE.
See also
| thousandsSeparatorFrom | property |
public var thousandsSeparatorFrom:StringCharacter to use as the thousands separator in the input String.
The default value is ",".
| thousandsSeparatorTo | property |
public var thousandsSeparatorTo:StringCharacter to use as the thousands separator in the output string.
The default value is ",".
| useNegativeSign | property |
public var useNegativeSign:Boolean
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.
| useThousandsSeparator | property |
public var useThousandsSeparator:Boolean
If true, split the number into thousands increments
by using a separator character.
The default value is true.
| CurrencyFormatter | () | constructor |
public function CurrencyFormatter()Constructor.
| format | () | method |
public override function format(value:Object):String
Formats value as currency.
If value cannot be formatted, return an empty String
and write a description of the error to the error property.
value:Object — Value to format.
|
String —
Formatted string. Empty if an error occurs.
|
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CurrencyFormatter. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx: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="";
}
}
]]>
</mx:Script>
<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"/>
<mx:Panel title="CurrencyFormatter Example" width="75%" height="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Form>
<mx:FormItem label="Enter U.S. dollar amount:">
<mx:TextInput id="priceUS" text="" width="50%"/>
</mx:FormItem>
<mx:FormItem label="Formatted amount: ">
<mx:TextInput id="formattedUSPrice" text="" width="50%" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<mx:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</mx:Panel>
</mx:Application>
