Package org.zkoss.calendar.api

Interface Calendars

  • public interface Calendars
    Deprecated.
    This interface defines the methods used for Calendars.
    Author:
    jumperchen

    • Method Detail

      • getDefaultTimeZone

        TimeZone getDefaultTimeZone()
        Deprecated.
        Returns the current time zone of the calendar.

      • getModel

        CalendarModel getModel()
        Deprecated.
        Returns the calendar model.

      • setModel

        void setModel​(CalendarModel model)
        Deprecated.
        Sets the calendar model.

      • addTimeZone

        void addTimeZone​(String label,
                 TimeZone timezone)
        Deprecated.
        Adds the time zone to the calendar.

        Note: the first added will be the default time zone of the calendar.

        Parameters:
        label - the description of the time zone.
        timezone - a time zone. (Cannot duplicate)

      • addTimeZone

        void addTimeZone​(String label,
                 String timezone)
        Deprecated.
        Adds the time zone to the calendar.

        Note: the first added will be the default time zone of the calendar.

        Parameters:
        label - the description of the time zone.
        timezone - a id of time zone. (Cannot duplicate)
        See Also:
        TimeZone.getTimeZone(String), addTimeZone(String, TimeZone)

      • setTimeZone

        void setTimeZone​(String timezone)
        Deprecated.
        Sets the time zone to the calendar, it is easily used for ZUL file. e.g. 
         <calendars timeZone="Taiwan=GMT+8, Sweden=GMT+1,">
        Parameters:
        timezone -

      • removeTimeZone

        boolean removeTimeZone​(TimeZone timezone)
        Deprecated.
        Removes the time zone from the calendar

      • getTimeZones

        Map<TimeZone,​String> getTimeZones()
        Deprecated.
        Returns the unmodifiable map including all the timezone inside the calendar.

      • getEvent

        List<CalendarItem> getEvent​(Date beginDate)
        Deprecated.
        Returns the unmodifiable list including all the calendar events matching from the specified date in the same date. e.g. "20090324" exclusive the time of the date "23:30".

        Note: never null.

      • getItemRender

        ItemRender getItemRender()
        Deprecated.
        As of release 2.0-RC Returns the item renderer used for CalendarItem to draw its outline (i.e. HTML), like the DSP renderer of ZK component.

        Note: never null.

      • setItemRender

        void setItemRender​(ItemRender render)
        Deprecated.
        As of release 2.0-RC Sets the item renderer.

      • setDateFormatter

        void setDateFormatter​(DateFormatter dfmater)
        Deprecated.
        Sets the date formatter. In fact, there are five places in the calendar must have different date display.
        See Also:
        DateFormatter

      • getDateFormatter

        DateFormatter getDateFormatter()
        Deprecated.
        Returns the date formatter.

        Note: never null.

      • getBeginDate

        Date getBeginDate()
        Deprecated.
        Returns the beginning date, which is based on getCurrentDate() in the current view depended on which mold is using.

      • getEndDate

        Date getEndDate()
        Deprecated.
        Returns the end date, which is based on getCurrentDate() in the current view depended on which mold is using.

      • getWeekOfMonth

        int getWeekOfMonth()
        Deprecated.
        Returns the number of the week of the month in the current date.

      • previousPage

        void previousPage()
        Deprecated.
        Navigates the current date to the previous page, that is, when the getDays() is seven with default mold, the previous page means the previous week. In the month mold, it means the previous month.

      • nextPage

        void nextPage()
        Deprecated.
        Navigates the current date to the next page, that is, when the getDays() is seven with default mold, the next page means the next week. In the month mold, it means the next month.

      • setCurrentDate

        void setCurrentDate​(Date curDate)
        Deprecated.
        Sets the current date.

        Default: today (depend on which timezone the calendar is using).

      • getCurrentDate

        Date getCurrentDate()
        Deprecated.
        Returns the current date.

        Default: today (depend on which timezone the calendar is using).

      • setDays

        void setDays​(int days)
        Deprecated.
        Sets the days, that is, how many column should be displayed on the default mold.

        Default: 7. (i.e. one week), in month view, the attribute will be ignored.

      • getDays

        int getDays()
        Deprecated.
        Returns the days.

        Default: 7. (i.e. one week) If the days is less than 1, 1 is assumed.

      • setFirstDayOfWeek

        void setFirstDayOfWeek​(int value)
        Deprecated.
        Sets what the first day of the week is; e.g., SUNDAY in the U.S., MONDAY in France.

        Default: Calendar.SUNDAY

        Note: it is only allowed when days with 7 in the default mold or using the month mold.

        Parameters:
        value - the given first day of the week.
        See Also:
        getFirstDayOfWeek(), Calendar.setFirstDayOfWeek(int)

      • setFirstDayOfWeek

        void setFirstDayOfWeek​(String day)
        Deprecated.
        Sets what the first day of the week is.

        Note: it is only allowed when days with 7 in the default mold or using the month mold.

        Parameters:
        day - SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY. Case insensitive

      • setWeekOfYear

        void setWeekOfYear​(boolean weekOfYear)
        Deprecated.
        Sets whether enable to show the week number within the current year or not.

      • isWeekOfYear

        boolean isWeekOfYear()
        Deprecated.
        Returns whether enable to show the week number within the current year or not.

        Default: false

      • isReadonly

        boolean isReadonly()
        Deprecated.
        Returns whether it is readonly.

        Default: false.

      • setReadonly

        void setReadonly​(boolean readonly)
        Deprecated.
        Sets whether it is readonly.