Package org.zkoss.calendar.api
Interface CalendarItem
-
- All Known Implementing Classes:
AbstractCalendarItem,DefaultCalendarItem,SimpleCalendarEvent,SimpleCalendarItem
public interface CalendarItemThis interface defines the methods used forCalendarsto render the event data.- Author:
- jumperchen,jimmy
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description InstantgetBegin()Returns the beginning date of the calendar item in Instant.default DategetBeginDate()Deprecated.since 3.0.0StringgetContent()Returns the content of the calendar item.StringgetContentColor()Deprecated.since 3.1.0StringgetContentStyle()Returns the CSS style applied to the content Node.InstantgetEnd()Returns the beginning date of the calendar item in Instant.default DategetEndDate()Deprecated.since 3.0.0StringgetHeaderColor()Deprecated.since 3.1.0StringgetHeaderStyle()Returns the CSS style applied to the header node.StringgetSclass()Returns the CSS class.StringgetStyle()Returns the CSS style.StringgetTitle()Returns the title of the calendar item.StringgetZclass()Returns the zclass of the calendar item.booleanisLocked()When it returns true, an end-user can't move the calendar item by mouse drag and drop in a browser.
-
-
-
Method Detail
-
getBeginDate
@Deprecated default Date getBeginDate()
Deprecated.since 3.0.0Returns the beginning date of the calendar item.
-
getBegin
Instant getBegin()
Returns the beginning date of the calendar item in Instant.- Since:
- 3.0.0
-
getEndDate
@Deprecated default Date getEndDate()
Deprecated.since 3.0.0Returns the end date of the calendar item. (exclusive)
-
getEnd
Instant getEnd()
Returns the beginning date of the calendar item in Instant.- Since:
- 3.0.0
-
getTitle
String getTitle()
Returns the title of the calendar item.Note: never null
-
getContent
String getContent()
Returns the content of the calendar item.Note: never null
-
getHeaderColor
@Deprecated String getHeaderColor()
Deprecated.since 3.1.0Returns the color of the header in the calendar item. Only allows the value being recognized by CSS.
-
getContentColor
@Deprecated String getContentColor()
Deprecated.since 3.1.0Returns the color of the content in the calendar item. Only allows the value being recognized by CSS.
-
getStyle
String getStyle()
Returns the CSS style.
-
getContentStyle
String getContentStyle()
Returns the CSS style applied to the content Node.- Since:
- 3.1.0
-
getHeaderStyle
String getHeaderStyle()
Returns the CSS style applied to the header node.- Since:
- 3.1.0
-
getZclass
String getZclass()
Returns the zclass of the calendar item.- Since:
- 3.1.0
-
getSclass
String getSclass()
Returns the CSS class.The default styles of CalendarItem doesn't depend on the value of
getSclass(). Rather, sclass is provided to perform small adjustment, e.g., only changing the font size. In other words, the default style is still applied if you change the value ofgetSclass(), unless you override it. To replace the default style completely, use zclass instead. Note: never null- Since:
- 3.1.0
- See Also:
getZclass()
-
isLocked
boolean isLocked()
When it returns true, an end-user can't move the calendar item by mouse drag and drop in a browser. Otherwise, an end-user can freely move the item.
-
-