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

Package | spark.validators.supportClasses
Class | public class GlobalizationValidatorBase
Inheritance | GlobalizationValidatorBase GlobalizationBase AdvancedStyleClient flash.events.EventDispatcher
Implements | IValidator
Subclasses | NumberValidatorBase

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

The GlobalizationValidatorBase class is the base class for all Spark validators. This class implements the ability for a validator to make a field required, which means that the user must enter a value in the field or the validation fails. This class also enables or disables the validator.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<s:GlobalizationValidatorBase>` tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

      <s:GlobalizationValidatorBase
        Properties
        enabled="true"
        listener="Value of the source property"
        property="No default"
        required="true"
        requiredFieldError="This field is required."
        source="No default"
        trigger="Value of the source property"
        triggerEvent="valueCommit"

        Events
        invalid="No default"
        valid="No default"
      />

See also

mx.events.ValidationResultEvent
mx.validators.ValidationResult
mx.validators.RegExpValidationResult

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | actualLocaleIDName : String [read-only] The name of the actual locale ID used by this class object. | GlobalizationBase
|  | className : String [read-only] The name of the component class. | AdvancedStyleClient
|  | enabled : Boolean Setting this value to false will stop the validator from performing validation. | GlobalizationValidatorBase
|  | id : String The identity of the component. | AdvancedStyleClient
|  | inheritingStyles : Object An object containing the inheritable styles for this non-visual style client instance. | AdvancedStyleClient
|  | lastOperationStatus : String [read-only] The status of the most recent operation that this class object performed. | GlobalizationBase
|  | listener : Object Specifies the validation listener. | GlobalizationValidatorBase
|  | moduleFactory : IFlexModuleFactory A module factory is used as context for finding the style manager that controls the styles for this non-visual style client instance. | AdvancedStyleClient
|  | nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles. | AdvancedStyleClient
|  | property : String A String specifying the name of the property of the source object that contains the value to validate. | GlobalizationValidatorBase
|  | required : Boolean = true If true, specifies that a missing or empty value causes a validation error. | GlobalizationValidatorBase
|  | requiredFieldError : String Error message when a value is missing and the required property is true. | GlobalizationValidatorBase
|  | source : Object Specifies the object containing the property to validate. | GlobalizationValidatorBase
|  | styleDeclaration : CSSStyleDeclaration The style declaration that holds the inline styles declared by this object. | AdvancedStyleClient
|  | styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component. | AdvancedStyleClient
|  | styleName : Object The source of this object's style values. | AdvancedStyleClient
|  | styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors. | AdvancedStyleClient
|  | trigger : IEventDispatcher Specifies the component generating the event that triggers the validator. | GlobalizationValidatorBase
|  | triggerEvent : String Specifies the event that triggers the validation. | GlobalizationValidatorBase

Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualListeners : Array [read-only] Contains an Array of listener objects, if any, or the source object. | GlobalizationValidatorBase
|  | actualTrigger : IEventDispatcher [read-only] Contains the trigger object, if any, or the source object. | GlobalizationValidatorBase
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | GlobalizationValidatorBase
|  | subFields : Array An Array of Strings containing the names for the properties contained in the value Object passed to the validate() method. | GlobalizationValidatorBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | GlobalizationValidatorBase() Constructor. | GlobalizationValidatorBase
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | AdvancedStyleClient
|  | getClassStyleDeclarations():Array Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist. | AdvancedStyleClient
|  | getStyle(styleProp:String):* [override] Gets a style property that has been set anywhere in this component's style lookup chain. | GlobalizationBase
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | AdvancedStyleClient
|  | initialized(document:Object, id:String):void The initialized method is called when this class or a class that extends this class is used in an MXML declaration. | AdvancedStyleClient
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | AdvancedStyleClient
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | AdvancedStyleClient
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children of this style client instance. | AdvancedStyleClient
|  | regenerateStyleCache(recursive:Boolean):void Sets up the internal style cache values so that the getStyle() method functions. | AdvancedStyleClient
|  | registerEffects(effects:Array):void Registers the EffectManager as one of the event listeners for each effect event. | AdvancedStyleClient
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | AdvancedStyleClient
|  | styleChanged(styleProp:String):void Detects changes to style properties. | AdvancedStyleClient
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | AdvancedStyleClient
|  | validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Performs validation and optionally notifies the listeners of the result. | GlobalizationValidatorBase
|  | validateAll(validators:Array):Array [static] Invokes all the validators in the validators Array. | GlobalizationValidatorBase

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | addListenerHandler():void Sets up all of the listeners for the valid and invalid events dispatched from the validator. | GlobalizationValidatorBase
|  | doValidation(value:Object):Array Executes the validation logic of this validator, including validating that a missing or empty value causes a validation error as defined by the value of the required property. | GlobalizationValidatorBase
|  | getValueFromSource():Object Returns the Object to validate. | GlobalizationValidatorBase
|  | handleResults(errorResults:Array):ValidationResultEvent Returns a ValidationResultEvent from the Array of error results. | GlobalizationValidatorBase
|  | isRealValue(value:Object):Boolean Returns true if value is not null. | GlobalizationValidatorBase
|  | removeListenerHandler():void Disconnects all of the listeners for the valid and invalid events dispatched from the validator. | GlobalizationValidatorBase
|  | resourcesChanged():void This method is called when a GlobalizationValidatorBase is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way. | GlobalizationValidatorBase
|  | setDeferredStyles():void | AdvancedStyleClient

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | change | The change event is generated whenever the locale style is changed or another property is set that would cause the format of a number to change or cause updates to the other values available through this class. | GlobalizationBase
|  | invalid | Dispatched when validation fails. | GlobalizationValidatorBase
|  | valid | Dispatched when validation succeeds. | GlobalizationValidatorBase

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | locale | Type: String CSS Inheritance: yes The locale identifier that specifies the language, region, script and optionally other related tags and keys. See also http://www.unicode.org/reports/tr35/ | GlobalizationBase

Property Detail

actualListeners | property

`actualListeners:Array` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Contains an Array of listener objects, if any, or the source object. Used to determine which object to notify about the validation result.

Implementation
`protected function get actualListeners():Array`

actualTrigger | property |

`actualTrigger:IEventDispatcher` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Contains the trigger object, if any, or the source object. Used to determine the listener object for the `triggerEvent`.

Implementation
`protected function get actualTrigger():IEventDispatcher`

enabled | property |

`enabled:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

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`

listener | property |

`listener:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

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.

Implementation
`public function get listener():Object`
`public function set listener(value:Object):void`

property | property |

`property:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

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

The default value is `null`.

Implementation
`public function get property():String`
`public function set property(value:String):void`

required | property |

`public var required:Boolean = true`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

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

The default value is `true`.

requiredFieldError | property |

`requiredFieldError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

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

The default value is `"This field is required."`.

Implementation
`public function get requiredFieldError():String`
`public function set requiredFieldError(value:String):void`

resourceManager | property |

`resourceManager:IResourceManager` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

A reference to the object which manages all of the application's localized resources. This is a singleton instance which implements the IResourceManager interface.

This property can be used as the source for data binding.

Implementation
`protected function get resourceManager():IResourceManager`

source | property |

`source:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

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 the `property` property as well. The `source` property is optional.

The default value is `null`.

Implementation
`public function get source():Object`
`public function set source(value:Object):void`

subFields | property |

`protected var subFields:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

An Array of Strings containing the names for the properties contained in the `value` Object passed to the `validate()` method. For example, CreditCardValidator sets this property to `[ "cardNumber", "cardType" ]`. This value means that the `value` Object passed to the `validate()` method should contain a `cardNumber` and a `cardType` property.

trigger | property |

`trigger:IEventDispatcher`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

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.

Implementation
`public function get trigger():IEventDispatcher`
`public function set trigger(value:IEventDispatcher):void`

triggerEvent | property |

`triggerEvent:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

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 ("").

Implementation
`public function get triggerEvent():String`
`public function set triggerEvent(value:String):void`
Constructor Detail

GlobalizationValidatorBase | () | Constructor

`public function GlobalizationValidatorBase()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Constructor.

Method Detail

addListenerHandler | () | method

`protected function addListenerHandler():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Sets up all of the listeners for the `valid` and `invalid` events dispatched from the validator. Subclasses of the GlobalizationValidatorBase class should first call the `removeListenerHandler()` method, and then the `addListenerHandler()` method if the value of one of their listeners or sources changes. The CreditCardValidator and DateValidator classes use this function internally.

doValidation | () | method |

`protected function doValidation(value:Object):Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Executes the validation logic of this validator, including validating that a missing or empty value causes a validation error as defined by the value of the `required` property.

If you create a subclass of a validator class, you must override this method.

Parameters

| `value:Object` — Value to validate.

Returns

| `Array` — For an invalid result, an Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator that failed validation.

See also

mx.validators.ValidationResult

getValueFromSource | () | method |

`protected function getValueFromSource():Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Returns the Object to validate.

Returns

| `Object` — The Object to validate.

handleResults | () | method |

`protected function handleResults(errorResults:Array):ValidationResultEvent`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Returns a ValidationResultEvent from the Array of error results. Internally, this function takes the results from the `doValidation()` method and puts it into a ValidationResultEvent object. You never call this function directly, and you should rarely override it.

Parameters

| `errorResults:Array` — Array of ValidationResult objects.

Returns

| `ValidationResultEvent` — The ValidationResultEvent returned by the `validate()` method.

isRealValue | () | method |

`protected function isRealValue(value:Object):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Returns `true` if `value` is not null.

Parameters

| `value:Object` — The value to test.

Returns

| `Boolean` — `true` if `value` is not null.

removeListenerHandler | () | method |

`protected function removeListenerHandler():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Disconnects all of the listeners for the `valid` and `invalid` events dispatched from the validator. Subclasses should first call the `removeListenerHandler()` method and then the `addListenerHandler` method if the value of one of their listeners or sources changes. The CreditCardValidator and DateValidator classes use this function internally.

resourcesChanged | () | method |

`protected function resourcesChanged():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

This method is called when a GlobalizationValidatorBase is constructed, and again whenever the ResourceManager dispatches a `"change"` Event to indicate that the localized resources have changed in some way.

This event will be dispatched when you set the ResourceManager's `localeChain` property, when a resource module has finished loading, and when you call the ResourceManager's `update()` method.

Subclasses should override this method and, after calling `super.resourcesChanged()`, do whatever is appropriate in response to having new resource values.

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

validateAll | () | method |

`public static function validateAll(validators:Array):Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Invokes all the validators in the `validators` Array. Returns an Array containing one ValidationResultEvent object for each validator that failed. Returns an empty Array if all validators succeed.

Parameters

| `validators:Array` — An Array containing the GlobalizationValidatorBase objects to execute.

Returns

| `Array` — Array of ValidationResultEvent objects, where the Array contains one ValidationResultEvent object for each validator that failed. The Array is empty if all validators succeed.

Event Detail

invalid | Event

Event Object Type: `mx.events.ValidationResultEvent`
ValidationResultEvent.type property = `mx.events.ValidationResultEvent.INVALID`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Dispatched when validation fails.

The `ValidationResultEvent.INVALID` constant defines the value of the `type` property of the event object for an `invalid` event. The value of this constant is "invalid".

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`field` | The name of the field that failed validation.
`message` | A single string that contains every error message from all of the ValidationResult objects in the results Array.
`results` | An array of ValidationResult objects, one per validated field.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

valid | Event |

Event Object Type: `mx.events.ValidationResultEvent`
ValidationResultEvent.type property = `mx.events.ValidationResultEvent.VALID`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Dispatched when validation succeeds.

The `ValidationResultEvent.VALID` constant defines the value of the `type` property of the event object for a `valid`event. The value of this constant is "valid".

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`field` | An empty String.
`message` | An empty String.
`results` | An empty Array.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

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