Class Index | File Index

Classes


Built-In Namespace Date

Method Summary
Method Attributes Method Name and Description
 
Converts a date to a string according to specs in fmt
 
setISO8601(string, offset)
Converts a string in ISO 8601 format to a date object.
 
toISO8601String(format, offset)
Convert date to an ISO 8601 formatted string.
Method Detail
formatDate(fmt)
Converts a date to a string according to specs in fmt
Defined in: <ricoCommon.js>.
Parameters:
fmt
string specifying the output format, may be one of the following:
locale or localeDateTime
use javascript's built-in toLocaleString() function
localeDate
use javascript's built-in toLocaleDateString() function
translate or translateDateTime
use the date and time format specified in the RicoTranslate object
translateDate
use the date format specified in the RicoTranslate object
Otherwise
Any combination of: yyyy, yy, mmmm, mmm, mm, m, hh, h, HH, H, nn, ss, a/p
Returns:
formatted string

setISO8601(string, offset)
Converts a string in ISO 8601 format to a date object.
Defined in: <ricoCommon.js>.
Parameters:
string
value to be converted
offset
can be used to bias the conversion and must be in minutes if provided
Returns:
true if string is a valid date or date-time.
See:
Based on delete.me.uk article

toISO8601String(format, offset)
Convert date to an ISO 8601 formatted string.
Defined in: <ricoCommon.js>.
Parameters:
format
an integer in the range 1-6 (default is 6):
1 (year)
YYYY (eg 1997)
2 (year and month)
YYYY-MM (eg 1997-07)
3 (complete date)
YYYY-MM-DD (eg 1997-07-16)
4 (complete date plus hours and minutes)
YYYY-MM-DDThh:mmTZD (eg 1997-07-16T19:20+01:00)
5 (complete date plus hours, minutes and seconds)
YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)
6 (complete date plus hours, minutes, seconds and a decimal fraction of a second)
YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45+01:00)
offset
See:
Based on: codeproject.com article

Documentation generated by JsDoc Toolkit 2.1.0 on Fri Mar 27 2009 23:48:21 GMT-0500 (CDT)