| 包 | 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 类基于输入的 String 或 Date 对象使用格式 String 返回格式化的日期和时间 String。您可以轻松创建多种不同的格式，包括国际格式。
如果出现错误，则会返回一个空 String，以及一个说明已将该错误保存到 error 属性的 String。error 属性可以是下列值之一：
-
"Invalid value"表示传递给format()方法的值既不是 Date 对象，也不是可识别的日期字符串表示形式。（允许参数为空。） -
"Invalid format"表示formatString属性设置为空 ("")，或者formatString属性中的模式字母少于一个。
parseDateString() 方法使用 mx.formatters.DateBase 类定义本地化字符串信息，利用此信息可以将设置为 String 格式的日期转换为 Date 对象。
显示 MXML 语法
隐藏 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 元素
公共属性
| 属性 | 由以下参数定义 | ||
|---|---|---|---|
 | constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| error : String
发生错误时由 formatter 保存的说明。 | Formatter | |
| formatString : String
掩码模式。 | DateFormatter | ||
受保护的属性
公共方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
构造函数。 | DateFormatter | ||
[覆盖]
根据用于设置日期格式的 String 或 Date 对象生成日期格式化的 String。 | DateFormatter | ||
|
表示对象是否已经定义了指定的属性。 | Object | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
[静态]
将已设置为 String 格式的日期转换为 Date 对象。 | DateFormatter | ||
|
表示指定的属性是否存在、是否可枚举。 | Object | |
|
设置循环操作动态属性的可用性。 | Object | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
|
返回指定对象的字符串表示形式。 | Object | |
|
返回指定对象的原始值。 | Object | |
受保护的方法
属性详细信息
formatString | 属性 |
formatString:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
掩码模式。
使用特定的大写字母组成模式 String，如 YYYY/MM。
DateFormatter 模式 String 既可以包含模式字母，也可以包含其他文本。要形成有效的模式 String，只需要一个模式字母。
下表描述了有效的模式字母：
| 模式字母 | 说明 |
|---|---|
| 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 |
根据用于设置日期格式的 String 或 Date 对象生成日期格式化的 String。formatString 属性用于确定输出 String 的格式。如果无法设置 value 的格式，则会返回一个空 String，并将对错误的描述写入 error 属性。
参数
value:Object — 要格式化的日期。此值可以是 Date 对象，也可以是已设置日期格式的 String，如“Thursday, April 22, 2004”。
|
String — 格式化的 String。如果发生错误，则为空字符串。将有关错误条件的描述写入 error 属性。
|
parseDateString | () | 方法 |
public static function parseDateString(str:String):Date| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
将已设置为 String 格式的日期转换为 Date 对象。月份名称和日期名称必须符合 mx.formatters.DateBase 中的名称。String 的小时值必须介于 0 和 23（含）之间。分钟和秒的值必须介于 0 和 59（含）之间。以下示例使用此方法创建 Date 对象：
var myDate:Date = DateFormatter.parseDateString("2009-12-02 23:45:30");
参数
str:String — 已设置为 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>
Tue Jun 12 2018, 11:04 AM Z