DateFormatter

套件	mx.formatters
類別	public class DateFormatter
繼承	DateFormatter Formatter Object
子類別	ExpiryDateFormat

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

使用 Flex 4.5 開始，Adobe 建議您使用 spark.formatters.DateTimeFormatter 類別當作是此類別的替代類別。

The DateFormatter class uses a format String to return a formatted date and time String from an input String or a Date object. You can create many variations easily, including international formats.

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

"Invalid value" means a value that is not a Date object or a is not a recognized String representation of a date is passed to the format() method. (An empty argument is allowed.)
"Invalid format" means either the formatString property is set to empty (""), or there is less than one pattern letter in the formatString property.

The parseDateString() method uses the mx.formatters.DateBase class to define the localized string information required to convert a date that is formatted as a String into a Date object.

MXML 語法

隱藏 MXML 語法

You use the <mx:DateFormatter> tag to render date and time Strings from a Date object.

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

  <mx:DateFormatter
    formatString="Y|M|D|A|E|H|J|K|L|N|S|Q"
   />

檢視範例

相關 API 元素

mx.formatters.DateBase

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

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

保護屬性

隱藏繼承保護屬性

顯示繼承保護屬性

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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		DateFormatter() Constructor.	DateFormatter
		format(value:Object):String [覆寫] Generates a date-formatted String from either a date-formatted String or a Date object.	DateFormatter
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		parseDateString(str:String):Date [靜態] Converts a date that is formatted as a String into a Date object.	DateFormatter
		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.

You compose a pattern String using specific uppercase letters, for example: YYYY/MM.

The DateFormatter pattern String can contain other text in addition to pattern letters. To form a valid pattern String, you only need one pattern letter.

The following table describes the valid pattern letters:

Pattern letter	Description
Y	Year. If the number of pattern letters is two, the year is truncated to two digits; otherwise, it appears as four digits. The year can be zero-padded, as the third example shows in the following set of examples: YY = 05 YYYY = 2005 YYYYY = 02005
M	Month in year. The format depends on the following criteria: If the number of pattern letters is one, the format is interpreted as numeric in one or two digits. If the number of pattern letters is two, the format is interpreted as numeric in two digits. If the number of pattern letters is three, the format is interpreted as short text. If the number of pattern letters is four, the format is interpreted as full text. Examples: M = 7 MM= 07 MMM=Jul MMMM= July
D	Day in month. While a single-letter pattern string for day is valid, you typically use a two-letter pattern string. Examples: D=4 DD=04 DD=10
E	Day in week. The format depends on the following criteria: If the number of pattern letters is one, the format is interpreted as numeric in one or two digits. If the number of pattern letters is two, the format is interpreted as numeric in two digits. If the number of pattern letters is three, the format is interpreted as short text. If the number of pattern letters is four, the format is interpreted as full text. Examples: E = 1 EE = 01 EEE = Mon EEEE = Monday
A	am/pm indicator.
J	Hour in day (0-23).
H	Hour in day (1-24).
K	Hour in am/pm (0-11).
L	Hour in am/pm (1-12).
N	Minute in hour. Examples: N = 3 NN = 03
S	Second in minute. Example: SS = 30
Q	Millisecond in second Example: QQ = 78 QQQ = 078
Other text	You can add other text into the pattern string to further format the string. You can use punctuation, numbers, and all lowercase letters. You should avoid uppercase letters because they may be interpreted as pattern letters. Example: EEEE, MMM. D, YYYY at L:NN:QQQ A = Tuesday, Sept. 8, 2005 at 1:26:012 PM

預設值為 "MM/DD/YYYY"。

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

建構函式詳細資料

()

建構函式

public function DateFormatter()

語言版本:

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

Generates a date-formatted String from either a date-formatted String or a Date object. The formatString property determines the format of the output String. If value cannot be formatted, return an empty String and write a description of the error to the error property.

參數

value:Object — Date to format. This can be a Date object, or a date-formatted String such as "Thursday, April 22, 2004".

傳回值

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

parseDateString

()

方法

public static function parseDateString(str:String):Date

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Converts a date that is formatted as a String into a Date object. Month and day names must match the names in mx.formatters.DateBase. The hour value in the String must be between 0 and 23, inclusive. The minutes and seconds value must be between 0 and 59, inclusive. The following example uses this method to create a Date object:

      var myDate:Date = DateFormatter.parseDateString("2009-12-02 23:45:30");

參數

str:String — Date that is formatted as a String.

傳回值

Date — Date object.

相關 API 元素

mx.formatters.DateBase

範例如何使用本範例

DateFormatterExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the DateFormatter. -->
<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 = dateVal.validate();
                if (vResult.type == ValidationResultEvent.VALID) {
                    formattedDate.text = dateFormatter.format(dob.text);
                } else {
                    formattedDate.text = "";
                }
            }
        ]]>
    </fx:Script>

    <fx:Declarations>
        <mx:DateFormatter id="dateFormatter" formatString="month: MM, day: DD, year: YYYY"/>
        <mx:DateValidator id="dateVal" source="{dob}" property="text" inputFormat="mm/dd/yyyy"/>
    </fx:Declarations>

    <s:Panel title="DateFormatter Example" width="75%" height="75%" horizontalCenter="0" verticalCenter="0">
        <mx:Form left="10" right="10" top="10" bottom="10">
            <mx:FormItem label="Enter date (mm/dd/yyyy):" width="100%">
                <s:TextInput id="dob" text=""/>
            </mx:FormItem>
            <mx:FormItem label="Formatted date: " width="100%">
                <s:TextInput id="formattedDate" text="" editable="false"/>
            </mx:FormItem>
            <mx:FormItem>
                <s:Button label="Validate and Format" click="Format();"/>
            </mx:FormItem>
        </mx:Form>
    </s:Panel>

</s:Application>

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

DateFormatter - AS3 Flex

類別 x

formatString

DateFormatter

format

parseDateString