oracle.adf.view.rich.util

Class DateCustomizer

java.lang.Object

oracle.adf.view.rich.util.DateCustomizer

public abstract class DateCustomizer
extends Object

The DateCustomizer class allows customization of dates such as formatting dates to Strings.

Author:

The Oracle ADF Faces Team

Constructor Summary

Constructors

Constructor and Description
DateCustomizer()

Method Summary

Methods

Modifier and Type	Method and Description
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.
String	getInlineStyle(Date date, String key, Locale locale, TimeZone tz) getInlineStyle() returns inline CSS styles to be applied to a portion of the Calendar.

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.

getInlineStyle

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

getInlineStyle() returns inline CSS styles to be applied to a portion of the Calendar. The getInlineStyle method of a hypothetical subclass of DateFormatter might do the following with the date December 25 2013:

• key: "af|calendar::day-of-week-dayview", return: "background-color: red"

Parameters:

date - Date to format

key - Indicates the section of the calendar being styled. See the tagdoc for list of keys.

locale - Current locale

tz - Current timezone

Returns:

CSS which can be applied to the style attribute, for the section of the Calendar specified by key. Null is returned if the default string should be used.