Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
IValidator

Package | mx.validators
Interface | public interface IValidator
Implementors | GlobalizationValidatorBase, Validator

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

This interface specifies the methods and properties that a Validator object must implement.

This interface allows to validate multiple data types like numbers, currency, phone numbers, zip codes etc that are defined in both mx and spark namespaces. The classes mx:Validator and spark:GlobaliationValidatorBase implement this interface. The validateAll() method in these classes use this interface type to call the validate() method on multiple validator objects.

See also

mx.validators.Validator
spark.validators.GlobalizationValidatorBase

Public Properties

| Property | Defined By
--- | --- | ---
|  | enabled : Boolean Property to enable/disable validation process. | IValidator

Public Methods

| Method | Defined By
--- | --- | ---
|  | validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Performs validation and optionally notifies the listeners of the result. | IValidator

Property Detail

enabled | property

`enabled:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.0

Property to enable/disable validation process.

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

The default value is `true`.

Implementation
`public function get enabled():Boolean`
`public function set enabled(value:Boolean):void`
Method Detail

validate | () | method

`public function validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Performs validation and optionally notifies the listeners of the result.

Parameters

| `value:Object` (default = `null`)`` — 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:Boolean` (default = `false`)`` — If `false`, then after validation, the validator will notify the listener of the result.

Returns

| `ValidationResultEvent` — 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

mx.events.ValidationResultEvent
mx.validators.ValidationResult

Wed Nov 15 2017, 09:50 AM +01:00