| パッケージ | mx.formatters |
| クラス | public class DateFormatter |
| 継承 | DateFormatter  Formatter Object |
| サブクラス | ExpiryDateFormat |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
 | Flex 4.5 以降では、このクラスの代わりとして spark.formatters.DateTimeFormatter クラスを使用することをお勧めします。 |
DateFormatter クラスは、書式ストリングを使用して、入力ストリングまたは Date オブジェクトから、書式設定された日付および時刻のストリングを返します。 国際的な形式をはじめ、さまざまな形式を作成できます。
エラーが発生すると、空のストリングが返され、エラーを説明するストリングが error プロパティに保存されます。 この error プロパティに保存される可能性のある値は、次のうちのいずれかです。
-
"Invalid value"は、Date オブジェクトではない値、または日付のストリング表現とは認識できない値がformat()メソッドに渡されたことを示します （空の引数は許可されています）。 -
"Invalid format"は、formatStringプロパティに空の値（""）が設定されているか、formatStringプロパティにパターン文字が含まれていないことを示します。
parseDateString() メソッドは、mx.formatters.DateBase クラスを使用して、ストリングとして書式設定された日付を Date オブジェクトに変換するために必要な、ローカライズされたストリングに関する情報を定義します。
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 エレメント
パブリックプロパティ
| プロパティ | 定義元 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| error : String
エラーが発生したときにフォーマッターによって保存される説明を表します。 | Formatter | |
| formatString : String
マスクパターンを表します。 | DateFormatter | ||
プロテクトプロパティ
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクターです。 | DateFormatter | ||
[オーバーライド]
日付形式のストリングまたは Date オブジェクトから日付形式のストリングを生成します。 | DateFormatter | ||
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
[静的]
ストリングとしてフォーマットした日付を Date オブジェクトに変換します。 | DateFormatter | ||
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
プロテクトメソッド
プロパティの詳細
formatString | プロパティ |
formatString:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクパターンを表します。
パターンストリングは YYYY/MM のように特定の大文字を使用して構成します。
DateFormatter パターンストリングには、パターン文字に加えてそれ以外のテキストを含めることができます。 有効なパターンストリングを作成するには、少なくとも 1 文字のパターン文字が必要です。
次の表に、有効なパターン文字を示します。
| パターン文字 | 説明 |
|---|---|
| Y | 年です。パターン文字の数が 2 の場合、年は 2 桁に切り詰められます。それ以外の場合、4 桁で表示されます。 次の例の 3 番目に示すように、指定された桁数になるように 0 が追加されます。
|
| M | 月です。 形式は、次の条件により決まります。
|
| D | 日付です。 1 文字の日付パターンストリングも有効ですが、通常は 2 文字のパターンストリングを使用します。
例：
|
| E | 曜日です。 形式は、次の条件により決まります。
|
| A | 午前 / 午後を表します。 |
| J | 時刻（0 ～ 23）です。 |
| H | 時刻（1 ～ 24）です。 |
| K | 午前 / 午後で区切った時刻（0 ～ 11）です。 |
| L | 午前 / 午後で区切った時刻（1 ～ 12）です。 |
| N | 分数です。
例：
|
| S | 秒数です。
例：
|
| Q | ミリ秒数です。
例：
|
| その他のテキスト | その他のテキストをパターンストリングに追加して、ストリングをさらにフォーマットすることができます。 句読点や数字、任意の小文字を使用できます。 大文字はパターン文字として解釈される場合があるため、大文字は使用しないでください。
例：
|
デフォルト値： "MM/DD/YYYY"。
実装
public function get formatString():String public function set formatString(value:String):voidコンストラクターの詳細
DateFormatter | () | コンストラクター |
public function DateFormatter()| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
コンストラクターです。
メソッドの詳細
format | () | メソッド |
override public function format(value:Object):String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
日付形式のストリングまたは Date オブジェクトから日付形式のストリングを生成します。 出力ストリングのフォーマットは formatString プロパティによって決まります。 value をフォーマットできない場合、空のストリングが返され、error プロパティにエラーの説明が書き込まれます。
パラメーター
value:Object — フォーマットする日付を表します。 これには、Date オブジェクト、または "Thursday, April 22, 2004" などの日付形式のストリングを指定できます。
|
String — フォーマットしたストリングを表します。 エラーが発生した場合は空です。 エラーの状態を示す説明が error プロパティに書き込まれます。
|
parseDateString | () | メソッド |
public static function parseDateString(str:String):Date| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ストリングとしてフォーマットした日付を Date オブジェクトに変換します。 月名と曜日名は mx.formatters.DateBase 内の名前に一致する必要があります。ストリングの時間の値は、0 ～ 23 の間にする必要があります。分と秒の値は、0 ～ 59 の間にする必要があります。次の例では、このメソッドを使用して Date オブジェクトを作成します。
var myDate:Date = DateFormatter.parseDateString("2009-12-02 23:45:30");
パラメーター
str:String — ストリングとしてフォーマットした日付を表します。
|
Date — Date オブジェクトです。
|
関連する API エレメント
例 この例の使用方法
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>
Tue Jun 12 2018, 10:34 AM Z