mx.formatters.PhoneFormatter （Flex 3.2）

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

PhoneFormatter クラスは、有効な数値を電話番号（国際電話番号を含む）の形式にフォーマットします。

7 桁の米国形式の電話番号については、ショートカットが用意されています。 areaCode プロパティに値が含まれ、7 桁の形式のストリング（###-####）を使用した場合、返されるストリングに自動的に市外局番が追加されます。市外局番のデフォルトの形式は、（###）です。この形式は areaCodeFormat プロパティを使用して変更できます。エリアコードは、3 桁のプレースホルダーを使用する限り任意に設定できます。

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

"Invalid value"は、無効な数値が format() メソッドに渡されたことを示します。値は Number 型または String 型の有効な数値にする必要があります。または、値の桁数が、フォーマットストリングで指定された桁数と異なっています。
"Invalid format" は、formatString プロパティの任意の文字が validPatternChars プロパティで指定されている文字と一致しない、または areaCodeFormat プロパティが指定されているのに対して、数値プレースホルダの数が 3 ではないことを示します。

MXML のシンタックス expanded

MXML シンタックスを隠す

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

  <mx:PhoneFormatter
    areaCode="-1"
    areaCodeFormat="(###)"
    formatString="(###) ###-####"
    validPatternChars="+()#-. "
  />

例を表示

関連項目

mx.formatters.SwitchSymbolFormatter

パブリックプロパティ

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

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

	プロパティ		定義元
		areaCode : Object 10 桁の電話番号を構成するために米国形式の 7 桁の電話番号に追加される市外局番（エリアコード）を表します。	PhoneFormatter
		areaCodeFormat : String areacode プロパティが 7 桁形式で表示された場合に使用される、市外局番のデフォルトの形式です。	PhoneFormatter
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		defaultInvalidFormatError : String [静的] 無効なフォーマットストリングがフォーマッタに指定されたことを示すエラーメッセージです。	Formatter
		defaultInvalidValueError : String [静的] 無効な値がフォーマッタに指定されたことを示すエラーメッセージです。	Formatter
		error : String エラーが発生したときにフォーマッタによって保存される説明を表します。	Formatter
		formatString : String 指定の電話番号のフォーマットを示すマスク文字を含むストリングを表します。	PhoneFormatter
		prototype : Object [静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		validPatternChars : String formatString プロパティで使用できる有効な文字のリストを表します。	PhoneFormatter

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

	メソッド	定義元
		PhoneFormatter() コンストラクタです。	PhoneFormatter
		format(value:Object):String [override] ストリングを電話番号としてフォーマットします。	PhoneFormatter
		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

プロパティの詳細

areaCode

プロパティ

areaCode:Object

10 桁の電話番号を構成するために米国形式の 7 桁の電話番号に追加される市外局番（エリアコード）を表します。値が -1 の場合、前に市外局番を追加しません。

デフォルト値 : -1.

実装
public function get areaCode():Object
public function set areaCode(value:Object):void

areaCodeFormat

プロパティ

areaCodeFormat:String

areacode プロパティが 7 桁形式で表示された場合に使用される、市外局番のデフォルトの形式です。

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

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

formatString

プロパティ

formatString:String

指定の電話番号のフォーマットを示すマスク文字を含むストリングを表します。

デフォルト値 : "(###) ###-####".

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

validPatternChars

プロパティ

validPatternChars:String

formatString プロパティで使用できる有効な文字のリストを表します。このプロパティは、formatString プロパティの検証に使用されます。

デフォルト値 : "+()#- .".

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

コンストラクタの詳細

PhoneFormatter

()

コンストラクタ

public function PhoneFormatter()

コンストラクタです。

メソッドの詳細

format

()

メソッド

override public function format(value:Object):String

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

パラメータ

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

戻り値

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

例例の使用法

PhoneFormatterExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate PhoneFormatter. -->
<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 = pnVal.validate();
                if (vResult.type==ValidationResultEvent.VALID) {
                    formattedPhone.text= phoneFormatter.format(phone.text);
                }
              
                else {
                    formattedPhone.text= "";
                }
            }
        ]]>
    </mx:Script>

    <mx:PhoneFormatter id="phoneFormatter" 
        formatString="(###) ###-####" validPatternChars="#-() "/>

    <mx:PhoneNumberValidator id="pnVal" source="{phone}" property="text" 
            allowedFormatChars=""/>

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

        <mx:Form>
            <mx:FormItem label="Enter a 10-digit phone number:">
                <mx:TextInput id="phone" text="" width="75%"/>
            </mx:FormItem>

            <mx:FormItem label="Formatted phone number: ">
                <mx:TextInput id="formattedPhone" text="" width="75%" 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/PhoneFormatter.html

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