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:

IJQueryWidget, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IClusterable, 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>

public class Calendar
extends JQueryContainer

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

IJQueryWidget.JQueryWidget

Field Summary

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

widgetBehavior

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Calendar(String id, CalendarModel model)
Constructor

Calendar(String id, CalendarModel model, Options options)
Constructor

Calendar(String id, Options options)
Constructor

Method Summary

void	addFeed(CharSequence gcal) Adds a Google Calendar Feed
void	addFeed(CharSequence gcal, String className) Adds a Google Calendar Feed
CalendarModel	getModel() Gets the calendar's model
boolean	isEditable() Indicates whether the event can be edited (ie, clicked). IIF true, an event can override this global setting to false by using CalendarEvent#setEditable(boolean); If true, the onEventClick(AjaxRequestTarget, CalendarView, int) event and onDayClick(AjaxRequestTarget, CalendarView, Date) event will be triggered
boolean	isEventDropEnabled() Indicates whether the event can be dragged & dropped.
boolean	isEventResizeEnabled() Indicates whether the event can be resized.
boolean	isSelectable() Indicated whether a cell can be selected. If true, the onSelect(AjaxRequestTarget, CalendarView, Date, Date, boolean) event will be triggered
JQueryBehavior	newWidgetBehavior(String selector) see IJQueryWidget.newWidgetBehavior(String)
protected void	onConfigure(JQueryBehavior behavior) Called immediately after the onConfigure method in a behavior.
void	onDayClick(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, Date date) Triggered when a calendar day is clicked
void	onEventClick(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, int eventId) Triggered when an event is clicked. isEditable() 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). 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). isEventResizeEnabled() should return true for this event to be triggered.
protected void	onInitialize()
void	onSelect(org.apache.wicket.ajax.AjaxRequestTarget target, CalendarView view, Date start, Date end, boolean allDay) Triggered when an cell is selected. isSelectable() should return true for this event to be triggered.
void	refresh(org.apache.wicket.ajax.AjaxRequestTarget target) Refreshes the events currently available in the selected view.

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

getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, 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, getFeedbackMessage, 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, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

Calendar

public Calendar(String id,
                Options options)

Constructor

Parameters:

id - the markup id

options - 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,
                Options options)

Constructor

Parameters:

id - the markup id

model - the CalendarModel

options - 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

addFeed

public void addFeed(CharSequence gcal)

Adds a Google Calendar Feed

Parameters:

gcal - url to xml feed

addFeed

public void addFeed(CharSequence gcal,
                    String className)

Adds a Google Calendar Feed

Parameters:

gcal - url to xml feed

className - css class to be used

refresh

public void refresh(org.apache.wicket.ajax.AjaxRequestTarget target)

Refreshes the events currently available in the selected view.

Parameters:

target - the AjaxRequestTarget

isEditable

public boolean isEditable()

Indicates whether the event can be edited (ie, clicked).
IIF true, an event can override this global setting to false by using CalendarEvent#setEditable(boolean);
If true, the onEventClick(AjaxRequestTarget, CalendarView, int) event and onDayClick(AjaxRequestTarget, CalendarView, Date) event will be triggered

Returns:

false by default

isSelectable

public boolean isSelectable()

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

Returns:

false by default

isEventDropEnabled

public boolean isEventDropEnabled()

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

Returns:

false by default

isEventResizeEnabled

public boolean isEventResizeEnabled()

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

Returns:

false by default

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class JQueryContainer

onConfigure

protected void onConfigure(JQueryBehavior behavior)

Called immediately after the onConfigure method in a behavior. Since this is before the rendering cycle has begun, the behavior can modify the configuration of the component (i.e. Options)

Parameters:

behavior - the JQueryBehavior

onSelect

public void onSelect(org.apache.wicket.ajax.AjaxRequestTarget target,
                     CalendarView view,
                     Date start,
                     Date 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 Date

end - the event end Date

allDay - the event all-day property

onDayClick

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

Triggered when a calendar day is clicked

Parameters:

target - the AjaxRequestTarget

view - the current calendar view

date - the day

onEventClick

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

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

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)

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

public void onEventResize(org.apache.wicket.ajax.AjaxRequestTarget target,
                          int 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

newWidgetBehavior

public JQueryBehavior newWidgetBehavior(String selector)

see IJQueryWidget.newWidgetBehavior(String)

Specified by:

newWidgetBehavior in interface IJQueryWidget