| Pacote | mx.validators |
| Classe | public class CurrencyValidator |
| Herança | CurrencyValidator  Validator EventDispatcher 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.validators.CurrencyValidator como uma alternativa a esta classe. |
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.
Sintaxe MXML
Mostrar sintaxe MXML
Ocultar sintaxe MXMLThe <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=","
/>
Elementos da API relacionados
| Propriedade | 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
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | 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 | |
| Método | Definido por | ||
|---|---|---|---|
Constructor. | CurrencyValidator | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento. | EventDispatcher | |
|
Envia um evento para o fluxo de eventos. | EventDispatcher | |
|
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento. | EventDispatcher | |
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
|
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | |
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
|
Remove um ouvinte do objeto EventDispatcher. | EventDispatcher | |
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
|
Performs validation and optionally notifies
the listeners of the result. | Validator | |
| [estático]
Invokes all the validators in the validators Array. | Validator | |
[estático]
Convenience method for calling a validator. | CurrencyValidator | ||
|
Retorna o valor primitivo do objeto especificado. | Object | |
|
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado. | EventDispatcher | |
| Método | Definido por | ||
|---|---|---|---|
|
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
[substituir]
Override of the base class doValidation() method
to validate a currency expression. | CurrencyValidator | ||
|
Returns the Object to validate. | Validator | |
|
Returns a ValidationResultEvent from the Array of error results. | Validator | |
|
Returns true if value is not null. | Validator | |
|
Disconnects all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
|
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 | |
alignSymbol | propriedade |
alignSymbol: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 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".
O valor padrão é CurrencyValidatorAlignSymbol.LEFT.
Implementação
public function get alignSymbol():String public function set alignSymbol(value:String):voidElementos da API relacionados
allowNegative | propriedade |
allowNegative:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Specifies whether negative numbers are permitted.
Can be true or false.
O valor padrão é true.
Implementação
public function get allowNegative():Object public function set allowNegative(value:Object):voidcurrencySymbol | propriedade |
currencySymbol:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
O valor padrão é "$".
Implementação
public function get currencySymbol():String public function set currencySymbol(value:String):voidcurrencySymbolError | propriedade |
currencySymbolError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the currency symbol, defined by currencySymbol,
is in the wrong location.
O valor padrão é "The currency symbol occurs in an invalid location.".
Implementação
public function get currencySymbolError():String public function set currencySymbolError(value:String):voiddecimalPointCountError | propriedade |
decimalPointCountError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the decimal separator character occurs more than once.
O valor padrão é "The decimal separator can only occur once.".
Implementação
public function get decimalPointCountError():String public function set decimalPointCountError(value:String):voiddecimalSeparator | propriedade |
decimalSeparator:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
O valor padrão é ".".
Implementação
public function get decimalSeparator():String public function set decimalSeparator(value:String):voidexceedsMaxError | propriedade |
exceedsMaxError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the value is greater than maxValue.
O valor padrão é "The amount entered is too large.".
Implementação
public function get exceedsMaxError():String public function set exceedsMaxError(value:String):voidinvalidCharError | propriedade |
invalidCharError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the currency contains invalid characters.
O valor padrão é "The input contains invalid characters.".
Implementação
public function get invalidCharError():String public function set invalidCharError(value:String):voidinvalidFormatCharsError | propriedade |
invalidFormatCharsError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the value contains an invalid formatting character.
O valor padrão é "One of the formatting parameters is invalid.".
Implementação
public function get invalidFormatCharsError():String public function set invalidFormatCharsError(value:String):voidlowerThanMinError | propriedade |
lowerThanMinError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the value is less than minValue.
O valor padrão é "The amount entered is too small.".
Implementação
public function get lowerThanMinError():String public function set lowerThanMinError(value:String):voidmaxValue | propriedade |
maxValue:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Maximum value for a valid number. A value of NaN means it is ignored.
O valor padrão é NaN.
Implementação
public function get maxValue():Object public function set maxValue(value:Object):voidminValue | propriedade |
minValue:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Minimum value for a valid number. A value of NaN means it is ignored.
O valor padrão é NaN.
Implementação
public function get minValue():Object public function set minValue(value:Object):voidnegativeError | propriedade |
negativeError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the value is negative and
the allowNegative property is false.
O valor padrão é "The amount may not be negative.".
Implementação
public function get negativeError():String public function set negativeError(value:String):voidprecision | 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 |
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.
O valor padrão é 2.
Implementação
public function get precision():Object public function set precision(value:Object):voidprecisionError | propriedade |
precisionError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the value has a precision that exceeds the value
defined by the precision property.
O valor padrão é "The amount entered has too many digits beyond the decimal point.".
Implementação
public function get precisionError():String public function set precisionError(value:String):voidseparationError | propriedade |
separationError:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Error message when the thousands separator is incorrectly placed.
O valor padrão é "The thousands separator must be followed by three digits.".
Implementação
public function get separationError():String public function set separationError(value:String):voidthousandsSeparator | propriedade |
thousandsSeparator:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
O valor padrão é ",".
Implementação
public function get thousandsSeparator():String public function set thousandsSeparator(value:String):voidCurrencyValidator | () | Construtor |
public function CurrencyValidator()| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Constructor.
doValidation | () | método |
override protected function doValidation(value:Object):Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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.
|
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| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | 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".
|
Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
Elementos da API relacionados
<?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>
Wed Jun 13 2018, 11:10 AM Z