Package | mx.validators |
Class | public class ZipCodeValidator |
Inheritance | ZipCodeValidator Validator flash.events.EventDispatcher |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The <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'." />
See also
Property | Defined By | ||
---|---|---|---|
allowedFormatChars : String
The set of formatting characters allowed in the ZIP code. | ZipCodeValidator | ||
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 | ||
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 | ||
initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | ||
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 | ||
validateZipCode(validator:ZipCodeValidator, value:Object, baseField:String):Array [static]
Convenience method for calling a validator. | ZipCodeValidator |
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 [override]
Override of the base class doValidation() method
to validate a ZIP code. | ZipCodeValidator | ||
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 |
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 " -".
.
public function get allowedFormatChars():String
public function set allowedFormatChars(value:String):void
domain | 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
.
public function get domain():String
public function set domain(value:String):void
invalidCharError | 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."
.
public function get invalidCharError():String
public function set invalidCharError(value:String):void
invalidDomainError | 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'."
.
public function get invalidDomainError():String
public function set invalidDomainError(value:String):void
wrongCAFormatError | 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'."
.
public function get wrongCAFormatError():String
public function set wrongCAFormatError(value:String):void
wrongLengthError | 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."
.
public function get wrongLengthError():String
public function set wrongLengthError(value:String):void
wrongUSFormatError | 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'."
.
public function get wrongUSFormatError():String
public function set wrongUSFormatError(value:String):void
ZipCodeValidator | () | Constructor |
public function ZipCodeValidator()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
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.
|
See also
<?xml version="1.0" encoding="utf-8"?> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!-- 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>