View source

class CurrencyValidator

package feathers.validators

extends Validator

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.

See also:

Static methods

staticvalidateCurrency(validator:CurrencyValidator, value:Dynamic, baseField:String):Array<ValidationResult>

Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.

Parameters:

validator

The CurrencyValidator instance.

value

The object to validate.

baseField

Text representation of the subfield specified in the value parameter. For example, if the value parameter specifies value.currency, the baseField value is "currency".

Returns:

An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

See also:

Constructor

new()

Constructor.

Variables

alignSymbol:String

Specifies the alignment of the currencySymbol relative to the rest of the expression. Acceptable values in Haxe are CurrencyValidatorAlignSymbol.LEFT, CurrencyValidatorAlignSymbol.RIGHT, and CurrencyValidatorAlignSymbol.ANY.

See also:

allowNegative:Bool

Specifies whether negative numbers are permitted. Can be true or false.

currencySymbol:String

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.

currencySymbolError:String

Error message when the currency symbol, defined by currencySymbol, is in the wrong location.

decimalPointCountError:String

Error message when the decimal separator character occurs more than once.

decimalSeparator:String

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.

exceedsMaxError:String

Error message when the value is greater than maxValue.

invalidCharError:String

Error message when the currency contains invalid characters.

invalidFormatCharsError:String

Error message when the value contains an invalid formatting character.

lowerThanMinError:String

Error message when the value is less than minValue.

maxValue:Float

Maximum value for a valid number. A value of Math.NaN means it is ignored.

minValue:Float

Minimum value for a valid number. A value of Math.NaN means it is ignored.

negativeError:String

Error message when the value is negative and the allowNegative property is false.

precision:Int

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.

precisionError:String

Error message when the value has a precision that exceeds the value defined by the precision property.

separationError:String

Error message when the thousands separator is incorrectly placed.

thousandsSeparator:String

The character used to separate thousands. Cannot be a digit and must be distinct from the currencySymbol and the decimalSeparator.

Inherited Variables

Defined by Validator

enabled:Bool

Setting this value to false will stop the validator from performing validation. When a validator is disabled, it dispatch no events, and the validate() method returns null. *

listener:Dynamic

Specifies the validation listener.

If you do not specify a listener, Flex uses the value of the source property. After Flex determines the source component, it changes the border color of the component, displays an error message for a failure, or hides any existing error message for a successful validation.

property:String

A String specifying the name of the property of the source object that contains the value to validate. Setting property is optional, but if you specify source, you should set a value for either property or valueFunction as well.

Reading the property uses reflection, which may not work if Dead Code Elimination (DCE) is enabled. The property property is included for backwards compatibility with the Flex API, but the new valueFunction is now recommended instead.

See also:

  • valueFunction

required:Bool

If true, specifies that a missing or empty value causes a validation error.

requiredFieldError:String

Error message when a value is missing and the required property is true.

source:Dynamic

Specifies the object containing the property to validate. Set this to an instance of a component or a data model. You use data binding syntax in MXML to specify the value. This property supports dot-delimited Strings for specifying nested properties.

If you specify a value to the source property, then you should specify a value to either the property property or the valueFunction property as well. The source property is optional.

See also:

  • property

  • valueFunction

trigger:IEventDispatcher

Specifies the component generating the event that triggers the validator. If omitted, by default Flex uses the value of the source property. When the trigger dispatches a triggerEvent, validation executes.

triggerEvent:String

Specifies the event that triggers the validation. If omitted, Flex uses the valueCommit event. Flex dispatches the valueCommit event when a user completes data entry into a control. Usually this is when the user removes focus from the component, or when a property value is changed programmatically. If you want a validator to ignore all events, set triggerEvent to the empty string ("").

valueFunction:() ‑> Dynamic

A function that returns the value to validate. It's recommended to use valueFunction instead of property because reflection is used with property, which could result in issues if Dead Code Elimination (DCE) is enabled.

Inherited Methods

Defined by Validator

@:value({ suppressEvents : false, value : null })validate(?value:Dynamic, suppressEvents:Bool = false):ValidationResultEvent

Performs validation and optionally notifies the listeners of the result.

Parameters:

value

Optional value to validate. If null, then the validator uses the source and property properties to determine the value. If you specify this argument, you should also set the listener property to specify the target component for any validation error messages.

suppressEvents

If false, then after validation, the validator will notify the listener of the result.

Returns:

A ValidationResultEvent object containing the results of the validation. For a successful validation, the ValidationResultEvent.results Array property is empty. For a validation failure, the ValidationResultEvent.results Array property contains one ValidationResult object for each field checked by the validator, both for fields that failed the validation and for fields that passed. Examine the ValidationResult.isError property to determine if the field passed or failed the validation.

See also: