Paquete | flash.globalization |
Clase | public final class CurrencyFormatter |
Herencia | CurrencyFormatter Object |
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
La clase CurrencyFormatter utiliza los datos y la funcionalidad proporcionada por el sistema operativo y está diseñado para formato a valores de divisa en función de las convenciones de una configuración regional específica y el tipo de divisa. La posición del símbolo de divisa, el símbolo negativo, el separador decimal, la separador de agrupación, el separador decimal del patrón de agrupación y otros elementos puede variar según la configuración regional.
Si el sistema operativo admite la configuración regional solicitada, las propiedades y el tipo de divisa se establecen de acuerdo con las convenciones y los valores predeterminados de la configuración regional. Si la configuración regional requerida no está disponible, se establecen las propiedades de repuesto o según una configuración regional predeterminada del sistema, que se puede recuperar mediante la propiedad actualLocaleIDName
.
Debido al uso de la configuración del usuario, al uso de patrones de formato proporcionados por el sistema operativo y al uso de una configuración regional de repuesto cuando la configuración regional requerida no se admite, los usuarios puedan ver diferentes resultados de formato, incluso cuando se utiliza el mismo ID de configuración regional.
Propiedad | Definido por | ||
---|---|---|---|
actualLocaleIDName : String [solo lectura]
El nombre del ID real de configuración regional utilizado por este objeto CurrencyFormatter. | CurrencyFormatter | ||
constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | ||
currencyISOCode : String [solo lectura]
El código ISO 4217 de divisa de tres letras para la configuración regional real que se utiliza. | CurrencyFormatter | ||
currencySymbol : String [solo lectura]
El símbolo o cadena de divisa para la configuración regional real que se utiliza. | CurrencyFormatter | ||
decimalSeparator : String
El carácter de separador decimal se utiliza para aplicar formato o analizar cantidades de divisa con parte decimal. | CurrencyFormatter | ||
digitsType : uint
Define el conjunto de caracteres de dígitos utilizados cuando se aplica formato a cantidades de divisa. | CurrencyFormatter | ||
fractionalDigits : int
El número máximo de dígitos que pueden aparecer después del separador decimal. | CurrencyFormatter | ||
groupingPattern : String
Describe la colocación de los separadores de agrupación dentro de la cadena de cantidad de divisa con formato. | CurrencyFormatter | ||
groupingSeparator : String
El carácter o la cadena utilizado para el separador de agrupación. | CurrencyFormatter | ||
lastOperationStatus : String [solo lectura]
El estado de la última operación que este objeto CurrencyFormatter ha realizado. | CurrencyFormatter | ||
leadingZero : Boolean
Especifica si se incluye un cero a la izquierda en una cantidad de divisa con formato cuando no hay dígitos enteros a la izquierda del separador decimal. | CurrencyFormatter | ||
negativeCurrencyFormat : uint
Un valor numérico que indica un patrón de formato para cantidades de divisa negativas. | CurrencyFormatter | ||
negativeSymbol : String
El símbolo negativo que utilizado al aplicar formato a cantidades de divisa negativas. | CurrencyFormatter | ||
positiveCurrencyFormat : uint
Un valor numérico que indica un patrón de formato para cantidades de divisa positivas. | CurrencyFormatter | ||
requestedLocaleIDName : String [solo lectura]
El nombre del ID de configuración regional requerido que se transfirió al constructor de este objeto CurrencyFormatter. | CurrencyFormatter | ||
trailingZeros : Boolean
Especifica si se incluyen ceros a la derecha en una cantidad de divisa con formato. | CurrencyFormatter | ||
useGrouping : Boolean
Permite el uso del separador de agrupación cuando se aplica formato a cantidades de divisa. | CurrencyFormatter |
Método | Definido por | ||
---|---|---|---|
CurrencyFormatter(requestedLocaleIDName:String)
Construye un nuevo objeto CurrencyFormatter para dar formato a números que representan cantidades de divisa según las convenciones de una configuración regional determinada. | CurrencyFormatter | ||
Crea una cadena que representa una cantidad de divisa con formato según las propiedades actuales de este objeto CurrencyFormatter, incluidas la configuración regional, el símbolo de divisa y el código ISO. | CurrencyFormatter | ||
Determina si el símbolo de divisa especificado actualmente puede utilizarse cuando se aplica formato a cantidades de divisa. | CurrencyFormatter | ||
[estática]
Muestra una lista de todos los nombres de ID de configuración regional admitidos por esta clase. | CurrencyFormatter | ||
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 | ||
Analiza una cadena en una cantidad de divisa y en un símbolo de divisa. | CurrencyFormatter | ||
Indica si existe la propiedad especificada y si es enumerable. | Object | ||
Establece las propiedades currencyISOCode y currencySymbol del objeto CurrencyFormatter. | CurrencyFormatter | ||
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 |
actualLocaleIDName | propiedad |
actualLocaleIDName:String
[solo lectura] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El nombre del ID real de configuración regional utilizado por este objeto CurrencyFormatter.
Existen tres posibilidades para el valor del nombre, en función del sistema operativo y del valor del parámetro requestedLocaleIDName
transferido al constructor CurrencyFormatter()
.
- Si la configuración regional requerida no era
LocaleID.DEFAULT
y el sistema operativo admite la configuración regional requerida, el nombre devuelto es el mismo que la propiedadrequestedLocaleIDName
. - Si
LocaleID.DEFAULT
se ha utilizado como el valor del parámetrorequestedLocaleIDName
en el constructor, se utiliza el nombre de la configuración regional actual especificado por el sistema operativo del usuario. El valor deLocaleID.DEFAULT
conserva la configuración personalizada del usuario en el sistema operativo. Transferir un valor explícito como el parámetrorequestedLocaleIDName
no necesariamente produce el mismo resultado que utilizarLocaleID.DEFAULT
incluso si los dos ID de configuración regional son los mismos. El usuario podría haber personalizado los ajustes de la configuración regional de su equipo y, al solicitar un nombre ID de configuración regional explícito en lugar de utilizarLocaleID.DEFAULT
, la aplicación no recuperaría dichos ajustes personalizados. - Si el sistema no admite el nombre de
requestedLocaleIDName
especificado en el constructor, se proporciona un nombre de ID de configuración regional de repuesto.
Implementación
public function get actualLocaleIDName():String
Elementos de API relacionados
currencyISOCode | propiedad |
currencyISOCode:String
[solo lectura] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El código ISO 4217 de divisa de tres letras para la configuración regional real que se utiliza.
Este código se utiliza para determinar el símbolo o cadena de divisa cuando se da formato a cantidades de divisa con el método format()
y el parámetro withCurrencySymbol
establecido en false
.
Esta propiedad se inicializa mediante el constructor según la configuración regional real que se utiliza. Cuando se utiliza una configuración regional de repuesto, esta propiedad refleja el código de divisa predeterminado preferido para la configuración regional de repuesto.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get currencyISOCode():String
Elementos de API relacionados
currencySymbol | propiedad |
currencySymbol:String
[solo lectura] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El símbolo o cadena de divisa para la configuración regional real que se utiliza.
Esta propiedad se utiliza como símbolo de divisa cuando se da formato a cantidades de divisa con el método format()
y el parámetro withCurrencySymbol
establecido en true
.
Esta propiedad se inicializa mediante el constructor según la configuración regional real que se utiliza. Cuando se utiliza una configuración regional de repuesto, esta propiedad reflejará el código de divisa predeterminado preferido para la configuración regional de repuesto.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get currencySymbol():String
Elementos de API relacionados
decimalSeparator | propiedad |
decimalSeparator:String
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El carácter de separador decimal se utiliza para aplicar formato o analizar cantidades de divisa con parte decimal.
Esta propiedad está definida inicialmente según la configuración regional que esté seleccionada cuando se construye el objeto formateador.
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get decimalSeparator():String
public function set decimalSeparator(value:String):void
Emite
TypeError — si se asigna un valor null a esta propiedad.
|
Elementos de API relacionados
digitsType | propiedad |
digitsType:uint
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Define el conjunto de caracteres de dígitos utilizados cuando se aplica formato a cantidades de divisa.
Los distintos idiomas y regiones utilizan conjuntos de caracteres diferentes para representar los dígitos del 0 al 9. Esta propiedad define el conjunto de dígitos que se va a utilizar.
El valor de esta propiedad representa el valor Unicode para el dígito cero de un conjunto de dígitos decimales. Los valores válidos de esta propiedad se definen en la clase NationalDigitsType.
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get digitsType():uint
public function set digitsType(value:uint):void
Emite
TypeError — si se asigna un valor null a esta propiedad.
|
Elementos de API relacionados
fractionalDigits | propiedad |
fractionalDigits:int
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El número máximo de dígitos que pueden aparecer después del separador decimal.
Los números se redondean al número de dígitos especificado en esta propiedad. El esquema de redondeo varía en función del sistema operativo del usuario.
Cuando la propiedad trailingZeros
se establece en true
, la parte fraccionaria del número (después de la coma decimal) se rellena con ceros hasta que su longitud coincida con el valor de esta propiedad fractionalDigits
.
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es 0.
Implementación
public function get fractionalDigits():int
public function set fractionalDigits(value:int):void
Elementos de API relacionados
groupingPattern | propiedad |
groupingPattern:String
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Describe la colocación de los separadores de agrupación dentro de la cadena de cantidad de divisa con formato.
Cuando la propiedad useGrouping
se establece como true, la propiedad groupingPattern
se utiliza para definir la ubicación y el patrón utilizados para el separador de agrupación.
El patrón de agrupación se define como una cadena que contiene los números separados por puntos y comas y, opcionalmente, pueden terminar con un asterisco. Por ejemplo: "3;2;*"
. Cada número de la cadena representa el número de dígitos de un grupo. El separador de agrupación se coloca antes de cada grupo de dígitos. Un asterisco al final de la cadena indica que los grupos con ese número de dígitos se deben repetir para el resto de la cadena con formato. Si no hay asterisco, no hay grupos ni separadores adicionales para el resto de la cadena con formato.
El primer número de la cadena corresponde al primer grupo de dígitos a la izquierda del separador decimal. Los siguientes números definen el número de dígitos de los grupos subsiguientes a la izquierda. Por lo tanto, la cadena "3;2;*" indica que el separador de agrupación se coloca después del primer grupo de 3 dígitos, seguido de grupos de 2 dígitos. Por ejemplo: 98,76,54,321
La tabla siguiente muestra ejemplos de formato de la cantidad de divisa 123456789.12 con varios patrones de agrupación. El separador de agrupación es una coma, el separador decimal es un punto y el símbolo de divisa es un signo dólar ($).
Patrón de agrupación | Formato de ejemplo |
3;* | $123,456,789.12 |
3;2;* | $12,34,56,789.12 |
3 | $123456,789.12 |
Sólo se puede definir un número de tamaños de agrupación. En algunos sistemas operativos, los patrones de agrupación solamente puede contener dos números más un asterisco. Otros sistemas operativos admiten hasta cuatro números y un asterisco. Para los patrones sin un asterisco, algunos sistemas operativos sólo admiten un número, mientras que otros admiten hasta tres. Si se supera el número máximo de elementos de patrón de agrupación, los elementos adicionales se pasarán por alto y la propiedad lastOperationStatus
se establecerá como se describe a continuación.
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
Implementación
public function get groupingPattern():String
public function set groupingPattern(value:String):void
Emite
TypeError — si se asigna un valor null a esta propiedad.
|
Elementos de API relacionados
groupingSeparator | propiedad |
groupingSeparator:String
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El carácter o la cadena utilizado para el separador de agrupación.
El valor de esta propiedad se utiliza como separador de agrupación cuando las cantidades de divisa con formato de la propiedad useGrouping
se establecen como true
. Esta propiedad está definida inicialmente según la configuración regional que esté seleccionada cuando se construye el objeto formateador.
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get groupingSeparator():String
public function set groupingSeparator(value:String):void
Emite
TypeError — si se asigna un valor null a esta propiedad.
|
Elementos de API relacionados
lastOperationStatus | propiedad |
lastOperationStatus:String
[solo lectura] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El estado de la última operación que este objeto CurrencyFormatter ha realizado. La propiedad lastOperationStatus
se establece siempre que se llame al constructor o a un método de esta clase, o si se establece otra propiedad. Para conocer los valores posibles, consulte la descripción de cada método.
Implementación
public function get lastOperationStatus():String
Elementos de API relacionados
leadingZero | propiedad |
leadingZero:Boolean
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Especifica si se incluye un cero a la izquierda en una cantidad de divisa con formato cuando no hay dígitos enteros a la izquierda del separador decimal.
Cuando esta propiedad se establece en true
, se incluye un cero a la izquierda del separador decimal cuando haya valores numéricos con formato entre -1.0 y 1.0. Si esta propiedad se establece en false
no se incluye ningún un cero a la izquierda.
Por ejemplo, si la cantidad de divisa es 0.321 y esta propiedad se establece true
, el cero a la izquierda sí se incluye en la cadena con formato. Si la propiedad se establece como false
, no se incluye ningún cero a la izquierda. En ese caso, la cadena sólo incluye el separador decimal seguido de los dígitos decimales, es decir, $.321
.
La tabla siguiente muestra ejemplos de cómo se aplica formato a cantidades de divisa en función de los valores de esta propiedad y las propiedades fractionalDigits
y trailingZeros
relacionadas.
trailingZeros | leadingZero | fractionalDigits | 0.12 | 0 |
true | true | 3 | $0.120 | $0.000 |
false | true | 3 | $0.12 | $0 |
true | false | 3 | $.120 | $.000 |
false | false | 3 | $.12 | $0 |
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get leadingZero():Boolean
public function set leadingZero(value:Boolean):void
Emite
TypeError — si se asigna un valor null a esta propiedad.
|
Elementos de API relacionados
negativeCurrencyFormat | propiedad |
negativeCurrencyFormat:uint
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Un valor numérico que indica un patrón de formato para cantidades de divisa negativas. Este patrón define la ubicación del símbolo de divisa y del símbolo negativo o el paréntesis en relación con la parte numérica de la cantidad de divisa con formato.
El valor de esta propiedad debe ser una de las constantes definidas en la siguiente tabla.
La tabla siguiente resume los patrones de formato posibles para cantidades de divisa negativas. Cuando se aplica formato a una cantidad de divisa con el método format()
:
- El símbolo '¤' se sustituye por el valor de la propiedad
currencyISOCode
ocurrencySymbol
, en función del valor del parámetrowithCurrencySymbol
transmitido al métodoformat()
; - El carácter '-' se sustituye por el valor de la propiedad
negativeNumberSymbol
; - El carácter 'n' se sustituye por el valor de la cantidad de divisa que se transfiere al método
format()
.
Tipo de formato de divisa negativa | Patrón de formato |
0 | (¤n) |
1 | -¤n |
2 | ¤-n |
3 | ¤n- |
4 | (n¤) |
5 | -n¤ |
6 | n-¤ |
7 | n¤- |
8 | -n ¤ |
9 | -¤ n |
10 | n ¤- |
11 | ¤ n- |
12 | ¤ -n |
13 | n- ¤ |
14 | (¤ n) |
15 | (n ¤) |
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get negativeCurrencyFormat():uint
public function set negativeCurrencyFormat(value:uint):void
Emite
ArgumentError — si el valor asignado no está comprendido entre 0 y 15.
|
Elementos de API relacionados
negativeSymbol | propiedad |
negativeSymbol:String
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El símbolo negativo que utilizado al aplicar formato a cantidades de divisa negativas.
Este símbolo se utiliza con el formato de divisa negativa cuando se aplica formato a una cantidad de divisa que es menor que cero. No se utiliza en formatos de divisas negativas que no incluyen un signo negativo (por ejemplo, cuando las cantidades de divisa negativas aparecen entre paréntesis).
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get negativeSymbol():String
public function set negativeSymbol(value:String):void
Emite
TypeError — si se asigna un valor null a esta propiedad.
|
Elementos de API relacionados
positiveCurrencyFormat | propiedad |
positiveCurrencyFormat:uint
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Un valor numérico que indica un patrón de formato para cantidades de divisa positivas. Este formato define la ubicación del símbolo de divisa relativo a la parte numérica de la cantidad de divisa.
El valor de esta propiedad debe ser una de las constantes definidas en la siguiente tabla.
La tabla siguiente resume los códigos de formato posibles para cantidades de divisa positivas. Cuando se aplica formato a una cantidad de divisa con el método format()
:
- El símbolo '¤' se sustituye por el valor de la propiedad
currencyISOCode
ocurrencySymbol
, en función del valor del parámetrowithCurrencySymbol
transmitido al métodoformat()
; - El carácter 'n' se sustituye por el valor de la cantidad de divisa que se transfiere al método
format()
.
Tipo de formato de divisa positiva | Patrón de formato |
0 | ¤n |
1 | n¤ |
2 | ¤ n |
3 | n ¤ |
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get positiveCurrencyFormat():uint
public function set positiveCurrencyFormat(value:uint):void
Emite
ArgumentError — si el valor asignado no está comprendido entre 0 y 3.
|
Elementos de API relacionados
requestedLocaleIDName | propiedad |
requestedLocaleIDName:String
[solo lectura] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
El nombre del ID de configuración regional requerido que se transfirió al constructor de este objeto CurrencyFormatter.
Si se ha utilizado el valor LocaleID.DEFAULT
, el nombre devuelto es "i-default". La configuración regional real que se utiliza puede ser diferente de la configuración regional requerida cuando cuando se aplica una configuración regional de repuesto. El nombre de la configuración regional real se puede recuperar usando la propiedad actualLocaleIDName
.
Implementación
public function get requestedLocaleIDName():String
Elementos de API relacionados
trailingZeros | propiedad |
trailingZeros:Boolean
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Especifica si se incluyen ceros a la derecha en una cantidad de divisa con formato.
Cuando esta propiedad se establece en true
, se incluyen ceros a la derecha en la parte fraccionaria del número con formato hasta el límite especificado por la propiedad fractionalDigits
. Cuando esta propiedad se establece en false
, no se muestra ningún cero a la derecha.
Por ejemplo, si la cantidad de divisa es 123.4, esta propiedad se establece en true, y la propiedad fractionalDigits
se establece en 3, la cadena con formato mostrará ceros a la derecha, es decir, 123.400
. Si esta propiedad es false
, no se incluyen ceros a la derecha y la cadena muestra simplemente el separador decimal seguido de los dígitos decimales sin ceros añadidos, es decir, $123,4
.
La tabla siguiente muestra ejemplos de cómo se aplica formato a cantidades de divisa en función de los valores de esta propiedad y las propiedades fractionalDigits
y leadingZero
relacionadas.
trailingZeros | leadingZero | fractionalDigits | 0.12 | 0 |
true | true | 3 | $0.120 | $0.000 |
false | true | 3 | $0.12 | $0 |
true | false | 3 | $.120 | $.000 |
false | false | 3 | $.12 | $0 |
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
El valor predeterminado es dependent on the actual locale and operating system.
Implementación
public function get trailingZeros():Boolean
public function set trailingZeros(value:Boolean):void
Emite
TypeError — si se asigna un valor null a esta propiedad.
|
Elementos de API relacionados
useGrouping | propiedad |
useGrouping:Boolean
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Permite el uso del separador de agrupación cuando se aplica formato a cantidades de divisa.
Cuando la propiedad useGrouping
se establece en true
, los dígitos se agrupan y se delimitan mediante el carácter separador de agrupación. Por ejemplo: $123,456,789
Cuando la propiedad useGrouping
se establece en false
, los dígitos no se agrupan ni se separan. Por ejemplo: $123456789
La propiedad groupingSeparator
define el símbolo que se va a utilizar como separador de agrupación. La propiedad groupingPattern
define el número de dígitos entre los separadores de agrupación.
Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
Implementación
public function get useGrouping():Boolean
public function set useGrouping(value:Boolean):void
Elementos de API relacionados
CurrencyFormatter | () | Información sobre |
public function CurrencyFormatter(requestedLocaleIDName:String)
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Construye un nuevo objeto CurrencyFormatter para dar formato a números que representan cantidades de divisa según las convenciones de una configuración regional determinada.
Este constructor determina si el sistema operativo actual admite el nombre del ID solicitado configuración regional. Si no se admite, se utilizará en su lugar una configuración regional repuesto. Si se utiliza una configuración regional de repuesto, la propiedad lastOperationStatus
indica el tipo de repuesto y la propiedad actualLocaleIDName
contiene el nombre del ID de configuración regional de repuesto.
Ciertas propiedades currencySymbol
y currencyISOCode
se definen automáticamente según la configuración regional.
NOTA: cuando se usa una configuración regional de repuesto, las propiedades de divisa se establecen en sus valores predeterminados y, por tanto, las propiedades currencySymbol
o currencyISOCode
pueden proporcionar valores inesperados. Es una buena idea examinar los valores de las propiedades currencySymbol
y currencyISOCode
antes de aplicar formato a una cantidad de divisa.
Para dar formato a partir de las preferencias del sistema operativo actuales del usuario, transfiera el valor LocaleID.DEFAULT
del parámetro requestedLocaleIDName
al constructor.
Cuando se llama al constructor y se completa correctamente, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
Cuando nombre del ID de la configuración regional no está disponible, lastOperationStatus
se establece en uno de los valores siguientes:
LastOperationStatus.USING_FALLBACK_WARNING
LastOperationStatus.USING_DEFAULT_WARNING
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus.
Para obtener información detallada sobre las advertencias que aparecen en la lista anterior y sobre otros valores posibles de la proipedad lastOperationStatus
, consulte las descripciones de la clase LastOperationStatus
.
requestedLocaleIDName:String — El nombre de ID de configuración regional preferida para utilizar al determinar los formatos de fecha u hora.
|
Emite
TypeError — Si el parámetro requestedLocaleIDName es null .
|
Elementos de API relacionados
format | () | método |
public function format(value:Number, withCurrencySymbol:Boolean = false):String
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Crea una cadena que representa una cantidad de divisa con formato según las propiedades actuales de este objeto CurrencyFormatter, incluidas la configuración regional, el símbolo de divisa y el código ISO.
De forma predeterminada, este método utiliza la propiedad currencyISOCode
para determinar el símbolo de divisa y otros ajustes durante la aplicación de formato.
Muchos países y regiones utilizan los mismos símbolos de divisa para diferentes monedas. Por ejemplo Estados Unidos, Australia, Nueva Zelanda, Canadá y México utilizan el mismo símbolo de dólar ($) para los valores de divisa local. Cuando el formato de divisa difiere de la divisa local del usuario, es mejor utilizar el código ISO como cadena de divisa. Seguidamente se puede utilizar el método formattingWithCurrencySymbolIsSafe()
para probar si el código ISO de la divisa al que se debe dar formato coincide con la propiedad currencyISOCode
del formateador.
Este método puede dar formato a números muy grandes y muy pequeños. Sin embargo, el número de dígitos significativos está limitado a la precisión proporcionada por el tipo de datos Number.
Parámetros
value:Number — El valor numérico al que se va a aplicar formato en una cadena de divisa.
| |
withCurrencySymbol:Boolean (default = false ) — Cuando se establece en false, la propiedad currencyISOCode determina qué cadena o símbolo de divisa se utiliza en la cadena de salida. Cuando se establece como true, se utiliza el valor actual de la propiedad currencySymbol en la cadena de salida.
|
String — Una cadena que contiene el valor de divisa con formato.
|
Elementos de API relacionados
currencyISOCode
formattingWithCurrencySymbolIsSafe()
lastOperationStatus
LastOperationStatus
Ejemplo ( Cómo utilizar este ejemplo )
withCurrencySymbol
se establece en true, la propiedad currencySymbol
se utiliza para dar formato a la cantidad de divisa.
var cf:CurrencyFormatter = new CurrencyFormatter("fr-CA"); trace(cf.actualLocaleIDName); // "fr-CA" trace(cf.currencyISOCode); // "CAD" trace(cf.currencySymbol); // "$" trace(cf.format(1254.56)); // "1 254,56 CAD" trace(cf.format(1254.56, true)); // "1 254,56 $"
El segundo ejemplo muestra un método de aplicación de formato a una cantidad de divisa en dólares canadienses utilizando la configuración regional predeterminada del usuario. El método formattingWithCurrencySymbolIsSafe()
se utiliza para probar si la divisa predeterminada del usuario es dólares canadienses y, si es así, se utiliza el método format con el parámetro withCurrencySymbol
definido como true. En caso contrario, la divisa se establece en dólares canadienses con un símbolo de divisa más descriptivo. El ejemplo muestra cómo se debe aplicar formato a la divisa si la configuración regional predeterminada es francés (Canadá) o inglés (EE.UU.).
var cf:CurrencyFormatter = new CurrencyFormatter(LocaleID.DEFAULT); if (cf.formattingWithCurrencySymbolIsSafe("CAD")) { trace(cf.actualLocaleIDName); // "fr-CA French (Canada)" trace(cf.format(1254.56, false)); // "1 254,56 $" } else { trace(cf.actualLocaleIDName); // "en-US English (USA)" cf.setCurrency("CAD", "C$") trace(cf.format(1254.56, true)); // "C$ 1,254.56" }
formattingWithCurrencySymbolIsSafe | () | método |
public function formattingWithCurrencySymbolIsSafe(requestedISOCode:String):Boolean
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Determina si el símbolo de divisa especificado actualmente puede utilizarse cuando se aplica formato a cantidades de divisa.
Muchas regiones y países utilizan los mismos símbolos de divisa. Este método se puede utilizar para evitar el uso de un símbolo de divisa ambiguo, o un símbolo de divisa o código ISO distinto del esperado debido a la utilización de una configuración regional de repuesto.
Un caso de uso común para este método es determinar si debe mostrar un símbolo de divisa local (si se aplica formato a la cantidad en la divisa predeterminada del usuario) o una cadena de código ISO más específica (si se aplica formato la cantidad en una divisa diferente de la predeterminada del usuario).
Este método compara el parámetro requestedISOCode
con la propiedad currencyISOCode
actual, devolviendo true
si las cadenas son iguales y false
si no lo son. Cuando las cadenas son iguales, utilizar el método format()
con el parámetro withCurrencySymbol
establecido en true
tiene como resultado una cadena de valor de divisa con formato con un símbolo exclusivo de divisa para la configuración regional. Si este método devuelve false, utilizar format()
con el parámetro withCurrencySymbol
establecido en true podría provocar el uso de un símbolo de divisa ambiguo o incorrecto.
Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
Parámetros
requestedISOCode:String — Un código ISO 4217 de divisa de tres letras (por ejemplo, USD para dólares dólares, EUR para euros). Debe contener tres letras en mayúsculas entre A y Z.
|
Boolean — true si la propiedad currencyISOCode coincide con el parámetro requestedISOCode ; en caso contrario, false .
|
Emite
TypeError — si el parámetro requestedISOCode es null.
|
Elementos de API relacionados
getAvailableLocaleIDNames | () | método |
public static function getAvailableLocaleIDNames():Vector.<String>
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Muestra una lista de todos los nombres de ID de configuración regional admitidos por esta clase.
Si esta clase no se admite en el sistema operativo actual, este método devuelve un valor null.
Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
Vector.<String> — Un vector de cadenas que contiene todos los nombres de ID de configuración regional admitidos por esta clase.
|
parse | () | método |
public function parse(inputString:String):CurrencyParseResult
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Analiza una cadena en una cantidad de divisa y en un símbolo de divisa.
El algoritmo de análisis utiliza el valor de la propiedad decimalSeparator
para determinar la parte integral y fraccionaria del número. Utiliza los valores de las propiedades negativeCurrencyFormat
y positiveCurrencyFormat
para determinar la ubicación del símbolo o la cadena de divisa con relación a la cantidad de divisa. Para valores negativos, el valor de la propiedad negativeCurrencyFormat
determina la ubicación del símbolo negativo y si se utilizan paréntesis.
Si el orden del símbolo de divisa, el signo menos y el número de la cadena de entrada no coincide con el patrón identificado por las propiedades negativeCurrencyFormat
y positiveCurrencyFormat
:
- La propiedad
value
del objeto CurrencyParseResult devuelto se establece comoNaN
. - La propiedad
currencyString
del objeto CurrencyParseResult devuelto se establece comonull
. - La propiedad
lastOperationStatus
se establece para indicar que ha fallado el análisis.
La cadena de entrada puede incluir caracteres de espacio que se omiten durante el análisis.
El análisis se realizará correctamente incluso si no hay ningún símbolo de divisa. No se lleva a cabo ninguna validación de la parte de la cadena correspondiente al símbolo de divisa. Si no hay símbolo o cadena de divisa, la propiedad currencyString
del objeto CurrencyParseResult devuelto se establece en una cadena vacía.
Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
Parámetros
inputString:String — La cadena de entrada que se va a analizar.
|
CurrencyParseResult — Un objeto CurrencyParseResult que contiene el valor numérico y el símbolo o cadena de divisa.
|
Emite
TypeError — si el parámetro inputString es null.
|
Elementos de API relacionados
setCurrency | () | método |
public function setCurrency(currencyISOCode:String, currencySymbol:String):void
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10.1, AIR 2 |
Establece las propiedades currencyISOCode
y currencySymbol
del objeto CurrencyFormatter.
Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus
se establece en:
LastOperationStatus.NO_ERROR
En caso contrario, las propiedades currencyISOCode
y currencySymbol
no se modifican y la propiedad lastOperationStatus
se establece en una de las constantes definidas en la clase LastOperationStatus
.
Parámetros
currencyISOCode:String — El código ISO 4217 de divisa de tres letras (p. ej., USD para dólares dólares, EUR para euros). Debe contener tres letras en mayúsculas entre A y Z.
| |
currencySymbol:String — El símbolo o cadena de divisa que se va a utilizar cuando se aplica formato a los valore de divisa. Puede ser una cadena vacía.
|
Emite
TypeError — Si el parámetro currencyISOCode o currencySymbol es null.
|
Elementos de API relacionados
Este ejemplo utiliza las siguientes configuraciones regionales:
- La configuración regional del sistema operativo predeterminado para el formato de divisa (
LocaleID.DEFAULT
) - Japonés (Japón)
- Inglés (EE.UU.)
- Francés (Francia)
El ejemplo realiza las acciones siguientes para cada configuración regional de la lista:
- Crea un objeto CurrencyFormatter
- Utiliza el método
formattingWithCurrencySymbolIsSafe()
para comprobar si la divisa predeterminada para la configuración regional es euros ("EUR") y si es así, si da formato a la cadena mediante el símbolo de divisa. En caso contrario, aplica formato a la cadena mediante el código ISO.
package { import flash.display.Sprite; import flash.globalization.CurrencyFormatter; import flash.globalization.LocaleID; public class CurrencyFormatterExample1 extends Sprite { public function CurrencyFormatterExample1():void { var cf:CurrencyFormatter; var amountWithSymbol:String; var amountWithISOCode:String var localeNames:Array = [LocaleID.DEFAULT, "ja-JP", "en-US", "fr-FR"]; for each (var localeName:String in localeNames) { cf = new CurrencyFormatter(localeName); trace('\n' + "LocaleID requested=" + cf.requestedLocaleIDName + "; actual=" + cf.actualLocaleIDName); trace("Last Operation Status: " + cf.lastOperationStatus ); trace("Currency ISO Code: " + cf.currencyISOCode); if (cf.formattingWithCurrencySymbolIsSafe("EUR")) { amountWithSymbol = cf.format(123456789.19, true); trace("Format using Symbol: "+ amountWithSymbol); } else { amountWithISOCode = cf.format(123456789.19); trace("Format using ISO Code: " + amountWithISOCode); } } } } }
Este ejemplo lleva a cabo los siguientes pasos:
- Crea un objeto CurrencyFormatter para la configuración regional Inglés (EE.UU.).
- Utiliza el método
parse()
para analizar la cadena de entrada. - Muestra los valores de la cadena y la cantidad de divisa del objeto CurrencyParseResult resultante.
package { import flash.display.Sprite; import flash.globalization.CurrencyFormatter; import flash.globalization.CurrencyParseResult; import flash.globalization.LastOperationStatus; import flash.globalization.LocaleID; public class CurrencyFormatterParseExample extends Sprite { public function CurrencyFormatterParseExample() { var cf:CurrencyFormatter = new CurrencyFormatter( "en_US" ); trace("LocaleID requested=" + cf.requestedLocaleIDName + "; actual=" + cf.actualLocaleIDName); trace("Last Operation Status: " + cf.lastOperationStatus ); var inputString:String = "Dollar 123,567,89,0.254"; var result:CurrencyParseResult = cf.parse(inputString); if (cf.lastOperationStatus == LastOperationStatus.NO_ERROR ) { trace("Amount value: " + result.value); trace("Currency string: " + result.currencyString); } } } }
Tue Jun 12 2018, 02:12 PM Z