Пакет | mx.formatters |
Класс | public class DateFormatter |
Наследование | DateFormatter Formatter Object |
Подклассы | ExpiryDateFormat |
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Начиная с Flex 4.5, Adobe рекомендует вместо этого класса использовать класс spark.formatters.DateTimeFormatter. |
Класс DateFormatter использует строку формата для возврата отформатированной строки даты и времени из входной строки или объекта Date. Можно создать большое количество вариантов, в том числе международные форматы.
В случае ошибки возвращается пустая строка, а строка с описанием ошибки сохраняется в свойстве error
. Свойство error
может иметь одно из следующих значений:
-
Invalid value
означает, что методуformat()
передано значение, которое не является объектом Date или распознаваемым представлением строки даты. (Допускается пустой аргумент.) -
Invalid format
означает, что для свойстваformatString
установлено пустое значение («») либо в свойствеformatString
содержится менее одной буквы образца.
Метод parseDateString()
использует класс mx.formatters.DateBase для определения информации локализованной строки, необходимой для преобразования отформатированной в качестве строки даты в объект Date.
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" />
Связанные элементы API
Свойство | Определено | ||
---|---|---|---|
constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | ||
error : String
Описание, сохраняемое средством форматирования при появлении ошибки. | Formatter | ||
formatString : String
Образец маски. | DateFormatter |
Метод | Определено | ||
---|---|---|---|
Конструктор. | DateFormatter | ||
[переопределить]
Генерирует отформатированную в качестве даты строку из отформатированной в качестве даты строки или из объекта Date. | DateFormatter | ||
Показывает, определено ли заданное свойство для объекта. | Object | ||
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | ||
[статические]
Преобразует отформатированную в качестве строки дату в объект Date. | DateFormatter | ||
Показывает наличие заданного свойства и его перечисляемость. | Object | ||
Задает доступность динамического свойства для операций цикла. | Object | ||
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | ||
Возвращает строковое представление заданного объекта. | Object | ||
Возвращает элементарное значение заданного объекта. | Object |
formatString | свойство |
formatString:String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Образец маски.
Строка образца составляется из букв в верхнем регистре, например: YYYY/MM.
Строка образца DateFormatter может помимо букв образца содержать и другой текст. Для создания допустимой строки образца требуется хотя бы одна буква образца.
В таблице представлены допустимые буквы образца:
Буква образца | Описание |
---|---|
Y | Год. Если в образце используются две буквы, обозначение года сокращается до двух цифр; в противном случае год обозначается четырьмя цифрами. Год может обозначаться с добавлением нуля, как показано в третьем примере:
|
M | Месяц года. Формат зависит от критериев, перечисленных ниже.
|
D | Число месяца. Несмотря на то что для обозначения числа месяца можно использовать одну букву образца, как правило, используется две буквы.
Примеры:
|
E | День недели. Формат зависит от критериев, перечисленных ниже.
|
A | Индикатор am/pm (до и после полудня). |
J | Час суток (0-23). |
H | Час суток (1-24). |
K | Час в формате am/pm (0-11). |
L | Час в формате am/pm (1-12). |
N | Минута часа.
Примеры:
|
S | Секунда минуты.
Пример:
|
Q | Миллисекунда секунды
Пример:
|
Другой текст | В строку образца можно добавить другой текст для дополнительного форматирования строки. Можно использовать пунктуацию, числа и все буквы в нижнем регистре. Необходимо избегать букв в верхнем регистре, поскольку они могут интерпретироваться как буквы образца.
Пример:
|
Значением по умолчанию является "MM/DD/YYYY".
Реализация
public function get formatString():String
public function set formatString(value:String):void
DateFormatter | () | Конструктор |
public function DateFormatter()
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конструктор.
format | () | метод |
override public function format(value:Object):String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Генерирует отформатированную в качестве даты строку из отформатированной в качестве даты строки или из объекта Date. Формат выходной строки определяется свойством formatString
. Если отформатировать значение value
невозможно, возвращает пустую строку и записывает описание ошибки в свойство error
.
Параметры
value:Object — Дата для форматирования. Может быть объектом Date или отформатированной в виде даты строкой, например Thursday, April 22, 2004.
|
String — Отформатированная строка. В случае ошибки эта строка будет пустой. Описание состояния ошибки записывается в свойство error .
|
parseDateString | () | метод |
public static function parseDateString(str:String):Date
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Преобразует отформатированную в качестве строки дату в объект Date. Названия месяцев и дней недели должны соответствовать названиям в классе mx.formatters.DateBase. Значение часа в строке должно находиться между 0 и 23 включительно. Значение минут и секунд должно находиться между 0 и 59 включительно. Этот метод используется в следующем примере для создания объекта Date:
var myDate:Date = DateFormatter.parseDateString("2009-12-02 23:45:30");
Параметры
str:String — Дата, отформатированная в виде строки.
|
Date — Объект Date.
|
Связанные элементы API
<?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, 11:34 AM Z