Package | mx.formatters |
Classe | public class DateFormatter |
Héritage | DateFormatter Formatter Object |
Sous-classes | ExpiryDateFormat |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
A partir de Flex 4.5, Adobe vous recommande d’utiliser la classe spark.formatters.DateTimeFormatter comme alternative à cette classe. |
La classe DateFormatter utilise une chaîne de format pour renvoyer une chaîne de date et d’heure formatée à partir d’une chaîne d’entrée ou d’un objet Date. Vous pouvez créer facilement de nombreuses variantes, y compris dans des formats internationaux.
Si une erreur se produit, une chaîne vide est renvoyée et une chaîne décrivant l’erreur est enregistrée dans la propriété error
. La propriété error
peut prendre l’une des valeurs suivantes :
-
"Invalid value"
signifie qu’une valeur qui n’est pas un objet Date ou une chaîne reconnue représentant une date a été transmise à la méthodeformat()
(argument vide autorisé). -
"Invalid format"
signifie que la valeur de la propriétéformatString
est vide ("") ou que la propriétéformatString
contient moins d’une lettre de modèle.
La méthode parseDateString()
utilise la classe mx.formatters.DateBase pour définir les informations sur la chaîne localisée, nécessaires pour convertir en objet Date une date formatée en tant que chaîne.
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|Q" />
Eléments de l’API associés
Propriété | Défini par | ||
---|---|---|---|
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
error : String
Description enregistrée par la classe de formatage lorsqu’une erreur survient. | Formatter | ||
formatString : String
Modèle de masque. | DateFormatter |
Méthode | Défini par | ||
---|---|---|---|
Constructeur. | DateFormatter | ||
[override]
Génère une chaîne de date formatée à partir d’une chaîne de date formatée ou d’un objet Date. | DateFormatter | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
[statique]
Convertit une date formatée en tant que chaîne en objet Date. | DateFormatter | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Renvoie la valeur primitive de l’objet spécifié. | Object |
formatString | propriété |
formatString:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Modèle de masque.
Vous pouvez créer une chaîne de modèle en utilisant des lettres majuscules, par exemple : YYYY/MM.
Outre les lettres de modèle, la chaîne de modèle de la classe DateFormatter peut contenir du texte supplémentaire. Une seule lettre de modèle est nécessaire pour créer une chaîne de modèle valide.
Le tableau ci-dessous décrit les lettres de modèle valides :
Lettre de modèle | Description |
---|---|
Y | Année. Si le modèle contient deux lettres, l’année est tronquée à deux chiffres. Sinon, elle est présentée en utilisant quatre chiffres. Il est possible d’ajouter des zéros de remplissage à l’année, comme l’illustre le troisième exemple ci-dessous :
|
M | Mois de l’année. Le format dépend des critères suivants :
|
D | Jour du mois. Bien qu’une chaîne de modèle représentant le jour à l’aide d’une seule lettre soit valide, la chaîne de modèle comporte en général deux lettres.
Exemples :
|
E | Jour de la semaine. Le format dépend des critères suivants :
|
A | Indicateur am/pm. |
J | Heure du jour (0-23). |
H | Heure du jour (1-24). |
K | Heure au format am/pm (0-11). |
L | Heure au format am/pm (1-12). |
N | Minute.
Exemples :
|
S | Seconde.
Exemple :
|
Q | Milliseconde dans une seconde
Exemple :
|
Autre texte | Vous pouvez ajouter du texte à la chaîne de modèle pour personnaliser le formatage de la chaîne. Vous pouvez ainsi utiliser des signes de ponctuation, des nombres et des minuscules. Evitez d’utiliser des majuscules, car elles risquent d’être interprétées comme des lettres de modèle.
Exemple :
|
La valeur par défaut est "MM/DD/YYYY".
Implémentation
public function get formatString():String
public function set formatString(value:String):void
DateFormatter | () | Constructeur |
public function DateFormatter()
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Constructeur.
format | () | méthode |
override public function format(value:Object):String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Génère une chaîne de date formatée à partir d’une chaîne de date formatée ou d’un objet Date. La propriété formatString
détermine le format de la chaîne de sortie. Si la valeur value
ne peut pas être formatée, une chaîne vide est renvoyée et une description de l’erreur est écrite dans la propriété error
.
Paramètres
value:Object — Date à formater. Il peut s’agir d’un objet Date ou d’une chaîne de date formatée, par exemple « Mardi 22 avril 2004 ».
|
String — Chaîne formatée. Vide si une erreur se produit. Une description de la condition d’erreur est écrite dans la propriété error .
|
parseDateString | () | méthode |
public static function parseDateString(str:String):Date
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Convertit une date formatée en tant que chaîne en objet Date. Les noms des mois et des jours doivent correspondre aux noms de la classe mx.formatters.DateBase. La valeur hour de la chaîne doit être comprise entre 0 et 23 inclus. Les valeurs minutes et seconds doivent être comprises entre 0 et 59 inclus. L’exemple suivant utilise cette méthode pour créer un objet Date :
var myDate:Date = DateFormatter.parseDateString("2009-12-02 23:45:30");
Paramètres
str:String — Date formatée en tant que chaîne.
|
Date — Objet Date.
|
Eléments de l’API associés
<?xml version="1.0" encoding="utf-8"?> <!-- Simple example to demonstrate the DateFormatter. --> <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: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 = ""; } } ]]> </fx:Script> <fx:Declarations> <mx:DateFormatter id="dateFormatter" formatString="month: MM, day: DD, year: YYYY"/> <mx:DateValidator id="dateVal" source="{dob}" property="text" inputFormat="mm/dd/yyyy"/> </fx:Declarations> <s:Panel title="DateFormatter Example" width="75%" height="75%" horizontalCenter="0" verticalCenter="0"> <mx:Form left="10" right="10" top="10" bottom="10"> <mx:FormItem label="Enter date (mm/dd/yyyy):" width="100%"> <s:TextInput id="dob" text=""/> </mx:FormItem> <mx:FormItem label="Formatted date: " width="100%"> <s:TextInput id="formattedDate" text="" editable="false"/> </mx:FormItem> <mx:FormItem> <s:Button label="Validate and Format" click="Format();"/> </mx:FormItem> </mx:Form> </s:Panel> </s:Application>
Tue Jun 12 2018, 09:30 AM Z