| Package | mx.validators |
| Class | public class EmailValidator |
| Inheritance | EmailValidator  Validator EventDispatcher Object |
You can use IP domain names if they are enclosed in square brackets; for example, myname@[206.132.22.1]. You can use individual IP numbers from 0 to 255.
MXML Syntax
Hide MXML Syntax
The <mx:EmailValidator> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
Show MXML Syntax
<mx:EmailValidator
invalidCharError="Invalid characters in your email address."
invalidDomainError= "The domain in your email address is incorrectly formatted."
invalidIPDomainError="The IP domain in your email address is incorrectly formatted."
invalidPeriodsInDomainError="The domain in your email address has consecutive periods."
missingAtSignError="Missing an at character in your email address."
missingPeriodInDomainError="The domain in your email address is missing a period."
missingUsernameError="The username in your email address is missing."
tooManyAtSignsError="Too many at characters in your email address."
/>
| 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 | |
| invalidCharError : String
Error message when there are invalid characters in the e-mail address.
| EmailValidator | ||
| invalidDomainError : String
Error message when the suffix (the top level domain)
is not 2, 3, 4 or 6 characters long.
| EmailValidator | ||
| invalidIPDomainError : String
Error message when the IP domain is invalid.
| EmailValidator | ||
| invalidPeriodsInDomainError : String
Error message when there are continuous periods in the domain.
| EmailValidator | ||
| listener : Object
Specifies the validation listener.
| Validator | |
| missingAtSignError : String
Error message when there is no at sign in the email address.
| EmailValidator | ||
| missingPeriodInDomainError : String
Error message when there is no period in the domain.
| EmailValidator | ||
| missingUsernameError : String
Error message when there is no username.
| EmailValidator | ||
| property : String
A String specifying the name of the property
of the
source object that contains
the value to validate. | Validator | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| required : Boolean
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 | |
| tooManyAtSignsError : String
Error message when there is more than one at sign in the e-mail address.
| EmailValidator | ||
| trigger : IEventDispatcher
Specifies the component generating the event that triggers the validator.
| Validator | |
| triggerEvent : String
Specifies the event that triggers the validation.
| Validator | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| EmailValidator | ||
|
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 | |
|
Dispatches an event into the event flow.
| EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Called automatically by the MXML compiler when the Validator
is created using an MXML tag.
| Validator | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Returns the string representation of the specified object.
| Object | |
|
Performs validation and optionally notifies
the listeners of the result.
| Validator | |
|
[static]
Invokes all the validators in the
validators Array. | Validator | |
|
[static]
Convenience method for calling a validator
from within a custom validation function.
| EmailValidator | ||
|
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 | ||
|---|---|---|---|
|
addListenerHandler():void
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
|
Override of the base class
doValidation() method
to validate an e-mail address. | EmailValidator | ||
|
Returns the Object to validate.
| Validator | |
|
Returns a ValidationResultEvent from the Array of error results.
| Validator | |
|
Returns
true if value is null. | Validator | |
|
removeListenerHandler():void
Disconnects all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
| invalidCharError | property |
public var invalidCharError:StringError message when there are invalid characters in the e-mail address.
The default value is "Invalid characters in your email address.".
| invalidDomainError | property |
public var invalidDomainError:StringError message when the suffix (the top level domain) is not 2, 3, 4 or 6 characters long.
The default value is "The domain in your email address is incorrectly formatted.".
| invalidIPDomainError | property |
public var invalidIPDomainError:StringError message when the IP domain is invalid. The IP domain must be enclosed by square brackets.
The default value is "The IP domain in your email address is incorrectly formatted.".
| invalidPeriodsInDomainError | property |
public var invalidPeriodsInDomainError:StringError message when there are continuous periods in the domain.
The default value is "The domain in your email address has continous periods.".
| missingAtSignError | property |
public var missingAtSignError:StringError message when there is no at sign in the email address.
The default value is "Missing an at character in your email address.".
| missingPeriodInDomainError | property |
public var missingPeriodInDomainError:StringError message when there is no period in the domain.
The default value is "The domain in your email address is missing a period.".
| missingUsernameError | property |
public var missingUsernameError:StringError message when there is no username.
The default value is "The username in your email address is missing.".
| tooManyAtSignsError | property |
public var tooManyAtSignsError:StringError message when there is more than one at sign in the e-mail address. This property is optional.
The default value is "Too many at characters in your email address.".
| EmailValidator | () | constructor |
public function EmailValidator()Constructor.
| doValidation | () | method |
protected override function doValidation(value:Object):Array
Override of the base class doValidation() method
to validate an e-mail address.
You do not call this method directly; Flex calls it as part of performing a validation. If you create a custom Validator class, you must implement this method.
Parametersvalue:Object — Either a String or an Object to validate.
|
Array —
An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
| validateEmail | () | method |
public static function validateEmail(validator:EmailValidator, value:Object, baseField:String):ArrayConvenience method for calling a validator from within a custom validation function. Each of the standard Flex validators has a similar convenience method.
Parametersvalidator:EmailValidator — The EmailValidator instance.
|
|
value:Object — A field to validate.
|
|
baseField:String — Text representation of the subfield
specified in the value parameter.
For example, if the value parameter specifies value.email,
the baseField value is "email".
|
Array —
An Array of ValidationResult objects, with one
ValidationResult object for each field examined by the validator.
|
See also
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the EmailValidator. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
import mx.controls.Alert;
</mx:Script>
<mx:EmailValidator source="{email}" property="text"
trigger="{myButton}" triggerEvent="click"
valid="Alert.show('Validation Succeeded!');"/>
<mx:Panel title="EmailValidator Example" width="75%" height="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Form>
<mx:FormItem label="Enter an e-mail address: ">
<mx:TextInput id="email" width="100%"/>
</mx:FormItem>
<mx:FormItem >
<mx:Button id="myButton" label="Validate" />
</mx:FormItem>
</mx:Form>
</mx:Panel>
</mx:Application>