Package org.zkoss.calendar.impl

Class AbstractCalendarItem<T>

java.lang.Object

org.zkoss.calendar.impl.AbstractCalendarItem<T>

All Implemented Interfaces:

CalendarItem

Direct Known Subclasses:

DefaultCalendarItem, SimpleCalendarItem

public abstract class AbstractCalendarItem<T>
extends Object
implements CalendarItem

A skeletal implementation for CalendarItem

Since:

3.0.0

Author:

leon

Field Summary

Fields

Modifier and Type	Field	Description
protected T	_begin
protected String	_content
protected String	_contentStyle
protected T	_end
protected String	_headerStyle
protected boolean	_locked
protected String	_sclass
protected String	_style
protected String	_title

Constructor Summary

Constructors

Constructor	Description
AbstractCalendarItem()	Unused constructor, used for serialization / deserialization
AbstractCalendarItem(String title, String content, String headerColor, String contentColor, boolean locked, T begin, T end)	Deprecated.
AbstractCalendarItem(String title, String content, String style, String contentStyle, String headerStyle, boolean locked, T begin, T end)
AbstractCalendarItem(String title, String content, String sclass, String style, String contentStyle, String headerStyle, boolean locked, T begin, T end)

Method Summary

Modifier and Type	Method	Description
protected abstract Instant	convertToInstant(T date)
Instant	getBegin()	Returns the beginning date of the calendar item in Instant.
String	getContent()	Returns the content of the calendar item.
String	getContentColor()	Deprecated.
String	getContentStyle()	Returns the CSS style applied to the content Node.
Instant	getEnd()	Returns the beginning date of the calendar item in Instant.
String	getHeaderColor()	Deprecated.
String	getHeaderStyle()	Returns the CSS style applied to the header node.
String	getSclass()	Returns the CSS class.
String	getStyle()	Returns the CSS style.
String	getTitle()	Returns the title of the calendar item.
String	getZclass()	Returns the zclass of the calendar item.
boolean	isLocked()	When it returns true, an end-user can't move the calendar item by mouse drag and drop in a browser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.zkoss.calendar.api.CalendarItem

getBeginDate, getEndDate

Field Detail

_title

protected String _title

_content

protected String _content

_sclass

protected String _sclass

_style

protected String _style

_contentStyle

protected String _contentStyle

_headerStyle

protected String _headerStyle

_locked

protected boolean _locked

_begin

protected T _begin

_end

protected T _end

Constructor Detail

AbstractCalendarItem

public AbstractCalendarItem()

Unused constructor, used for serialization / deserialization

AbstractCalendarItem

@Deprecated
public AbstractCalendarItem(String title,
                            String content,
                            String headerColor,
                            String contentColor,
                            boolean locked,
                            T begin,
                            T end)

Deprecated.

AbstractCalendarItem

public AbstractCalendarItem(String title,
                            String content,
                            String style,
                            String contentStyle,
                            String headerStyle,
                            boolean locked,
                            T begin,
                            T end)

AbstractCalendarItem

public AbstractCalendarItem(String title,
                            String content,
                            String sclass,
                            String style,
                            String contentStyle,
                            String headerStyle,
                            boolean locked,
                            T begin,
                            T end)

Method Detail

getBegin

public Instant getBegin()

Description copied from interface: CalendarItem

Returns the beginning date of the calendar item in Instant.

Specified by:

getBegin in interface CalendarItem

getEnd

public Instant getEnd()

Description copied from interface: CalendarItem

Returns the beginning date of the calendar item in Instant.

Specified by:

getEnd in interface CalendarItem

convertToInstant

protected abstract Instant convertToInstant(T date)

getTitle

public String getTitle()

Description copied from interface: CalendarItem

Returns the title of the calendar item.

Note: never null

Specified by:

getTitle in interface CalendarItem

getContent

public String getContent()

Description copied from interface: CalendarItem

Returns the content of the calendar item.

Note: never null

Specified by:

getContent in interface CalendarItem

getHeaderColor

@Deprecated
public String getHeaderColor()

Deprecated.

Description copied from interface: CalendarItem

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

Specified by:

getHeaderColor in interface CalendarItem

getContentColor

@Deprecated
public String getContentColor()

Deprecated.

Description copied from interface: CalendarItem

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

Specified by:

getContentColor in interface CalendarItem

getStyle

public String getStyle()

Description copied from interface: CalendarItem

Returns the CSS style.

Specified by:

getStyle in interface CalendarItem

getContentStyle

public String getContentStyle()

Description copied from interface: CalendarItem

Returns the CSS style applied to the content Node.

Specified by:

getContentStyle in interface CalendarItem

getHeaderStyle

public String getHeaderStyle()

Description copied from interface: CalendarItem

Returns the CSS style applied to the header node.

Specified by:

getHeaderStyle in interface CalendarItem

getZclass

public String getZclass()

Description copied from interface: CalendarItem

Returns the zclass of the calendar item.

Specified by:

getZclass in interface CalendarItem

getSclass

public String getSclass()

Description copied from interface: CalendarItem

Returns the CSS class.

The default styles of CalendarItem doesn't depend on the value of CalendarItem.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 of CalendarItem.getSclass(), unless you override it. To replace the default style completely, use zclass instead. Note: never null

Specified by:

getSclass in interface CalendarItem

See Also:

CalendarItem.getZclass()

isLocked

public boolean isLocked()

Description copied from interface: CalendarItem

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.

Specified by:

isLocked in interface CalendarItem