| Package | mx.formatters |
| Class | public class DateFormatter |
| Inheritance | DateFormatter  Formatter Object |
If an error occurs, an empty String is returned and a String describing
the error is saved to the error property. The error
property can have one of the following values:
"Invalid value" means a value that is not a Date object or a
is not a recognized String representation of a date is
passed to the format() method. (An empty argument is allowed.)"Invalid format" means either the formatString
property is set to empty (""), or there is less than one pattern letter
in the formatString property.
Hide MXML Syntax
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:
Show MXML Syntax
<mx:DateFormatter
formatString="Y|M|D|A|E|H|J|K|L|N|S"
/>
See also
| Property | Defined by | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| error : String
Description saved by the formatter when an error occurs.
| Formatter | |
| formatString : String
The mask pattern.
| DateFormatter | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| DateFormatter | ||
|
Generates a date-formatted String from either a date-formatted String or a Date object.
| DateFormatter | ||
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Returns the string representation of the specified object.
| Object | |
|
Returns the primitive value of the specified object.
| Object | |
| Method | Defined by | ||
|---|---|---|---|
|
[static]
Converts a date that is formatted as a String into a Date object.
| DateFormatter | ||
| formatString | property |
public var formatString:StringThe mask pattern.
You compose a pattern String using specific uppercase letters, for example: YYYY/MM.
The DateFormatter pattern String can contain other text in addition to pattern letters. To form a valid pattern String, you only need one pattern letter.
The following table describes the valid pattern letters:
| Pattern letter | Description |
|---|---|
| Y | Year. If the number of pattern letters is two, the year is
truncated to two digits; otherwise, it appears as four digits.
The year can be zero-padded, as the third example shows in the
following set of examples:
|
| M | Month in year. The format depends on the following criteria:
|
| D | Day in month. While a single-letter pattern string for day is valid,
you typically use a two-letter pattern string.
Examples:
|
| E | Day in week. The format depends on the following criteria:
|
| A | am/pm indicator. |
| J | Hour in day (0-23). |
| H | Hour in day (1-24). |
| K | Hour in am/pm (0-11). |
| L | Hour in am/pm (1-12). |
| N | Minute in hour.
Examples:
|
| S | Second in minute.
Example:
|
| Other text | You can add other text into the pattern string to further
format the string. You can use punctuation, numbers,
and all lowercase letters. You should avoid uppercase letters
because they may be interpreted as pattern letters.
Example:
|
The default value is "MM/DD/YYYY".
| DateFormatter | () | constructor |
public function DateFormatter()Constructor.
| format | () | method |
public override function format(value:Object):String
Generates a date-formatted String from either a date-formatted String or a Date object.
The formatString property
determines the format of the output String.
If value cannot be formatted, return an empty String
and write a description of the error to the error property.
value:Object — Date to format. This can be a Date object,
or a date-formatted String such as "Thursday, April 22, 2004".
|
String —
Formatted String. Empty if an error occurs. A description
of the error condition is written to the error property.
|
| parseDateString | () | method |
protected static function parseDateString(str:String):DateConverts a date that is formatted as a String into a Date object. Month and day names must match the names in mx.formatters.DateBase.
Parametersstr:String — Date that is formatted as a String.
|
Date —
Date object.
|
See also
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the DateFormatter. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx: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= "";
}
}
]]>
</mx:Script>
<mx:DateFormatter id="dateFormatter" formatString="month: MM, day: DD, year: YYYY"/>
<mx:DateValidator id="dateVal" source="{dob}" property="text" inputFormat="mm/dd/yyyy"/>
<mx:Panel title="DateFormatter Example" width="95%" height="95%"
paddingTop="10" paddingLeft="5" paddingRight="5" paddingBottom="10">
<mx:Form width="100%">
<mx:FormItem label="Enter date (mm/dd/yyyy):" width="100%">
<mx:TextInput id="dob" text=""/>
</mx:FormItem>
<mx:FormItem label="Formatted date: " width="100%">
<mx:TextInput id="formattedDate" text="" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<mx:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</mx:Panel>
</mx:Application>