パッケージmx.validators
クラスpublic class ZipCodeValidator
継承ZipCodeValidator Inheritance Validator Inheritance EventDispatcher Inheritance Object

ZipCodeValidator クラスでは、ストリングの長さと書式が 5 桁の ZIP コード、5 桁 + 4 桁の米国 ZIP コード、またはカナダ郵便番号として適切であるかどうかを検証します。

MXML のシンタックスexpandedMXML シンタックスを隠す

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

例を表示

関連項目

mx.validators.ZipCodeValidatorDomainType

パブリックプロパティ
 プロパティ定義元
  allowedFormatChars : String
郵便番号で使用できる書式文字のセットを表します。
ZipCodeValidator
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  domain : String
チェックする郵便番号の種類を表します。
ZipCodeValidator
 Inheritedenabled : Boolean
この値を false に設定すると、バリデータによる検証が行えなくなります。
Validator
  invalidCharError : String
郵便番号に無効な文字が含まれる場合に発生するエラーメッセージを表します。
ZipCodeValidator
  invalidDomainError : String
domain プロパティに無効な値が含まれる場合に発生するエラーメッセージを表します。
ZipCodeValidator
 Inheritedlistener : Object
検証のリスナーを指定します。
Validator
 Inheritedproperty : String
検証する値を含む source オブジェクトのプロパティの名前を指定するストリングを表します。
Validator
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedrequired : Boolean = true
true の場合、検証エラーの原因となる欠損値または空値を指定します。
Validator
 InheritedrequiredFieldError : String
値が欠損し、required プロパティが true の場合に発生するエラーメッセージです。
Validator
 Inheritedsource : Object
検証するプロパティを含むオブジェクトを指定します。
Validator
 Inheritedtrigger : IEventDispatcher
バリデータをトリガするイベントの生成を行うコンポーネントを指定します。
Validator
 InheritedtriggerEvent : String
検証をトリガするイベントを指定します。
Validator
  wrongCAFormatError : String
カナダの無効な郵便番号に対して発生するエラーメッセージを表します。
ZipCodeValidator
  wrongLengthError : String
米国の無効な郵便番号に対して発生するエラーメッセージを表します。
ZipCodeValidator
  wrongUSFormatError : String
誤った書式の郵便番号に対して発生するエラーメッセージを表します。
ZipCodeValidator
プロテクトプロパティ
 プロパティ定義元
 InheritedactualListeners : Array
[読み取り専用] リスナーオブジェクトが存在する場合はリスナーオブジェクトを含みます。そうでない場合は、ソースオブジェクトを含みます。
Validator
 InheritedactualTrigger : IEventDispatcher
[読み取り専用] トリガオブジェクトが存在する場合はトリガオブジェクトを含みます。そうでない場合は、ソースオブジェクトを含みます。
Validator
 InheritedresourceManager : IResourceManager
[読み取り専用] アプリケーションのローカライズされたすべてのリソースを管理するオブジェクトへの参照です。
Validator
 InheritedsubFields : Array
validate() メソッドに渡された value オブジェクトに含まれるプロパティ名を含むストリングの配列です。
Validator
パブリックメソッド
 メソッド定義元
  
ZipCodeValidator()
コンストラクタです。
ZipCodeValidator
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
initialized(document:Object, id:String):void
MXML タグを使用してバリデータを作成したときに、MXML コンパイラによって自動的に呼び出されます。
Validator
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
toString():String
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent
検証を実行し、リスナーに任意で結果を通知します。
Validator
 Inherited
validateAll(validators:Array):Array
[静的] validators 配列に含まれるすべてのバリデータを呼び出します。
Validator
  
validateZipCode(validator:ZipCodeValidator, value:Object, baseField:String):Array
[静的] バリデータを呼び出す上で便利なメソッドです。
ZipCodeValidator
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
 Inherited
addListenerHandler():void
バリデータから送出された valid イベントおよび invalid イベントのすべてのリスナーを設定します。
Validator
  
doValidation(value:Object):Array
[override] 郵便番号の妥当性を検証する上で基本クラスの doValidation() メソッドをオーバーライドします。
ZipCodeValidator
 Inherited
getValueFromSource():Object
検証するオブジェクトを返します。
Validator
 Inherited
handleResults(errorResults:Array):ValidationResultEvent
エラー結果の配列から ValidationResultEvent を返します。
Validator
 Inherited
isRealValue(value:Object):Boolean
value が null でない場合、true を返します。
Validator
 Inherited
removeListenerHandler():void
バリデータから送出された valid イベントおよび invalid イベントのすべてのリスナーを切断します。
Validator
 Inherited
resourcesChanged():void
このメソッドは、バリデータが作成されたときと、ResourceManager が "change" イベントを送出してローカライズされたリソースが何らかの点で変更されたことを示すときに再び呼び出されます。
Validator
イベント
 イベント 概要 定義元
 Inherited
activate
[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited
deactivate
[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
 Inherited
invalid
検証が失敗すると送出されます。Validator
 Inherited
valid
検証が正常に完了すると送出されます。Validator
プロテクト定数
 定数定義元
 InheritedDECIMAL_DIGITS : String = "0123456789"
[静的] 0 から 9 の 10 進数字を含むストリングです。
Validator
 InheritedROMAN_LETTERS : String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
[静的] ローマ字アルファベットの大文字と小文字を含む（"A" から "Z"、および "a" から "z"）ストリングです。
Validator
プロパティの詳細
allowedFormatCharsプロパティ
allowedFormatChars:String

郵便番号で使用できる書式文字のセットを表します。 数値またはアルファベット（a ～ z、A ～ Z）は指定できません。

デフォルト値 : " -"..



実装
    public function get allowedFormatChars():String
    public function set allowedFormatChars(value:String):void
domainプロパティ 
domain:String

チェックする郵便番号の種類を表します。 MXML では、以下の値を指定できます。"US or Canada"、"US Only" および "Canada Only"。

ActionScript では、定数 ZipCodeValidatorDomainType.US_ONLY、ZipCodeValidatorDomainType.US_OR_CANADA または ZipCodeValidatorDomainType.CANADA_ONLY を使用してこのプロパティを設定できます。

デフォルト値 : ZipCodeValidatorDomainType.US_ONLY.



実装
    public function get domain():String
    public function set domain(value:String):void
invalidCharErrorプロパティ 
invalidCharError:String

郵便番号に無効な文字が含まれる場合に発生するエラーメッセージを表します。

デフォルト値 : "ZIP コードに無効な文字が含まれています。".



実装
    public function get invalidCharError():String
    public function set invalidCharError(value:String):void
invalidDomainErrorプロパティ 
invalidDomainError:String

domain プロパティに無効な値が含まれる場合に発生するエラーメッセージを表します。

デフォルト値 : "domain パラメータが無効です。'US Only' または 'US or Canada' のいずれかである必要があります。".



実装
    public function get invalidDomainError():String
    public function set invalidDomainError(value:String):void
wrongCAFormatErrorプロパティ 
wrongCAFormatError:String

カナダの無効な郵便番号に対して発生するエラーメッセージを表します。

デフォルト値 : "カナダの郵便番号は 'A1B 2C3' の形式である必要があります。".



実装
    public function get wrongCAFormatError():String
    public function set wrongCAFormatError(value:String):void
wrongLengthErrorプロパティ 
wrongLengthError:String

米国の無効な郵便番号に対して発生するエラーメッセージを表します。

デフォルト値 : "ZIP コードは 5 桁または 5+4 桁である必要があります。".



実装
    public function get wrongLengthError():String
    public function set wrongLengthError(value:String):void
wrongUSFormatErrorプロパティ 
wrongUSFormatError:String

誤った書式の郵便番号に対して発生するエラーメッセージを表します。

デフォルト値 : 「ZIP+4 コードは '12345-6789' の形式である必要があります。」.



実装
    public function get wrongUSFormatError():String
    public function set wrongUSFormatError(value:String):void
コンストラクタの詳細
ZipCodeValidator()コンストラクタ
public function ZipCodeValidator()

コンストラクタです。

メソッドの詳細
doValidation()メソッド
override protected function doValidation(value:Object):Array

郵便番号の妥当性を検証する上で基本クラスの doValidation() メソッドをオーバーライドします。

このメソッドはユーザーが直接呼び出すものではなく、妥当性を検証する際に Flex から呼び出されます。 Validator クラスをカスタムで作成する場合は、このメソッドを実装する必要があります。

パラメータ

value:Object — 検証するオブジェクトです。

戻り値
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。
validateZipCode()メソッド 
public static function validateZipCode(validator:ZipCodeValidator, value:Object, baseField:String):Array

バリデータを呼び出す上で便利なメソッドです。 他の標準 Flex バリデータにもそれぞれ同様の便利なメソッドがあります。

パラメータ

validator:ZipCodeValidator — ZipCodeValidator インスタンスを表します。
 
value:Object — 検証するフィールドを表します。
 
baseField:String — value パラメータで指定したサブフィールドのテキスト表現です。 例えば、value パラメータで value.zipCode を指定する場合、baseField の値は "zipCode" です。

戻り値
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。

関連項目

mx.validators.ValidationResult
例 例の使用法
ZipCodeValidatorExample.mxml
<?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>



© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Mar 19 2009, 08:51 PM -07:00
 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/validators/ZipCodeValidator.html