| Paquete | mx.formatters |
| Clase | public class NumberFormatter |
| Herencia | NumberFormatter  Formatter Object |
| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
 | Desde Flex 4.5, Adobe recomienda la utilización de la clase spark.formatters.NumberFormatter como una alternativa a esta clase. |
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 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 contain an unusable setting.
Mostrar sintaxis MXML
Ocultar sintaxis MXMLThe <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"/>
Elementos de API relacionados
| Propiedad | Definido por | ||
|---|---|---|---|
 | constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | 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 | ||
| error : 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 | ||
| Método | Definido por | ||
|---|---|---|---|
Constructor. | NumberFormatter | ||
[override]
Formats the number as a String. | NumberFormatter | ||
|
Indica si un objeto tiene definida una propiedad especificada. | Object | |
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
|
Devuelve el valor simple del objeto especificado. | Object | |
decimalSeparatorFrom | propiedad |
decimalSeparatorFrom:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es ".".
Implementación
public function get decimalSeparatorFrom():String public function set decimalSeparatorFrom(value:String):voidElementos de API relacionados
decimalSeparatorTo | propiedad |
decimalSeparatorTo:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es ".".
Implementación
public function get decimalSeparatorTo():String public function set decimalSeparatorTo(value:String):voidElementos de API relacionados
precision | propiedad |
precision:Object| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es -1.
Implementación
public function get precision():Object public function set precision(value:Object):voidrounding | propiedad |
rounding:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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".
El valor predeterminado es NumberBaseRoundType.NONE.
Implementación
public function get rounding():String public function set rounding(value:String):voidElementos de API relacionados
thousandsSeparatorFrom | propiedad |
thousandsSeparatorFrom:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es ",".
Implementación
public function get thousandsSeparatorFrom():String public function set thousandsSeparatorFrom(value:String):voidElementos de API relacionados
thousandsSeparatorTo | propiedad |
thousandsSeparatorTo:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es ",".
Implementación
public function get thousandsSeparatorTo():String public function set thousandsSeparatorTo(value:String):voidElementos de API relacionados
useNegativeSign | propiedad |
useNegativeSign:Object| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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).
El valor predeterminado es true.
Implementación
public function get useNegativeSign():Object public function set useNegativeSign(value:Object):voiduseThousandsSeparator | propiedad |
useThousandsSeparator:Object| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
If true, split the number into thousands increments
by using a separator character.
El valor predeterminado es true.
Implementación
public function get useThousandsSeparator():Object public function set useThousandsSeparator(value:Object):voidNumberFormatter | () | Información sobre |
public function NumberFormatter()| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Constructor.
format | () | método |
override public function format(value:Object):String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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.
|
String — Formatted String. Empty if an error occurs.
|
<?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>
Tue Jun 12 2018, 02:12 PM Z