mx.formatters.NumberFormatter (Flex 3)

Pacote	mx.formatters
Classe	public class NumberFormatter
Herança	NumberFormatter Formatter Object

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

Sintaxe em MXML expanded

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

Veja Exemplos

Veja também

mx.formatters.NumberBase
mx.formatters.NumberBaseRoundType

	Propriedade	Definido por
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		decimalSeparatorFrom : String Decimal separator character to use when parsing an input String.	NumberFormatter
		decimalSeparatorTo : String Decimal separator character to use when outputting formatted decimal numbers.	NumberFormatter
		defaultInvalidFormatError : String [static] Error message for an invalid format string specified to the formatter.	Formatter
		defaultInvalidValueError : String [static] Error messages for an invalid value specified to the formatter.	Formatter
		error : String Descrição saved by the formatter when an error occurs.	Formatter
		precision : Object Number of decimal places to include in the output String.	NumberFormatter
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		rounding : String Specifies how to round the number.	NumberFormatter
		thousandsSeparatorFrom : String Character to use as the thousands separator in the input String.	NumberFormatter
		thousandsSeparatorTo : String Character to use as the thousands separator in the output String.	NumberFormatter
		useNegativeSign : Object If true, format a negative number by preceding it with a minus "-" sign.	NumberFormatter
		useThousandsSeparator : Object If true, split the number into thousands increments by using a separator character.	NumberFormatter

	Propriedade	Definido por
		resourceManager : IResourceManager [write-only] A reference to the object which manages all of the application's localized resources.	Formatter

	Método	Definido por
		NumberFormatter() Constructor.	NumberFormatter
		format(value:Object):String Formats the number as a String.	NumberFormatter
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

	Método	Definido por
		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

decimalSeparatorFrom

propriedade

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

decimalSeparatorTo

propriedade

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

precision

propriedade

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

Implementação
public function get precision():Object
public function set precision(value:Object):void

rounding

propriedade

rounding:String [read-write]

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.

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

Veja também

mx.formatters.NumberBaseRoundType

thousandsSeparatorFrom

propriedade

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

thousandsSeparatorTo

propriedade

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

useNegativeSign

propriedade

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

useThousandsSeparator

propriedade

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

NumberFormatter

()

Construtor

public function NumberFormatter()

Constructor.

Detalhes do método

format

()

método

public override function format(value:Object):String

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.

Parâmetros

value:Object — Value to format.

Retorna

String — Formatted String. Empty if an error occurs.

Exemplos How to use examples

NumberFormatterExample.mxml

<?xml version="1.0"?>
<!-- Simple exemplo to demonstrate NumberFormatter. -->
<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) {
             
                formattedNumber.text= numberFormatter.format(inputVal.text);
             }
             
             else {
                formattedNumber.text= "";
             }
          }
      ]]>      
    </mx:Script>

    <mx:NumberFormatter id="numberFormatter" precision="4" 
        useThousandsSeparator="true" useNegativeSign="true"/>

    <mx:NumberValidator id="numVal" source="{inputVal}" property="text" 
        allowNegative="true" domain="real"/>

    <mx:Panel title="NumberFormatter Example" width="75%" height="75%" 
            paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

        <mx:Form>
            <mx:FormItem label="Enter number:">
                <mx:TextInput id="inputVal" text="" width="50%"/>
            </mx:FormItem>

            <mx:FormItem label="Formatted number (precision=4): ">
                <mx:TextInput id="formattedNumber" editable="false" width="50%"/>
            </mx:FormItem>

            <mx:FormItem>
                <mx:Button label="Validate and Format" click="Format();"/>
            </mx:FormItem>
        </mx:Form>
        
    </mx:Panel>
</mx:Application>

Flex 3 - Referência da Linguagem	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
NumberFormatter	Propriedades \| Métodos \| Exemplos