| Package | mx.validators |
| Class | public class CurrencyValidator |
| Inheritance | CurrencyValidator  Validator EventDispatcher Object |
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
Hide MXML Syntax
The <mx:CurrencyValidator> tag
inherits all of the tag properties of its superclass,
and adds the following tag properties:
Show MXML Syntax
<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=","
/>
See also
| Property | Defined By | ||
|---|---|---|---|
| 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
A reference to the class object or constructor function for a given object instance.
| Object | |
| currencySymbol : String
The single-character String used to specify the currency symbol,
such as "$" 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 | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
|
Constructor.
| CurrencyValidator | ||
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event.
| EventDispatcher | |
|
Dispatches an event into the event flow.
| EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Called automatically by the MXML compiler when the Validator
is created using an MXML tag.
| Validator | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Returns the string representation of the specified object.
| Object | |
|
Performs validation and optionally notifies
the listeners of the result.
| Validator | |
|
[static]
Invokes all the validators in the validators Array.
| Validator | |
|
[static]
Convenience method for calling a validator.
| CurrencyValidator | ||
|
Returns the primitive value of the specified object.
| Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator.
| Validator | |
|
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 | property |
alignSymbol:String [read-write]
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".
The default value is CurrencyValidatorAlignSymbol.LEFT.
public function get alignSymbol():String
public function set alignSymbol(value:String):void
See also
| allowNegative | property |
allowNegative:Object [read-write]
Specifies whether negative numbers are permitted.
Can be true or false.
The default value is true.
public function get allowNegative():Object
public function set allowNegative(value:Object):void
| currencySymbol | property |
currencySymbol:String [read-write]
The single-character String used to specify the currency symbol,
such as "$" or "£".
Cannot be a digit and must be distinct from the
thousandsSeparator and the decimalSeparator.
The default value is "$".
public function get currencySymbol():String
public function set currencySymbol(value:String):void
| currencySymbolError | property |
currencySymbolError:String [read-write]
Error message when the currency symbol, defined by currencySymbol,
is in the wrong location.
The default value is "The currency symbol occurs in an invalid location.".
public function get currencySymbolError():String
public function set currencySymbolError(value:String):void
| decimalPointCountError | property |
decimalPointCountError:String [read-write] Error message when the decimal separator character occurs more than once.
The default value is "The decimal separator can only occur once.".
public function get decimalPointCountError():String
public function set decimalPointCountError(value:String):void
| decimalSeparator | property |
decimalSeparator:String [read-write]
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.
The default value is ".".
public function get decimalSeparator():String
public function set decimalSeparator(value:String):void
| exceedsMaxError | property |
exceedsMaxError:String [read-write]
Error message when the value is greater than maxValue.
The default value is "The amount entered is too large.".
public function get exceedsMaxError():String
public function set exceedsMaxError(value:String):void
| invalidCharError | property |
invalidCharError:String [read-write] Error message when the currency contains invalid characters.
The default value is "The input contains invalid characters.".
public function get invalidCharError():String
public function set invalidCharError(value:String):void
| invalidFormatCharsError | property |
invalidFormatCharsError:String [read-write] Error message when the value contains an invalid formatting character.
The default value is "One of the formatting parameters is invalid.".
public function get invalidFormatCharsError():String
public function set invalidFormatCharsError(value:String):void
| lowerThanMinError | property |
lowerThanMinError:String [read-write]
Error message when the value is less than minValue.
The default value is "The amount entered is too small.".
public function get lowerThanMinError():String
public function set lowerThanMinError(value:String):void
| maxValue | property |
maxValue:Object [read-write] Maximum value for a valid number. A value of NaN means it is ignored.
The default value is NaN.
public function get maxValue():Object
public function set maxValue(value:Object):void
| minValue | property |
minValue:Object [read-write] Minimum value for a valid number. A value of NaN means it is ignored.
The default value is NaN.
public function get minValue():Object
public function set minValue(value:Object):void
| negativeError | property |
negativeError:String [read-write]
Error message when the value is negative and
the allowNegative property is false.
The default value is "The amount may not be negative.".
public function get negativeError():String
public function set negativeError(value:String):void
| precision | property |
precision:Object [read-write]
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.
The default value is 2.
public function get precision():Object
public function set precision(value:Object):void
| precisionError | property |
precisionError:String [read-write]
Error message when the value has a precision that exceeds the value
defined by the precision property.
The default value is "The amount entered has too many digits beyond the decimal point.".
public function get precisionError():String
public function set precisionError(value:String):void
| separationError | property |
separationError:String [read-write] Error message when the thousands separator is incorrectly placed.
The default value is "The thousands separator must be followed by three digits.".
public function get separationError():String
public function set separationError(value:String):void
| thousandsSeparator | property |
thousandsSeparator:String [read-write]
The character used to separate thousands.
Cannot be a digit and must be distinct from the
currencySymbol and the decimalSeparator.
The default value is ",".
public function get thousandsSeparator():String
public function set thousandsSeparator(value:String):void
| CurrencyValidator | () | Constructor |
public function CurrencyValidator()
Constructor.
| doValidation | () | method |
protected override function doValidation(value:Object):Array
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 | () | method |
public static function validateCurrency(validator:CurrencyValidator, value:Object, baseField:String):Array
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.
|
See also
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CurrencyValidator. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
import mx.controls.Alert;
</mx:Script>
<mx:CurrencyValidator source="{priceUS}" property="text" precision="2"
trigger="{myButton}" triggerEvent="click"
valid="Alert.show('Validation Succeeded!');"/>
<mx:Panel title="CurrencyValidator Example" width="75%" height="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Form>
<mx:FormItem label="Enter a U.S. dollar amount: ">
<mx:TextInput id="priceUS" width="100%"/>
</mx:FormItem>
<mx:FormItem >
<mx:Button id="myButton" label="Validate"/>
</mx:FormItem>
</mx:Form>
</mx:Panel>
</mx:Application>