Package org.zkoss.calendar.api

Interface DateFormatter

All Known Subinterfaces:

ZonedDateTimeFormatter

All Known Implementing Classes:

SimpleDateFormatter

public interface DateFormatter

A date formatter is used to display the different date format in the calendar.

Author:

jumperchen

See Also:

ZonedDateTimeFormatter

Method Summary

Modifier and Type	Method	Description
String	getCaptionByDate(Date date, Locale locale, TimeZone timezone)	Returns the caption of the date.
String	getCaptionByDateOfMonth(Date date, Locale locale, TimeZone timezone)	Returns the caption of the date of month.
String	getCaptionByDayOfWeek(Date date, Locale locale, TimeZone timezone)	Returns the caption of the day of week.
String	getCaptionByPopup(Date date, Locale locale, TimeZone timezone)	Returns the caption of the popup title.
String	getCaptionByTimeOfDay(Date date, Locale locale, TimeZone timezone)	Returns the caption of the time of day.
String	getCaptionByWeekOfYear(Date date, Locale locale, TimeZone timezone)	Returns the caption of the week number within the current year.

Method Detail

getCaptionByDayOfWeek

String getCaptionByDayOfWeek(Date date,
                             Locale locale,
                             TimeZone timezone)

Returns the caption of the day of week.

getCaptionByTimeOfDay

String getCaptionByTimeOfDay(Date date,
                             Locale locale,
                             TimeZone timezone)

Returns the caption of the time of day.

getCaptionByDate

String getCaptionByDate(Date date,
                        Locale locale,
                        TimeZone timezone)

Returns the caption of the date.

getCaptionByDateOfMonth

String getCaptionByDateOfMonth(Date date,
                               Locale locale,
                               TimeZone timezone)

Returns the caption of the date of month.

getCaptionByPopup

String getCaptionByPopup(Date date,
                         Locale locale,
                         TimeZone timezone)

Returns the caption of the popup title.

getCaptionByWeekOfYear

String getCaptionByWeekOfYear(Date date,
                              Locale locale,
                              TimeZone timezone)

Returns the caption of the week number within the current year.