mx.formatters.ZipCodeFormatter （Flex 3.2）

パッケージ	mx.formatters
クラス	public class ZipCodeFormatter
継承	ZipCodeFormatter Formatter Object

ZipCodeFormatter クラスは、ユーザーが定義した formatString プロパティの設定に基づいて、有効な数値を次のいずれかの形式にフォーマットします。

#####-####
##### ####
#####
### ###（カナダ式）

6 桁のマスクには 6 桁の数値を設定する必要があります。 5 桁または 9 桁のマスクを使用している場合は、5 桁または 9 桁の数値を使用してフォーマットできます。

エラーが発生すると、空のストリングが返され、エラーを説明するストリングが error プロパティに保存されます。この error プロパティに保存される可能性のある値は、次のうちのいずれかです。

"Invalid value"は、無効な数値が format() メソッドに渡されたことを示します。値は、Number 型または String 型の有効な数値である必要があります。ただし、カナダの郵便番号の場合は英数字の値を使用できます。または、桁数が formatString プロパティで許可した桁数と一致していません。
"Invalid format" は、formatString プロパティの任意の文字が validFormatChars プロパティで指定された文字と一致しない、または数値プレースホルダの数が 9 つ、5 つ、6 つのいずれでもないことを示します。

MXML のシンタックス expanded

MXML シンタックスを隠す

The <mx:ZipCodeFormatter> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:ZipCodeFormatter
    formatString="#####|#####-####|### ###"
  />

例を表示

関連項目

mx.formatters.SwitchSymbolFormatter

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		defaultInvalidFormatError : String [静的] 無効なフォーマットストリングがフォーマッタに指定されたことを示すエラーメッセージです。	Formatter
		defaultInvalidValueError : String [静的] 無効な値がフォーマッタに指定されたことを示すエラーメッセージです。	Formatter
		error : String エラーが発生したときにフォーマッタによって保存される説明を表します。	Formatter
		formatString : String マスクパターンを表します。	ZipCodeFormatter
		prototype : Object [静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object

	プロパティ	定義元
		resourceManager : IResourceManager [読み取り専用] アプリケーションのローカライズされたすべてのリソースを管理するオブジェクトへの参照です。	Formatter

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		ZipCodeFormatter() コンストラクタです。	ZipCodeFormatter
		format(value:Object):String [override] 指定のフォーマットを使用して、ストリングをフォーマットします。	ZipCodeFormatter
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object

	メソッド	定義元
		resourcesChanged():void このメソッドは、Formatter の作成時に呼び出されます。また、ローカライズされたリソースが何らかの方法で変更されたことを示すために、ResourceManager が "change" イベントを送出した時点で常に呼び出されます。	Formatter

プロパティの詳細

formatString

プロパティ

formatString:String

マスクパターンを表します。有効な値は、"#####-####"、"##### ####"、"#####"、"###-###"、および "### ###" です。

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

実装
public function get formatString():String
public function set formatString(value:String):void

コンストラクタの詳細

ZipCodeFormatter

()

コンストラクタ

public function ZipCodeFormatter()

コンストラクタです。

メソッドの詳細

format

()

メソッド

override public function format(value:Object):String

指定のフォーマットを使用して、ストリングをフォーマットします。値をフォーマットできない場合、空のストリングが返され、error プロパティにエラーの説明が書き込まれます。

パラメータ

value:Object — フォーマットする値を表します。

戻り値

String — フォーマットしたストリングを表します。エラーが発生した場合は空です。エラーの状態を示す説明が error プロパティに書き込まれます。

例例の使用法

ZipCodeFormatterExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate ZipCodeFormatter. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:Script>
        <![CDATA[

            import mx.events.ValidationResultEvent;            
            private var vResult:ValidationResultEvent;

            // Event handler to validate and format input.
            private function Format():void 
            {
                vResult = zcVal.validate();
                
                if (vResult.type==ValidationResultEvent.VALID) {
                    formattedZipcode.text= zipFormatter.format(zip.text);
                }
                
                else {
                    formattedZipcode.text= "";
                }
            }
        ]]>      
    </mx:Script>

    <mx:ZipCodeFormatter id="zipFormatter" formatString="#####-####"/>

    <mx:ZipCodeValidator id="zcVal" source="{zip}" property="text" allowedFormatChars=""/>

    <mx:Panel title="ZipCodeFormatter Example" width="75%" height="75%" 
            paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

        <mx:Form width="100%">
            <mx:FormItem label="Enter a 5 or 9 digit U.S. ZIP code:" width="100%">
                <mx:TextInput id="zip" text=""/>
            </mx:FormItem>

            <mx:FormItem label="Formatted ZIP code: " width="100%">
                <mx:TextInput id="formattedZipcode" text="" editable="false"/>
            </mx:FormItem>

            <mx:FormItem>
                <mx:Button label="Validate and Format" click="Format();"/>
            </mx:FormItem>
        </mx:Form>

    </mx:Panel>
</mx:Application>

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

Adobe® Flex™ 3.2 リファレンスガイド This Help system only	すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレームフレームなし
ZipCodeFormatter	プロパティ \| メソッド \| 例