DateCustomizer (ADF RichClient API Documentation)

Method Summary
`abstract String`	`format(Date date, String key, Locale locale, TimeZone tz)` The format method formats a date based on a key.
`String`	`formatRange(Date startDate, Date endDate, String key, Locale locale, TimeZone tz)` The format method formats a date range based on a key.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DateCustomizer

public DateCustomizer()

Method Detail

format

public abstract String format(Date date,
                              String key,
                              Locale locale,
                              TimeZone tz)

The format method formats a date based on a key.

The format method of a hypothetical subclass of DateFormatter might do the following with the date December 25, 2008:

key: "WEEK_IN_YEAR", return: "Week 52"
key: "DAY_OF_WEEK", return: "Thursday"
key: "HOLIDAY_NAME", return: "Christmas"

Parameters:: date - the date to format; key - the key that indicates what type of return value is expected.; locale - the current locale; tz - the current timezone
Returns:: the formatted string. Null is returned if the default string should be used. If an unknown key is passed in null is returned. An empty string is returned to clear the default string.

formatRange

public String formatRange(Date startDate,
                          Date endDate,
                          String key,
                          Locale locale,
                          TimeZone tz)

The format method formats a date range based on a key.

The format method of a hypothetical subclass of DateFormatter might do the following with the start date December 25, 2008 and end date January 1, 2009:

key: "WEEK_RANGE", return: "12-25-2008 to 1-1-2009"

Parameters:: startDate - the date to format; endDate - the date to format; key - the key that indicates what type of return value is expected.; locale - the current locale; tz - the current timezone
Returns:: the formatted string. Null is returned if the default string should be used. If an unknown key is passed in null is returned. An empty string is returned to clear the default string.