ZipCodeValidator

Pacote	mx.validators
Classe	public class ZipCodeValidator
Herança	ZipCodeValidator Validator EventDispatcher Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

The ZipCodeValidator class validates that a String has the correct length and format for a five-digit ZIP code, a five-digit+four-digit United States ZIP code, or Canadian postal code.

Sintaxe MXML expanded

Ocultar sintaxe MXML

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'." 
  />

Veja os exemplos

Elementos da API relacionados

mx.validators.ZipCodeValidatorDomainType

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		allowedFormatChars : String The set of formatting characters allowed in the ZIP code.	ZipCodeValidator
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	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
		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

Propriedades protegidas

Ocultar propriedades protegidas herdadas

Mostrar propriedades protegidas herdadas

	Propriedade		Definido por
		actualListeners : Array [somente leitura] Contains an Array of listener objects, if any, or the source object.	Validator
		actualTrigger : IEventDispatcher [somente leitura] Contains the trigger object, if any, or the source object.	Validator
		resourceManager : IResourceManager [somente leitura] A reference to the object which manages all of the application's localized resources.	Validator
		subFields : Array An Array of Strings containing the names for the properties contained in the value Object passed to the validate() method.	Validator

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		ZipCodeValidator() Constructor.	ZipCodeValidator
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	EventDispatcher
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	EventDispatcher
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the Validator is created using an MXML tag.	Validator
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove um ouvinte do objeto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Performs validation and optionally notifies the listeners of the result.	Validator
		validateAll(validators:Array):Array [estático] Invokes all the validators in the validators Array.	Validator
		validateZipCode(validator:ZipCodeValidator, value:Object, baseField:String):Array [estático] Convenience method for calling a validator.	ZipCodeValidator
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object
		willTrigger(type:String):Boolean Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	EventDispatcher

Métodos protegidos

Ocultar métodos protegidos herdados

Mostrar métodos protegidos herdados

	Método		Definido por
		addListenerHandler():void Sets up all of the listeners for the valid and invalid events dispatched from the validator.	Validator
		doValidation(value:Object):Array [substituir] 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

Eventos

Clique para obter mais informações sobre eventos

Ocultar eventos herdados

Mostrar eventos herdados

	Resumo	Definido por
activate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.	EventDispatcher
deactivate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.	EventDispatcher
invalid	Dispatched when validation fails.	Validator
valid	Dispatched when validation succeeds.	Validator

Constantes protegidas

Ocultar constantes protegidas herdadas

Mostrar constantes protegidas herdadas

	Constante		Definido por

Detalhes da propriedade

allowedFormatChars

propriedade

allowedFormatChars:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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].

O valor padrão é " -"..

Implementação
public function get allowedFormatChars():String
public function set allowedFormatChars(value:String):void

domain

propriedade

domain:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

O valor padrão é ZipCodeValidatorDomainType.US_ONLY.

Implementação
public function get domain():String
public function set domain(value:String):void

invalidCharError

propriedade

invalidCharError:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Error message when the ZIP code contains invalid characters.

O valor padrão é "The ZIP code contains invalid characters.".

Implementação
public function get invalidCharError():String
public function set invalidCharError(value:String):void

invalidDomainError

propriedade

invalidDomainError:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Error message when the domain property contains an invalid value.

O valor padrão é "The domain parameter is invalid. It must be either 'US Only' or 'US or Canada'.".

Implementação
public function get invalidDomainError():String
public function set invalidDomainError(value:String):void

wrongCAFormatError

propriedade

wrongCAFormatError:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Error message for an invalid Canadian postal code.

O valor padrão é "The Canadian postal code must be formatted 'A1B 2C3'.".

Implementação
public function get wrongCAFormatError():String
public function set wrongCAFormatError(value:String):void

wrongLengthError

propriedade

wrongLengthError:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Error message for an invalid US ZIP code.

O valor padrão é "The ZIP code must be 5 digits or 5+4 digits.".

Implementação
public function get wrongLengthError():String
public function set wrongLengthError(value:String):void

wrongUSFormatError

propriedade

wrongUSFormatError:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Error message for an incorrectly formatted ZIP code.

O valor padrão é "The ZIP+4 code must be formatted '12345-6789'.".

Implementação
public function get wrongUSFormatError():String
public function set wrongUSFormatError(value:String):void

Detalhes do construtor

()

Construtor

public function ZipCodeValidator()

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Constructor.

Detalhes do método

doValidation

()

método

override protected function doValidation(value:Object):Array

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Parâmetros

value:Object — Object to validate.

Retorna

Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

validateZipCode

()

método

public static function validateZipCode(validator:ZipCodeValidator, value:Object, baseField:String):Array

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.

Parâmetros

	`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"`.

Retorna

Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

Elementos da API relacionados

mx.validators.ValidationResult

Exemplos Como usar este exemplo

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>

Aspectos jurídicos | Política de privacidade on-line

ZipCodeValidator - AS3 Flex

Classes x

allowedFormatChars

domain

invalidCharError

invalidDomainError

wrongCAFormatError

wrongLengthError

wrongUSFormatError