パッケージmx.formatters
クラスpublic class DateFormatter
継承DateFormatter Inheritance Formatter Inheritance Object

DateFormatter クラスは、書式ストリングを使用して、入力ストリングまたは Date オブジェクトから、書式設定された日付および時刻のストリングを返します。 国際的な形式をはじめ、さまざまな形式を作成できます。

エラーが発生すると、空のストリングが返され、エラーを説明するストリングが error プロパティに保存されます。 この error プロパティに保存される可能性のある値は、次のうちのいずれかです。

parseDateString() メソッドは、mx.formatters.DateBase クラスを使用して、ストリングとして書式設定された日付を Date オブジェクトに変換するために必要な、ローカライズされたストリングに関する情報を定義します。

MXML のシンタックスexpandedMXML シンタックスを隠す

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"
   /> 
  

例を表示

関連項目

mx.formatters.DateBase


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheriteddefaultInvalidFormatError : String
[静的] 無効なフォーマットストリングがフォーマッタに指定されたことを示すエラーメッセージです。
Formatter
 InheriteddefaultInvalidValueError : String
[静的] 無効な値がフォーマッタに指定されたことを示すエラーメッセージです。
Formatter
 Inheritederror : String
エラーが発生したときにフォーマッタによって保存される説明を表します。
Formatter
  formatString : String
マスクパターンを表します。
DateFormatter
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
プロテクトプロパティ
 プロパティ定義元
 InheritedresourceManager : IResourceManager
[読み取り専用] アプリケーションのローカライズされたすべてのリソースを管理するオブジェクトへの参照です。
Formatter
パブリックメソッド
 メソッド定義元
  
コンストラクタです。
DateFormatter
  
[override] 日付形式のストリングまたは Date オブジェクトから日付形式のストリングを生成します。
DateFormatter
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロテクトメソッド
 メソッド定義元
  
[静的] ストリングとしてフォーマットした日付を Date オブジェクトに変換します。
DateFormatter
 Inherited
このメソッドは、Formatter の作成時に呼び出されます。また、ローカライズされたリソースが何らかの方法で変更されたことを示すために、ResourceManager が "change" イベントを送出した時点で常に呼び出されます。
Formatter
プロパティの詳細
formatStringプロパティ
formatString:String

マスクパターンを表します。

パターンストリングは YYYY/MM のように特定の大文字を使用して構成します。

DateFormatter パターンストリングには、パターン文字に加えてそれ以外のテキストを含めることができます。 有効なパターンストリングを作成するには、少なくとも 1 文字のパターン文字が必要です。

次の表に、有効なパターン文字を示します。

パターン文字説明
Y 年です。パターン文字の数が 2 の場合、年は 2 桁に切り詰められます。それ以外の場合、4 桁で表示されます。 次の例の 3 番目に示すように、指定された桁数になるように 0 が追加されます。
  • YY = 05
  • YYYY = 2005
  • YYYYY = 02005
M 月です。 形式は、次の条件により決まります。
  • パターン文字の数が 1 つの場合、形式は 1 桁または 2 桁の数値として解釈されます。
  • パターン文字の数が 2 つの場合、形式は 2 桁の数値として解釈されます。
  • パターン文字の数が 3 つの場合、形式は省略したテキストとして解釈されます。
  • パターン文字の数が 4 つの場合、形式は省略されないテキストとして解釈されます。
例:
  • M = 7
  • MM = 07
  • MMM = Jul
  • MMMM = July
D日付です。 1 文字の日付パターンストリングも有効ですが、通常は 2 文字のパターンストリングを使用します。

例:

  • D = 4
  • DD = 04
  • DD = 10
E曜日です。 形式は、次の条件により決まります。
  • パターン文字の数が 1 つの場合、形式は 1 桁または 2 桁の数値として解釈されます。
  • パターン文字の数が 2 つの場合、形式は 2 桁の数値として解釈されます。
  • パターン文字の数が 3 つの場合、形式は省略したテキストとして解釈されます。
  • パターン文字の数が 4 つの場合、形式は省略されないテキストとして解釈されます。
例:
  • E = 1
  • EE = 01
  • EEE = Mon
  • EEEE = Monday
A 午前 / 午後を表します。
J時刻(0 ~ 23)です。
H時刻(1 ~ 24)です。
K午前 / 午後で区切った時刻(0 ~ 11)です。
L午前 / 午後で区切った時刻(1 ~ 12)です。
N分数です。

例:

  • N = 3
  • NN = 03
S秒数です。

例:

  • SS = 30
その他のテキストその他のテキストをパターンストリングに追加して、ストリングをさらにフォーマットすることができます。 句読点や数字、任意の小文字を使用できます。 大文字はパターン文字として解釈される場合があるため、大文字は使用しないでください。

例:

  • EEEE, MMM. D, YYYY at L:NN A = Tuesday, Sept. 8, 2005 at 1:26 PM

デフォルト値 : MM/DD/YYYY.



実装
    public function get formatString():String
    public function set formatString(value:String):void
コンストラクタの詳細
DateFormatter()コンストラクタ
public function DateFormatter()

コンストラクタです。

メソッドの詳細
format()メソッド
override public function format(value:Object):String

日付形式のストリングまたは Date オブジェクトから日付形式のストリングを生成します。 出力ストリングのフォーマットは formatString プロパティによって決まります。 value をフォーマットできない場合、空のストリングが返され、error プロパティにエラーの説明が書き込まれます。

パラメータ

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

戻り値
String — フォーマットしたストリングを表します。 エラーが発生した場合は空です。 エラーの状態を示す説明が error プロパティに書き込まれます。
parseDateString()メソッド 
protected static function parseDateString(str:String):Date

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

パラメータ

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

戻り値
Date — Date オブジェクト。

関連項目

例の使用法
DateFormatterExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the DateFormatter. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

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

    <mx:DateFormatter id="dateFormatter" formatString="month: MM, day: DD, year: YYYY"/>

    <mx:DateValidator id="dateVal" source="{dob}" property="text" inputFormat="mm/dd/yyyy"/>

    <mx:Panel title="DateFormatter Example" width="95%" height="95%" 
            paddingTop="10" paddingLeft="5" paddingRight="5" paddingBottom="10">

        <mx:Form width="100%">
            <mx:FormItem label="Enter date (mm/dd/yyyy):" width="100%">
                <mx:TextInput id="dob" text=""/>
            </mx:FormItem>

            <mx:FormItem label="Formatted date: " width="100%">
                <mx:TextInput id="formattedDate" text="" editable="false"/>
            </mx:FormItem>

            <mx:FormItem>
                <mx:Button label="Validate and Format" click="Format();"/>
            </mx:FormItem>
        </mx:Form>

    </mx:Panel>
</mx:Application>




 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/formatters/DateFormatter.html