Package org.zkoss.calendar.api

Interface ZonedDateTimeFormatter

All Superinterfaces:

DateFormatter

All Known Implementing Classes:

SimpleDateFormatter

public interface ZonedDateTimeFormatter
extends DateFormatter

A date (ZonedDateTime) formatter is used to generate a customized date format in the calendar. Allow to return HTML characters.

Since:

3.0.0

Author:

leon

Method Summary

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

Method Detail

getCaptionByDayOfWeek

@Deprecated
default String getCaptionByDayOfWeek(Date date,
                                     Locale locale,
                                     TimeZone timezone)

Deprecated.

As of release 3.0.0

Returns the caption of the day of week.

Specified by:

getCaptionByDayOfWeek in interface DateFormatter

getCaptionByDayOfWeek

String getCaptionByDayOfWeek(ZonedDateTime date,
                             Locale locale)

Returns the caption of the day of week.

getCaptionByTimeOfDay

@Deprecated
default String getCaptionByTimeOfDay(Date date,
                                     Locale locale,
                                     TimeZone timezone)

Deprecated.

As of release 3.0.0

Returns the caption of the time of day.

Specified by:

getCaptionByTimeOfDay in interface DateFormatter

getCaptionByTimeOfDay

String getCaptionByTimeOfDay(ZonedDateTime date,
                             Locale locale)

Returns the caption of the time of day.

getCaptionByDate

@Deprecated
default String getCaptionByDate(Date date,
                                Locale locale,
                                TimeZone timezone)

Deprecated.

As of release 3.0.0

Returns the caption of the date.

Specified by:

getCaptionByDate in interface DateFormatter

getCaptionByDate

String getCaptionByDate(ZonedDateTime date,
                        Locale locale)

Returns the caption of the date.

getCaptionByDateOfMonth

@Deprecated
default String getCaptionByDateOfMonth(Date date,
                                       Locale locale,
                                       TimeZone timezone)

Deprecated.

As of release 3.0.0

Returns the caption of the date of month.

Specified by:

getCaptionByDateOfMonth in interface DateFormatter

getCaptionByDateOfMonth

String getCaptionByDateOfMonth(ZonedDateTime date,
                               Locale locale)

Returns the caption of the date of month.

getCaptionByPopup

@Deprecated
default String getCaptionByPopup(Date date,
                                 Locale locale,
                                 TimeZone timezone)

Deprecated.

As of release 3.0.0

Returns the caption of the popup title.

Specified by:

getCaptionByPopup in interface DateFormatter

getCaptionByPopup

String getCaptionByPopup(ZonedDateTime date,
                         Locale locale)

Returns the caption of the popup title.

getCaptionByWeekOfYear

@Deprecated
default String getCaptionByWeekOfYear(Date date,
                                      Locale locale,
                                      TimeZone timezone)

Deprecated.

As of release 3.0.0

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

Specified by:

getCaptionByWeekOfYear in interface DateFormatter

getCaptionByWeekOfYear

String getCaptionByWeekOfYear(ZonedDateTime date,
                              Locale locale)

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