org.zkoss.calendar

Class Calendars

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.calendar.Calendars

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Calendars
extends org.zkoss.zul.impl.XulElement

A complete calendar component to represent a calendar to support both molds, default and month, and multi-timezone. By default mold, it can change the days to show one day or a week (days equal to seven) on the calendar at the same time. In the month mold, seven days is always assumed.

The Calendars component allows only one single toolbar as its child component, and now it can only manipulate the calendar event by a model named CalendarModel. And there are three events, onEventCreate, onEventEdit, and onEventUpdate that can be listened to operate the calendar event triggering by user action, in addition to there are two events onDayClick and onWeekClick to be triggered when user clicks on the caption of the day number and the week number within the current year. Besides, the calendar can also support the read-only display by invoking setReadonly(boolean).

Author:

jumperchen,jimmy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Calendars()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDayEvent(CalendarEvent ce)
void	addTimeZone(String label, String timezone) Adds the time zone to the calendar.
void	addTimeZone(String label, TimeZone timezone) Adds the time zone to the calendar.
Object	clone()
Date	getBeginDate() Returns the beginning date, which is based on getCurrentDate() in the current view depended on which AbstractComponent.getMold() is using.
int	getBeginTime()
CalendarEvent	getCalendarEventById(String id)
String	getCalendarEventId(CalendarEvent ce)
Date	getCurrentDate() Returns the current date.
DateFormatter	getDateFormatter() Returns the date formatter.
int	getDays() Returns the days.
TimeZone	getDefaultTimeZone() Returns the current time zone of the calendar.
Date	getEndDate() Returns the end date, which is based on getCurrentDate() in the current view depended on which AbstractComponent.getMold() is using.
int	getEndTime()
List<CalendarEvent>	getEvent(Date beginDate) Returns the unmodifiable list including all the calendar events matching from the specified date in the same date.
protected String	getEventKey(CalendarEvent evt)
EventRender	getEventRender() Deprecated. As of release 2.0-RC Returns the event renderer used for CalendarEvent to draw its outline (i.e. HTML), like the DSP renderer of ZK component. Note: never null.
int	getFirstDayOfWeek() Gets what the first day of the week is; e.g., SUNDAY in the U.S., MONDAY in France.
CalendarModel	getModel() Returns the calendar model.
int	getTimeslots()
Map<TimeZone,String>	getTimeZones() Returns the unmodifiable map including all the timezone inside the calendar.
org.zkoss.zul.Toolbar	getToolbar()
int	getWeekOfMonth() Returns the number of the week of the month in the current date.
String	getZclass()
boolean	insertBefore(org.zkoss.zk.ui.Component newChild, org.zkoss.zk.ui.Component refChild)
boolean	isEscapeXML() Return whether the event content escape XML
boolean	isReadonly() Returns whether it is readonly.
boolean	isWeekOfYear() Returns whether enable to show the week number within the current year or not.
void	modifyDayEvent(CalendarEvent ce)
void	nextPage() 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.
void	onAddDayEventResponse()
void	onInitRender()
void	onModifyDayEventResponse()
void	onRemoveDayEventResponse()
void	previousPage() 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.
void	removeDayEvent(CalendarEvent ce)
boolean	removeTimeZone(TimeZone timezone) Removes the time zone from the calendar
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
protected void	reSendEventGroup()
void	service(org.zkoss.zk.au.AuRequest request, boolean everError)
void	setBeginTime(int beginTime)
void	setCurrentDate(Date curDate) Sets the current date.
void	setDateFormatter(DateFormatter dfmater) Sets the date formatter.
void	setDateFormatter(String clsnm) Sets the date formatter by a class name.
void	setDays(int days) Sets the days, that is, how many column should be displayed on the default mold.
void	setEndTime(int endTime)
void	setEscapeXML(boolean escapeXML) Sets whether the event content escape XML
void	setEventRender(EventRender render) Deprecated. As of release 2.0-RC Sets the event renderer.
void	setFirstDayOfWeek(int value) Sets what the first day of the week is; e.g., SUNDAY in the U.S., MONDAY in France.
void	setFirstDayOfWeek(String day) Sets what the first day of the week is.
void	setModel(CalendarModel model) Sets the calendar model.
void	setMold(String mold)
void	setReadonly(boolean readonly) Sets whether it is readonly.
void	setTimeslots(int timeslots)
void	setTimeZone(String timezone) Sets the time zone to the calendar, it is easily used for ZUL file.
void	setWeekOfYear(boolean weekOfYear) Sets whether enable to show the week number within the current year or not.

Methods inherited from class org.zkoss.zul.impl.XulElement

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Calendars

public Calendars()

Method Detail

setWeekOfYear

public void setWeekOfYear(boolean weekOfYear)

Sets whether enable to show the week number within the current year or not.

isWeekOfYear

public boolean isWeekOfYear()

Returns whether enable to show the week number within the current year or not.

Default: false

setReadonly

public void setReadonly(boolean readonly)

Sets whether it is readonly.

isReadonly

public boolean isReadonly()

Returns whether it is readonly.

Default: false.

setDateFormatter

public void setDateFormatter(DateFormatter dfmater)

Sets the date formatter. In fact, there are five places in the calendar must have different date display.

See Also:

DateFormatter

setDateFormatter

public void setDateFormatter(String clsnm)
                      throws ClassNotFoundException,
                             NoSuchMethodException,
                             IllegalAccessException,
                             InstantiationException,
                             InvocationTargetException

Sets the date formatter by a class name.

Throws:

ClassNotFoundException

NoSuchMethodException

IllegalAccessException

InstantiationException

InvocationTargetException

See Also:

DateFormatter, setDateFormatter(DateFormatter)

getDateFormatter

public DateFormatter getDateFormatter()

Returns the date formatter.

Note: never null.

setDays

public void setDays(int days)

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

public int getDays()

Returns the days.

Default: 7

setFirstDayOfWeek

public void setFirstDayOfWeek(int value)

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

public void setFirstDayOfWeek(String day)

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

getFirstDayOfWeek

public int getFirstDayOfWeek()

Gets what the first day of the week is; e.g., SUNDAY in the U.S., MONDAY in France.

Default: Calendar.SUNDAY

Returns:

the first day of the week.

See Also:

setFirstDayOfWeek(int), Calendar.getFirstDayOfWeek()

onAddDayEventResponse

public void onAddDayEventResponse()

onRemoveDayEventResponse

public void onRemoveDayEventResponse()

onModifyDayEventResponse

public void onModifyDayEventResponse()

addDayEvent

public void addDayEvent(CalendarEvent ce)

modifyDayEvent

public void modifyDayEvent(CalendarEvent ce)

removeDayEvent

public void removeDayEvent(CalendarEvent ce)

addTimeZone

public void addTimeZone(String label,
               TimeZone timezone)

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

public void addTimeZone(String label,
               String timezone)

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

public void setTimeZone(String timezone)

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

public boolean removeTimeZone(TimeZone timezone)

Removes the time zone from the calendar

getDefaultTimeZone

public TimeZone getDefaultTimeZone()

Returns the current time zone of the calendar.

getTimeZones

public Map<TimeZone,String> getTimeZones()

Returns the unmodifiable map including all the timezone inside the calendar.

getCalendarEventId

public String getCalendarEventId(CalendarEvent ce)

getCalendarEventById

public CalendarEvent getCalendarEventById(String id)

getEventKey

protected String getEventKey(CalendarEvent evt)

getEvent

public List<CalendarEvent> getEvent(Date beginDate)

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.

previousPage

public void previousPage()

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

public void nextPage()

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.

getBeginDate

public Date getBeginDate()

Returns the beginning date, which is based on getCurrentDate() in the current view depended on which AbstractComponent.getMold() is using.

getEndDate

public Date getEndDate()

Returns the end date, which is based on getCurrentDate() in the current view depended on which AbstractComponent.getMold() is using.

setCurrentDate

public void setCurrentDate(Date curDate)

Sets the current date.

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

getCurrentDate

public Date getCurrentDate()

Returns the current date.

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

setBeginTime

public void setBeginTime(int beginTime)

Since:

2.1.0 Sets the begin time.

Default: 0.

getBeginTime

public int getBeginTime()

Since:

2.1.0 Returns the begin time.

Default: 0.

setEndTime

public void setEndTime(int endTime)

Since:

2.1.0 Sets the end time.

Default: 24.

getEndTime

public int getEndTime()

Since:

2.1.0 Returns the end time.

Default: 24.

setTimeslots

public void setTimeslots(int timeslots)

Since:

2.1.0 Sets the time slot per hour.

Default: 2.

getTimeslots

public int getTimeslots()

Since:

2.1.0 Returns the time slot per hour.

Default: 2.

getWeekOfMonth

public int getWeekOfMonth()

Returns the number of the week of the month in the current date.

reSendEventGroup

protected void reSendEventGroup()

onInitRender

public void onInitRender()

getToolbar

public org.zkoss.zul.Toolbar getToolbar()

getModel

public CalendarModel getModel()

Returns the calendar model.

setModel

public void setModel(CalendarModel model)

Sets the calendar model.

setMold

public void setMold(String mold)

Specified by:

setMold in interface org.zkoss.zk.ui.Component

Overrides:

setMold in class org.zkoss.zk.ui.AbstractComponent

setEscapeXML

public void setEscapeXML(boolean escapeXML)

Sets whether the event content escape XML

Parameters:

escapeXML -

isEscapeXML

public boolean isEscapeXML()

Return whether the event content escape XML

Returns:

boolean

getZclass

public String getZclass()

Overrides:

getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

insertBefore

public boolean insertBefore(org.zkoss.zk.ui.Component newChild,
                   org.zkoss.zk.ui.Component refChild)

Specified by:

insertBefore in interface org.zkoss.zk.ui.Component

Overrides:

insertBefore in class org.zkoss.zk.ui.AbstractComponent

clone

public Object clone()

Specified by:

clone in interface org.zkoss.zk.ui.Component

Overrides:

clone in class org.zkoss.zul.impl.XulElement

service

public void service(org.zkoss.zk.au.AuRequest request,
           boolean everError)

Specified by:

service in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

service in class org.zkoss.zk.ui.HtmlBasedComponent

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class org.zkoss.zul.impl.XulElement

Throws:

IOException

getEventRender

public EventRender getEventRender()

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

Note: never null.

setEventRender

public void setEventRender(EventRender render)

Deprecated. As of release 2.0-RC Sets the event renderer.