Implementing Event Listeners"
m (replace tt with code (via JWB)) |
|||
| Line 15: | Line 15: | ||
{{notice| text=Event names change since version 3.0.0}} | {{notice| text=Event names change since version 3.0.0}} | ||
| − | == [https://www.zkoss.org/javadoc/latest/zkcal/org/zkoss/calendar/event/CalendarsEvent.html#ON_ITEM_CREATE < | + | == [https://www.zkoss.org/javadoc/latest/zkcal/org/zkoss/calendar/event/CalendarsEvent.html#ON_ITEM_CREATE <code>CalendarsEvent.ON_ITEM_CREATE</code>] == |
This event is triggered when a user clicks an empty cell in the time cell. | This event is triggered when a user clicks an empty cell in the time cell. | ||
[[File:onitemcreate.gif | center]] | [[File:onitemcreate.gif | center]] | ||
| − | Event name in 2.1: [https://www.zkoss.org/javadoc/zkcal/2.1.5/org/zkoss/calendar/event/CalendarsEvent.html#ON_EVENT_CREATE < | + | Event name in 2.1: [https://www.zkoss.org/javadoc/zkcal/2.1.5/org/zkoss/calendar/event/CalendarsEvent.html#ON_EVENT_CREATE <code>ON_EVENT_CREATE (onEventCreate)</code>] |
| − | == [https://www.zkoss.org/javadoc/latest/zkcal/org/zkoss/calendar/event/CalendarsEvent.html#ON_ITEM_EDIT < | + | == [https://www.zkoss.org/javadoc/latest/zkcal/org/zkoss/calendar/event/CalendarsEvent.html#ON_ITEM_EDIT <code>CalendarsEvent.ON_ITEM_EDIT</code>] == |
This event is triggered when a user clicks on an existing calendar item. | This event is triggered when a user clicks on an existing calendar item. | ||
[[File:onitemedit.gif | center]] | [[File:onitemedit.gif | center]] | ||
| − | Event name in 2.1: [https://www.zkoss.org/javadoc/zkcal/2.1.5/org/zkoss/calendar/event/CalendarsEvent.html#ON_EVENT_EDIT < | + | Event name in 2.1: [https://www.zkoss.org/javadoc/zkcal/2.1.5/org/zkoss/calendar/event/CalendarsEvent.html#ON_EVENT_EDIT <code>ON_EVENT_EDIT(onEventEdit)</code>] |
| − | ==[https://www.zkoss.org/javadoc/latest/zkcal/org/zkoss/calendar/event/CalendarsEvent.html#ON_ITEM_UPDATE < | + | ==[https://www.zkoss.org/javadoc/latest/zkcal/org/zkoss/calendar/event/CalendarsEvent.html#ON_ITEM_UPDATE <code>CalendarsEvent.ON_ITEM_UPDATE</code>] == |
This event is triggered when a user drags to change a calendar item's time span or drags to move the item to a different date. | This event is triggered when a user drags to change a calendar item's time span or drags to move the item to a different date. | ||
| Line 35: | Line 35: | ||
[[File:onitemupdate2.gif | center]] | [[File:onitemupdate2.gif | center]] | ||
| − | Event name in 2.1: [https://www.zkoss.org/javadoc/zkcal/2.1.5/org/zkoss/calendar/event/CalendarsEvent.html#ON_EVENT_UPDATE < | + | Event name in 2.1: [https://www.zkoss.org/javadoc/zkcal/2.1.5/org/zkoss/calendar/event/CalendarsEvent.html#ON_EVENT_UPDATE <code>ON_EVENT_UPDATE(onEventUpdate)</code>] |
= CalendarsEvent = | = CalendarsEvent = | ||
| Line 46: | Line 46: | ||
| − | Then you can call < | + | Then you can call <code>getBeginDate(), getEndDate(),</code>or <code>getCalendarItem()</code> to implement your application logic. Please refer to [http://www.zkoss.org/javadoc/latest/zkcal/org/zkoss/calendar/event/CalendarsEvent.html javadoc] for complete methods and their details. |
{{ZKCalendarEssentialsPageFooter}} | {{ZKCalendarEssentialsPageFooter}} | ||
Revision as of 09:05, 17 January 2022
Event Listener
ZK supports to add an event listener on zul or in Java, please refer to ZK Developer's Reference/Event Handling/Event Listening.
Supported Events
Since 3.0.0
The ZK Calendar will fire events below:
Notice: Event names change since version 3.0.0
CalendarsEvent.ON_ITEM_CREATE
This event is triggered when a user clicks an empty cell in the time cell.
Event name in 2.1: ON_EVENT_CREATE (onEventCreate)
CalendarsEvent.ON_ITEM_EDIT
This event is triggered when a user clicks on an existing calendar item.
Event name in 2.1: ON_EVENT_EDIT(onEventEdit)
CalendarsEvent.ON_ITEM_UPDATE
This event is triggered when a user drags to change a calendar item's time span or drags to move the item to a different date.
Event name in 2.1: ON_EVENT_UPDATE(onEventUpdate)
CalendarsEvent
ZK will call your event listener method with an CalendarsEvent as a parameter when one of the supported events is triggered. So you should declare your method signature like:
@Listen(CalendarsEvent.ON_ITEM_CREATE + " = #calendars")
public void showCreationBox(CalendarsEvent event) {...}
Then you can call getBeginDate(), getEndDate(),or getCalendarItem() to implement your application logic. Please refer to javadoc for complete methods and their details.
The example project is at Github