PhoneFormatter

套件	mx.formatters
類別	public class PhoneFormatter
繼承	PhoneFormatter Formatter Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The PhoneFormatter class formats a valid number into a phone number format, including international configurations.

A shortcut is provided for the United States seven-digit format. If the areaCode property contains a value and you use the seven-digit format string, (###-####), a seven-digit value to format automatically adds the area code to the returned String. The default format for the area code is (###). You can change this using the areaCodeFormat property. You can format the area code any way you want as long as it contains three number placeholders.

If an error occurs, an empty String is returned and a String that describes the error is saved to the error property. The error property can have one of the following values:

"Invalid value" means an invalid numeric value is passed to the format() method. The value should be a valid number in the form of a Number or a String, or the value contains a different number of digits than what is specified in the format String.
"Invalid format" means any of the characters in the formatString property do not match the allowed characters specified in the validPatternChars property, or the areaCodeFormat property is specified but does not contain exactly three numeric placeholders.

MXML 語法

隱藏 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="+()#-. "
  />

檢視範例

相關 API 元素

mx.formatters.SwitchSymbolFormatter

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		areaCode : Object Area code number added to a seven-digit United States format phone number to form a 10-digit phone number.	PhoneFormatter
		areaCodeFormat : String Default format for the area code when the areacode property is rendered by a seven-digit format.	PhoneFormatter
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		error : String Description saved by the formatter when an error occurs.	Formatter
		formatString : String String that contains mask characters that represent a specified phone number format.	PhoneFormatter
		validPatternChars : String List of valid characters that can be used in the formatString property.	PhoneFormatter

保護屬性

隱藏繼承保護屬性

顯示繼承保護屬性

	屬性		定義自
		resourceManager : IResourceManager [唯讀] A reference to the object which manages all of the application's localized resources.	Formatter

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		PhoneFormatter() Constructor.	PhoneFormatter
		format(value:Object):String [覆寫] Formats the String as a phone number.	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
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		valueOf():Object 會傳回指定之物件的基本值。	Object

保護方法

隱藏繼承保護方法

顯示繼承保護方法

	方法		定義自
		resourcesChanged():void This method is called when a Formatter is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.	Formatter

屬性詳細資訊

areaCode

屬性

areaCode:Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Area code number added to a seven-digit United States format phone number to form a 10-digit phone number. A value of -1 means do not prepend the area code.

預設值為 -1。

實作
public function get areaCode():Object
public function set areaCode(value:Object):void

areaCodeFormat

屬性

areaCodeFormat:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Default format for the area code when the areacode property is rendered by a seven-digit format.

預設值為 "(###) "。

實作
public function get areaCodeFormat():String
public function set areaCodeFormat(value:String):void

formatString

屬性

formatString:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

String that contains mask characters that represent a specified phone number format.

預設值為 "(###) ###-####"。

實作
public function get formatString():String
public function set formatString(value:String):void

validPatternChars

屬性

validPatternChars:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

List of valid characters that can be used in the formatString property. This property is used during validation of the formatString property.

預設值為 "+()#- ."。

實作
public function get validPatternChars():String
public function set validPatternChars(value:String):void

建構函式詳細資料

()

建構函式

public function PhoneFormatter()

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Constructor.

方法詳細資訊

format

()

方法

override public function format(value:Object):String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Formats the String as a phone number. If the value cannot be formatted, return an empty String and write a description of the error to the error property.

參數

value:Object — Value to format.

傳回值

String — Formatted String. Empty if an error occurs. A description of the error condition is written to the error property.

範例如何使用本範例

PhoneFormatterExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate PhoneFormatter. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <fx: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 = "";
                }
            }
        ]]>
    </fx:Script>

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

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

    <s:Panel title="PhoneFormatter Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <mx:Form left="10" right="10" top="10" bottom="10">
            <mx:FormItem label="Enter a 10-digit phone number:">
                <s:TextInput id="phone" text="" width="75%"/>
            </mx:FormItem>
            <mx:FormItem label="Formatted phone number: ">
                <s:TextInput id="formattedPhone" text="" width="75%" editable="false"/>
            </mx:FormItem>
            <mx:FormItem>
                <s:Button label="Validate and Format" click="Format();"/>
            </mx:FormItem>
        </mx:Form>
    </s:Panel>

</s:Application>

法律聲明 | 線上隱私權政策

PhoneFormatter - AS3 Flex

類別 x

areaCode

areaCodeFormat

formatString

validPatternChars

PhoneFormatter

format