Validator

(Preview)

Package	mx.validators
Class	public class Validator
Inheritance	Validator EventDispatcher Object
Implements	IMXMLObject, IValidator
Subclasses	CreditCardValidator, CurrencyValidator, DateValidator, EmailValidator, NumberValidator, PhoneNumberValidator, RegExpValidator, SocialSecurityValidator, StringValidator, StyleValidator, ZipCodeValidator

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The Validator class is the base class for all Flex 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.

MXML Syntax expanded

Hide MXML Syntax

The Validator class defines the following tag attributes, which all of its subclasses inherit:

  <mx:Validator 
    enabled="true|false" 
    listener="Value of the source property" 
    property="No default" 
    required="true|false" 
    requiredFieldError="This field is required." 
    source="No default" 
    trigger="Value of the source property" 
    triggerEvent="valueCommit" 
  />

View the examples

More examples

Using error tips
Validating data by using custom validators
Example: Creating a simple validator

Related API Elements

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

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		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.	Validator
		listener : Object Specifies the validation listener.	Validator
		property : String A String specifying the name of the property of the source object that contains the value to validate.	Validator
		required : Boolean = true If true, specifies that a missing or empty value causes a validation error.	Validator
		requiredFieldError : String Error message when a value is missing and the required property is true.	Validator
		source : Object Specifies the object containing the property to validate.	Validator
		trigger : IEventDispatcher Specifies the component generating the event that triggers the validator.	Validator
		triggerEvent : String Specifies the event that triggers the validation.	Validator

Protected Properties

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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Validator() Constructor.	Validator
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the Validator is created using an MXML tag.	Validator
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Performs validation and optionally notifies the listeners of the result.	Validator
		validateAll(validators:Array):Array [static] Invokes all the validators in the validators Array.	Validator
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

	Method		Defined By
		addListenerHandler():void Sets up all of the listeners for the valid and invalid events dispatched from the validator.	Validator
		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.	Validator
		getValueFromSource():Object Returns the Object to validate.	Validator
		handleResults(errorResults:Array):ValidationResultEvent Returns a ValidationResultEvent from the Array of error results.	Validator
		isRealValue(value:Object):Boolean Returns true if value is not null.	Validator
		removeListenerHandler():void Disconnects all of the listeners for the valid and invalid events dispatched from the validator.	Validator
		resourcesChanged():void This method is called when a Validator is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.	Validator

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
invalid	Dispatched when validation fails.	Validator
valid	Dispatched when validation succeeds.	Validator

Protected Constants

	Constant		Defined By
		DECIMAL_DIGITS : String = "0123456789" [static] A String containing the decimal digits 0 through 9.	Validator
		ROMAN_LETTERS : String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" [static] A string containing the upper- and lower-case letters of the Roman alphabet ("A" through "Z" and "a" through "z").	Validator

Property Detail

Constructor Detail

Method Detail

Event Detail

Constant Detail

Examples How to use this example

SimpleValidatorExample.mxml

Copy

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Validator class. -->
<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:Script>
        <![CDATA[
            // Import necessary classes.
            import mx.controls.Alert;
            import mx.events.ValidationResultEvent;
            
            // Event listener for the valid and invalid events.
            private function handleValid(evt:ValidationResultEvent):void {
                if (evt.type == ValidationResultEvent.VALID) {
                    // Enable Submit button.
                    submitButton.enabled = true;
                } else {
                    submitButton.enabled = false;
                }
            }

            // Submit form is everything is valid. 
            private function submitForm():void {
                Alert.show("Form Submitted!");
            }
        ]]>
    </fx:Script>

    <fx:Declarations>
        <!-- The Validator class defines the required property and the validator events
             used by all validator subclasses. -->
        <mx:Validator id="reqValid" required="true"
                source="{fname}" property="text" 
                valid="handleValid(event)"
                invalid="handleValid(event);" />
    </fx:Declarations>

    <s:Panel title="Validator Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <mx:Form left="10" right="10" top="10" bottom="10">
            <mx:FormItem>
                <mx:Text width="100%" color="blue"
                        text="Enter a value in the Name field before you can submit. The E-mail field is optional."/>
            </mx:FormItem>
            <mx:FormItem label="Name: " required="true">
                <mx:TextInput id="fname" width="100%"/>
            </mx:FormItem>
            <mx:FormItem label="E-mail address: " required="false">
                <mx:TextInput id="email" width="100%"/>
            </mx:FormItem>
            <mx:FormItem>
                <mx:Button id="submitButton" enabled="false" 
                        label="Submit" click="submitForm();"/>
            </mx:FormItem>
        </mx:Form>
    </s:Panel>

</s:Application>

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

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.

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.

Validator - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.validators

actualListeners

actualTrigger

enabled

listener

property

required

requiredFieldError

resourceManager

source

subFields

trigger

triggerEvent

addListenerHandler

doValidation

getValueFromSource

handleResults

initialized

isRealValue

removeListenerHandler

resourcesChanged

validate

validateAll

invalid

valid

DECIMAL_DIGITS

ROMAN_LETTERS

	`document:Object` — The MXML document containing this Validator.

	`id:String` — Ignored.

	`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.