Package | spark.validators |
Class | public class CurrencyValidator |
Inheritance | CurrencyValidator ![]() ![]() ![]() ![]() ![]() ![]() |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4.5 |
Runtime Versions: | Flash Player 10.1, AIR 2.5 |
CurrencyValidator
class ensures that a String represents
a valid currency amount according to the conventions of a locale.
This class uses the locale
style for specifying the Locale ID.
The validator can ensure that a currency string falls within a given
range (specified by minValue
and maxValue
properties), is an integer (specified by domain
property),
is non-negative (specified by allowNegative
property),
correctly specifies negative and positive numbers,
has the correct currency ISO code or currency symbol,
and does not exceed the specified number of fractionalDigits
.
The validator sets default property values by making use of the
flash.globalization.CurrencyFormatter
class and therefore the
locale specific values are supplied by the operating system.
The flash.globalization.CurrencyFormatter
class uses the
underlying operating system to supply the locale specific data. In case
the operating system does not provide currency formatting, this class
provides fallback functionality.

The <s:CurrencyValidator>
tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<s:CurrencyValidator Properties currencyISOCode="locale specified string or customized by user." currencyStringError="Currency name is repeated or not correct." currencySymbol="locale specified string or customized by user." negativeCurrencyFormat="locale specified string or customized by user." negativeCurrencyFormatError="The negative format of the input currency is incorrect." positiveCurrencyFormat="locale specified string or customized by user." positiveCurrencyFormatError="The positive format of the input currency is incorrect." />
More examples
Related API Elements
Property | Defined By | ||
---|---|---|---|
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object |
Method | Defined By | ||
---|---|---|---|
![]() | 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 | |
![]() |
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 this object, formatted according to locale-specific conventions. | Object | |
![]() |
Returns the string representation of the specified object. | Object | |
![]() |
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 |
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
<?xml version="1.0" encoding="utf-8"?> <!-- Sample program for spark.formatters.NumberValidator --> <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:Declarations> <s:CurrencyValidator id="currencyValidator" source='{inputNumber}' property="text" trigger='{validateBtn}' triggerEvent="click" /> <s:CurrencyFormatter id="currencyFormatter" useCurrencySymbol="true" useGrouping="true"/> </fx:Declarations> <fx:Script> <![CDATA[ [Bindable] private var number:Number = 123456789.12; ]]> </fx:Script> <mx:Form> <mx:FormItem label="Input Locale ID Name"> <mx:HBox> <s:TextInput id="inputLocaleIDName" text="en-US"/> <!-- Upon button click, sets the locale style on the document UI component. The formatter will inherit this style. --> <s:Button click="setStyle('locale', inputLocaleIDName.text);" label="Apply"/> </mx:HBox> <mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/> </mx:FormItem> <mx:FormItem label="Allow Negative"> <mx:CheckBox id="alowNegative" selected="true" change="currencyValidator.allowNegative = alowNegative.selected"/> </mx:FormItem> <mx:FormItem label="Fractional Digits"> <mx:TextInput id="fractionalDigits" text='{currencyValidator.fractionalDigits}' change="currencyFormatter.fractionalDigits = currencyValidator.fractionalDigits = Number(fractionalDigits.text)"/> </mx:FormItem> <mx:FormItem label="Currency Symbol"> <mx:TextInput id="currencySymbol" text='{currencyValidator.currencySymbol}' change="currencyFormatter.currencySymbol = currencyValidator.currencySymbol = currencySymbol.text"/> </mx:FormItem> <mx:FormItem label="Actual Locale ID Name"> <mx:Text text="{currencyValidator.actualLocaleIDName}"/> </mx:FormItem> <mx:FormItem label="Enter currency amount" > <mx:HBox> <mx:TextInput id="inputNumber" /> <mx:Button id="validateBtn" label="Validate" /> </mx:HBox> </mx:FormItem> <mx:FormItem label="Example currency"> <mx:Text text="{currencyFormatter.format(123456789.12)}"/> </mx:FormItem> </mx:Form> </s:Application>
Wed Nov 21 2018, 06:34 AM -08:00