Package com.googlecode.wicket.jquery.ui.calendar

Interface ICalendarListener

All Superinterfaces:

org.apache.wicket.util.io.IClusterable, Serializable

All Known Implementing Classes:

Calendar, CalendarAdapter

public interface ICalendarListener
extends org.apache.wicket.util.io.IClusterable

Event listener shared by the Calendar widget and the CalendarBehavior

Author:

Sebastien Briquet - sebfz1

Method Summary

Modifier and Type	Method	Description
CharSequence	getEventDropPrecondition()	Gets the javascript statement which will be executed before onEventDrop(AjaxRequestTarget, String, long, boolean) event is triggered A common use case is to call the revertFunc callback to cancel the event.
CharSequence	getEventResizePrecondition()	Gets the javascript statement which will be executed before onEventResize(AjaxRequestTarget, String, long) event is triggered A common use case is to call the revertFunc callback to cancel the event.
boolean	isDayClickEnabled()	Indicates whether a day can be clicked. If true, the onDayClick(AjaxRequestTarget, CalendarView, LocalDateTime, boolean) event will be triggered Note: true will enable the global 'editable' option to true.
boolean	isEventClickEnabled()	Indicates whether an event can be clicked. If true, the onEventClick(AjaxRequestTarget, CalendarView, String) event will be triggered Note: true will enable the global 'editable' option to true.
boolean	isEventDropEnabled()	Indicates whether the event can be dragged & dropped.
boolean	isEventResizeEnabled()	Indicates whether the event can be resized.
boolean	isObjectDropEnabled()	Indicates whether the onObjectDrop(AjaxRequestTarget, String, LocalDateTime, boolean) event will be triggered
boolean	isSelectable()	Indicates whether a cell can be selected. If true, the onSelect(AjaxRequestTarget, CalendarView, LocalDateTime, LocalDateTime, boolean) event will be triggered
boolean	isViewRenderEnabled()	Indicates whether the onViewRender(AjaxRequestTarget, CalendarView, LocalDate, LocalDate) event will be triggered
void	onDayClick(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, LocalDateTime date, boolean allDay)	Triggered when a calendar day is clicked isDayClickEnabled() should return true for this event to be triggered.
void	onEventClick(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, String eventId)	Triggered when an event is clicked. isEventClickEnabled() should return true for this event to be triggered.
void	onEventDrop(org.apache.wicket.ajax.AjaxRequestTarget target, String eventId, long delta, boolean allDay)	Triggered when an event is dropped (after being dragged). isEventDropEnabled() should return true for this event to be triggered.
void	onEventResize(org.apache.wicket.ajax.AjaxRequestTarget target, String eventId, long delta)	Triggered when an event is dropped (after being dragged). isEventResizeEnabled() should return true for this event to be triggered.
void	onObjectDrop(org.apache.wicket.ajax.AjaxRequestTarget target, String title, LocalDateTime date, boolean allDay)	Triggered when an event-object is dropped. isObjectDropEnabled() should return true for this event to be triggered.
void	onSelect(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, LocalDateTime start, LocalDateTime end, boolean allDay)	Triggered when an cell is selected. isSelectable() should return true for this event to be triggered.
void	onViewRender(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, LocalDate start, LocalDate end)	Triggered when the calendar loads and every time a different date-range is displayed. isViewRenderEnabled() should return true for this event to be triggered.

Method Detail

isSelectable

boolean isSelectable()

Indicates whether a cell can be selected.
If true, the onSelect(AjaxRequestTarget, CalendarView, LocalDateTime, LocalDateTime, boolean) event will be triggered

Returns:

false by default

isDayClickEnabled

boolean isDayClickEnabled()

Indicates whether a day can be clicked.
If true, the onDayClick(AjaxRequestTarget, CalendarView, LocalDateTime, boolean) event will be triggered
Note: true will enable the global 'editable' option to true.

Returns:

false by default

See Also:

CalendarEvent.setEditable(Boolean)

isEventClickEnabled

boolean isEventClickEnabled()

Indicates whether an event can be clicked.
If true, the onEventClick(AjaxRequestTarget, CalendarView, String) event will be triggered
Note: true will enable the global 'editable' option to true.

Returns:

false by default

See Also:

CalendarEvent.setEditable(Boolean)

isObjectDropEnabled

boolean isObjectDropEnabled()

Indicates whether the onObjectDrop(AjaxRequestTarget, String, LocalDateTime, boolean) event will be triggered

Returns:

false by default

isEventDropEnabled

boolean isEventDropEnabled()

Indicates whether the event can be dragged & dropped. If true, the onEventDrop(AjaxRequestTarget, String, long, boolean) event will be triggered

Returns:

false by default

isEventResizeEnabled

boolean isEventResizeEnabled()

Indicates whether the event can be resized. If true, the onEventResize(AjaxRequestTarget, String, long) event will be triggered

Returns:

false by default

isViewRenderEnabled

boolean isViewRenderEnabled()

Indicates whether the onViewRender(AjaxRequestTarget, CalendarView, LocalDate, LocalDate) event will be triggered

Returns:

false by default

getEventDropPrecondition

CharSequence getEventDropPrecondition()

Gets the javascript statement which will be executed before onEventDrop(AjaxRequestTarget, String, long, boolean) event is triggered
A common use case is to call the revertFunc callback to cancel the event.

Returns:

the javascript statement, empty string by default

See Also:

http://arshaw.com/fullcalendar/docs/event_ui/eventDrop/

getEventResizePrecondition

CharSequence getEventResizePrecondition()

Gets the javascript statement which will be executed before onEventResize(AjaxRequestTarget, String, long) event is triggered
A common use case is to call the revertFunc callback to cancel the event.

Returns:

the javascript statement, empty string by default

See Also:

http://arshaw.com/fullcalendar/docs/event_ui/eventResize/

onSelect

void onSelect(org.apache.wicket.ajax.AjaxRequestTarget target,
              CalendarView view,
              LocalDateTime start,
              LocalDateTime end,
              boolean allDay)

Triggered when an cell is selected.
isSelectable() should return true for this event to be triggered.

Parameters:

target - the AjaxRequestTarget

view - the current calendar view

start - the event start LocalDateTime

end - the event end LocalDateTime

allDay - the event all-day property

onDayClick

void onDayClick(org.apache.wicket.ajax.AjaxRequestTarget target,
                CalendarView view,
                LocalDateTime date,
                boolean allDay)

Triggered when a calendar day is clicked
isDayClickEnabled() should return true for this event to be triggered.

Parameters:

target - the AjaxRequestTarget

view - the current calendar view

date - the day

allDay - the event all-day property

onEventClick

void onEventClick(org.apache.wicket.ajax.AjaxRequestTarget target,
                  CalendarView view,
                  String eventId)

Triggered when an event is clicked.
isEventClickEnabled() should return true for this event to be triggered.

Parameters:

target - the AjaxRequestTarget

view - the current calendar view

eventId - the CalendarEvent id

onEventDrop

void onEventDrop(org.apache.wicket.ajax.AjaxRequestTarget target,
                 String eventId,
                 long delta,
                 boolean allDay)

Triggered when an event is dropped (after being dragged).
isEventDropEnabled() should return true for this event to be triggered.

Parameters:

target - the AjaxRequestTarget

eventId - the CalendarEvent id

delta - the delta (time) with the original event date

allDay - the event all-day property

onEventResize

void onEventResize(org.apache.wicket.ajax.AjaxRequestTarget target,
                   String eventId,
                   long delta)

Triggered when an event is dropped (after being dragged).
isEventResizeEnabled() should return true for this event to be triggered.

Parameters:

target - the AjaxRequestTarget

eventId - the CalendarEvent id

delta - the delta (time) with the original event date

onObjectDrop

void onObjectDrop(org.apache.wicket.ajax.AjaxRequestTarget target,
                  String title,
                  LocalDateTime date,
                  boolean allDay)

Triggered when an event-object is dropped.
isObjectDropEnabled() should return true for this event to be triggered.

Parameters:

target - the AjaxRequestTarget

title - the title

date - the day

allDay - the event all-day property

onViewRender

void onViewRender(org.apache.wicket.ajax.AjaxRequestTarget target,
                  CalendarView view,
                  LocalDate start,
                  LocalDate end)

Triggered when the calendar loads and every time a different date-range is displayed.
isViewRenderEnabled() should return true for this event to be triggered.

Parameters:

target - the AjaxRequestTarget

view - the current calendar view

start - the start LocalDate of the current view

end - the event end LocalDate of the current view