The ZK Calendar Component"

From Documentation
m
m (replace tt with code (via JWB))
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{ZKCalendarEssentialsPageHeader}}
 
{{ZKCalendarEssentialsPageHeader}}
===The ZK Calendar Component===
+
 
 +
 
 
In this section, a brief overview is given on how developers work with the ZK Calendar component.
 
In this section, a brief overview is given on how developers work with the ZK Calendar component.
====The Bare Calendar Component====
+
=The Bare Calendar Component=
----
 
 
ZK Calendar is a single ZK component. Developers could declare it within any ZK container components, such as Window,  tabs, groupbox, etc.
 
ZK Calendar is a single ZK component. Developers could declare it within any ZK container components, such as Window,  tabs, groupbox, etc.
 
   
 
   
For example:<br>
+
For example:
 +
 
 
<source lang="xml">
 
<source lang="xml">
 
<window title="Bare ZK Calendar" border="normal">
 
<window title="Bare ZK Calendar" border="normal">
 +
<calendars />
 +
</window>
 +
</source>
 +
which renders:
  
<calendars/>
+
[[Image: bareCalendar.png]]
  
</window>
 
</source>
 
which renders:<br/>
 
[[Image: bareCalendar.png]]<br/>
 
 
The bare <calendars> declaration takes the following default values:
 
The bare <calendars> declaration takes the following default values:
 +
<source lang="xml">
 
<calendars firstDayOfWeek="Sunday" mold="default" >
 
<calendars firstDayOfWeek="Sunday" mold="default" >
 +
</source>
 +
 +
 +
= Component Attributes =
 +
 +
Developers can customize the calendars component by its attributes.
 +
 +
== firstDayOfWeek ==
 +
Determin the first day of week to be displayed on the calendar, by default: firstDayOfWeek="Sunday"
 +
 +
== mold ==
 +
Supported values:
 +
 +
* <code>default</code>: displays a "date-time" format in which it displays hours of the day and days of a week.
 +
* <code>monthly</code>: displays the days in a month.
 +
 +
== timeZone ==
 +
Set one or more time zones.
 +
 +
<source lang='xml'>
 +
<calendars timeZone="Finland=GMT+2, Taiwan=GMT+8"/>
 +
</source>
 +
 +
[[File:zkcal-timeZone.png | center]]
 +
 +
== width , height ==
 +
Set the size of the component, for example:
 +
<source lang='xml'>
 +
<calendars width="400px" height="600px"/>
 +
</source>
 +
 +
 +
== beginTime ==
 +
Sets the begining time of a day.
  
====Calendar Component Attributes====
+
<source lang='xml'>
----
+
<calendars beginTime="8"/>
Developers customize the calendars component by declaring its attributes, for example:
+
</source>
*the first day of week to be displayed on the calendar, by default: firstDayOfWeek="Sunday"
+
[[File:zkcal-beginTime.png | center]]
*the default mold (mold="default") displays a "date-time" format in which it displays hours of the day and days of a week ; the monthly mold (mold="monthly") displays the days in a month
 
*the time zone, for example: timeZone="Finland=GMT+2"
 
*size of the calendar component, for example: width="400px" height="600px"
 
  
  
====Triggered Calendar Events====
+
=Triggered Calendar Events=
----
 
 
The calendar component triggers three events when users select time slots on ZK Calendar:
 
The calendar component triggers three events when users select time slots on ZK Calendar:
 
*onEventCreate
 
*onEventCreate
 
*onEventEdit
 
*onEventEdit
 
*onEventUpdate
 
*onEventUpdate
Developers implement the corresponding event listeners to allow writing, editing, and updating (time updates) of calendar events (appointments) to data models. These methods pass the {{Hide in print|<javadoc>org.zkoss.calendar.event.CalendarsEvent</javadoc>}}{{Only in print|CalendarsEvent}} object to the event listeners and information such as begin date and end date of the selected time slot.  
+
Developers implement the corresponding event listeners to allow writing, editing, and updating (time updates) of calendar events (appointments) to data models. These methods pass the <javadoc>org.zkoss.calendar.event.CalendarsEvent</javadoc> object to the event listeners and information such as begin date and end date of the selected time slot.
 +
 
 +
 
 +
=Calendar Event Data Objects=
 +
 
 +
Developers implement the <javadoc directory="zkcal" type="interface">org.zkoss.calendar.api.CalendarEvent</javadoc> interface, or use the default implementation  <javadoc>org.zkoss.calendar.impl.SimpleCalendarEvent</javadoc> to set information just as begin date and end date to the event data object after retrieving such information from the <javadoc>org.zkoss.calendar.event.CalendarsEvent</javadoc>.
 +
 
  
====Calendar Event Data Objects====
+
= Calendar Event Date Model=
----
 
Developers implement the <javadoc type="interface">org.zkoss.calendar.api.CalendarEvent</javadoc> interface, or use the default implementation  <javadoc>org.zkoss.calendar.impl.SimpleCalendarEvent</javadoc> to set information just as begin date and end date to the event data object after retrieving such information from the <javadoc>org.zkoss.calendar.event.CalendarsEvent</javadoc>.
 
  
====Calendar Event Date Model====
 
----
 
 
Developers implement the <javadoc type="interface">org.zkoss.calendar.api.CalendarModel</javadoc> interface, or use the default implementation <javadoc>org.zkoss.calendar.impl.SimpleCalendarModel</javadoc> to store event data objects
 
Developers implement the <javadoc type="interface">org.zkoss.calendar.api.CalendarModel</javadoc> interface, or use the default implementation <javadoc>org.zkoss.calendar.impl.SimpleCalendarModel</javadoc> to store event data objects
  

Latest revision as of 09:05, 17 January 2022


The ZK Calendar Component




In this section, a brief overview is given on how developers work with the ZK Calendar component.

The Bare Calendar Component

ZK Calendar is a single ZK component. Developers could declare it within any ZK container components, such as Window, tabs, groupbox, etc.

For example:

<window title="Bare ZK Calendar" border="normal">
	<calendars />
</window>

which renders:

BareCalendar.png

The bare <calendars> declaration takes the following default values:

<calendars firstDayOfWeek="Sunday" mold="default" >


Component Attributes

Developers can customize the calendars component by its attributes.

firstDayOfWeek

Determin the first day of week to be displayed on the calendar, by default: firstDayOfWeek="Sunday"

mold

Supported values:

  • default: displays a "date-time" format in which it displays hours of the day and days of a week.
  • monthly: displays the days in a month.

timeZone

Set one or more time zones.

<calendars timeZone="Finland=GMT+2, Taiwan=GMT+8"/>
Zkcal-timeZone.png

width , height

Set the size of the component, for example:

<calendars width="400px" height="600px"/>


beginTime

Sets the begining time of a day.

<calendars beginTime="8"/>
Zkcal-beginTime.png


Triggered Calendar Events

The calendar component triggers three events when users select time slots on ZK Calendar:

  • onEventCreate
  • onEventEdit
  • onEventUpdate

Developers implement the corresponding event listeners to allow writing, editing, and updating (time updates) of calendar events (appointments) to data models. These methods pass the CalendarsEvent object to the event listeners and information such as begin date and end date of the selected time slot.


Calendar Event Data Objects

Developers implement the CalendarEvent interface, or use the default implementation SimpleCalendarEvent to set information just as begin date and end date to the event data object after retrieving such information from the CalendarsEvent.


Calendar Event Date Model

Developers implement the CalendarModel interface, or use the default implementation SimpleCalendarModel to store event data objects




The example project is at Github


Last Update : 2022/01/17

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.