ASDoc

mx.formatters
PhoneFormatter クラス

PhoneFormatter クラス
mx.formatters.Formatter の拡張

PhoneFormatter は、有効な数値を電話番号 (国際電話番号を含む) の形式にフォーマットします。米国方式の 7 桁マスク (###-####) を使用していて、有効な市外局番と市外局番のフォーマットが存在する場合は、ショートカットを使用することができます。

MXML シンタックス

<mx:PhoneFormatter> タグには、次のプロパティを使用できます。

 <mx:PhoneFormatter
   formatString="(###) ###-####"
   validPatternChars "+,(,),#,-,.,"
   numberSymbol "#"
   areaCodeFormat "(###)"
   areaCode "No default."
 />

例を参照するにはここをクリックしてください

関連項目
SwitchSymbolFormatter

メソッド
	`format( value) : String` ストリングを電話番号としてフォーマットします。

mx.formatters.Formatter クラスから継承されるメソッド

format

プロパティ
	`areaCode:Number` 10 桁の電話番号を構成するために米国形式の 7 桁の電話番号に追加される市外局番 (エリアコード) を表します。
	`areaCodeFormat:String` `areaCode` プロパティが 7 桁のフォーマットで表される場合の市外局番のデフォルトのフォーマットを表します。
	`formatString:String` 指定の電話番号のフォーマットを示すマスク文字を含むストリングを表します。
	`numberSymbol:String` `formatString` プロパティの中で数値のプレースホルダーとして使用する文字を表します。
	`validPatternChars:String` `formatString` プロパティの中で使用できる有効な文字をカンマ区切りのリストで表します。

mx.formatters.Formatter クラスから継承されるプロパティ

error

メソッドの詳細

format

format( value)
										
													 :  String

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

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

戻り値
フォーマットしたストリング。エラーが発生した場合は空です。

プロパティの詳細

areaCode

areaCode:Number

10 桁の電話番号を構成するために米国形式の 7 桁の電話番号に追加される市外局番 (エリアコード) を表します。デフォルト値は定義されていません。

areaCodeFormat

areaCodeFormat:String

areaCode プロパティが 7 桁のフォーマットで表される場合の市外局番のデフォルトのフォーマットを表します。デフォルト値は "(###) " です。

formatString

formatString:String

指定の電話番号のフォーマットを示すマスク文字を含むストリングを表します。デフォルト値は "(###) ###-####" です。

numberSymbol

numberSymbol:String

formatString プロパティの中で数値のプレースホルダーとして使用する文字を表します。デフォルト値は "#" です。

validPatternChars

validPatternChars:String

formatString プロパティの中で使用できる有効な文字をカンマ区切りのリストで表します。このプロパティは formatString プロパティの検証時に使用されます。デフォルト値は "+()#-." です。

例

PhoneFormatterExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Phone formatter の使用方法を示す簡単な例 -->
<mx:Application xmlns:mx="http://www.macromedia.com/2003/mxml" backgroundColor="#FFFFFF">

<mx:Script>
<![CDATA[
                
function Format()
          {
if(mx.validators.Validator.isValid(this,'CheckModel.Phone'))
                  
formattedphone.text= phoneformatter.format(phone.text);
else
formattedphone.text= "";
          }

      ]]>
</mx:Script>

<mx:Panel title="Validate and Format Panel" backgroundColor="#0C8BF3">

<mx:Model id="CheckModel">
<Phone>{phone.text}</Phone>
</mx:Model>

<mx:Label text="Enter below 10-digit phone number, without space/character to be validated and formatted:"color="#FFFFFF"/>
<mx:TextInput id="phone" text="Enter 10-digit phone no" maxChars="10"/>
<mx:Button label="Validate and Format" click="Format();" width="160"/>
<mx:TextInput id="formattedphone" editable="false" color="#0000FF"/>

</mx:Panel>

<!-- Result of phone validation is formatted using PhoneFormatter and displayed. -->
<mx:PhoneFormatter id="phoneformatter" areaCodeFormat="[###]" formatString="[###]-###-####"
validPatternChars="+#-()[]"/>

<!-- PhoneValidator validates user input. -->
<mx:PhoneNumberValidator field="CheckModel.Phone" allowedFormatChars="+#-[]"/>

</mx:Application>