CurrencyValidator

Paquete	mx.validators
Clase	public class CurrencyValidator
Herencia	CurrencyValidator Validator EventDispatcher 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.validators.CurrencyValidator como una alternativa a esta clase.

The CurrencyValidator class ensures that a String represents a valid currency expression. It can make sure the input falls within a given range (specified by minValue and maxValue), is non-negative (specified by allowNegative), and does not exceed the specified precision. The CurrencyValidator class correctly validates formatted and unformatted currency expressions, e.g., "$12,345.00" and "12345". You can customize the currencySymbol, alignSymbol, thousandsSeparator, and decimalSeparator properties for internationalization.

Sintaxis MXML expanded

Ocultar sintaxis MXML

The <mx:CurrencyValidator> tag inherits all of the tag properties of its superclass, and adds the following tag properties:

  <mx:CurrencyValidator
    alignSymbol="left|right|any"
    allowNegative="true|false"
    currencySymbol="$"
    currencySymbolError="The currency symbol occurs in an invalid location."
    decimalPointCountError="The decimal separator can occur only once."
    decimalSeparator="."
    exceedsMaxError="The amount entered is too large."
    invalidCharError="The input contains invalid characters."
    invalidFormatCharsError="One of the formatting parameters is invalid."
    lowerThanMinError="The amount entered is too small."
    maxValue="NaN"
    minValue="NaN"
    negativeError="The amount may not be negative."
    precision="2"
    precisionError="The amount entered has too many digits beyond the decimal point."
    separationError="The thousands separator must be followed by three digits."
    thousandsSeparator=","
  />

Ver los ejemplos

Elementos de API relacionados

mx.validators.CurrencyValidatorAlignSymbol

Propiedades públicas

Ocultar propiedades públicas heredadas

Mostrar propiedades públicas heredadas

	Propiedad		Definido por
		alignSymbol : String Specifies the alignment of the currencySymbol relative to the rest of the expression.	CurrencyValidator
		allowNegative : Object Specifies whether negative numbers are permitted.	CurrencyValidator
		constructor : Object Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.	Object
		currencySymbol : String The character String used to specify the currency symbol, such as "$", "R$", or "£".	CurrencyValidator
		currencySymbolError : String Error message when the currency symbol, defined by currencySymbol, is in the wrong location.	CurrencyValidator
		decimalPointCountError : String Error message when the decimal separator character occurs more than once.	CurrencyValidator
		decimalSeparator : String The character used to separate the whole from the fractional part of the number.	CurrencyValidator
		enabled : Boolean Setting this value to false will stop the validator from performing validation.	Validator
		exceedsMaxError : String Error message when the value is greater than maxValue.	CurrencyValidator
		invalidCharError : String Error message when the currency contains invalid characters.	CurrencyValidator
		invalidFormatCharsError : String Error message when the value contains an invalid formatting character.	CurrencyValidator
		listener : Object Specifies the validation listener.	Validator
		lowerThanMinError : String Error message when the value is less than minValue.	CurrencyValidator
		maxValue : Object Maximum value for a valid number.	CurrencyValidator
		minValue : Object Minimum value for a valid number.	CurrencyValidator
		negativeError : String Error message when the value is negative and the allowNegative property is false.	CurrencyValidator
		precision : Object The maximum number of digits allowed to follow the decimal point.	CurrencyValidator
		precisionError : String Error message when the value has a precision that exceeds the value defined by the precision property.	CurrencyValidator
		property : String A String specifying the name of the property of the source object that contains the value to validate.	Validator
		required : Boolean = true If true, specifies that a missing or empty value causes a validation error.	Validator
		requiredFieldError : String Error message when a value is missing and the required property is true.	Validator
		separationError : String Error message when the thousands separator is incorrectly placed.	CurrencyValidator
		source : Object Specifies the object containing the property to validate.	Validator
		thousandsSeparator : String The character used to separate thousands.	CurrencyValidator
		trigger : IEventDispatcher Specifies the component generating the event that triggers the validator.	Validator
		triggerEvent : String Specifies the event that triggers the validation.	Validator

Propiedades protegidas

Ocultar propiedades protegidas heredadas

Mostrar propiedades protegidas heredadas

	Propiedad		Definido por
		actualListeners : Array [solo lectura] Contains an Array of listener objects, if any, or the source object.	Validator
		actualTrigger : IEventDispatcher [solo lectura] Contains the trigger object, if any, or the source object.	Validator
		resourceManager : IResourceManager [solo lectura] A reference to the object which manages all of the application's localized resources.	Validator
		subFields : Array An Array of Strings containing the names for the properties contained in the value Object passed to the validate() method.	Validator

Métodos públicos

Ocultar métodos públicos heredados

Mostrar métodos públicos heredados

	Método		Definido por
		CurrencyValidator() Constructor.	CurrencyValidator
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento.	EventDispatcher
		dispatchEvent(event:Event):Boolean Distribuye un evento en el flujo del evento.	EventDispatcher
		hasEventListener(type:String):Boolean Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica si un objeto tiene definida una propiedad especificada.	Object
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the Validator is created using an MXML tag.	Validator
		isPrototypeOf(theClass:Object):Boolean Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica si existe la propiedad especificada y si es enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Elimina un detector del objeto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.	Object
		toLocaleString():String Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.	Object
		toString():String Devuelve la representación de cadena del objeto especificado.	Object
		validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Performs validation and optionally notifies the listeners of the result.	Validator
		validateAll(validators:Array):Array [estática] Invokes all the validators in the validators Array.	Validator
		validateCurrency(validator:CurrencyValidator, value:Object, baseField:String):Array [estática] Convenience method for calling a validator.	CurrencyValidator
		valueOf():Object Devuelve el valor simple del objeto especificado.	Object
		willTrigger(type:String):Boolean Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto.	EventDispatcher

Métodos protegidos

Ocultar métodos protegidos heredados

Mostrar métodos protegidos heredados

	Método		Definido por
		addListenerHandler():void Sets up all of the listeners for the valid and invalid events dispatched from the validator.	Validator
		doValidation(value:Object):Array [override] Override of the base class doValidation() method to validate a currency expression.	CurrencyValidator
		getValueFromSource():Object Returns the Object to validate.	Validator
		handleResults(errorResults:Array):ValidationResultEvent Returns a ValidationResultEvent from the Array of error results.	Validator
		isRealValue(value:Object):Boolean Returns true if value is not null.	Validator
		removeListenerHandler():void Disconnects all of the listeners for the valid and invalid events dispatched from the validator.	Validator
		resourcesChanged():void This method is called when a Validator is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.	Validator

Eventos

Haga clic para obtener más información sobre los eventos

Ocultar eventos heredados

Mostrar eventos heredados

	Resumen	Definido por
activate	[evento broadcast] Se distribuye cuando Flash Player o AIR pasan a estar activos.	EventDispatcher
deactivate	[evento broadcast] Se distribuye cuando Flash Player o de AIR pasan a estar inactivos.	EventDispatcher
invalid	Dispatched when validation fails.	Validator
valid	Dispatched when validation succeeds.	Validator

Constantes protegidas

Ocultar constantes protegidas heredadas

Mostrar constantes protegidas heredadas

	Constante		Definido por

Información sobre propiedades

alignSymbol

propiedad

alignSymbol: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 the alignment of the currencySymbol relative to the rest of the expression. Acceptable values in ActionScript are CurrencyValidatorAlignSymbol.LEFT, CurrencyValidatorAlignSymbol.RIGHT, and CurrencyValidatorAlignSymbol.ANY. Acceptable values in MXML are "left", "right", and "any".

El valor predeterminado es CurrencyValidatorAlignSymbol.LEFT.

Implementación
public function get alignSymbol():String
public function set alignSymbol(value:String):void

Elementos de API relacionados

mx.validators.CurrencyValidatorAlignSymbol

allowNegative

propiedad

allowNegative: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

Specifies whether negative numbers are permitted. Can be true or false.

El valor predeterminado es true.

Implementación
public function get allowNegative():Object
public function set allowNegative(value:Object):void

currencySymbol

propiedad

currencySymbol: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

The character String used to specify the currency symbol, such as "$", "R$", or "£". Cannot be a digit and must be distinct from the thousandsSeparator and the decimalSeparator.

El valor predeterminado es "$".

Implementación
public function get currencySymbol():String
public function set currencySymbol(value:String):void

currencySymbolError

propiedad

currencySymbolError: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

Error message when the currency symbol, defined by currencySymbol, is in the wrong location.

El valor predeterminado es "The currency symbol occurs in an invalid location.".

Implementación
public function get currencySymbolError():String
public function set currencySymbolError(value:String):void

decimalPointCountError

propiedad

decimalPointCountError: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

Error message when the decimal separator character occurs more than once.

El valor predeterminado es "The decimal separator can only occur once.".

Implementación
public function get decimalPointCountError():String
public function set decimalPointCountError(value:String):void

decimalSeparator

propiedad

decimalSeparator: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

The character used to separate the whole from the fractional part of the number. Cannot be a digit and must be distinct from the currencySymbol and the thousandsSeparator.

El valor predeterminado es ".".

Implementación
public function get decimalSeparator():String
public function set decimalSeparator(value:String):void

exceedsMaxError

propiedad

exceedsMaxError: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

Error message when the value is greater than maxValue.

El valor predeterminado es "The amount entered is too large.".

Implementación
public function get exceedsMaxError():String
public function set exceedsMaxError(value:String):void

invalidCharError

propiedad

invalidCharError: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

Error message when the currency contains invalid characters.

El valor predeterminado es "The input contains invalid characters.".

Implementación
public function get invalidCharError():String
public function set invalidCharError(value:String):void

invalidFormatCharsError

propiedad

invalidFormatCharsError: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

Error message when the value contains an invalid formatting character.

El valor predeterminado es "One of the formatting parameters is invalid.".

Implementación
public function get invalidFormatCharsError():String
public function set invalidFormatCharsError(value:String):void

lowerThanMinError

propiedad

lowerThanMinError: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

Error message when the value is less than minValue.

El valor predeterminado es "The amount entered is too small.".

Implementación
public function get lowerThanMinError():String
public function set lowerThanMinError(value:String):void

maxValue

propiedad

maxValue: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

Maximum value for a valid number. A value of NaN means it is ignored.

El valor predeterminado es NaN.

Implementación
public function get maxValue():Object
public function set maxValue(value:Object):void

minValue

propiedad

minValue: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

Minimum value for a valid number. A value of NaN means it is ignored.

El valor predeterminado es NaN.

Implementación
public function get minValue():Object
public function set minValue(value:Object):void

negativeError

propiedad

negativeError: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

Error message when the value is negative and the allowNegative property is false.

El valor predeterminado es "The amount may not be negative.".

Implementación
public function get negativeError():String
public function set negativeError(value:String):void

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

The maximum number of digits allowed to follow the decimal point. Can be any non-negative integer. Note: Setting to 0 has the same effect as setting NumberValidator.domain to int. Setting it to -1, means it is ignored.

El valor predeterminado es 2.

Implementación
public function get precision():Object
public function set precision(value:Object):void

precisionError

propiedad

precisionError: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

Error message when the value has a precision that exceeds the value defined by the precision property.

El valor predeterminado es "The amount entered has too many digits beyond the decimal point.".

Implementación
public function get precisionError():String
public function set precisionError(value:String):void

separationError

propiedad

separationError: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

Error message when the thousands separator is incorrectly placed.

El valor predeterminado es "The thousands separator must be followed by three digits.".

Implementación
public function get separationError():String
public function set separationError(value:String):void

thousandsSeparator

propiedad

thousandsSeparator: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

The character used to separate thousands. Cannot be a digit and must be distinct from the currencySymbol and the decimalSeparator.

El valor predeterminado es ",".

Implementación
public function get thousandsSeparator():String
public function set thousandsSeparator(value:String):void

Información sobre constructores

()

Información sobre

public function CurrencyValidator()

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.

Información sobre métodos

doValidation

()

método

override protected function doValidation(value:Object):Array

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

Override of the base class doValidation() method to validate a currency expression.

You do not call this method directly; Flex calls it as part of performing a validation. If you create a custom Validator class, you must implement this method.

Parámetros

value:Object — Object to validate.

Valor devuelto

Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

validateCurrency

()

método

public static function validateCurrency(validator:CurrencyValidator, value:Object, baseField:String):Array

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

Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.

Parámetros

	`validator:CurrencyValidator` — The CurrencyValidator instance.

	`value:Object` — The object to validate.

	`baseField:String` — Text representation of the subfield specified in the `value` parameter. For example, if the `value` parameter specifies value.currency, the baseField value is "currency".

Valor devuelto

Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

Elementos de API relacionados

mx.validators.ValidationResult

Ejemplos Cómo utilizar este ejemplo

CurrencyValidatorExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CurrencyValidator. -->
<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>
        import mx.controls.Alert;
    </fx:Script>

    <fx:Declarations>
        <mx:CurrencyValidator source="{priceUS}" property="text" precision="2" 
                trigger="{myButton}" triggerEvent="click" 
                valid="Alert.show('Validation Succeeded!');"/>
    </fx:Declarations>

    <s:Panel title="CurrencyValidator Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <mx:Form left="10" right="10" top="10" bottom="10">
            <mx:FormItem label="Enter a U.S. dollar amount: ">
                 <s:TextInput id="priceUS" width="100%"/>
            </mx:FormItem>
            <mx:FormItem >
                <s:Button id="myButton" label="Validate"/>
            </mx:FormItem>
        </mx:Form>
    </s:Panel>

</s:Application>

Avisos legales | Política de privacidad en línea

CurrencyValidator - AS3 Flex

Clases x

alignSymbol

allowNegative

currencySymbol

currencySymbolError

decimalPointCountError

decimalSeparator

exceedsMaxError

invalidCharError

invalidFormatCharsError

lowerThanMinError

maxValue

minValue

negativeError

precision

precisionError

separationError

thousandsSeparator