| Package | mx.validators |
| Class | public class ZipCodeValidator |
| Inheritance | ZipCodeValidator  Validator EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Show MXML Syntax
Hide MXML SyntaxThe <mx:ZipCodeValidator> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:ZipCodeValidator
allowedFormatChars=" -"
domain="US Only | US or Canada | Canada Only"
invalidCharError="The ZIP code contains invalid characters."
invalidDomainError="The domain parameter is invalid. It must be either 'US Only', 'Canada Only', or 'US or Canada'."
wrongCAFormatError="The Canadian postal code must be formatted 'A1B 2C3'."
wrongLengthError="The ZIP code must be 5 digits or 5+4 digits."
wrongUSFormatError="The ZIP+4 code must be formatted '12345-6789'."
/>
More examples
Learn more
Validating data
About the source and property properties
About triggering validation
Triggering validation by using events
Triggering validation programmatically
Validating required fields
General guidelines for validation
Working with validation errors
Working with validation events
About the source and property properties
About triggering validation
Triggering validation by using events
Triggering validation programmatically
Validating required fields
General guidelines for validation
Working with validation errors
Working with validation events
Related API Elements
Public Properties
| 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 = 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 | |
| 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 | ||
Protected Properties
Public Methods
| 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 | |
|
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. | 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 | |
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 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 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
allowedFormatChars | property |
allowedFormatChars:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 " -"..
Implementation
public function get allowedFormatChars():String public function set allowedFormatChars(value:String):voiddomain | property |
domain:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Type of ZIP code to check.
In MXML, valid values are "US or Canada",
"US Only" and "Canada Only".
In ActionScript, you can use the following constants to set this property:
ZipCodeValidatorDomainType.US_ONLY,
ZipCodeValidatorDomainType.US_OR_CANADA, or
ZipCodeValidatorDomainType.CANADA_ONLY.
The default value is ZipCodeValidatorDomainType.US_ONLY.
Implementation
public function get domain():String public function set domain(value:String):voidinvalidCharError | property |
invalidCharError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message when the ZIP code contains invalid characters.
The default value is "The ZIP code 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 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'.".
Implementation
public function get invalidDomainError():String public function set invalidDomainError(value:String):voidwrongCAFormatError | property |
wrongCAFormatError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message for an invalid Canadian postal code.
The default value is "The Canadian postal code must be formatted 'A1B 2C3'.".
Implementation
public function get wrongCAFormatError():String public function set wrongCAFormatError(value:String):voidwrongLengthError | property |
wrongLengthError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message for an invalid US ZIP code.
The default value is "The ZIP code must be 5 digits or 5+4 digits.".
Implementation
public function get wrongLengthError():String public function set wrongLengthError(value:String):voidwrongUSFormatError | property |
wrongUSFormatError:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Error message for an incorrectly formatted ZIP code.
The default value is "The ZIP+4 code must be formatted '12345-6789'.".
Implementation
public function get wrongUSFormatError():String public function set wrongUSFormatError(value:String):voidConstructor Detail
ZipCodeValidator | () | Constructor |
public function ZipCodeValidator()| 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 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.
Parameters
value: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):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.
Parameters
validator: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.
|
Related API Elements
Examples How to use this example
ZipCodeValidatorExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the ZipCodeValidator. -->
<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:ZipCodeValidator source="{zip}" property="text"
trigger="{myButton}" triggerEvent="click"
valid="Alert.show('Validation Succeeded!');"
invalid="Alert.show('Validation Failed!');"/>
</fx:Declarations>
<s:Panel title="ZipcodeValidator Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter a 5 or 9 digit U.S. Zip code: ">
<s:TextInput id="zip" width="100%"/>
</mx:FormItem>
<mx:FormItem >
<s:Button id="myButton" label="Validate" />
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Mon Nov 28 2011, 06:48 AM -08:00