Referência do ActionScript® 3.0 para Adobe® Flash® Platform
Início  |  Ocultar listas de Pacotes e Classes |  Pacotes  |  Classes  |  Novidades  |  Índice  |  Apêndices  |  Por que inglês?
Filtros: Recuperando dados do servidor...
Recuperando dados do servidor...
mx.formatters 

NumberFormatter  - AS3 Flex

Pacotemx.formatters
Classepublic class NumberFormatter
HerançaNumberFormatter Inheritance Formatter Inheritance 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.NumberFormatter como uma alternativa a esta classe.

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 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 MXMLexpandedOcultar sintaxe MXML

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 os exemplos

Elementos da API relacionados



Propriedades públicas
 PropriedadeDefinido por
 Inheritedconstructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.
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
 Inheritederror : String
Description saved by the formatter when an error occurs.
Formatter
  precision : Object
Number of decimal places to include in the output String.
NumberFormatter
  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
Propriedades protegidas
 PropriedadeDefinido por
 InheritedresourceManager : IResourceManager
[somente leitura] A reference to the object which manages all of the application's localized resources.
Formatter
Métodos públicos
 MétodoDefinido por
  
Constructor.
NumberFormatter
  
[substituir] Formats the number as a String.
NumberFormatter
 Inherited
Indica se um objeto tem uma propriedade especificada definida.
Object
 Inherited
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.
Object
 Inherited
Indica se a propriedade especificada existe e é enumerável.
Object
 Inherited
Define a disponibilidade de uma propriedade dinâmica para operações de repetição.
Object
 Inherited
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.
Object
 Inherited
Retorna a representação de string do objeto especificado.
Object
 Inherited
Retorna o valor primitivo do objeto especificado.
Object
Métodos protegidos
 MétodoDefinido por
 Inherited
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

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.

When setting this property, ensure that the value of the thousandsSeparatorFrom property does not equal this property. Otherwise, an error occurs when formatting the value.

O valor padrão é ".".



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

Elementos da API relacionados

decimalSeparatorTo

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.

When setting this property, ensure that the value of the thousandsSeparatorTo property does not equal this property. Otherwise, an error occurs when formatting the value.

O valor padrão é ".".



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

Elementos da API relacionados

precision

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

O valor padrão é -1.



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

rounding

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

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

O valor padrão é NumberBaseRoundType.NONE.



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

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

When setting this property, ensure that the value of the decimalSeparatorFrom property does not equal this property. Otherwise, an error occurs when formatting the value.

O valor padrão é ",".



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

Elementos da API relacionados

thousandsSeparatorTo

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.

When setting this property, ensure that the value of the decimalSeparatorTo property does not equal this property. Otherwise, an error occurs when formatting the value.

O valor padrão é ",".



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

Elementos da API relacionados

useNegativeSign

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):void

useThousandsSeparator

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):void
Detalhes do construtor

NumberFormatter

()Construtor
public function NumberFormatter()

Versão da linguagem: ActionScript 3.0
Versão de produto: Flex 3
Versões de runtime: Flash Player 9, AIR 1.1

Constructor.

Detalhes do método

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




[ X ]Por que inglês?
O conteúdo na Referência do ActionScript 3.0 aparece em inglês

Nem todas as partes da Referência do ActionScript 3.0 estão traduzidas em todos os idiomas. Quando um elemento de um idioma não está traduzido, ele é exibido em inglês. Por exemplo, a classe ga.controls.HelpBox não está traduzida em nenhum idioma. Por isso, na versão da referência em português do Brasil, a classe ga.controls.HelpBox é exibida em inglês.