fever.data.formatter.DateFormatter - Fever & FvAsWing ActionScript 2 Frameworks

Description

DateFormatter class uses a pattern formated String to render date and time from a Date object.

If no pattern is defined, use pattern "DD/MM/YYYY" by default.

Pattern can be defined with many terms, pre-defined are :

D : Day in month (1 to 31)
DD : Day in month (01 to 31)
E : Short day name (use Localisation API
EE : Full day name (use Localisation API
M : Month of year (1 to 12)
MM : Month of year (01 ti 12)
MMM : Short month name (use Localisation API
MMMM : Full month name (use Localisation API
YY : Year with 2 ends digits
YYYY : Year with 4 digits
H : Hour in day (0 to 23)
HH : Hour in day (00 to 23)
L : Hour in day (0 to 11)
LL : Hour in day (00 to 11)
A : 'AM' or 'PM' marker
N : Minutes in hour (0 to 59)
NN : Minutes in hour (00 to 59)
S : Seconds in minute (0 to 59)
SS : Seconds in minutes (00 to 59)

You can add or override pattern parsing method using addType method.

Example

   var f : DateFormatter = new DateFormatter();
   f.formatString = "EE DD MMMM YYYY - HH:NN:SS";
   var s : String = f.format( new Date() );

Constructor Detail

DateFormatter

public function DateFormatter()

Constructor.

Field Detail

formatString

public formatString:String

Formating pattern.

Usually, formatting pattern is auto defined using Localisation loaded.
If you set the pattern using this setter, formatter no longer listen to localisation change.

Call connectToLocalisation() method to reconnect formatter to localisation API.

Method Detail

addType

public function addType(type:String, scope, f:Function):Void

Defines custom formatting method for specific token.

Parameters

`type`	Token to search for
`scope`	Context of `f` method
`f`	Formatting method

removeType

public function removeType(type:String):Void

Removes type to formatter

format

public function format(value:Date):String

Formats and returns passed-in value.

Return

Formatted String

Overrides

format() in fever.data.formatter.Formatter

onLocalisationUpdate

public function onLocalisationUpdate(event:LocalisationEvent):Void

Triggered when Localisation language change.

Specified By

onLocalisationUpdate() in fever.app.local.LocalisationListener

connectToLocalisation

public function connectToLocalisation():Void

Adds current formatter as Localisation listener.
Thus formatting pattern is autoupdate with current used lang.

Class fever.data.formatter.DateFormatter

Implemented Interfaces