com.googlecode.wicket.jquery.ui.calendar

Class Calendar

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.googlecode.wicket.jquery.core.JQueryContainer

com.googlecode.wicket.jquery.ui.calendar.Calendar

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.IJQueryWidget, ICalendarListener, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class Calendar
extends com.googlecode.wicket.jquery.core.JQueryContainer
implements ICalendarListener

Provides calendar widget, based on the jQuery fullcalendar plugin.

Author:

Sebastien Briquet - sebfz1, Martin Grigorov - martin-g

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

com.googlecode.wicket.jquery.core.IJQueryWidget.JQueryWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected com.googlecode.wicket.jquery.core.Options	options

Fields inherited from class com.googlecode.wicket.jquery.core.JQueryContainer

widgetBehavior

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
Calendar(String id, CalendarModel model) Constructor
Calendar(String id, CalendarModel model, com.googlecode.wicket.jquery.core.Options options) Constructor
Calendar(String id, com.googlecode.wicket.jquery.core.Options options) Constructor

Method Summary

Modifier and Type	Method and Description
void	addSource(EventSource source) Adds a EventSource, can be a EventSource.GoogleCalendar
CharSequence	getEventDropPrecondition() Gets the javascript statement which will be executed before ICalendarListener.onEventDrop(AjaxRequestTarget, int, 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 ICalendarListener.onEventResize(AjaxRequestTarget, int, long) event is triggered A common use case is to call the revertFunc callback to cancel the event.
CalendarModel	getModel() Gets the calendar's model
boolean	isDayClickEnabled() Indicates whether a day can be clicked. If true, the ICalendarListener.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 ICalendarListener.onEventClick(AjaxRequestTarget, CalendarView, int) 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 ICalendarListener.onObjectDrop(AjaxRequestTarget, String, LocalDateTime, boolean) event will be triggered
boolean	isSelectable() Indicates whether a cell can be selected. If true, the ICalendarListener.onSelect(AjaxRequestTarget, CalendarView, LocalDateTime, LocalDateTime, boolean) event will be triggered
boolean	isViewRenderEnabled() Indicates whether the ICalendarListener.onViewRender(AjaxRequestTarget, CalendarView, LocalDateTime, LocalDateTime) event will be triggered
protected CalendarModelBehavior	newCalendarModelBehavior(CalendarModel model) Gets a new CalendarModelBehavior
com.googlecode.wicket.jquery.core.JQueryBehavior	newWidgetBehavior(String selector) see IJQueryWidget.newWidgetBehavior(String)
void	onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
void	onDayClick(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, LocalDateTime date, boolean allDay) Triggered when a calendar day is clicked ICalendarListener.isDayClickEnabled() should return true for this event to be triggered.
void	onEventClick(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, int eventId) Triggered when an event is clicked. ICalendarListener.isEventClickEnabled() should return true for this event to be triggered.
void	onEventDrop(org.apache.wicket.ajax.AjaxRequestTarget target, int eventId, long delta, boolean allDay) Triggered when an event is dropped (after being dragged). ICalendarListener.isEventDropEnabled() should return true for this event to be triggered.
void	onEventResize(org.apache.wicket.ajax.AjaxRequestTarget target, int eventId, long delta) Triggered when an event is dropped (after being dragged). ICalendarListener.isEventResizeEnabled() should return true for this event to be triggered.
protected void	onInitialize()
void	onObjectDrop(org.apache.wicket.ajax.AjaxRequestTarget target, String title, LocalDateTime date, boolean allDay) Triggered when an event-object is dropped. ICalendarListener.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. ICalendarListener.isSelectable() should return true for this event to be triggered.
void	onViewRender(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, LocalDateTime start, LocalDateTime end) Triggered when the calendar loads and every time a different date-range is displayed. ICalendarListener.isViewRenderEnabled() should return true for this event to be triggered.
void	refresh(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler) Re-fetches and refreshes the events currently available in the selected view.

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryContainer

onBeforeRender

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onDetach, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

options

protected final com.googlecode.wicket.jquery.core.Options options

Constructor Detail

Calendar

public Calendar(String id,
                com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

options - the Options. Note that 'selectable' and 'selectHelper' options are set by overriding isSelectable() (default is false)

Calendar

public Calendar(String id,
                CalendarModel model)

Constructor

Parameters:

id - the markup id

model - the CalendarModel

Calendar

public Calendar(String id,
                CalendarModel model,
                com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

model - the CalendarModel

options - the Options. Note that 'selectable' and 'selectHelper' options are set by overriding isSelectable() (default is false)

Method Detail

getModel

public CalendarModel getModel()

Gets the calendar's model

Returns:

a CalendarModel

addSource

public void addSource(EventSource source)

Adds a EventSource, can be a EventSource.GoogleCalendar

Parameters:

source - the EventSource,

refresh

public void refresh(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)

Re-fetches and refreshes the events currently available in the selected view.

Parameters:

handler - the IPartialPageRequestHandler

isSelectable

public boolean isSelectable()

Description copied from interface: ICalendarListener

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

Specified by:

isSelectable in interface ICalendarListener

Returns:

false by default

isDayClickEnabled

public boolean isDayClickEnabled()

Description copied from interface: ICalendarListener

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

Specified by:

isDayClickEnabled in interface ICalendarListener

Returns:

false by default

See Also:

CalendarEvent.setEditable(Boolean)

isEventClickEnabled

public boolean isEventClickEnabled()

Description copied from interface: ICalendarListener

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

Specified by:

isEventClickEnabled in interface ICalendarListener

Returns:

false by default

See Also:

CalendarEvent.setEditable(Boolean)

isEventDropEnabled

public boolean isEventDropEnabled()

Description copied from interface: ICalendarListener

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

Specified by:

isEventDropEnabled in interface ICalendarListener

Returns:

false by default

isEventResizeEnabled

public boolean isEventResizeEnabled()

Description copied from interface: ICalendarListener

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

Specified by:

isEventResizeEnabled in interface ICalendarListener

Returns:

false by default

isObjectDropEnabled

public boolean isObjectDropEnabled()

Description copied from interface: ICalendarListener

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

Specified by:

isObjectDropEnabled in interface ICalendarListener

Returns:

false by default

isViewRenderEnabled

public boolean isViewRenderEnabled()

Description copied from interface: ICalendarListener

Indicates whether the ICalendarListener.onViewRender(AjaxRequestTarget, CalendarView, LocalDateTime, LocalDateTime) event will be triggered

Specified by:

isViewRenderEnabled in interface ICalendarListener

Returns:

false by default

getEventDropPrecondition

public CharSequence getEventDropPrecondition()

Description copied from interface: ICalendarListener

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

Specified by:

getEventDropPrecondition in interface ICalendarListener

Returns:

the javascript statement, empty string by default

See Also:

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

getEventResizePrecondition

public CharSequence getEventResizePrecondition()

Description copied from interface: ICalendarListener

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

Specified by:

getEventResizePrecondition in interface ICalendarListener

Returns:

the javascript statement, empty string by default

See Also:

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

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class com.googlecode.wicket.jquery.core.JQueryContainer

onConfigure

public void onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)

Specified by:

onConfigure in interface com.googlecode.wicket.jquery.core.IJQueryWidget

Overrides:

onConfigure in class com.googlecode.wicket.jquery.core.JQueryContainer

onSelect

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

Description copied from interface: ICalendarListener

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

Specified by:

onSelect in interface ICalendarListener

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

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

Description copied from interface: ICalendarListener

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

Specified by:

onDayClick in interface ICalendarListener

Parameters:

target - the AjaxRequestTarget

view - the current calendar view

date - the day

allDay - the event all-day property

onEventClick

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

Description copied from interface: ICalendarListener

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

Specified by:

onEventClick in interface ICalendarListener

Parameters:

target - the AjaxRequestTarget

view - the current calendar view

eventId - the CalendarEvent id

onEventDrop

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

Description copied from interface: ICalendarListener

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

Specified by:

onEventDrop in interface ICalendarListener

Parameters:

target - the AjaxRequestTarget

eventId - the CalendarEvent id

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

allDay - the event all-day property

onEventResize

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

Description copied from interface: ICalendarListener

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

Specified by:

onEventResize in interface ICalendarListener

Parameters:

target - the AjaxRequestTarget

eventId - the CalendarEvent id

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

onObjectDrop

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

Description copied from interface: ICalendarListener

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

Specified by:

onObjectDrop in interface ICalendarListener

Parameters:

target - the AjaxRequestTarget

title - the title

date - the day

allDay - the event all-day property

onViewRender

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

Description copied from interface: ICalendarListener

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

Specified by:

onViewRender in interface ICalendarListener

Parameters:

target - the AjaxRequestTarget

view - the current calendar view

start - the start LocalDateTime of the current view

end - the event end LocalDateTime of the current view

newWidgetBehavior

public com.googlecode.wicket.jquery.core.JQueryBehavior newWidgetBehavior(String selector)

see IJQueryWidget.newWidgetBehavior(String)

Specified by:

newWidgetBehavior in interface com.googlecode.wicket.jquery.core.IJQueryWidget

newCalendarModelBehavior

protected CalendarModelBehavior newCalendarModelBehavior(CalendarModel model)

Gets a new CalendarModelBehavior

Parameters:

model - the CalendarModel

Returns:

the CalendarModelBehavior