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 display the different date format in the calendar.

Since:

3.0.0

Author:

leon

Method Summary

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

Method Detail

getCaptionByDayOfWeek

@Deprecated
default java.lang.String getCaptionByDayOfWeek(java.util.Date date,
                                                           java.util.Locale locale,
                                                           java.util.TimeZone timezone)

Deprecated. As of release 3.0.0

Returns the caption of the day of week.

Specified by:

getCaptionByDayOfWeek in interface DateFormatter

getCaptionByDayOfWeek

java.lang.String getCaptionByDayOfWeek(java.time.ZonedDateTime date,
                                       java.util.Locale locale)

Returns the caption of the day of week.

getCaptionByTimeOfDay

@Deprecated
default java.lang.String getCaptionByTimeOfDay(java.util.Date date,
                                                           java.util.Locale locale,
                                                           java.util.TimeZone timezone)

Deprecated. As of release 3.0.0

Returns the caption of the time of day.

Specified by:

getCaptionByTimeOfDay in interface DateFormatter

getCaptionByTimeOfDay

java.lang.String getCaptionByTimeOfDay(java.time.ZonedDateTime date,
                                       java.util.Locale locale)

Returns the caption of the time of day.

getCaptionByDate

@Deprecated
default java.lang.String getCaptionByDate(java.util.Date date,
                                                      java.util.Locale locale,
                                                      java.util.TimeZone timezone)

Deprecated. As of release 3.0.0

Returns the caption of the date.

Specified by:

getCaptionByDate in interface DateFormatter

getCaptionByDate

java.lang.String getCaptionByDate(java.time.ZonedDateTime date,
                                  java.util.Locale locale)

Returns the caption of the date.

getCaptionByDateOfMonth

@Deprecated
default java.lang.String getCaptionByDateOfMonth(java.util.Date date,
                                                             java.util.Locale locale,
                                                             java.util.TimeZone timezone)

Deprecated. As of release 3.0.0

Returns the caption of the date of month.

Specified by:

getCaptionByDateOfMonth in interface DateFormatter

getCaptionByDateOfMonth

java.lang.String getCaptionByDateOfMonth(java.time.ZonedDateTime date,
                                         java.util.Locale locale)

Returns the caption of the date of month.

getCaptionByPopup

@Deprecated
default java.lang.String getCaptionByPopup(java.util.Date date,
                                                       java.util.Locale locale,
                                                       java.util.TimeZone timezone)

Deprecated. As of release 3.0.0

Returns the caption of the popup title.

Specified by:

getCaptionByPopup in interface DateFormatter

getCaptionByPopup

java.lang.String getCaptionByPopup(java.time.ZonedDateTime date,
                                   java.util.Locale locale)

Returns the caption of the popup title.

getCaptionByWeekOfYear

@Deprecated
default java.lang.String getCaptionByWeekOfYear(java.util.Date date,
                                                            java.util.Locale locale,
                                                            java.util.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

java.lang.String getCaptionByWeekOfYear(java.time.ZonedDateTime date,
                                        java.util.Locale locale)

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