org.zkoss.calendar.api

Interface CalendarEvent

All Known Implementing Classes:

SimpleCalendarEvent

public interface CalendarEvent

This interface defines the methods used for Calendars to render the event data.

Author:

jumperchen,jimmy

Method Summary

Methods

Modifier and Type	Method and Description
Date	getBeginDate() Returns the beginning date of the calendar event.
String	getContent() Returns the content of the calendar event.
String	getContentColor() Returns the color of the content in the calendar event.
Date	getEndDate() Returns the end date of the calendar event.
String	getHeaderColor() Returns the color of the header in the calendar event.
String	getTitle() Returns the title of the calendar event.
String	getZclass() Returns the zclass of the calendar event.
boolean	isLocked() Returns whether the calendar event is locked or not.

Method Detail

getBeginDate

Date getBeginDate()

Returns the beginning date of the calendar event.

Note: never null

getEndDate

Date getEndDate()

Returns the end date of the calendar event. (exclusive)

Note: never null

getTitle

String getTitle()

Returns the title of the calendar event.

Note: never null

getContent

String getContent()

Returns the content of the calendar event.

Note: never null

getHeaderColor

String getHeaderColor()

Returns the color of the header in the calendar event. Only allows the value being recognized by CSS.

Note: never null

getContentColor

String getContentColor()

Returns the color of the content in the calendar event. Only allows the value being recognized by CSS.

Note: never null

getZclass

String getZclass()

Returns the zclass of the calendar event.

Note: never null

isLocked

boolean isLocked()

Returns whether the calendar event is locked or not.