ZipCodeFormatter

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

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The ZipCodeFormatter class formats a valid number into one of the following formats, based on a user-supplied formatString property.

#####-####
##### ####
#####
### ### (Canadian)

A six-digit number must be supplied for a six-digit mask. If you use a five-digit or a nine-digit mask, you can use either a five-digit or a nine-digit number for formatting.

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, except for Canadian postal code, which allows alphanumeric values, or the number of digits does not match the allowed digits from the formatString property.
"Invalid format" means any of the characters in the formatString property do not match the allowed characters specified in the validFormatChars property, or the number of numeric placeholders does not equal 9, 5, or 6.

MXML 語法

隱藏 MXML 語法

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

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

檢視範例

相關 API 元素

mx.formatters.SwitchSymbolFormatter

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		error : String Description saved by the formatter when an error occurs.	Formatter
		formatString : String The mask pattern.	ZipCodeFormatter

保護屬性

隱藏繼承保護屬性

顯示繼承保護屬性

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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		ZipCodeFormatter() Constructor.	ZipCodeFormatter
		format(value:Object):String [覆寫] Formats the String by using the specified format.	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
		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

屬性詳細資訊

formatString

屬性

formatString:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The mask pattern. Possible values are "#####-####", "##### ####", "#####", "###-###" and "### ###".

預設值為 "#####"。

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

建構函式詳細資料

()

建構函式

public function ZipCodeFormatter()

語言版本:

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 by using the specified format. 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.

範例如何使用本範例

ZipCodeFormatterExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate ZipCodeFormatter. -->
<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 = zcVal.validate();

                if (vResult.type == ValidationResultEvent.VALID) {
                    formattedZipcode.text = zipFormatter.format(zip.text);
                } else {
                    formattedZipcode.text = "";
                }
            }
        ]]>
    </fx:Script>

    <fx:Declarations>
        <mx:ZipCodeFormatter id="zipFormatter" formatString="#####-####"/>
        <mx:ZipCodeValidator id="zcVal" source="{zip}" property="text" allowedFormatChars=""/>
    </fx:Declarations>

    <s:Panel title="ZipCodeFormatter Example"
            width="75%" height="75%" 
            horizontalCenter="0" verticalCenter="0">
        <mx:Form left="10" right="10" top="10" bottom="10">
            <mx:FormItem label="Enter a 5 or 9 digit U.S. ZIP code:" width="100%">
                <s:TextInput id="zip" text=""/>
            </mx:FormItem>
            <mx:FormItem label="Formatted ZIP code: " width="100%">
                <s:TextInput id="formattedZipcode" text="" editable="false"/>
            </mx:FormItem>
            <mx:FormItem>
                <s:Button label="Validate and Format" click="Format();"/>
            </mx:FormItem>
        </mx:Form>
    </s:Panel>

</s:Application>

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

ZipCodeFormatter - AS3 Flex

類別 x

formatString

ZipCodeFormatter

format