パッケージmx.formatters
public class PhoneFormatter
継承PhoneFormatter Inheritance Formatter Inheritance Object

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

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

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

MXML シンタックスexpandedMXML シンタックスの非表示

<mx:PhoneFormatter> タグは、スーパークラスのすべてのタグ属性を継承し、次のタグ属性を追加します。

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

例の表示

関連項目

mx.formatters.SwitchSymbolFormatter


パブリックプロパティ
 プロパティ定義
  areaCode : int
10 桁の電話番号を構成するために米国形式の 7 桁の電話番号に追加される市外局番 (エリアコード) を表します。
PhoneFormatter
  areaCodeFormat : String
areacode プロパティが 7 桁形式で表示された場合に使用される、市外局番のデフォルトの形式です。
PhoneFormatter
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 Inheritederror : String
エラーが発生したときにフォーマッタによって保存される説明を表します。
Formatter
  formatString : String
指定の電話番号のフォーマットを示すマスク文字を含むストリングを表します。
PhoneFormatter
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  validPatternChars : String
formatString プロパティで使用できる有効な文字のリストを表します。
PhoneFormatter
Protectedプロパティ
 プロパティ定義
 InheriteddefaultInvalidFormatError : String = "Invalid format"
無効なフォーマットストリングがフォーマッターに指定されたことを示すエラーメッセージです。
Formatter
 InheriteddefaultInvalidValueError : String = "Invalid value"
無効な値がフォーマッターに指定されたことを示すエラーメッセージです。
Formatter
 InheritedpackageResources : ResourceBundle
[static] formatters.properties からのすべてのシンボルを含む ResourceBundle オブジェクトです。
Formatter
パブリックメソッド
 メソッド定義
  PhoneFormatter()
コンストラクタ。
PhoneFormatter
  format(value:Object):String
ストリングを電話番号としてフォーマットします。
PhoneFormatter
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
プロパティの詳細
areaCodeプロパティ
public var areaCode:int

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

デフォルト値-1.

areaCodeFormatプロパティ 
public var areaCodeFormat:String

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

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

formatStringプロパティ 
public var formatString:String

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

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

validPatternCharsプロパティ 
public var validPatternChars:String

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

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

コンストラクタの詳細
PhoneFormatter()コンストラクタ
public 関数 PhoneFormatter()

コンストラクタ。

メソッドの詳細
format()メソッド
public override function format(value:Object):String

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

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

戻り値
String — フォーマットしたストリングを表します。エラーが発生した場合は空です。エラーの状態を示す説明が error プロパティに書き込まれます。
PhoneFormatterExample
<?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/2_jp/langref/mx/formatters/PhoneFormatter.html