Pacotemx.formatters
Classepublic class CurrencyFormatter
HerançaCurrencyFormatter Inheritance Formatter Inheritance Object

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:

Sintaxe em MXMLexpandedHide MXML Syntax

The <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"
 />

Veja Exemplos

Veja também

mx.formatters.NumberBase
mx.formatters.NumberBaseRoundType

Propriedades Públicas
 PropriedadeDefinido por
  alignSymbol : String
Aligns currency symbol to the left side or the right side of the formatted number.
CurrencyFormatter
 Inheritedconstructor : 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
 InheriteddefaultInvalidFormatError : String
[static] Error message for an invalid format string specified to the formatter.
Formatter
 InheriteddefaultInvalidValueError : String
[static] Error messages for an invalid value specified to the formatter.
Formatter
 Inheritederror : String
Descrição saved by the formatter when an error occurs.
Formatter
  precision : Object
Number of decimal places to include in the output String.
CurrencyFormatter
 Inheritedprototype : 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 : 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
Propriedades Protegidas
 PropriedadeDefinido por
 InheritedresourceManager : IResourceManager
[write-only] A reference to the object which manages all of the application's localized resources.
Formatter
Métodos Públicos
 MétodoDefinido por
  
CurrencyFormatter()
Constructor.
CurrencyFormatter
  
format(value:Object):String
Formats value as currency.
CurrencyFormatter
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Métodos Protegidos
 MétodoDefinido por
 Inherited
resourcesChanged():void
This method is called when a Formatter is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
Formatter
Detalhes da propriedade
alignSymbolpropriedade
alignSymbol:String  [read-write]

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".


Implementação
    public function get alignSymbol():String
    public function set alignSymbol(value:String):void
currencySymbolpropriedade 
currencySymbol:String  [read-write]

Character to use as a currency symbol for a formatted number. You can use one or more characters to represent the currency symbol; for exemplo, "$" 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 "$".


Implementação
    public function get currencySymbol():String
    public function set currencySymbol(value:String):void
decimalSeparatorFrompropriedade 
decimalSeparatorFrom:String  [read-write]

Decimal separator character to use when parsing an input string.

The default value is ".".


Implementação
    public function get decimalSeparatorFrom():String
    public function set decimalSeparatorFrom(value:String):void
decimalSeparatorTopropriedade 
decimalSeparatorTo:String  [read-write]

Decimal separator character to use when outputting formatted decimal numbers.

The default value is ".".


Implementação
    public function get decimalSeparatorTo():String
    public function set decimalSeparatorTo(value:String):void
precisionpropriedade 
precision:Object  [read-write]

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 exemplo, 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.


Implementação
    public function get precision():Object
    public function set precision(value:Object):void
roundingpropriedade 
rounding:String  [read-write]

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.


Implementação
    public function get rounding():String
    public function set rounding(value:String):void

Veja também

mx.formatters.NumberBaseRoundType
thousandsSeparatorFrompropriedade 
thousandsSeparatorFrom:String  [read-write]

Character to use as the thousands separator in the input String.

The default value is ",".


Implementação
    public function get thousandsSeparatorFrom():String
    public function set thousandsSeparatorFrom(value:String):void
thousandsSeparatorTopropriedade 
thousandsSeparatorTo:String  [read-write]

Character to use as the thousands separator in the output string.

The default value is ",".


Implementação
    public function get thousandsSeparatorTo():String
    public function set thousandsSeparatorTo(value:String):void
useNegativeSignpropriedade 
useNegativeSign:Object  [read-write]

If true, format a negative number by preceding it with a minus "-" sign. If false, format the number surrounded by parentheses, for exemplo (400).

The default value is true.


Implementação
    public function get useNegativeSign():Object
    public function set useNegativeSign(value:Object):void
useThousandsSeparatorpropriedade 
useThousandsSeparator:Object  [read-write]

If true, split the number into thousands increments by using a separator character.

The default value is true.


Implementação
    public function get useThousandsSeparator():Object
    public function set useThousandsSeparator(value:Object):void
Detalhes do construtor
CurrencyFormatter()Construtor
public function CurrencyFormatter()

Constructor.

Detalhes do método
format()método
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.

Parâmetros

value:Object — Value to format.

Retorna
String — Formatted string. Empty if an error occurs.
Exemplos How to use examples
CurrencyFormatterExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple exemplo 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>



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Traduzido e mantido por Igor Costa - www.igorcosta.com