| パッケージ | spark.formatters |
| クラス | public class DateTimeFormatter |
| 継承 | DateTimeFormatter GlobalizationBase AdvancedStyleClient EventDispatcher Object |
| 実装 | IFormatter |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
Date オブジェクトのロケールに依存したフォーマットを提供します。
このクラスは flash.globalization.DateTimeFormatter クラスのラッパークラスです。 したがって、ロケール固有のフォーマット機能と月名、曜日名および週の最初の日は flash.globalization.DateTimeFormatter によって指定されます。 ただし、この DateTimeFormatter クラスは MXML 宣言で使用でき、要求されたロケール ID 名にロケールスタイルを使用し、バインド可能なメソッドおよびプロパティを持ちます。
flash.globalization.DateTimeFormatter クラスでは、フォーマット機能と、ロケール固有データの提供用に、基盤となるオペレーティングシステムを使用します。 一部のオペレーティングシステムでは、flash.globalization クラスがサポートされておらず、これらのシステムではこのラッパークラスが代替機能を提供します。
MXML シンタックス
MXML シンタックスを隠すThe <s:DateTimeFormatter> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:DateTimeFormatter
Properties
dateStyle="long"
dateTimePattern="EEEE, MMMM dd, yyyy h:mm:ss a"
errorText="null"
timeStyle="long"
useUTC="false"
/>
さらに例を参照
関連する API エレメント
| プロパティ | 定義元 | ||
|---|---|---|---|
| actualLocaleIDName : String [オーバーライド] [読み取り専用]
このクラスオブジェクトで使用される実際のロケール ID の名前。 | DateTimeFormatter | ||
![]() | className : String [読み取り専用]
コンポーネントクラスの名前です。 | AdvancedStyleClient | |
![]() | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| dateStyle : String
DateTimeFormatter のこのインスタンスの日付スタイル。 | DateTimeFormatter | ||
| dateTimePattern : String
DateTimeFormatter オブジェクトで日付と時間をフォーマットするために使用するパターン文字列。 | DateTimeFormatter | ||
| errorText : String
エラーが発生したときに format() メソッドによって返される文字列。 | DateTimeFormatter | ||
![]() | id : String
コンポーネントの ID です。 | AdvancedStyleClient | |
![]() | inheritingStyles : Object
このビジュアルでないスタイルクライアントのインスタンスの継承可能なスタイルを含むオブジェクトです。 | AdvancedStyleClient | |
| lastOperationStatus : String [オーバーライド] [読み取り専用]
このクラスオブジェクトが実行した最新の操作のステータス。 | DateTimeFormatter | ||
![]() | moduleFactory : IFlexModuleFactory
モジュールファクトリは、このビジュアルでないスタイルクライアントのインスタンスのスタイルを制御するスタイルマネージャーを検索するためのコンテキストとして使用されます。 | AdvancedStyleClient | |
![]() | nonInheritingStyles : Object
このコンポーネントの非継承スタイルのチェーンの始まりです。 | AdvancedStyleClient | |
![]() | styleDeclaration : CSSStyleDeclaration
このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。 | AdvancedStyleClient | |
![]() | styleManager : IStyleManager2 [読み取り専用]
このコンポーネントで使用する StyleManager インスタンスを返します。 | AdvancedStyleClient | |
![]() | styleName : Object
オブジェクトのスタイル値のソースです。 | AdvancedStyleClient | |
![]() | styleParent : IAdvancedStyleClient
コンポーネントの親は、下位要素のセレクターを評価するために使用されます。 | AdvancedStyleClient | |
| timeStyle : String
DateTimeFormatter のこのインスタンスの時刻スタイル。 | DateTimeFormatter | ||
| useUTC : Boolean
日付をフォーマットするときに使用される日付と時刻の値が、ローカルまたは UTC のいずれかを制御する Boolean フラグ。 | DateTimeFormatter | ||
| メソッド | 定義元 | ||
|---|---|---|---|
指定されたロケールと提供された日付と時刻フォーマットスタイルの規則に基づいて、日付と時間をフォーマットするための新しい DateTimeFormatter オブジェクトを構築します。 | DateTimeFormatter | ||
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | |
![]() |
このコンポーネントインスタンスからスタイルプロパティを削除します。 | AdvancedStyleClient | |
![]() |
イベントをイベントフローに送出します。 | EventDispatcher | |
ユーザーのローカル時刻または UTC 時刻のいずれかで日付を指定するオブジェクトの表示文字列をフォーマットします。 | DateTimeFormatter | ||
[静的]
このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。 | DateTimeFormatter | ||
![]() |
このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。 | AdvancedStyleClient | |
このロケールおよびカレンダーシステムの週の最初の日に対応する整数を返します。 | DateTimeFormatter | ||
現在のカレンダーシステムの月の名前を含むローカライズされた文字列のリストを取得します。 | DateTimeFormatter | ||
![]() | [オーバーライド]
このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。 | GlobalizationBase | |
現在のカレンダーシステムの曜日の名前を含むローカライズされた文字列のリストを取得します。 | DateTimeFormatter | ||
![]() |
currentCSSState が null でない場合、true を返します。 | AdvancedStyleClient | |
![]() |
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | |
![]() |
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
![]() |
initialized メソッドは、このクラスまたはこのクラスを拡張するクラスが MXML 宣言で使用されると呼び出されます。 | AdvancedStyleClient | |
![]() |
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
![]() |
cssState が currentCSSState に一致した場合は、true を返します。 | AdvancedStyleClient | |
![]() |
このインスタンスが、指定されたタイプと同じであるのか、それともそのサブクラスであるのかを判別します。 | AdvancedStyleClient | |
![]() |
スタイルの変更を、このスタイルクライアントのインスタンスの子に通知します。 | AdvancedStyleClient | |
![]() |
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
![]() |
getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。 | AdvancedStyleClient | |
![]() |
各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。 | AdvancedStyleClient | |
![]() |
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | |
![]() |
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
![]() |
このコンポーネントインスタンスのスタイルプロパティを設定します。 | AdvancedStyleClient | |
![]() |
スタイルプロパティの変更を検出します。 | AdvancedStyleClient | |
![]() |
コンポーネントのスタイルを初めて初期化するとき、Flex は stylesInitialized() メソッドを呼び出します。 | AdvancedStyleClient | |
![]() |
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
![]() |
指定されたオブジェクトのストリング表現を返します。 | Object | |
![]() |
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
![]() |
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
スタイルには共通スタイルと特定のテーマに関連するスタイルがあります。共通スタイルは、任意のテーマと共に使用できます。特定のテーマに関連するスタイルは、アプリケーションがそのテーマを使用する場合にのみ使用できます。
actualLocaleIDName | プロパティ |
actualLocaleIDName:String [読み取り専用] [オーバーライド] | 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
このクラスオブジェクトで使用される実際のロケール ID の名前。これはフォーマットするデータと機能にオペレーティングシステムからアクセスするために使用されるロケールです。
locale スタイルによって設定されたロケールが使用できない場合、actualLocaleIDName の値は locale スタイルの値とは異なります。 この値は使用中の代替ロケールを示します。 locale スタイルが LocaleID.DEFAULT に設定された場合、ユーザーのオペレーティングシステムによって指定されたロケールの名前が使用されます。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
override public function get actualLocaleIDName():String関連する API エレメント
DateTimeFormatter()
dateStyle | プロパティ |
dateStyle:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
DateTimeFormatter のこのインスタンスの日付スタイル。この日付スタイルは、オペレーティングシステムから事前定義の時間およびロケール固有のフォーマットパターンを取得するために使用されます。 日付をフォーマットするとき、locale スタイル、timeStyle および dateStyle プロパティによって日付のフォーマットが決定されます。 日付スタイルの値は、値を dateStyle プロパティまたは dateTimePattern プロパティのいずれかに割り当てる 2 つの方法で設定できます。
このプロパティに指定可能な値は、flash.globalization.DateTimeStyle クラスで定義されます。 dateStyle プロパティの可能な値は次のとおりです。
DateTimeStyle.LONGDateTimeStyle.MEDIUMDateTimeStyle.SHORTDateTimeStyle.NONEDateTimeStyle.CUSTOM
dateTimePattern プロパティに値を割り当てた場合、副次的な作用として、dateStyle プロパティは DateTimeStyle.CUSTOM に設定されます。
デフォルト値: DateTimeStyle.LONG。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
public function get dateStyle():String public function set dateStyle(value:String):void例外
ArgumentError — 割り当てられた値が有効な DateTimeStyle 定数でないか、DateTimeStyle.CUSTOM の場合。
| |
TypeError — dateStyle が null に設定されている場合。
|
関連する API エレメント
dateTimePattern | プロパティ |
dateTimePattern:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
DateTimeFormatter オブジェクトで日付と時間をフォーマットするために使用するパターン文字列。
このパターンは次の 2 つの方法のいずれかで設定できます。
dateStyleおよびtimeStyleプロパティを設定する方法dateTimePatternプロパティを設定する方法
このプロパティに直接値を割り当てた場合、副次的な作用として、現在の時刻と日付のスタイルがオーバーライドされ、DateTimeStyle.CUSTOM という値に設定されます。
パターン構文について詳しくは、 flash.globalization.DateTimeFormatter.setDateTimePattern() メソッドを参照してください。
デフォルト値: "EEEE, MMMM dd, yyyy h:mm:ss a"。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
public function get dateTimePattern():String public function set dateTimePattern(value:String):void関連する API エレメント
errorText | プロパティ |
errorText:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
エラーが発生したときに format() メソッドによって返される文字列。
errorText が null でなく、日付のフォーマット中にエラーが発生した場合、format メソッドはこのプロパティに割り当てられた文字列を返します。
var dtf:DateTimeFormatter = new DateTimeFormatter();
dtf.setStyle("locale", "en-US");
dtf.errorText = "----"
trace(dtf.format("abc")); // ----
デフォルト値: null。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
public function get errorText():String public function set errorText(value:String):void関連する API エレメント
lastOperationStatus | プロパティ |
lastOperationStatus:String [読み取り専用] [オーバーライド] | 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
このクラスオブジェクトが実行した最新の操作のステータス。コンストラクターまたはこのクラスのメソッドが呼び出されたり、プロパティが設定されたりすると、必ず lastOperationStatus が設定されます。有効な値については、各メソッドの説明を参照してください。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
override public function get lastOperationStatus():StringtimeStyle | プロパティ |
timeStyle:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
DateTimeFormatter のこのインスタンスの時刻スタイル。この時間スタイルは、オペレーティングシステムから事前定義の時間およびロケール固有のフォーマットパターンを取得するために使用されます。 日付をフォーマットするとき、locale スタイル、timeStyle および dateStyle プロパティによって日付のフォーマットが決定されます。 時刻スタイルの値は、値を timeStyle プロパティまたは dateTimePattern プロパティのいずれかに割り当てる 2 つの方法で設定できます。
このプロパティの値は、flash.globalization.DateTimeStyle クラスで定義されます。timeStyle プロパティの可能な値は次のとおりです。
DateTimeStyle.LONGDateTimeStyle.MEDIUMDateTimeStyle.SHORTDateTimeStyle.NONEDateTimeStyle.CUSTOM
dateTimePattern プロパティに値を割り当てた場合、副次的な作用として、dateStyle プロパティは DateTimeStyle.CUSTOM に設定されます。
デフォルト値: DateTimeStyle.LONG。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
public function get timeStyle():String public function set timeStyle(value:String):void例外
ArgumentError — 割り当てられた値が有効な DateTimeStyle 定数でないか、DateTimeStyle.CUSTOM の場合。
| |
TypeError — dateStyle または timeStyle パラメーターが null の場合。
|
関連する API エレメント
useUTC | プロパティ |
useUTC:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
日付をフォーマットするときに使用される日付と時刻の値が、ローカルまたは UTC のいずれかを制御する Boolean フラグ。useUTC が true に設定される場合、UTC 値が使用されます。 値が false に設定される場合、オペレーティングシステムの現在のタイムゾーンの日付と時刻が使用されます。
デフォルト値: false。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
public function get useUTC():Boolean public function set useUTC(value:Boolean):void関連する API エレメント
DateTimeFormatter | () | コンストラクター |
public function DateTimeFormatter()| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
指定されたロケールと日付/時刻のフォーマットスタイルの規則に従って日付と時刻をフォーマットする新しい DateTimeFormatter オブジェクトを作成します。
このクラスのロケールはロケールスタイルによって提供されます。 ロケールスタイルは、次のいくつかの方法で設定できます。
- MXML 宣言内でクラスを使用し、宣言を格納するドキュメントからロケールを継承する。 例:
<fx:Declarations>
<s:DateTimeFormatter id="df" />
</fx:Declarations>
<fx:Declarations>
<s:DateTimeFormatter id="df_Japanese" locale="ja-JP" />
</fx:Declarations>
df.setStyle("locale", "ja-JP")
addStyleClient() メソッドを呼び出すことによって UIComponent からスタイルを継承する。
locale スタイルが上記のいずれかの手法で設定されていない場合は、このクラスのインスタンスが StyleClient として topLevelApplication に追加されるため、locale 依存のプロパティ getter または locale 依存のメソッドが呼び出されるときに、topLevelApplication オブジェクトから locale が継承されます。
このクラスのほとんどのプロパティは、ロケールスタイルに基づいて自動的に設定されます。 ロケールスタイルが変更されると、明示的に設定されていないすべてのプロパティは新しいロケールに基づいて更新されます。 使用される実際のロケールは actualLocaleIDName プロパティによって指定されることに注意してください。
関連する API エレメント
format | () | メソッド |
public function format(value:Object):String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
ユーザーのローカル時刻または UTC 時刻のいずれかで日付を指定するオブジェクトの表示文字列をフォーマットします。
Date オブジェクトには日付と時刻の値のセットが 2 つあり、1 つはユーザーのローカル時刻のセット(date、day、fullYear、hours、minutes、month および seconds)で、もう 1 つは UTC 時刻のセット(dateUTC、dayUTC、fullYearUTC、hoursUTC、minutesUTC、monthUTC および secondsUTC)です。 ブール型プロパティ useUTC は、日付をフォーマットするときに使用する日付と時刻のコンポーネントのセットを制御します。 フォーマットは、locale スタイルプロパティによって設定されるロケールの規則と、dateStyle および timeStyle プロパティ、またはこの DateTimeFormatter インスタンス用に指定された dateTimePattern を使用して実行されます。
不正な入力値またはその他のエラーによりフォーマット中にエラーが発生した場合、format() メソッドはデフォルトで null を返します。 ただし、errorText プロパティが null 以外の場合、errorText プロパティの値が返されます。 lastOperationStatus プロパティが、発生したエラーを示すように設定されます。
パラメーター
value:Object — フォーマットされる Date 値。 オブジェクトが Date でない場合、オブジェクトは Date() コンストラクターを使用して数値に変換されます。
|
String — 日付または時間の値を表すフォーマットされた文字列。
|
関連する API エレメント
getAvailableLocaleIDNames | () | メソッド |
public static function getAvailableLocaleIDNames():Vector.<String>| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。これはオペレーティングシステムでサポートされているロケールのリストです。ResourceManager にリソースがあるロケールのリストではありません。
戻り値Vector.<String> — このクラスおよびオペレーティングシステムでサポートされているすべてのロケール ID 名を含む文字列のベクトル。
|
getFirstWeekday | () | メソッド |
getMonthNames | () | メソッド |
public function getMonthNames(nameStyle:String = "full", context:String = "standalone"):Vector.<String>| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
現在のカレンダーシステムの月の名前を含むローカライズされた文字列のリストを取得します。このリストの最初の要素は、年の最初の月の名前です。
パラメーター
nameStyle:String (default = "full") — 使用される名前文字列のスタイルを示します。有効な値は次のとおりです。
| |
context:String (default = "standalone") — フォーマットされた文字列が使用されるコンテキストを示すコード。このコンテキストは、特定のロケールにのみ影響します。有効な値は次のとおりです。
|
Vector.<String> — 現在のロケール(ロケールスタイルによって指定される)、名前スタイルおよびコンテキストの月の名前を含むローカライズされた文字列のベクトル。 このベクトルのインデックス 0 における最初の要素は年の最初の月の名前、次の要素は年の 2 番目の月の名前というように続きます。
|
例外
TypeError — nameStyle または context パラメータが null の場合。
|
関連する API エレメント
getWeekdayNames | () | メソッド |
public function getWeekdayNames(nameStyle:String = "full", context:String = "standalone"):Vector.<String>| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
現在のカレンダーシステムの曜日の名前を含むローカライズされた文字列のリストを取得します。リストの最初の要素は、日曜日の名前を表しています。
パラメーター
nameStyle:String (default = "full") — 使用される名前文字列のスタイルを示します。有効な値は次のとおりです。
| |
context:String (default = "standalone") — フォーマットされた文字列が使用されるコンテキストを示すコード。このコンテキストは、コンテキストに応じて月の名前表示が変わる特定のロケールにのみ適用されます。例えば、ギリシャ語では、月の名前だけを表示する場合と、月と日にちを表示する場合では、月名の表示が異なります。有効な値は次のとおりです。
|
Vector.<String> — 現在のロケール(ロケールスタイルによって指定される)、名前スタイルおよびコンテキストの月の名前を含むローカライズされた文字列のベクトル。 このベクトルのインデックス 0 における最初の要素は日曜日の名前、次の要素は月曜日の名前というように続きます。
|
例外
TypeError — nameStyle または context パラメータが null の場合。
|
関連する API エレメント
<?xml version="1.0" encoding="utf-8"?>
<!-- Sample program for spark.formatters.DateTimeFormatter -->
<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:Declarations>
<s:DateTimeFormatter id="dateTimeFormatter"/>
</fx:Declarations>
<fx:Script>
<![CDATA[
import mx.collections.ArrayCollection;
private static const dateTimeStyleMenuItems:ArrayCollection
= new ArrayCollection(["long", "medium", "short", "none"]);
]]>
</fx:Script>
<mx:Form>
<mx:FormItem label="Input Locale ID Name">
<mx:HBox>
<s:TextInput id="inputLocaleIDName"/>
<!-- Upon button click, sets the locale style on the document
UI component. The formatter will inherit this style. -->
<s:Button click="setStyle('locale', inputLocaleIDName.text);"
label="Apply"/>
</mx:HBox>
<mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/>
</mx:FormItem>
<mx:FormItem label="Date Style">
<s:DropDownList id="dateStyle" requireSelection="true"
change="dateTimeFormatter.dateStyle = dateTimeStyleMenuItems[dateStyle.selectedIndex]"
dataProvider="{dateTimeStyleMenuItems}"/>
</mx:FormItem>
<mx:FormItem label="Time Style">
<s:DropDownList id="timeStyle" requireSelection="true"
change="dateTimeFormatter.timeStyle = dateTimeStyleMenuItems[timeStyle.selectedIndex]"
dataProvider="{dateTimeStyleMenuItems}"/>
</mx:FormItem>
<mx:FormItem label="Input Date">
<mx:TextInput id="inputDate" text="{new Date().toString()}"/>
</mx:FormItem>
<mx:FormItem label="Actual Locale ID Name">
<mx:Text text="{dateTimeFormatter.actualLocaleIDName}"/>
</mx:FormItem>
<mx:FormItem label="Formatted Result">
<mx:Text id="uiFormattedDate"
text="{dateTimeFormatter.format(inputDate.text)}"/>
</mx:FormItem>
</mx:Form>
</s:Application>
Tue Jun 12 2018, 10:34 AM Z
MXML シンタックスを表示