メソッド | プロパティ | フレームあり | フレームなし

mx.formatters
DateFormatter クラス

継承を示す線


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

DateFormatter は、フォーマットしたストリングを使用して Date オブジェクトから日付および時刻のストリングをレンダリングします。国際的な形式を含め、さまざまな形式を作成できます。

MXML シンタックス

Date オブジェクトから日時のストリングをレンダリングするには、<mx:DateFormatter> タグを使用します。<mx:DateFormatter> タグには、次のプロパティを使用できます。

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

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

関連項目
    DateBase
    StringFormatter



メソッド
       format( value) :  String
ストリングを日付としてフォーマットします。
staticparseDateString( str:String) :  Date
Date オブジェクトにストリングとしてフォーマットした日付を変換します。

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



プロパティ
       formatString:String
ユーザー定義のマスクパターンを表します。

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



メソッドの詳細

format

format( value) :  String

ストリングを日付としてフォーマットします。出力ストリングのフォーマットは formatString プロパティによって決まります。値をフォーマットできない場合は、空のストリングが返され、error プロパティにはエラーの説明が格納されます。

パラメータ
    value - フォーマットする日付を表します。これには、Date オブジェクト、または "Thursday, April 22, 2004" などの日付ストリングを指定できます。

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


parseDateString

static  parseDateString( str:String) :  Date

Date オブジェクトにストリングとしてフォーマットした日付を変換します。月名と曜日名は DateBase 内の名前に一致する必要があります。

パラメータ
    str:String - ストリングとしてフォーマットした日付を表します。

戻り値
     Date オブジェクト。



プロパティの詳細

formatString

formatString:String  

ユーザー定義のマスクパターンを表します。デフォルト値は MM/DD/YYYY です。パターンストリングは YYYY/MM のように特定の大文字を使用して構成します。DateFormatter のパターンストリングにはパターン文字に加えてそれ以外のテキストを含めることができますが、パターンストリングの末尾はパターン文字にする必要があります。最後のパターン文字以降のテキストは切り捨てられます。通常は、パターン文字で始まり、パターン文字で終わる形式を使用するのが最適です。パターンストリングは 1 文字のパターン文字だけで有効になります。

次のパターン文字があります。
Y - 年
M - 月
D - 日
E - 曜日
A - 午前 (AM) または午後 (PM) の指定
J - 時 (0 ~ 23)
H - 時 (1 ~ 24)
K - 午前 (AM) または午後 (PM) の時 (0 ~ 11)
L - 午前 (AM) または午後 (PM) の時 (1 ~ 12)
N - 分
S - 秒


DateFormatterExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Date 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.DOB'))
                  
formatteddate.text=dateformatter.format(dob.text);
else
formatteddate.text= "";
          }

      ]]>
</mx:Script>

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

<mx:Model id="CheckModel">
<DOB>{dob.text}</DOB>
</mx:Model>

<mx:Label text="Enter below date to be validated and formatted:"color="#FFFFFF"/>
<mx:TextInput id="dob" text="Enter date "/>
<mx:Label text="*allowed characters in date:/ - . " color="#FFCCCC"/>
<mx:Button label="Validate and Format" click="Format();" width="160"/>
<mx:TextInput id="formatteddate" editable="false" color="#0000FF"/>

</mx:Panel>

<!-- 日付の検証結果が DateFormatter によってフォーマットされ表示されます。 -->
<mx:DateFormatter id="dateformatter" formatString="month:MM, day:DD, year:YYYY"/>

<!-- DateValidator がユーザー入力を検証します。 -->
<mx:DateValidator field="CheckModel.DOB" allowedFormatChars="/-." inputFormat="mm/dd/yyyy"/>

</mx:Application>