| Package | mx.validators |
| Class | public class ZipCodeValidator |
| Inheritance | ZipCodeValidator  Validator EventDispatcher Object |
Hide MXML Syntax
The <mx:ZipCodeValidator> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
Show MXML Syntax
<mx:ZipCodeValidator
allowedFormatChars=" -"
domain="US Only | US or Canada"
invalidCharError="The ZIP code contains invalid characters."
invalidDomainError="The domain parameter is invalid. It must be either 'US Only' or 'US or Canada'."
wrongCAFormatError="The Canadian ZIP code must be formatted 'A1B 2C3'."
wrongLengthError="The ZIP code must be 5 digits or 5+4 digits."
wrongUSFormatError="The ZIP+4 extension must be formatted '12345-6789'."
/>
See also
| Property | Defined by | ||
|---|---|---|---|
| allowedFormatChars : String
The set of formatting characters allowed in the ZIP code.
| ZipCodeValidator | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| domain : String
Type of ZIP code to check.
| ZipCodeValidator | ||
| enabled : Boolean
Setting this value to
false will stop the validator
from performing validation. | Validator | |
| invalidCharError : String
Error message when the ZIP code contains invalid characters.
| ZipCodeValidator | ||
| invalidDomainError : String
Error message when the
domain property contains an invalid value. | ZipCodeValidator | ||
| 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 | |
| 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 | |
| trigger : IEventDispatcher
Specifies the component generating the event that triggers the validator.
| Validator | |
| triggerEvent : String
Specifies the event that triggers the validation.
| Validator | |
| wrongCAFormatError : String
Error message for an invalid Canadian postal code.
| ZipCodeValidator | ||
| wrongLengthError : String
Error message for an invalid US ZIP code.
| ZipCodeValidator | ||
| wrongUSFormatError : String
Error message for an incorrectly formatted ZIP code.
| ZipCodeValidator | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| ZipCodeValidator | ||
|
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.
| ZipCodeValidator | ||
|
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 a ZIP code. | ZipCodeValidator | ||
|
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 | |
| allowedFormatChars | property |
allowedFormatChars:String [read-write]The set of formatting characters allowed in the ZIP code. This can not have digits or alphabets [a-z A-Z].
The default value is " -"..
public function get allowedFormatChars():String
public function set allowedFormatChars(value:String):void
| domain | property |
public var domain:String
Type of ZIP code to check.
In MXML, valid values are "US or Canada"
and "US Only".
In ActionScript, you can use the following constants to set this property:
ZipCodeValidatorDomainType.US_ONLY and
ZipCodeValidatorDomainType.US_OR_CANADA.
The default value is ZipCodeValidatorDomainType.US_ONLY.
| invalidCharError | property |
public var invalidCharError:StringError message when the ZIP code contains invalid characters.
The default value is "The ZIP code contains invalid characters.".
| invalidDomainError | property |
public var invalidDomainError:String
Error message when the domain property contains an invalid value.
The default value is "The domain parameter is invalid. It must be either 'US Only' or 'US or Canada'.".
| wrongCAFormatError | property |
public var wrongCAFormatError:StringError message for an invalid Canadian postal code.
The default value is "The Canadian postal code must be formatted 'A1B 2C3'.".
| wrongLengthError | property |
public var wrongLengthError:StringError message for an invalid US ZIP code.
The default value is "The ZIP code must be 5 digits or 5+4 digits.".
| wrongUSFormatError | property |
public var wrongUSFormatError:StringError message for an incorrectly formatted ZIP code.
The default value is "The ZIP+4 code extension must be formatted '12345-6789'.".
| ZipCodeValidator | () | constructor |
public function ZipCodeValidator()Constructor.
| doValidation | () | method |
protected override function doValidation(value:Object):Array
Override of the base class doValidation() method
to validate a ZIP code.
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 — Object to validate.
|
Array —
An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
| validateZipCode | () | method |
public static function validateZipCode(validator:ZipCodeValidator, value:Object, baseField:String):ArrayConvenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.
Parametersvalidator:ZipCodeValidator — The ZipCodeValidator 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.zipCode,
the baseField value is "zipCode".
|
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 ZipCodeValidator. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
import mx.controls.Alert;
</mx:Script>
<mx:ZipCodeValidator source="{zip}" property="text"
trigger="{myButton}" triggerEvent="click"
valid="Alert.show('Validation Succeeded!');"/>
<mx:Panel title="ZipcodeValidator Example" width="75%" height="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Form>
<mx:FormItem label="Enter a 5 or 9 digit U.S. Zip code: ">
<mx:TextInput id="zip" width="100%"/>
</mx:FormItem>
<mx:FormItem >
<mx:Button id="myButton" label="Validate" />
</mx:FormItem>
</mx:Form>
</mx:Panel>
</mx:Application>