| Package | spark.validators.supportClasses |
| Class | public class GlobalizationValidatorBase |
| Inheritance | GlobalizationValidatorBase  GlobalizationBase AdvancedStyleClient EventDispatcher Object |
| Implements | IValidator |
| Subclasses | NumberValidatorBase |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10.1, AIR 2.5 |
Show MXML Syntax
Hide MXML SyntaxThe <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"
/>
Related API Elements
| 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 | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| 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 | ||
| 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 | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | GlobalizationValidatorBase | ||
| 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 | |
|
Deletes a style property from this component instance. | AdvancedStyleClient | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Returns an Array of CSSStyleDeclaration objects for the type selector
that applies to this component, or null if none exist. | AdvancedStyleClient | |
| [override]
Gets a style property that has been set anywhere in this
component's style lookup chain. | GlobalizationBase | |
|
Returns true if currentCSSState is not null. | AdvancedStyleClient | |
|
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 | |
|
The initialized method is called when this class or a class that
extends this class is used in an MXML declaration. | AdvancedStyleClient | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Returns true if cssState matches currentCSSState. | AdvancedStyleClient | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | AdvancedStyleClient | |
|
Propagates style changes to the children of this style client
instance. | AdvancedStyleClient | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets up the internal style cache values so that the
getStyle()
method functions. | AdvancedStyleClient | |
|
Registers the EffectManager as one of the event listeners
for each effect event. | AdvancedStyleClient | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | AdvancedStyleClient | |
|
Detects changes to style properties. | AdvancedStyleClient | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | AdvancedStyleClient | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
Performs validation and optionally notifies
the listeners of the result. | GlobalizationValidatorBase | ||
[static]
Invokes all the validators in the validators Array. | GlobalizationValidatorBase | ||
|
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. | GlobalizationValidatorBase | ||
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 | ||
Returns the Object to validate. | GlobalizationValidatorBase | ||
Returns a ValidationResultEvent from the Array of error results. | GlobalizationValidatorBase | ||
Returns true if value is not null. | GlobalizationValidatorBase | ||
Disconnects all of the listeners for the
valid and invalid
events dispatched from the validator. | GlobalizationValidatorBase | ||
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 | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| 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 | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when validation fails. | GlobalizationValidatorBase | |||
| Dispatched when validation succeeds. | GlobalizationValidatorBase | |||
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.
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():ArrayactualTrigger | 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():IEventDispatcherenabled | 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):voidlistener | 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):voidproperty | 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):voidrequired | 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):voidresourceManager | 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. When this property is modified, it dispatches the unused event.
Implementation
protected function get resourceManager():IResourceManagersource | 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):voidsubFields | 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):voidtriggerEvent | 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):voidGlobalizationValidatorBase | () | Constructor |
public function GlobalizationValidatorBase()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10.1, AIR 2.5 |
Constructor.
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.
|
Array — For an invalid result, an Array of ValidationResult objects,
with one ValidationResult object for each field examined
by the validator that failed validation.
|
Related API Elements
getValueFromSource | () | method |
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.
|
ValidationResultEvent — The ValidationResultEvent returned by the
validate() method.
|
isRealValue | () | method |
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)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)false, then after validation,
the validator will notify the listener of the result.
|
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.
|
Related API Elements
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.
|
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.
|
invalid | Event |
mx.events.ValidationResultEventproperty ValidationResultEvent.type =
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.
TheValidationResultEvent.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 |
mx.events.ValidationResultEventproperty ValidationResultEvent.type =
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.
TheValidationResultEvent.VALID constant defines the value of the
type property of the event object for a validevent.
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. |
Thu Dec 6 2018, 01:12 PM -08:00