DateTimeFormatter  - AS3

Nazwa bieżącego identyfikatora ustawień regionalnych używanych przez dany obiekt klasy DateTimeFormatter.

Istnieją trzy możliwości dla wartości nazwy — w zależności od systemu operacyjnego i wartości parametru requestedLocaleIDName przekazywanego do konstruktora Collator().

1. Jeśli zażądano innych ustawień narodowych niż LocaleID.DEFAULT, a system operacyjny zapewnia obsługę dla żądanych ustawień, wówczas zwrócona nazwa będzie taka sama, jak właściwość requestedLocaleIDName.
2. Jeśli wartością parametru requestedLocaleIDName przekazanego do konstruktora było LocaleID.DEFAULT, wówczas używana będzie nazwa bieżących ustawień narodowych określonych przez system operacyjny użytkownika. Wartość LocaleID.DEFAULT powoduje zachowanie niestandardowych ustawień użytkownika w systemie operacyjnym. Przekazanie wartości jawnej jako parametru requestedLocaleIDName nie spowoduje uzyskania takiego samego rezultatu, jak użycie LocaleID.DEFAULT, nawet jeśli obydwa identyfikatory ustawień narodowych są takie same. Możliwe, że użytkownik dostosował ustawienia narodowe na własnym komputerze, a żądanie jawnego identyfikatora ustawień narodowych — zamiast LocaleID.DEFAULT — sprawi, że aplikacja nie odczyta tych niestandardowych ustawień.
3. Jeśli system nie obsługuje parametru requestedLocaleIDName określonego w konstruktorze, wówczas zostanie udostępniony identyfikator alternatywnych ustawień narodowych.

Powiązane elementy interfejsu API

Status poprzedniej operacji wykonanej przez ten obiekt DateTimeFormatter. Właściwość lastOperationStatus zostanie ustawiona przy każdym wywołaniu konstruktora lub metody tej klasy, a także w przypadku ustawienia innej właściwości. Możliwe wartości przedstawiają opisy poszczególnych metod.

Powiązane elementy interfejsu API

Nazwa identyfikatora żądanych ustawień regionalnych, która została przekazana do konstruktora obiektu klasy DateTimeFormatter.

Jeśli użyto wartości LocaleID.DEFAULT, wówczas zwrócona zostanie nazwa „i-default”. W przypadku zastosowania awaryjnych ustawień narodowych rzeczywiste ustawienia mogą się różnić od żądanych ustawień narodowych. Nazwę rzeczywistych ustawień narodowych można uzyskać za pomocą właściwości actualLocaleIDName.

Powiązane elementy interfejsu API

Tworzy nowy obiekt DateTimeFormatter w celu sformatowania dat i godzin zgodnie z konwencjami określonych ustawień narodowych oraz zgodnie z określonymi stylami formatowania dat i godzin. Style daty i godziny są używane w celu ustawiania wzorców formatowania dat i godzin dla predefiniowanych wzorców zależnych od ustawień narodowych, z systemu operacyjnego.

Ten konstruktor określa, czy aktualny system operacyjny obsługuje żądane ustawienia narodowe identyfikowane przez identyfikator. Jeśli nie są obsługiwane, wówczas zostaną wykorzystane alternatywne ustawienia narodowe. Identyfikator alternatywnych ustawień narodowych można określić z właściwości actualLocaleIDName.

Jeśli dla dowolnego z parametrów requestedLocaleIDName, dateStyle lub timeStyle stosowane są rozwiązania alternatywne, wówczas właściwość lastOperationStatus zostanie ustawiona w celu wskazania typu rozwiązania alternatywnego.

W celu formatowania w oparciu o preferencje użytkownika dotyczące bieżącego systemu operacyjnego należy przekazać do konstruktora wartość LocaleID.DEFAULT w parametrze requestedLocaleIDName.

Jeśli po wywołaniu działanie konstruktora zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

Jeśli identyfikator żądanych ustawień narodowych nie jest dostępny, wówczas właściwość lastOperationStatus zostanie ustawiona na jedną z poniższych wartości:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Szczegółowe informacje na temat ostrzeżeń przedstawionych powyżej oraz na temat innych możliwych wartości właściwości lastOperationStatus zawierają opisy w klasie LastOperationStatus.

Powiązane elementy interfejsu API

Formatuje wyświetlany ciąg znaków dla obiektu Date, który jest interpretowany jako zgodny z lokalnym czasem użytkownika (przy wykorzystaniu składników czasu lokalnego obiektu Date, takich jak: date, day, fullYear, hours, minutes, month, i seconds). Formatowanie zostanie przeprowadzone przy wykorzystaniu konwencji identyfikatora ustawień narodowych, a także stylu daty i godziny, lub zgodnie z dostosowanym wzorcem daty i godziny określonym dla danej instancji klasy DateTimeFormatter.

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Parametry

Powiązane elementy interfejsu API

Formatuje wyświetlany ciąg znaków dla obiektu Date, który jest interpretowany jako należący do czasu UTC (przy wykorzystaniu składników UTC obiektu Date, takich jak: dateUTC, dayUTC, fullYearUTC, hoursUTC, minutesUTC, monthUTC i secondsUTC), zgodnie ze stylem dateStyle, timeStyle lub wzorcem daty i godziny. Formatowanie zostanie przeprowadzone przy wykorzystaniu konwencji identyfikatora ustawień narodowych, a także stylu daty i godziny, lub zgodnie z dostosowanym wzorcem daty i godziny określonym dla danej instancji klasy DateTimeFormatter.

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Parametry

Powiązane elementy interfejsu API

Wyświetla listę identyfikatorów ustawień narodowych obsługiwanych przez tę klasę.

Jeśli ta klasa nie jest obsługiwana w bieżącym systemie operacyjnym, wówczas ta metoda zwróci wartość null.

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Powiązane elementy interfejsu API

Pobiera styl daty dla tej instancji klasy DateTimeFormatter. Styl daty jest używany w celu pobrania predefiniowanego wzorca formatowania daty z systemu operacyjnego. Wartość stylu daty może zostać ustawiona przez konstruktor DateTimeFormatter(), metodę setDateTimeStyles() lub metodę setDateTimePattern().

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Powiązane elementy interfejsu API

Zwraca ciąg znaków wzorca używanego przez dany obiekt DateTimeFormatter w celu formatowania dat i godzin.

Ten wzorzec może zostać ustawiony na jeden z trzech sposobów

1. Przez parametry dateStyle i timeStyle używane w konstruktorze
2. Przez metodę setDateTimeStyles()
3. Przez metodę setDateTimePattern().

Opis składni wzorca przedstawiono w sekcji dotyczącej metody setDateTimePattern().

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Powiązane elementy interfejsu API

Zwraca liczbę całkowitą, która odpowiada pierwszemu dniu tygodnia dla danych ustawień narodowych i systemu kalendarza. Wartość 0 odpowiada niedzieli, 1 odpowiada poniedziałkowi itd., 6 odpowiada sobocie.

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Powiązane elementy interfejsu API

Pobiera listę zlokalizowanych ciągów znaków zawierających nazwy miesięcy dla bieżącego systemu kalendarza. Pierwszy element na liście to nazwa pierwszego miesiąca w roku.

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Parametry

Powiązane elementy interfejsu API

Pobiera styl godziny dla tej instancji klasy DateTimeFormatter. Styl godziny jest używany w celu pobrania predefiniowanego wzorca formatowania godziny z systemu operacyjnego. Wartość stylu godziny może zostać ustawiona przez konstruktor DateTimeFormatter(), metodę setDateTimeStyles() lub metodę setDateTimePattern().

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Powiązane elementy interfejsu API

Pobiera listę zlokalizowanych ciągów znaków zawierających nazwy dni tygodnia dla bieżącego systemu kalendarza. Pierwszy element na liście reprezentuje nazwę Niedziela.

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Parametry

Powiązane elementy interfejsu API

Ustawia ciąg wzorca używanego przez dany obiekt DateTimeFormatter w celu formatowania dat i godzin.

Wzorzec używany w celu formatowania dat może zostać ustawiony na jeden z trzech sposobów:

1. Przez parametry dateStyle i timeStyle używane w konstruktorze
2. Przez metodę setDateTimeStyles()
3. Przez metodę setDateTimePattern().

Efektem ubocznym stosowania tej metody jest zastąpienie bieżącego stylu daty i godziny dla tego obiektu klasy DateTimeFormatter i ustawienia dla stylów wartości DateTimeStyle.CUSTOM.

Ciąg znaków wzorca definiuje sposób formatowania daty i godziny. Wzorzec reprezentuje sekwencje liter, które zostaną zastąpione wartościami dat i godzin w sformatowanym ciągu znaków. Na przykład: we wzorcu „rrrr/MM” znaki „rrrr” zostaną zastąpione czterocyfrową wartością roku, po której pojawi się znak „/”, a znaki „MM” zostaną zastąpione dwucyfrowym oznaczeniem miesiąca.

Wiele liter używanych we wzorcu może być powtarzanych więcej niż jeden raz w celu uzyskania różnych wartości wyjściowych, zgodnie z opisem w tabeli poniżej.

Jeśli liczba znaków przekracza maksymalną liczbę liter obsługiwaną przez wzorzec, wówczas znaki zostaną ponownie odwzorowane na najdłuższą obsługiwaną sekwencję dla danego wzorca liter. Na przykład:

• MMMMMM zostanie zastąpione MMMM
• dddd zostanie zastąpione dd
• EEEEEEE zostanie zastąpione EEEE
• aa zostanie zastąpione a
• hhh zostanie zastąpione hh
• mmmm zostanie zastąpione mm

Teoretycznie wzorzec może zawierać maksymalnie 255 znaków, ale na niektórych platformach obowiązują bardziej restrykcyjne limity. Jeśli wzorzec przekracza limit liczy znaków, wówczas właściwość lastOperationStatus zostaje ustawiona na wartość LastOperationStatus.PATTERN_SYNTAX_ERROR.

Nie w każdym systemie operacyjnym obsługiwane są wszystkie możliwe wzorce. Jeśli wzorzec nie jest obsługiwany na danej platformie, wówczas zostanie wykorzystany wzorzec alternatywny, a właściwość lastOperationStatus zostanie ustawiona w taki sposób, aby wskazywała, że użyto wzorca alternatywnego. Jeśli nie jest dostępny żaden odpowiedni wzorzec alternatywny, wówczas zostanie użyty pusty ciąg znaków oraz ustawiona właściwość lastOperationStatus w celu wskazania, że wzorzec był nieobsługiwany.

W poniższej tabeli przedstawiono litery poprawnego wzorca oraz ich znaczenia.

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Parametry

Powiązane elementy interfejsu API

Ustawia style daty i godziny dla konkretnej instancji klasy DateTimeFormatter. Style daty i godziny są używane w celu ustawiania wzorców formatowania dat i godzin dla predefiniowanych wzorców zależnych od ustawień narodowych, z systemu operacyjnego. Ta metoda zastępuje style, które zostały ustawione za pomocą konstruktora DateTimeFormatter() lub za pomocą metody setDateTimePattern(). Wzorzec daty i godziny zostanie również zlokalizowany na podstawie ustawionych stylów.

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Parametry

Powiązane elementy interfejsu API

W tym przykładzie wykorzystano następujące ustawienia narodowe: angielskie (USA), francuskie (Francja), hiszpańskie (Hiszpania).

Dla każdych ustawień regionalnych na liście przykładowy kod wykonuje następujące czynności:

1. Tworzy obiekt DateTimeFormatter przy wykorzystaniu domyślnego stylu (long dateStyle, long timeStyle)
2. Formatuje bieżącą datę i godzinę za pomocą domyślnego stylu daty długiej.
3. Zmienia styl na styl daty krótkiej (wskazujący tylko godzinę) za pomocą stałych DateTimeStyle.NONE i DateTimeStyle.SHORT.
4. Formatuje bieżącą datę i godzinę za pomocą stylu daty krótkiej wskazującego tylko godzinę.

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() + ")");
            }        
        }
    }
}

Dla każdych ustawień regionalnych na liście przykładowy kod wykonuje następujące czynności:

1. Tworzy trzy wejściowe i wyjściowe pola tekstowe.
2. Tworzy obiekt DateTimeFormatter z użyciem angielskich (Stany Zjednoczone) ustawień narodowych.
3. Wywołuje funkcję configureTextField(), która ustawia pozycję i wielkość pól tekstowych, a następnie dodaje detektor zdarzeń do obiektu patternField.
4. Gdy użytkownik wprowadzi wzorzec do pola tekstowego patternField, funkcja textInputHandler sformatuje bieżącą datę i godzinę na podstawie wzorca i wyświetli w wyjściowych polach tekstowych wynik oraz wartość właściwości 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();    
        }
    }
}