(Preview)
| Package | mx.validators |
| Class | public class EmailValidator |
| Inheritance | EmailValidator  Validator EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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
Show MXML Syntax
Hide MXML SyntaxThe <mx:EmailValidator> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:EmailValidator
invalidCharError="Your e-mail address contains invalid characters."
invalidDomainError= "The domain in your e-mail address is incorrectly formatted."
invalidIPDomainError="The IP domain in your e-mail address is incorrectly formatted."
invalidPeriodsInDomainError="The domain in your e-mail address has consecutive periods."
missingAtSignError="An at sign (&64;) is missing in your e-mail address."
missingPeriodInDomainError="The domain in your e-mail address is missing a period."
missingUsernameError="The username in your e-mail address is missing."
tooManyAtSignsError="Your e-mail address contains too many &64; characters."
/>
More examples
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 | |
| 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 | |
| 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 | |
| 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 | |
Protected Properties
Public Methods
| 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 | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
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. | 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 | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
[override]
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 not null. | Validator | |
|
Disconnects all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
|
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 | |
Protected Constants
Property Detail
invalidCharError | property |
invalidCharError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message when there are invalid characters in the e-mail address.
The default value is "Your e-mail address contains invalid characters.".
Implementation
public function get invalidCharError():String public function set invalidCharError(value:String):voidinvalidDomainError | property |
invalidDomainError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error 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 e-mail address is incorrectly formatted.".
Implementation
public function get invalidDomainError():String public function set invalidDomainError(value:String):voidinvalidIPDomainError | property |
invalidIPDomainError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error 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 e-mail address is incorrectly formatted.".
Implementation
public function get invalidIPDomainError():String public function set invalidIPDomainError(value:String):voidinvalidPeriodsInDomainError | property |
invalidPeriodsInDomainError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message when there are continuous periods in the domain.
The default value is "The domain in your e-mail address has continous periods.".
Implementation
public function get invalidPeriodsInDomainError():String public function set invalidPeriodsInDomainError(value:String):voidmissingAtSignError | property |
missingAtSignError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message when there is no at sign in the email address.
The default value is "An at sign (&64;) is missing in your e-mail address.".
Implementation
public function get missingAtSignError():String public function set missingAtSignError(value:String):voidmissingPeriodInDomainError | property |
missingPeriodInDomainError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message when there is no period in the domain.
The default value is "The domain in your e-mail address is missing a period.".
Implementation
public function get missingPeriodInDomainError():String public function set missingPeriodInDomainError(value:String):voidmissingUsernameError | property |
missingUsernameError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message when there is no username.
The default value is "The username in your e-mail address is missing.".
Implementation
public function get missingUsernameError():String public function set missingUsernameError(value:String):voidtooManyAtSignsError | property |
tooManyAtSignsError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message when there is more than one at sign in the e-mail address. This property is optional.
The default value is "Your e-mail address contains too many &64; characters.".
Implementation
public function get tooManyAtSignsError():String public function set tooManyAtSignsError(value:String):voidConstructor Detail
EmailValidator | () | Constructor |
public function EmailValidator()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Method Detail
doValidation | () | method |
override protected function doValidation(value:Object):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Parameters
value: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):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Convenience method for calling a validator from within a custom validation function. Each of the standard Flex validators has a similar convenience method.
Parameters
validator: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.
|
Related API Elements
Examples How to use this example
EmailValidatorExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the EmailValidator. -->
<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>
import mx.controls.Alert;
</fx:Script>
<fx:Declarations>
<mx:EmailValidator source="{email}" property="text"
trigger="{myButton}" triggerEvent="click"
valid="Alert.show('Validation Succeeded!');"/>
</fx:Declarations>
<s:Panel title="EmailValidator Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter an e-mail address: ">
<s:TextInput id="email" width="100%"/>
</mx:FormItem>
<mx:FormItem >
<s:Button id="myButton" label="Validate" />
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Wed Nov 21 2018, 06:34 AM -08:00