Справочник по ActionScript® 3.0 для платформы Adobe® Flash®
Домашняя страница  |  Скрыть список пакетов и классов |  Пакеты  |  Классы  |  Что нового  |  Указатель  |  Приложения  |  Почему по-английски?
Фильтры: Получение данных с сервера...
Получение данных с сервера...
mx.formatters 

DateFormatter  - AS3 Flex

Пакетmx.formatters
Классpublic class DateFormatter
НаследованиеDateFormatter Inheritance Formatter Inheritance 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.

Синтаксис MXMLexpandedСкрыть синтаксис MXML

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



Общедоступные свойства
 СвойствоОпределено
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 Inheritederror : String
Описание, сохраняемое средством форматирования при появлении ошибки.
Formatter
  formatString : String
Образец маски.
DateFormatter
Защищенные свойства
 СвойствоОпределено
 InheritedresourceManager : IResourceManager
[только для чтения] Ссылка на объект, управляющий всеми локализованными ресурсами приложения.
Formatter
Общедоступные методы
 МетодОпределено
  
Конструктор.
DateFormatter
  
[переопределить] Генерирует отформатированную в качестве даты строку из отформатированной в качестве даты строки или из объекта Date.
DateFormatter
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
  
[статические] Преобразует отформатированную в качестве строки дату в объект Date.
DateFormatter
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.
Object
 Inherited
Возвращает строковое представление заданного объекта.
Object
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Защищенные методы
 МетодОпределено
 Inherited
Этот метод вызывается при создании класса Formatter и далее при каждой передаче события change для указания какого-либо изменения локализованных ресурсов.
Formatter
Сведения о свойстве

formatString

свойство
formatString:String

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Образец маски.

Строка образца составляется из букв в верхнем регистре, например: YYYY/MM.

Строка образца DateFormatter может помимо букв образца содержать и другой текст. Для создания допустимой строки образца требуется хотя бы одна буква образца.

В таблице представлены допустимые буквы образца:

Буква образцаОписание
Y Год. Если в образце используются две буквы, обозначение года сокращается до двух цифр; в противном случае год обозначается четырьмя цифрами. Год может обозначаться с добавлением нуля, как показано в третьем примере:
  • YY = 05
  • YYYY = 2005
  • YYYYY = 02005
M Месяц года. Формат зависит от критериев, перечисленных ниже.
  • Если в образце используется одна буква, формат интерпретируется как числовой, состоящий из одной или двух цифр.
  • Если в образце используются две буквы, формат интерпретируется как числовой, состоящий из двух цифр.
  • Если в образце используются три буквы, формат интерпретируется как краткий текстовый формат.
  • Если в образце используются четыре буквы, формат интерпретируется как полный текстовый формат.
Примеры:
  • M = 7
  • MM= 07
  • MMM=Jul
  • MMMM= July
DЧисло месяца. Несмотря на то что для обозначения числа месяца можно использовать одну букву образца, как правило, используется две буквы.

Примеры:

  • D=4
  • DD=04
  • DD=10
EДень недели. Формат зависит от критериев, перечисленных ниже.
  • Если в образце используется одна буква, формат интерпретируется как числовой, состоящий из одной или двух цифр.
  • Если в образце используются две буквы, формат интерпретируется как числовой, состоящий из двух цифр.
  • Если в образце используются три буквы, формат интерпретируется как краткий текстовый формат.
  • Если в образце используются четыре буквы, формат интерпретируется как полный текстовый формат.
Примеры:
  • E = 1
  • EE = 01
  • EEE = Mon
  • EEEE = Monday
A Индикатор am/pm (до и после полудня).
JЧас суток (0-23).
HЧас суток (1-24).
KЧас в формате am/pm (0-11).
LЧас в формате am/pm (1-12).
NМинута часа.

Примеры:

  • N = 3
  • NN = 03
SСекунда минуты.

Пример:

  • SS = 30
QМиллисекунда секунды

Пример:

  • QQ = 78
  • QQQ = 078
Другой текстВ строку образца можно добавить другой текст для дополнительного форматирования строки. Можно использовать пунктуацию, числа и все буквы в нижнем регистре. Необходимо избегать букв в верхнем регистре, поскольку они могут интерпретироваться как буквы образца.

Пример:

  • EEEE, MMM. D, YYYY at L:NN:QQQ A = Tuesday, Sept. 8, 2005 at 1:26:012 PM

Значением по умолчанию является "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

DateFormatterExample.mxml
<?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>




[ X ]Почему по-английски?
Содержимое Справочника ActionScript 3.0 отображается на английском языке

Не все части Справочника ActionScript 3.0 переводятся на все языки. Если какой-то текстовый элемент не переведен, он отображается на английском языке. Например, компонент ga.controls.HelpBox не переведен ни на один из языков. Это значит, что в русской версии справки компонент ga.controls.HelpBox будет отображаться на английском языке.