| Pacote | mx.formatters |
| Classe | public class CurrencyFormatter |
| Herança | CurrencyFormatter  Formatter Object |
| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
 | Ao iniciar com Flex 4.5, a Adobe recomenda que você use a classe de spark.formatters.CurrencyFormatter como uma alternativa a esta classe. |
The CurrencyFormatter class formats a valid number as a currency value. It adjusts the decimal rounding and precision, the thousands separator, and the negative sign; it also adds a currency symbol. You place the currency symbol on either the left or the right side of the value with the
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 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 contains an unusable setting.
Mostrar sintaxe MXML
Ocultar sintaxe MXMLThe <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"
/>
Elementos da API relacionados
| Propriedade | Definido por | ||
|---|---|---|---|
| alignSymbol : String
Aligns currency symbol to the left side or the right side
of the formatted number. | CurrencyFormatter | ||
 | constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | 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 : Object
Number of decimal places to include in the output String. | CurrencyFormatter | ||
| 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 : Object
If true, format a negative number
by preceding it with a minus "-" sign. | CurrencyFormatter | ||
| useThousandsSeparator : Object
If true, split the number into thousands increments
by using a separator character. | CurrencyFormatter | ||
| Método | Definido por | ||
|---|---|---|---|
Constructor. | CurrencyFormatter | ||
[substituir]
Formats value as currency. | CurrencyFormatter | ||
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
|
Retorna o valor primitivo do objeto especificado. | Object | |
alignSymbol | propriedade |
alignSymbol:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Aligns currency symbol to the left side or the right side
of the formatted number.
Permitted values are "left" and "right".
O valor padrão é "left".
Implementação
public function get alignSymbol():String public function set alignSymbol(value:String):voidcurrencySymbol | propriedade |
currencySymbol:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Character 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.
O valor padrão é "$".
Implementação
public function get currencySymbol():String public function set currencySymbol(value:String):voiddecimalSeparatorFrom | propriedade |
decimalSeparatorFrom:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Decimal separator character to use when parsing an input string.
O valor padrão é ".".
Implementação
public function get decimalSeparatorFrom():String public function set decimalSeparatorFrom(value:String):voiddecimalSeparatorTo | propriedade |
decimalSeparatorTo:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Decimal separator character to use when outputting formatted decimal numbers.
O valor padrão é ".".
Implementação
public function get decimalSeparatorTo():String public function set decimalSeparatorTo(value:String):voidprecision | propriedade |
precision:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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 1.453.
If precision is -1 and you set some form of
rounding, return a value based on that rounding type.
O valor padrão é -1.
Implementação
public function get precision():Object public function set precision(value:Object):voidrounding | propriedade |
rounding:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
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".
O valor padrão é NumberBaseRoundType.NONE.
Implementação
public function get rounding():String public function set rounding(value:String):voidElementos da API relacionados
thousandsSeparatorFrom | propriedade |
thousandsSeparatorFrom:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Character to use as the thousands separator in the input String.
O valor padrão é ",".
Implementação
public function get thousandsSeparatorFrom():String public function set thousandsSeparatorFrom(value:String):voidthousandsSeparatorTo | propriedade |
thousandsSeparatorTo:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Character to use as the thousands separator in the output string.
O valor padrão é ",".
Implementação
public function get thousandsSeparatorTo():String public function set thousandsSeparatorTo(value:String):voiduseNegativeSign | propriedade |
useNegativeSign:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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).
O valor padrão é true.
Implementação
public function get useNegativeSign():Object public function set useNegativeSign(value:Object):voiduseThousandsSeparator | propriedade |
useThousandsSeparator:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
If true, split the number into thousands increments
by using a separator character.
O valor padrão é true.
Implementação
public function get useThousandsSeparator():Object public function set useThousandsSeparator(value:Object):voidCurrencyFormatter | () | Construtor |
public function CurrencyFormatter()| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Constructor.
format | () | método |
override public function format(value:Object):String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Formats value as currency.
If value cannot be formatted, return an empty String
and write a description of the error to the error property.
Parâmetros
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. -->
<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>
Wed Jun 13 2018, 11:10 AM Z