dojo.date.locale.format¶
| Status: | Draft |
|---|---|
| Version: | 1.0 |
| Project owner: | Adam Peller |
| Authors: | Seth Lytle, Adam Peller, Marcus Reimann |
| Available: | since V? |
Creates a string from a Date object using a known localized pattern.
Introduction¶
By default, this method formats both date and time from dateObject. Formatting patterns are chosen appropriate to the locale. Different formatting lengths may be chosen, with “full” used by default. Custom patterns may be used or registered with translations using the dojo.date.locale.addCustomFormats method. Formatting patterns are implemented using the syntax described at unicode.org
Usage¶
By simply passing a Javascript Date object to dojo.date.locale.format, Dojo will use the locale passed as djConfig.locale or the browser’s default to handle the formats, and you may choose from a variety of formats: short, medium, full, or long.
Various other options are available to format the date. You may choose to process only the date, only the time, or both, and you may decide to use your own custom datePattern or timePattern.
- dojo.date.locale.format(dateObject, options)
Parameter Type Description dateObject Date The date and/or time to be formatted. If a time only is formatted, the values in the year, month, and day fields are irrelevant. The opposite is true when formatting only dates. options dojo.date.locale.__FormatOptions Optional. An object with the following properties: Field Type Description am String override strings for am in times datePattern String override pattern with this string formatLength String choice of long, short, medium or full (plus any custom additions). Defaults to ‘short’ fullYear Boolean (format only) use 4 digit years whenever 2 digit years are called for locale String override the locale used to determine formatting rules pm String override strings for pm in times selector String choice of ‘time’,’date’ (default: date and time) strict Boolean (parse only) strict parsing, off by default timePattern String override pattern with this string The datePattern is composed of tokens and string literals
- string literals may be enclosed in single quotes, eg ‘which is’
- characters that aren’t a format token are rendered as is
- tokens consist of a character repeated one or more times
- the letter indicates the field type
- the number of repeats indicates the field width
- often, widths of 1 mean numeric, 2 or 3 mean abbreviated, and 4 mean full (yMEZG)
- other times, field widths are meant to be interpreted literally, eg qwdDh ...
- in some cases widths are ignored, eg a
Pattern Meaning Thu Mar 26 2009 13:37:43.777 (EST) Notes G era AD “ “ Anno Domini GGGG y year 2009 yyy qQ quarter 1 M month March MMMM w week of the year 12 d date 26 D day of the year 85 E day of the week Thursday EEEE “ “ Thu EEE a am/pm PM h hours by 0-11 1 H hours by 0-23 13 K hours by 1-12 k hours by 1-24 m minutes 37 s seconds 43 S milliseconds 777 SSS vz timezone EST Z timezone offset GMT-04:0 0 ZZZZ “ “ -0400 Z
Notes:
- Everything in this module assumes Gregorian calendars. Other calendars will be implemented in separate modules.
- the source mentions that a single quote can be added by supplying 2 of them, but this doesn’t appear to work
Examples¶
A simple example formatting a date in a number of ways¶
<script type="text/javascript">
dojo.require( "dojo.date.locale" );
function format(date,fmt) { return dojo.date.locale.format( date, {selector:"date", datePattern:fmt } ); };
var initDates = function() {
var date = new Date(2009,9,26,13,37,43,777);
var fmto = "EEEE, MMMM d yyyy GGG, h:m:s.SSS a z (ZZZZ)";
var fmt2 = "EEEE, MMMM d yyyy GGG, 'day' D, 'week' w, 'quarter' q, h:m:s.SSS a z 'ie hour' H -- ZZZZ";
var txt = dojo.query( ".date" )[0];
txt.innerHTML = format( date, fmto );
var fmts = {
explicit: fmto,
simple:"MMM d, yyyy",
abbreviated:"EEE, MMM d, yyyy G",
full:"MMMM d, 'in the year' yyyy GGGG",
time: "h:m:s.SSS a z",
ordinal: "'day' D, 'week' w, 'quarter' q 'of the year' yyyy",
literal: "'this is not really a date'",
"extra stuff": "MMM d, yyyy -- 39:45, ____+1"
};
var out = dojo.query( ".output" )[0];
for (var ii in fmts) {
var fmt = fmts[ii];
var res = format( date, fmt );
out.innerHTML += "<tr><td>" + ii + "</td><td>" + fmt + "</td><td>" + res + "</td></tr>";
}
}
dojo.addOnLoad( initDates );
</script>
<STYLE TYPE="text/css">
th,td { border:1px solid black; padding: .2em 1em; }
table { border-collapse:collapse }
</STYLE>
<h3>dojo.date.locale test</h3>
The following table shows the date: <div class="date"></div> formatted using dojo.date.locale.format
<table class="output" style="border:1px solid black; width: auto;">
<tr> <th>style</th> <th>format</th> <th>result</th> </tr>
</table>
Formatting dates and times using custom patterns¶
Render the current Date in several ways using format(). The inverse operation to take the String and return a Date object is parse().