DateTimeFormatter  - AS3

この DateTimeFormatter オブジェクトで使用される実際のロケール ID の名前。

オペレーティングシステムおよび Collator() コンストラクターに渡される requestedLocaleIDName パラメーターの値に応じて、この名前の値には 3 つの可能性があります。

1. 要求されたロケールが LocaleID.DEFAULT ではなく、要求されたロケールをオペレーティングシステムがサポートする場合、返される名前は requestedLocaleIDName プロパティと同じです。
2. LocaleID.DEFAULT がコンストラクターに対する requestedLocaleIDName パラメーターの値として使用された場合、ユーザーのオペレーティングシステムによって指定された現在のロケールの名前が使用されます。LocaleID.DEFAULT 値により、ユーザーのカスタマイズした設定が OS に保持されます。requestedLocaleIDName パラメーターとして明示的な値を渡した場合に、2 つのロケール ID 名が同じでも LocaleID.DEFAULT を使用する場合と同じ結果になるとは限りません。ユーザーがマシンのロケール設定をカスタマイズし、LocaleID.DEFAULT を使用するのではなく、明示的なロケール ID 名を要求した場合、アプリケーションがそれらのカスタマイズされた設定を取得しない場合があります。
3. システムがコンストラクターで指定された requestedLocaleIDName をサポートしていない場合、代替のロケール ID 名が提供されます。

関連する API エレメント

この DateTimeFormatter オブジェクトが実行した前の操作のステータス。コンストラクターまたはこのクラスのメソッドが呼び出されたり、別のプロパティが設定されたりすると、必ず lastOperationStatus プロパティが設定されます。有効な値については、各メソッドの説明を参照してください。

関連する API エレメント

この DateTimeFormatter オブジェクトのコンストラクターに渡された、要求されたロケール ID の名前。

LocaleID.DEFAULT 値が使用された場合、返される名前は「i-default」です。代替のロケールが適用される場合、実際に使用されるロケールは要求されたロケールと異なる場合があります。 実際のロケール名は actualLocaleIDName プロパティを使用して取得できます。

関連する API エレメント

指定されたロケールと提供された日付と時刻フォーマットスタイルの規則に基づいて、日付と時間をフォーマットするための新しい DateTimeFormatter オブジェクトを構築します。日付および時刻スタイルは、日付および時刻フォーマット パターンをオペレーティングシステムによる事前定義のロケールに依存したパターンに設定するために使用されます。

このコンストラクターは、現在のオペレーティングシステムが要求されたロケール ID 名をサポートしているかどうかを判別します。サポートされていない場合、代わりに代替のロケールが使用されます。代替のロケール ID の名前は、actualLocaleIDName プロパティから決めることができます。

requestedLocaleIDName、dateStyle または timeStyle パラメーターのいずれかに代替のパラメーターが使用されると、代替の種類を示すために lastOperationStatus プロパティが設定されます。

ユーザーの現在のオペレーティングシステムの環境設定に基づいてフォーマットするには、requestedLocaleIDName パラメーターの値 LocaleID.DEFAULT をコンストラクターに渡します。

コンストラクターが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

要求されたロケール ID 名を使用できない場合、lastOperationStatus は以下のいずれかに設定されます。

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

上記の警告および lastOperationStatus プロパティのその他の有効な値について詳しくは、LastOperationStatus クラスの説明を参照してください。

関連する API エレメント

ユーザーのローカル時間として解釈される（date、day、fullYear、hours、minutes、month および seconds などの Date オブジェクトのローカル時間コンポーネントを使用）Date オブジェクトの表示文字列をフォーマットします。フォーマットは、この DateTimeFormatter インスタンスに指定されたロケール ID と日付スタイルおよび時刻スタイル、またはカスタマイズされた日付パターンと時刻パターンの規則を使用して行われます。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

UTC 時間として解釈される（dateUTC、dayUTC、fullYearUTC、hoursUTC、minutesUTC、monthUTC および secondsUTC などの Date オブジェクトの UTC コンポーネントを使用）Date オブジェクトの表示文字列を dateStyle、timeStyle 、または日付時刻パターンに基づいてフォーマットします。フォーマットは、この DateTimeFormatter インスタンスに指定されたロケール ID と日付スタイルおよび時刻スタイル、またはカスタマイズされた日付パターンと時刻パターンの規則を使用して行われます。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

このクラスでサポートされているすべてのロケール ID 名のリストが表示されます。

このクラスが現在のオペレーティングシステムでサポートされていない場合、このメソッドは null 値を返します。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

DateTimeFormatter のこのインスタンスの日付スタイルを取得します。 この日付スタイルは、オペレーティングシステムから事前定義の日付フォーマットパターンを取得するために使用されます。 日付スタイルの値は、DateTimeFormatter() コンストラクター、setDateTimeStyles() メソッドまたは setDateTimePattern() メソッドによって設定できます。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

この DateTimeFormatter オブジェクトによって日付と時間をフォーマットするために使用されるパターン文字列を返します。

このパターンは次の 3 つの方法のいずれかで設定できます。

1. コンストラクターで使用されている dateStyle および timeStyle パラメーターによる方法
2. setDateTimeStyles() メソッドによる方法
3. setDateTimePattern() メソッドによる方法

パターンシンタックスについて詳しくは、「setDateTimePattern() メソッド」を参照してください。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

このロケールおよびカレンダーシステムの週の最初の日に対応する整数を返します。値 0 は日曜日、1 は月曜日というように対応し、6 が土曜日に対応します。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

現在のカレンダーシステムの月の名前を含むローカライズされた文字列のリストを取得します。このリストの最初の要素は、年の最初の月の名前です。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

DateTimeFormatter のこのインスタンスの時間スタイルを取得します。この時間スタイルは、オペレーティングシステムから事前定義の時間フォーマットパターンを取得するために使用されます。 時間スタイルの値は、DateTimeFormatter() コンストラクター、setDateTimeStyles() メソッドまたは setDateTimePattern() メソッドによって設定できます。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

関連する API エレメント

現在のカレンダーシステムの曜日の名前を含むローカライズされた文字列のリストを取得します。リストの最初の要素は、日曜日の名前を表しています。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

この DateTimeFormatter オブジェクトで日付と時間をフォーマットするために使用するパターン文字列を設定します。

日付をフォーマットするために使用されるパターンは次の 3 つの方法のいずれかで設定できます。

1. コンストラクターで使用されている dateStyle および timeStyle パラメーターによる方法
2. setDateTimeStyles() メソッドによる方法
3. setDateTimePattern() メソッドによる方法

このメソッドの副作用として、この DateTimeFormatter オブジェクトの現在の時間および日付スタイルが無効になり、値 DateTimeStyle.CUSTOM に設定されます。

パターンストリングにより、日付と時間をフォーマットする方法が定義されます。パターンには、フォーマットされたストリングで日付および時間の値に置き換えられる文字シーケンスが含まれます。例えば、「yyyy/MM」というパターンでは、「yyyy」という文字列が 4 桁の年に置き換えられ、その後に「/」が続き、「MM」という文字列が 2 桁の月に置き換えられます。

パターンで使用される文字の多くは、以下の表に示したように、2 回以上繰り返し使用して、様々な出力を生み出すことができます。

シーケンスがパターンでサポートされている文字の最大数を超えると、そのパターン文字でサポートされている最も長いシーケンスに戻って割り当てられます。次に実際の使用例を示します。

• MMMMMM は MMMM に置き換えられます
• dddd は dd に置き換えられます
• EEEEEEE は EEEE に置き換えられます
• aa は a に置き換えられます
• hhh は hh に置き換えられます
• mmmm は mm に置き換えられます

理論的には、パターンには最大 255 文字まで含むことができますが、さらに制限の厳しいプラットフォームもあります。パターンがパターン文字数制限を超えると、lastOperationStatus プロパティは値 LastOperationStatus.PATTERN_SYNTAX_ERROR に設定されます。

各オペレーティングシステムで有効なパターンがすべてサポートされているわけではありません。パターンがプラットフォームでサポートされていない場合、代替パターンが使用され、代替パターンが使用されていることを示すように lastOperationStatus プロパティが設定されます。適切な代替パターンを使用できない場合、空のストリングが使用され、パターンがサポートされていないことを示すように lastOperationStatus プロパティが設定されます。

次の表は有効なパターン文字とその意味を示しています。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

DateTimeFormatter のこのインスタンスの日付および時刻スタイルを設定します。日付および時刻スタイルは、日付および時刻フォーマット パターンをオペレーティングシステムによる事前定義のロケールに依存したパターンに設定するために使用されます。このメソッドにより、DateTimeFormatter() コンストラクターまたは setDateTimePattern() メソッドを使用して設定されたスタイルが置き換えられます。日付および時刻パターンは設定されたスタイルによっても更新されます。

このメソッドが呼び出されて正しく完了すると、lastOperationStatus プロパティが次のように設定されます。

• LastOperationStatus.NO_ERROR

それ以外の場合、lastOperationStatus プロパティは LastOperationStatus クラスで定義された定数のいずれかに設定されます。

パラメーター

関連する API エレメント

この例では、英語（米国）、フランス語（フランス）、スペイン語（スペイン）のロケールを使用しています。

この例では、リストの各ロケールに対して、次の処理を行います。

1. デフォルトのスタイル（長い dateStyle、長い timeStyle）を使用して DateTimeFormatter オブジェクトを作成します。
2. デフォルトの長い日付スタイルを使用して現在の日付と時刻をフォーマットします。
3. DateTimeStyle.NONE 定数および DateTimeStyle.SHORT 定数を使用して、時刻のみの短い日付スタイルに変更します。
4. 時刻のみの短い日付スタイルを使用して現在の日付と時刻をフォーマットします。

package {
    import flash.display.Sprite;
    import flash.globalization.DateTimeFormatter;
    import flash.globalization.DateTimeStyle;
    
    public class DateTimeFormatterExample extends Sprite
    {    
        private var localeList:Array = new Array("en-US", "fr-FR", "es-ES");
    
        public function DateTimeFormatterExample()
        {
            var date:Date = new Date();
            
            for each (var locale:String in localeList) {
                var dtf:DateTimeFormatter = new DateTimeFormatter(locale);
                trace('\n' + "LocaleID requested=" + dtf.requestedLocaleIDName 
                    + "; actual=" + dtf.actualLocaleIDName);
            
                var longDate:String = dtf.format(date);
                trace(longDate + " (" + dtf.getDateTimePattern() + ")");
            
                dtf.setDateTimeStyles(DateTimeStyle.NONE, DateTimeStyle.SHORT);
                var shortDate:String = dtf.format(date);
                trace(shortDate + " (" + dtf.getDateTimePattern() + ")");
            }        
        }
    }
}

この例では、リストの各ロケールに対して、次の処理を行います。

1. 入出力用のテキストフィールドを 3 つ作成します。
2. 英語（米国）ロケールを使用して DateTimeFormatter オブジェクトを作成します。
3. configureTextField() 関数を呼び出します。この関数はテキストフィールドの位置とサイズを設定し、patternField オブジェクトにイベントリスナーを追加します。
4. ユーザーが patternField テキストフィールドにパターンを入力すると、そのパターンを使用して textInputHandler 関数が現在の日付と時刻をフォーマットし、その結果と lastOperationStatus 値を出力テキストフィールドに表示します。

 
package {  
    import flash.display.Sprite;
    import flash.events.Event;
    import flash.globalization.DateTimeFormatter;
    import flash.text.*;
    
    public class DateTimePatternExample extends Sprite
    {    
        private var patternField:TextField = new TextField();
        private var resultField:TextField = new TextField();
        private var statusField:TextField = new TextField();
           private var date:Date = new Date();
         private var dtf:DateTimeFormatter = new DateTimeFormatter("en-US");           
         
        private function configureTextField():void
        {
            patternField.type = TextFieldType.INPUT;
            patternField.width = 300;
            patternField.height = 20;
            patternField.background = true;
            patternField.border = true;
            
            resultField.y = 40;
            resultField.width = 300;
            resultField.height = 20;
            
            statusField.y = 80;
            statusField.width = 300;
            statusField.height = 20;

            addChild(patternField);
            addChild(resultField);
            addChild(statusField);
            patternField.addEventListener(Event.CHANGE,textInputHandler);
        }

        private function textInputHandler(event:Event):void
        {                 
            dtf.setDateTimePattern(patternField.text);
            statusField.text = dtf.lastOperationStatus;
            resultField.text = dtf.format(date);
        }

        public function DateTimePatternExample()
        {
            configureTextField();    
        }
    }
}