| Paket | mx.validators |
| Klass | public class CurrencyValidator |
| Arv | CurrencyValidator  Validator EventDispatcher Object |
| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
 | Med början från Flex 4.5, rekommenderar Adobe att du använder klassen spark.validators.CurrencyValidator som ett alternativ till den här klassen. |
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-syntax
Visa MXML-syntax
Dölj MXML-syntaxThe <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=","
/>
Relaterade API-element
| Egenskap | Definieras med | ||
|---|---|---|---|
| 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
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans. | 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 | |
| Metod | Definieras med | ||
|---|---|---|---|
Constructor. | CurrencyValidator | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser. | EventDispatcher | |
|
Skickar en händelse till händelseflödet. | EventDispatcher | |
|
Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse. | EventDispatcher | |
|
Anger om det finns en egenskap angiven för ett objekt. | Object | |
|
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | |
|
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter. | Object | |
|
Anger om den angivna egenskapen finns och är uppräkningsbar. | Object | |
|
Tar bort en avlyssnare från EventDispatcher-objektet. | EventDispatcher | |
|
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder. | Object | |
|
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner. | Object | |
|
Returnerar det angivna objektets strängbeteckning. | Object | |
|
Performs validation and optionally notifies
the listeners of the result. | Validator | |
| [statisk]
Invokes all the validators in the validators Array. | Validator | |
[statisk]
Convenience method for calling a validator. | CurrencyValidator | ||
|
Returnerar det angivna objektets primitiva värde. | Object | |
|
Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen. | EventDispatcher | |
| Metod | Definieras med | ||
|---|---|---|---|
|
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
[åsidosätt]
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 | egenskap |
alignSymbol:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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".
Standardvärdet är CurrencyValidatorAlignSymbol.LEFT.
Implementering
public function get alignSymbol():String public function set alignSymbol(value:String):voidRelaterade API-element
allowNegative | egenskap |
allowNegative:Object| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Specifies whether negative numbers are permitted.
Can be true or false.
Standardvärdet är true.
Implementering
public function get allowNegative():Object public function set allowNegative(value:Object):voidcurrencySymbol | egenskap |
currencySymbol:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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.
Standardvärdet är "$".
Implementering
public function get currencySymbol():String public function set currencySymbol(value:String):voidcurrencySymbolError | egenskap |
currencySymbolError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the currency symbol, defined by currencySymbol,
is in the wrong location.
Standardvärdet är "The currency symbol occurs in an invalid location.".
Implementering
public function get currencySymbolError():String public function set currencySymbolError(value:String):voiddecimalPointCountError | egenskap |
decimalPointCountError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the decimal separator character occurs more than once.
Standardvärdet är "The decimal separator can only occur once.".
Implementering
public function get decimalPointCountError():String public function set decimalPointCountError(value:String):voiddecimalSeparator | egenskap |
decimalSeparator:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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.
Standardvärdet är ".".
Implementering
public function get decimalSeparator():String public function set decimalSeparator(value:String):voidexceedsMaxError | egenskap |
exceedsMaxError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the value is greater than maxValue.
Standardvärdet är "The amount entered is too large.".
Implementering
public function get exceedsMaxError():String public function set exceedsMaxError(value:String):voidinvalidCharError | egenskap |
invalidCharError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the currency contains invalid characters.
Standardvärdet är "The input contains invalid characters.".
Implementering
public function get invalidCharError():String public function set invalidCharError(value:String):voidinvalidFormatCharsError | egenskap |
invalidFormatCharsError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the value contains an invalid formatting character.
Standardvärdet är "One of the formatting parameters is invalid.".
Implementering
public function get invalidFormatCharsError():String public function set invalidFormatCharsError(value:String):voidlowerThanMinError | egenskap |
lowerThanMinError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the value is less than minValue.
Standardvärdet är "The amount entered is too small.".
Implementering
public function get lowerThanMinError():String public function set lowerThanMinError(value:String):voidmaxValue | egenskap |
maxValue:Object| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Maximum value for a valid number. A value of NaN means it is ignored.
Standardvärdet är NaN.
Implementering
public function get maxValue():Object public function set maxValue(value:Object):voidminValue | egenskap |
minValue:Object| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Minimum value for a valid number. A value of NaN means it is ignored.
Standardvärdet är NaN.
Implementering
public function get minValue():Object public function set minValue(value:Object):voidnegativeError | egenskap |
negativeError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the value is negative and
the allowNegative property is false.
Standardvärdet är "The amount may not be negative.".
Implementering
public function get negativeError():String public function set negativeError(value:String):voidprecision | egenskap |
precision:Object| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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.
Standardvärdet är 2.
Implementering
public function get precision():Object public function set precision(value:Object):voidprecisionError | egenskap |
precisionError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the value has a precision that exceeds the value
defined by the precision property.
Standardvärdet är "The amount entered has too many digits beyond the decimal point.".
Implementering
public function get precisionError():String public function set precisionError(value:String):voidseparationError | egenskap |
separationError:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Error message when the thousands separator is incorrectly placed.
Standardvärdet är "The thousands separator must be followed by three digits.".
Implementering
public function get separationError():String public function set separationError(value:String):voidthousandsSeparator | egenskap |
thousandsSeparator:String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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.
Standardvärdet är ",".
Implementering
public function get thousandsSeparator():String public function set thousandsSeparator(value:String):voidCurrencyValidator | () | Konstruktor |
public function CurrencyValidator()| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Constructor.
doValidation | () | metod |
override protected function doValidation(value:Object):Array| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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.
Parametrar
value:Object — Object to validate.
|
Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
validateCurrency | () | metod |
public static function validateCurrency(validator:CurrencyValidator, value:Object, baseField:String):Array| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.
Parametrar
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.
|
Relaterade API-element
<?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>
Tue Jun 12 2018, 01:40 PM Z