com.googlecode.wicket.kendo.ui.scheduler

Class Scheduler

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.kendo.ui.scheduler.Scheduler

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.IJQueryWidget, ISchedulerListener, 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 Scheduler
extends com.googlecode.wicket.jquery.core.JQueryContainer
implements ISchedulerListener

Provides the Kendo UI Scheduler

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Scheduler.GroupOrientation Provides an enum of available group orientation

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
Scheduler(String id) Constructor
Scheduler(String id, com.googlecode.wicket.jquery.core.Options options) Constructor
Scheduler(String id, SchedulerModel model) Constructor
Scheduler(String id, SchedulerModel model, com.googlecode.wicket.jquery.core.Options options) Main constructor
Scheduler(String id, SchedulerModel model, ResourceList resourceList) Constructor
Scheduler(String id, SchedulerModel model, ResourceListModel resourceListModel) Constructor
Scheduler(String id, SchedulerModel model, ResourceListModel resourceListModel, com.googlecode.wicket.jquery.core.Options options) Constructor
Scheduler(String id, SchedulerModel model, ResourceList resourceList, com.googlecode.wicket.jquery.core.Options options) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(ResourceList resourceList) Adds a ResourceList to the internal ResourceListModel
protected SchedulerEvent	eventOf(org.apache.wicket.ajax.json.JSONObject object) Utility method that converts a JSONObject event to a SchedulerEvent
protected CharSequence	getCallbackUrl() Gets the SchedulerModelBehavior callback url
protected ISchedulerConverter	getConverter() Gets the ISchedulerConverter
String	getEditTemplateToken() Gets the edit-template script token/id
String	getEventTemplateToken() Gets the event-template script token/id
protected Scheduler.GroupOrientation	getGroupOrientation() Gets the orientation of the group headers
SchedulerModel	getModel() Gets the sheduler's model
ResourceListModel	getResourceListModel() Gets the sheduler's ResourceListModel
boolean	isEditEnabled() Indicates whether a edit-event is enabled. If true, the ISchedulerListener.onEdit(AjaxRequestTarget, JSONObject, SchedulerViewType) event will be triggered by clicking an event or a free event slot.
protected boolean	isGroupedByDate() Indicates whether the resources are grouped by date.
protected ISchedulerConverter	newConverter() Gets a new ISchedulerConverter
protected com.googlecode.wicket.jquery.core.template.IJQueryTemplate	newEditTemplate() Gets a new IJQueryTemplate to customize the built-in edit window
protected com.googlecode.wicket.jquery.core.template.IJQueryTemplate	newEventTemplate() Gets a new IJQueryTemplate to customize the event rendering
protected SchedulerModelBehavior	newSchedulerModelBehavior(SchedulerModel model, ISchedulerConverter converter) Gets a new SchedulerModelBehavior
com.googlecode.wicket.jquery.core.JQueryBehavior	newWidgetBehavior(String selector) see IJQueryWidget.newWidgetBehavior(String)
void	onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
protected void	onConfigure(SchedulerDataSource dataSource) Configure the SchedulerDataSource with additional options
void	onCreate(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.ajax.json.JSONObject object) Triggered when an event is created through the Scheduler's dialog
void	onCreate(org.apache.wicket.ajax.AjaxRequestTarget target, SchedulerEvent event) Triggered when a SchedulerEvent is created.
void	onDelete(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.ajax.json.JSONObject object) Triggered when an event is deleted, either through the Scheduler's dialog or the x-icon
void	onDelete(org.apache.wicket.ajax.AjaxRequestTarget target, SchedulerEvent event) Triggered when a SchedulerEvent is deleted
void	onEdit(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.ajax.json.JSONObject object, SchedulerViewType view) Triggered when an event should be edited. This occurs on clicking an event or clicking a free slot, as well.
void	onEdit(org.apache.wicket.ajax.AjaxRequestTarget target, SchedulerEvent event, SchedulerViewType view) Triggered when a SchedulerEvent is edited.
protected void	onInitialize()
void	onNavigate(org.apache.wicket.ajax.AjaxRequestTarget target, SchedulerViewType oldView, SchedulerViewType newView) Triggered when the user changes the selected date, or view of the scheduler
protected void	onRefresh(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler) Triggered when refresh(IPartialPageRequestHandler) has been called
void	onUpdate(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.ajax.json.JSONObject object) Triggered when an event is updated through the Scheduler dialog or by drag & drop
void	onUpdate(org.apache.wicket.ajax.AjaxRequestTarget target, SchedulerEvent event) Triggered when a SchedulerEvent is updated
void	refresh(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler) Refreshes the events currently available in the selected view.
String	widget() Gets the Kendo UI widget

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, findChildComponent, findComponentToDequeue, get, 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, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, 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, urlFor, urlFor, 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

Scheduler

public Scheduler(String id)

Constructor

Parameters:

id - the markup id

Scheduler

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

Constructor

Parameters:

id - the markup id

options - the Options

Scheduler

public Scheduler(String id,
                 SchedulerModel model)

Constructor

Parameters:

id - the markup id

model - the SchedulerModel

Scheduler

public Scheduler(String id,
                 SchedulerModel model,
                 com.googlecode.wicket.jquery.core.Options options)

Main constructor

Parameters:

id - the markup id

model - the SchedulerModel

options - the Options

Scheduler

public Scheduler(String id,
                 SchedulerModel model,
                 ResourceList resourceList)

Constructor

Parameters:

id - the markup id

model - the SchedulerModel

resourceList - a ResourceList

Scheduler

public Scheduler(String id,
                 SchedulerModel model,
                 ResourceList resourceList,
                 com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

model - the SchedulerModel

resourceList - a ResourceList

options - the Options

Scheduler

public Scheduler(String id,
                 SchedulerModel model,
                 ResourceListModel resourceListModel)

Constructor

Parameters:

id - the markup id

model - the SchedulerModel

resourceListModel - the ResourceListModel

Scheduler

public Scheduler(String id,
                 SchedulerModel model,
                 ResourceListModel resourceListModel,
                 com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

model - the SchedulerModel

resourceListModel - the ResourceListModel

options - the Options

Method Detail

add

public void add(ResourceList resourceList)

Adds a ResourceList to the internal ResourceListModel

Parameters:

resourceList - the ResourceList

See Also:

getResourceListModel()

widget

public String widget()

Gets the Kendo UI widget

Returns:

the jQuery object

refresh

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

Refreshes the events currently available in the selected view.

Parameters:

handler - the IPartialPageRequestHandler

eventOf

protected SchedulerEvent eventOf(org.apache.wicket.ajax.json.JSONObject object)

Utility method that converts a JSONObject event to a SchedulerEvent

Parameters:

object - the JSONObject

Returns:

a new SchedulerEvent

isEditEnabled

public boolean isEditEnabled()

Description copied from interface: ISchedulerListener

Indicates whether a edit-event is enabled.
If true, the ISchedulerListener.onEdit(AjaxRequestTarget, JSONObject, SchedulerViewType) event will be triggered by clicking an event or a free event slot.

This can be useful to implement a custom dialog. If false the internal event handling will proceed and opens the Scheduler's dialog (see ISchedulerListener.onUpdate(AjaxRequestTarget, JSONObject) to process the dialog results).

Note: true will prevent the internal event handling (by using e.preventDefault()) to avoid conflicts with Scheduler's dialog.

Specified by:

isEditEnabled in interface ISchedulerListener

Returns:

false by default

getModel

public SchedulerModel getModel()

Gets the sheduler's model

Returns:

the SchedulerModel

getCallbackUrl

protected CharSequence getCallbackUrl()

Gets the SchedulerModelBehavior callback url

Returns:

the SchedulerModelBehavior callback url

getEditTemplateToken

public String getEditTemplateToken()

Gets the edit-template script token/id

Returns:

the template script token/id

getEventTemplateToken

public String getEventTemplateToken()

Gets the event-template script token/id

Returns:

the template script token/id

getConverter

protected final ISchedulerConverter getConverter()

Gets the ISchedulerConverter

Returns:

the ISchedulerConverter

getResourceListModel

public ResourceListModel getResourceListModel()

Gets the sheduler's ResourceListModel

Returns:

the ResourceListModel

getGroupOrientation

protected Scheduler.GroupOrientation getGroupOrientation()

Gets the orientation of the group headers

Returns:

Scheduler.GroupOrientation.horizontal by default

isGroupedByDate

protected boolean isGroupedByDate()

Indicates whether the resources are grouped by date.

Returns:

false by default

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

onConfigure

protected void onConfigure(SchedulerDataSource dataSource)

Configure the SchedulerDataSource with additional options

Parameters:

dataSource - the SchedulerDataSource

onRefresh

protected void onRefresh(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)

Triggered when refresh(IPartialPageRequestHandler) has been called

Parameters:

handler - the IPartialPageRequestHandler

onEdit

public final void onEdit(org.apache.wicket.ajax.AjaxRequestTarget target,
                         org.apache.wicket.ajax.json.JSONObject object,
                         SchedulerViewType view)

Description copied from interface: ISchedulerListener

Triggered when an event should be edited.
This occurs on clicking an event or clicking a free slot, as well. Use SchedulerEvent.isNew(SchedulerEvent) to determine the use-case.

Specified by:

onEdit in interface ISchedulerListener

Parameters:

target - the AjaxRequestTarget

object - the JSONObject event

view - the SchedulerViewType

See Also:

SchedulerEvent.isNew(SchedulerEvent)

onEdit

public void onEdit(org.apache.wicket.ajax.AjaxRequestTarget target,
                   SchedulerEvent event,
                   SchedulerViewType view)

Triggered when a SchedulerEvent is edited.

Parameters:

target - the AjaxRequestTarget

event - the SchedulerEvent

view - the SchedulerViewType

onNavigate

public void onNavigate(org.apache.wicket.ajax.AjaxRequestTarget target,
                       SchedulerViewType oldView,
                       SchedulerViewType newView)

Description copied from interface: ISchedulerListener

Triggered when the user changes the selected date, or view of the scheduler

Specified by:

onNavigate in interface ISchedulerListener

Parameters:

target - the AjaxRequestTarget

oldView - the old/previous SchedulerViewType

newView - the new/next SchedulerViewType

onCreate

public void onCreate(org.apache.wicket.ajax.AjaxRequestTarget target,
                     org.apache.wicket.ajax.json.JSONObject object)

Triggered when an event is created through the Scheduler's dialog
Warning: to be overridden with care!

Specified by:

onCreate in interface ISchedulerListener

Parameters:

target - the AjaxRequestTarget

object - the JSONObject event

onCreate

public void onCreate(org.apache.wicket.ajax.AjaxRequestTarget target,
                     SchedulerEvent event)

Triggered when a SchedulerEvent is created.

Parameters:

target - the AjaxRequestTarget

event - the SchedulerEvent

onUpdate

public void onUpdate(org.apache.wicket.ajax.AjaxRequestTarget target,
                     org.apache.wicket.ajax.json.JSONObject object)

Triggered when an event is updated through the Scheduler dialog or by drag & drop
Warning: to be overridden with care!

Specified by:

onUpdate in interface ISchedulerListener

Parameters:

target - the AjaxRequestTarget

object - the JSONObject event

onUpdate

public void onUpdate(org.apache.wicket.ajax.AjaxRequestTarget target,
                     SchedulerEvent event)

Triggered when a SchedulerEvent is updated

Parameters:

target - the AjaxRequestTarget

event - the SchedulerEvent

onDelete

public void onDelete(org.apache.wicket.ajax.AjaxRequestTarget target,
                     org.apache.wicket.ajax.json.JSONObject object)

Triggered when an event is deleted, either through the Scheduler's dialog or the x-icon
Warning: to be overridden with care!

Specified by:

onDelete in interface ISchedulerListener

Parameters:

target - the AjaxRequestTarget

object - the JSONObject event

onDelete

public void onDelete(org.apache.wicket.ajax.AjaxRequestTarget target,
                     SchedulerEvent event)

Triggered when a SchedulerEvent is deleted

Parameters:

target - the AjaxRequestTarget

event - the SchedulerEvent

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

newConverter

protected ISchedulerConverter newConverter()

Gets a new ISchedulerConverter

Returns:

a new SchedulerConverter by default

newEditTemplate

protected com.googlecode.wicket.jquery.core.template.IJQueryTemplate newEditTemplate()

Gets a new IJQueryTemplate to customize the built-in edit window

Returns:

null by default

See Also:

http://docs.telerik.com/kendo-ui/controls/scheduling/scheduler/how-to/custom-edit-and-event-templates

newEventTemplate

protected com.googlecode.wicket.jquery.core.template.IJQueryTemplate newEventTemplate()

Gets a new IJQueryTemplate to customize the event rendering

Returns:

null by default

See Also:

http://docs.telerik.com/kendo-ui/controls/scheduling/scheduler/how-to/custom-edit-and-event-templates

newSchedulerModelBehavior

protected SchedulerModelBehavior newSchedulerModelBehavior(SchedulerModel model,
                                                           ISchedulerConverter converter)

Gets a new SchedulerModelBehavior

Parameters:

model - the SchedulerModel

converter - the SchedulerEventFactory

Returns:

the SchedulerModelBehavior