| Pakket | mx.validators |
| Klasse | public class CurrencyValidator |
| Overerving | CurrencyValidator  Validator EventDispatcher Object |
| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
 | spark.validators.CurrencyValidator |
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.
MXML-syntaxis
MXML-syntaxis weergeven
MXML-syntaxis verbergenThe <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=","
/>
Verwante API-elementen
| Eigenschap | Gedefinieerd door | ||
|---|---|---|---|
| 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
Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie. | 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 | |
| Methode | Gedefinieerd door | ||
|---|---|---|---|
Constructor. | CurrencyValidator | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt. | EventDispatcher | |
|
Verzendt een gebeurtenis naar de gebeurtenisstroom. | EventDispatcher | |
|
Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis. | EventDispatcher | |
|
Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd. | Object | |
|
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | |
|
Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven. | Object | |
|
Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd. | Object | |
|
Verwijdert een listener uit het object EventDispatcher. | EventDispatcher | |
|
Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in. | Object | |
|
Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies. | Object | |
|
Retourneert een tekenreeksrepresentatie van het opgegeven object. | Object | |
|
Performs validation and optionally notifies
the listeners of the result. | Validator | |
| [statisch]
Invokes all the validators in the validators Array. | Validator | |
[statisch]
Convenience method for calling a validator. | CurrencyValidator | ||
|
Retourneert de primitieve waarde van het opgegeven object. | Object | |
|
Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis. | EventDispatcher | |
| Methode | Gedefinieerd door | ||
|---|---|---|---|
|
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
[overschrijven]
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 | eigenschap |
alignSymbol:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | 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".
De standaardwaarde is CurrencyValidatorAlignSymbol.LEFT.
Implementatie
public function get alignSymbol():String public function set alignSymbol(value:String):voidVerwante API-elementen
allowNegative | eigenschap |
allowNegative:Object| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Specifies whether negative numbers are permitted.
Can be true or false.
De standaardwaarde is true.
Implementatie
public function get allowNegative():Object public function set allowNegative(value:Object):voidcurrencySymbol | eigenschap |
currencySymbol:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | 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.
De standaardwaarde is "$".
Implementatie
public function get currencySymbol():String public function set currencySymbol(value:String):voidcurrencySymbolError | eigenschap |
currencySymbolError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the currency symbol, defined by currencySymbol,
is in the wrong location.
De standaardwaarde is "The currency symbol occurs in an invalid location.".
Implementatie
public function get currencySymbolError():String public function set currencySymbolError(value:String):voiddecimalPointCountError | eigenschap |
decimalPointCountError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the decimal separator character occurs more than once.
De standaardwaarde is "The decimal separator can only occur once.".
Implementatie
public function get decimalPointCountError():String public function set decimalPointCountError(value:String):voiddecimalSeparator | eigenschap |
decimalSeparator:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | 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.
De standaardwaarde is ".".
Implementatie
public function get decimalSeparator():String public function set decimalSeparator(value:String):voidexceedsMaxError | eigenschap |
exceedsMaxError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the value is greater than maxValue.
De standaardwaarde is "The amount entered is too large.".
Implementatie
public function get exceedsMaxError():String public function set exceedsMaxError(value:String):voidinvalidCharError | eigenschap |
invalidCharError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the currency contains invalid characters.
De standaardwaarde is "The input contains invalid characters.".
Implementatie
public function get invalidCharError():String public function set invalidCharError(value:String):voidinvalidFormatCharsError | eigenschap |
invalidFormatCharsError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the value contains an invalid formatting character.
De standaardwaarde is "One of the formatting parameters is invalid.".
Implementatie
public function get invalidFormatCharsError():String public function set invalidFormatCharsError(value:String):voidlowerThanMinError | eigenschap |
lowerThanMinError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the value is less than minValue.
De standaardwaarde is "The amount entered is too small.".
Implementatie
public function get lowerThanMinError():String public function set lowerThanMinError(value:String):voidmaxValue | eigenschap |
maxValue:Object| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Maximum value for a valid number. A value of NaN means it is ignored.
De standaardwaarde is NaN.
Implementatie
public function get maxValue():Object public function set maxValue(value:Object):voidminValue | eigenschap |
minValue:Object| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Minimum value for a valid number. A value of NaN means it is ignored.
De standaardwaarde is NaN.
Implementatie
public function get minValue():Object public function set minValue(value:Object):voidnegativeError | eigenschap |
negativeError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the value is negative and
the allowNegative property is false.
De standaardwaarde is "The amount may not be negative.".
Implementatie
public function get negativeError():String public function set negativeError(value:String):voidprecision | eigenschap |
precision:Object| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | 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.
De standaardwaarde is 2.
Implementatie
public function get precision():Object public function set precision(value:Object):voidprecisionError | eigenschap |
precisionError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the value has a precision that exceeds the value
defined by the precision property.
De standaardwaarde is "The amount entered has too many digits beyond the decimal point.".
Implementatie
public function get precisionError():String public function set precisionError(value:String):voidseparationError | eigenschap |
separationError:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Error message when the thousands separator is incorrectly placed.
De standaardwaarde is "The thousands separator must be followed by three digits.".
Implementatie
public function get separationError():String public function set separationError(value:String):voidthousandsSeparator | eigenschap |
thousandsSeparator:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | 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.
De standaardwaarde is ",".
Implementatie
public function get thousandsSeparator():String public function set thousandsSeparator(value:String):voidCurrencyValidator | () | Constructor |
public function CurrencyValidator()| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Constructor.
doValidation | () | methode |
override protected function doValidation(value:Object):Array| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | 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.
Parameters
value:Object — Object to validate.
|
Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
validateCurrency | () | methode |
public static function validateCurrency(validator:CurrencyValidator, value:Object, baseField:String):Array| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.
Parameters
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.
|
Verwante API-elementen
<?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:42 AM Z