| Package | spark.formatters |
| Class | public class DateTimeFormatter |
| Inheritance | DateTimeFormatter  GlobalizationBase AdvancedStyleClient EventDispatcher Object |
| Implements | IFormatter |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10.1, AIR 2.5 |
Date object.
This class is a wrapper class around the flash.globalization.DateTimeFormatter class. Therefore, the locale-specific formatting functionality and the month names, day names and the first day of the week are provided by the flash.globalization.DateTimeFormatter. However, this DateTimeFormatter class can be used in MXML declarations, uses the locale style for the requested Locale ID name, and has methods and properties that are bindable.
The flash.globalization.DateTimeFormatter class uses the underlying operating system for the formatting functionality and to supply the locale-specific data. On some operating systems, the flash.globalization classes are unsupported, on these systems, this wrapper class provides fallback functionality.
MXML Syntax
Show MXML Syntax
Hide MXML SyntaxThe <s:DateTimeFormatter> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:DateTimeFormatter
Properties
dateStyle="long"
dateTimePattern="EEEE, MMMM dd, yyyy h:mm:ss a"
errorText="null"
timeStyle="long"
useUTC="false"
/>
More examples
Error handling in a Spark formatter
Formatting dates with a Spark formatter
Localization
Formatting dates, numbers, and currencies
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| Method | Defined By | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
<?xml version="1.0" encoding="utf-8"?>
<!-- Sample program for spark.formatters.DateTimeFormatter -->
<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:Declarations>
<s:DateTimeFormatter id="dateTimeFormatter"/>
</fx:Declarations>
<fx:Script>
<![CDATA[
import mx.collections.ArrayCollection;
private static const dateTimeStyleMenuItems:ArrayCollection
= new ArrayCollection(["long", "medium", "short", "none"]);
]]>
</fx:Script>
<mx:Form>
<mx:FormItem label="Input Locale ID Name">
<mx:HBox>
<s:TextInput id="inputLocaleIDName"/>
<!-- Upon button click, sets the locale style on the document
UI component. The formatter will inherit this style. -->
<s:Button click="setStyle('locale', inputLocaleIDName.text);"
label="Apply"/>
</mx:HBox>
<mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/>
</mx:FormItem>
<mx:FormItem label="Date Style">
<s:DropDownList id="dateStyle" requireSelection="true"
change="dateTimeFormatter.dateStyle = dateTimeStyleMenuItems[dateStyle.selectedIndex]"
dataProvider="{dateTimeStyleMenuItems}"/>
</mx:FormItem>
<mx:FormItem label="Time Style">
<s:DropDownList id="timeStyle" requireSelection="true"
change="dateTimeFormatter.timeStyle = dateTimeStyleMenuItems[timeStyle.selectedIndex]"
dataProvider="{dateTimeStyleMenuItems}"/>
</mx:FormItem>
<mx:FormItem label="Input Date">
<mx:TextInput id="inputDate" text="{new Date().toString()}"/>
</mx:FormItem>
<mx:FormItem label="Actual Locale ID Name">
<mx:Text text="{dateTimeFormatter.actualLocaleIDName}"/>
</mx:FormItem>
<mx:FormItem label="Formatted Result">
<mx:Text id="uiFormattedDate"
text="{dateTimeFormatter.format(inputDate.text)}"/>
</mx:FormItem>
</mx:Form>
</s:Application>
Wed Nov 21 2018, 06:34 AM -08:00