DateTimeFormatter  - AS3

Nom de l’ID de paramètres régionaux actuel utilisé par cet objet DateTimeFormatter.

Il existe trois possibilités pour la valeur du nom, en fonction du système d’exploitation et de la valeur du paramètre requestedLocaleIDName transmis au constructeur Collator().

1. Si les paramètre régionaux requis n’étaient pas définis sur LocaleID.DEFAULT et que le système d’exploitation les prend en charge, le nom renvoyé est identique à la propriété requestedLocaleIDName.
2. Si LocaleID.DEFAULT a été utilisée comme valeur pour le paramètre requestedLocaleIDName transmis au constructeur, le nom des paramètres régionaux spécifié par le système d’exploitation de l’utilisateur est utilisé. La valeur LocaleID.DEFAULT préserve le paramètre personnalisé de l’utilisateur dans le système d’exploitation. La transmission d’une valeur explicite en tant que paramètre requestedLocaleIDName ne produit pas nécessairement le même résultat que l’utilisation de LocaleID.DEFAULT, même si le nom des deux identificateurs de paramètres régionaux est identique. Il est possible que l’utilisateur ait personnalisé les paramètres régionaux sur son ordinateur ; or, si vous demandez un identificateur de paramètres régionaux explicite au lieu d’utiliser LocaleID.DEFAULT, votre application ne récupérera pas ces paramètres personnalisés.
3. Si le système ne prend pas en charge le paramètre requestedLocaleIDName spécifié dans le constructeur, un nom d’ID de paramètres régionaux par défaut est fourni.

Eléments de l’API associés

Etat de dernière opération que cet objet DateTimeFormatter a effectuée. La propriété lastOperationStatus est définie chaque fois que le constructeur ou une méthode de cette classe est appelé(e), ou qu’une autre propriété est définie. Pour les valeurs disponibles, voir la description de chaque méthode.

Eléments de l’API associés

Nom de l’ID de paramètres régionaux requis ayant été transmis au constructeur de cet objet DateTimeFormatter.

Si la valeur LocaleID.DEFAULT a été utilisée, le nom renvoyé est "i-default". Les paramètres régionaux actuels peuvent différer des paramètres régionaux requis lorsque des paramètres régionaux par défaut sont appliqués. Il est possible de récupérer le nom du paramètre régional actuel à l’aide de la propriété actualLocaleIDName.

Eléments de l’API associés

Construit un nouvel objet DateTimeFormatter en vue de formater les dates et les heures conformément aux conventions des paramètres régionaux spécifiés, ainsi qu’aux styles de formatage de la date et de l’heure fournis. Les styles de date et d’heure sont utilisés pour définir les modèles de formatage de date et d’heure sur les modèles prédéfinis en fonction des paramètres régionaux à partir du système d’exploitation.

Ce constructeur détermine si le système d’exploitation actuel prend en charge le nom de l’identificateur de paramètres régionaux requis. Si ce n’est pas le cas, des paramètres régionaux de substitution sont utilisés. Il est possible de déterminer le nom de l’ID des paramètres régionaux de substitution via la propriété actualLocaleIDName.

Si une valeur de substitution est utilisée pour l’un des paramètres requestedLocaleIDName, dateStyle ou timeStyle, la propriété lastOperationStatus est définie pour indiquer le type de valeur de substitution.

Pour effectuer un formatage en fonction des préférences de l’utilisateur du système d’exploitation actuel, transmettez la valeur LocaleID.DEFAULT du paramètre requestedLocaleIDName au constructeur.

Lorsque le constructeur est appelé et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Lorsque le nom de l’identificateur de paramètres régionaux requis n’est pas disponible, la propriété lastOperationStatus est définie sur l’une des valeurs suivantes :

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Pour plus d’informations sur les avertissements répertoriés ci-dessus et d’autres valeurs possibles de la propriété lastOperationStatus, voir les descriptions de la classe LastOperationStatus.

Eléments de l’API associés

Formate une chaîne d’affichage pour un objet Date interprété comme étant en heure locale de l’utilisateur (utilisation des composants d’heure locale de l’objet Date, tels que date, day, fullYear, hours, minutes, month et seconds). Le formatage est effectué à l’aide des conventions de l’ID de paramètres régionaux et des styles de date et d’heure, ou à l’aide d’un modèle de date ou d’heure personnalisé, spécifiés pour cette occurrence de DateTimeFormatter.

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Paramètres

Eléments de l’API associés

Formate une chaîne d’affichage pour un objet Date interprété comme étant en heure UTC (utilisation des composants UTC de l’objet Date, tels que dateUTC, dayUTC, fullYearUTC, hoursUTC, minutesUTC, monthUTC et secondsUTC), conformément au modèle dateStyle, timeStyle ou dateTime. Le formatage est effectué à l’aide des conventions de l’ID de paramètres régionaux et des styles de date et d’heure, ou à l’aide d’un modèle de date ou d’heure personnalisé, spécifiés pour cette occurrence de DateTimeFormatter.

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Paramètres

Eléments de l’API associés

Répertorie tous les noms des ID de paramètres régionaux pris en charge par cette classe.

Si cette classe n’est pas prise en charge sur le système d’exploitation actuel, cette méthode renvoie une valeur nulle.

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Eléments de l’API associés

Obtient le style de date de cette occurrence de DateTimeFormatter. Le style de date permet d’extraire un modèle de formatage de date prédéfini du système d’exploitation. La valeur de style de date peut être définie par le constructeurDateTimeFormatter(), la méthode setDateTimeStyles() ou la méthode setDateTimePattern().

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Eléments de l’API associés

Renvoie la chaîne modèle utilisée par cet objet DateTimeFormatter pour formater la date et l’heure.

Ce modèle peut être défini de l’une des trois façons suivantes :

1. Via les paramètres dateStyle et timeStyle utilisés dans le constructeur
2. Via la méthode setDateTimeStyles()
3. Via la méthode setDateTimePattern().

Pour obtenir une description de la syntaxe du modèle, voir la méthode setDateTimePattern().

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Eléments de l’API associés

Renvoie un nombre entier correspondant au premier jour de la semaine pour les paramètres régionaux et le système calendaire spécifiés. La valeur 0 correspond à dimanche, 1 correspond à lundi et ainsi de suite, jusqu’à la valeur 6 qui correspond au samedi.

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Eléments de l’API associés

Extrait une liste de chaînes localisées contenant le nom des mois du système calendaire actuel. Le premier élément de la liste correspond au nom du premier mois de l’année.

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Paramètres

Eléments de l’API associés

Obtient le style d’heure de cette occurrence de DateTimeFormatter. Le style permet d’extraire un modèle de formatage d’heure prédéfini du système d’exploitation. La valeur de style d’heure peut être définie par le constructeurDateTimeFormatter(), la méthode setDateTimeStyles() ou la méthode setDateTimePattern().

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Eléments de l’API associés

Extrait une liste de chaînes localisées contenant le nom des jours de la semaine du système calendaire actuel. Le premier élément dans la liste représente le nom pour dimanche.

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Paramètres

Eléments de l’API associés

Définit la chaîne modèle utilisée par cet objet DateTimeFormatter pour formater la date et l’heure.

Le modèle utilisé pour formater les dates peut être définis de l’une des trois façons suivantes :

1. Via les paramètres dateStyle et timeStyle utilisés dans le constructeur
2. Via la méthode setDateTimeStyles()
3. Via la méthode setDateTimePattern().

Cette méthode a également pour effet de remplacer les styles de date et d’heure actuellement définis pour cet objet DateTimeFormatter par la valeur DateTimeStyle.CUSTOM.

Une chaîne de modèle définit la façon dont la date et l’heure sont formatées. Le modèle contient des séquences de lettres qui sont remplacées par les valeurs de date et d’heure dans la chaîne formatée. Par exemple, dans le modèle « yyyy/MM », les caractères « yyyy » sont remplacés par une année à quatre chiffres suivie du caractère « / », et les caractères « MM » sont remplacés par un mois à deux chiffres.

Il est possible de répéter plusieurs fois la plupart des lettres utilisées dans les modèles en vue d’obtenir différents résultats, comme décrit dans le tableau ci-dessous.

Si une séquence dépasse le nombre maximum de lettres pris en charge par un modèle, elle est à nouveau associée à la séquence la plus longue correspondant à la lettre de ce modèle. Par exemple :

• MMMMMM est remplacée par MMMM
• dddd est remplacée par dd
• EEEEEEE est remplacée par EEEE
• aa est remplacée par a
• hhh est remplacée par hh
• mmmm est remplacée par mm

En théorie, un modèle peut contenir jusqu’à 255 caractères. Toutefois, certaines plates-formes imposent une limite stricte. Si le modèle dépasse la limite de caractères, la propriété lastOperationStatus est définie sur la valeur LastOperationStatus.PATTERN_SYNTAX_ERROR.

Tous les systèmes d’exploitation ne prennent pas en charge tous les modèles. Si un modèle n’est pas pris en charge sur la plate-forme, un modèle de substitution est alors utilisé et la propriété lastOperationStatus est définie de façon à indiquer le recours à un modèle de substitution. S’il s’avère impossible de fournir un modèle de substitution valable, une chaîne vide est utilisée et la propriété lastOperationStatus est définie de façon à indiquer que le modèle n’est pas pris en charge.

Le tableau suivant décrit les lettres de modèle valides, ainsi que leur signification.

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Paramètres

Eléments de l’API associés

Définit les styles de date et d’heure pour cette occurrence de DateTimeFormatter. Les styles de date et d’heure permettent de définir les modèles de formatage de date et d’heure sur les modèles prédéfinis en fonction des paramètres régionaux à partir du système d’exploitation. Cette méthode remplace les styles définis à l’aide du constructeur DateTimeFormatter() ou à l’aide de la méthode setDateTimePattern(). Le modèle de date et d’heure est également mis à jour en fonction des styles définis.

Lorsque cette méthode est appelée et que l’appel aboutit, la propriété lastOperationStatus est définie sur :

• LastOperationStatus.NO_ERROR

Sinon, la propriété lastOperationStatus est définie sur l’une des constantes définies dans la classe LastOperationStatus.

Paramètres

Eléments de l’API associés

Cet exemple utilise les paramètres régionaux suivants : Anglais (Etats-Unis), Français (France), Espagnol (Espagne).

Cet exemple effectue les opérations suivantes pour chaque jeu de paramètres régionaux dans la liste :

1. Crée un objet DateTimeFormatter à l’aide d’un style par défaut (style de date long, style d’heure long).
2. Formate la date et l’heure actuelles à l’aide du style de date long par défaut.
3. Passe à un style de date court d’affichage de l’heure uniquement à l’aide des constantes DateTimeStyle.NONE et DateTimeStyle.SHORT.
4. Formate la date et l’heure actuelles à l’aide du style de date court d’affichage de l’heure uniquement.

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

Cet exemple effectue les opérations suivantes pour chaque jeu de paramètres régionaux dans la liste :

1. Crée trois champs de texte d’entrée et de sortie.
2. Crée un objet DateTimeFormatter à l’aide du jeu de paramètres régionaux Anglais (Etats-Unis).
3. Appelle la fonction configureTextField(), qui définit la position et la taille des champs de texte, et ajoute un écouteur d’événement à l’objet patternField.
4. Lorsque l’utilisateur saisit un modèle dans le champ de texte patternField, la fonction textInputHandler formate la date et l’heure actuelles à l’aide de ce modèle, puis affiche le résultat et la valeur lastOperationStatus dans les champs de texte de sortie.

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