com.googlecode.wicket.kendo.ui.widget.treeview

Class AjaxTreeView

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.widget.treeview.AjaxTreeView

All Implemented Interfaces:

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

Provides the Kendo UI TreeView

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AjaxTreeView.ExpandBehavior Provides a databound behavior that extends node(s)

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
AjaxTreeView(String id, TreeViewModel model) Constructor
AjaxTreeView(String id, TreeViewModel model, com.googlecode.wicket.jquery.core.Options options) Constructor

Method Summary

Modifier and Type	Method and Description
void	expandPath(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, String path) Expand the AjaxTreeView to the specified path
void	expandPaths(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, List<String> paths) Expand the AjaxTreeView to all specified paths
protected CharSequence	getCallbackUrl() Gets the TreeViewModelBehavior callback url
TreeViewModel	getModel() Gets the sheduler's model
String	getTemplateToken() Gets the template script token/id
boolean	isChangeEventEnabled() Indicates whether the 'change' event is enabled. If true, the ITreeViewListener.onChange(AjaxRequestTarget, int, String) event will be triggered
boolean	isDropEventEnabled() Indicates whether the 'drop' event is enabled. If true, the ITreeViewListener.onDrop(AjaxRequestTarget, int, int, String) event will be triggered
boolean	isExpandEventEnabled() Indicates whether the 'expand' event is enabled. If true, the ITreeViewListener.onExpand(AjaxRequestTarget, int) event will be triggered
protected com.googlecode.wicket.jquery.core.template.IJQueryTemplate	newTemplate() Gets a new IJQueryTemplate to customize the built-in edit window
protected TreeNodeFactory	newTreeNodeFactory() Gets a new TreeNodeFactory
protected TreeViewModelBehavior	newTreeViewModelBehavior(TreeViewModel model, TreeNodeFactory factory) Gets a new TreeViewModelBehavior
com.googlecode.wicket.jquery.core.JQueryBehavior	newWidgetBehavior(String selector) see IJQueryWidget.newWidgetBehavior(String)
void	onChange(org.apache.wicket.ajax.AjaxRequestTarget target, int nodeId, String nodePath) Triggered when the selection has changed
void	onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
protected void	onConfigure(KendoDataSource.HierarchicalDataSource dataSource) Configure the KendoDataSource.HierarchicalDataSource with additional options
void	onDrop(org.apache.wicket.ajax.AjaxRequestTarget target, int nodeId, int parentId, String position) Triggered when a node is (drag and) dropped
void	onExpand(org.apache.wicket.ajax.AjaxRequestTarget target, int nodeId) Triggered when a node is expanding
protected void	onInitialize()
protected void	onRefresh(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler) Triggered when refresh(IPartialPageRequestHandler) has been called
void	refresh(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler) Refreshes the widget by reading from the datasource
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

AjaxTreeView

public AjaxTreeView(String id,
                    TreeViewModel model)

Constructor

Parameters:

id - the markup id

model - the TreeViewModel

AjaxTreeView

public AjaxTreeView(String id,
                    TreeViewModel model,
                    com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

model - the TreeViewModel

options - the Options

Method Detail

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 widget by reading from the datasource

Parameters:

handler - the IPartialPageRequestHandler

expandPath

public void expandPath(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                       String path)

Expand the AjaxTreeView to the specified path

Parameters:

handler - the IPartialPageRequestHandler

path - the path to the node, as an id-array, ie: [1, 2, 3]

expandPaths

public void expandPaths(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                        List<String> paths)

Expand the AjaxTreeView to all specified paths

Parameters:

handler - the IPartialPageRequestHandler

paths - the path list to the node, as id-arrays

See Also:

expandPath(IPartialPageRequestHandler, String)

getModel

public TreeViewModel getModel()

Gets the sheduler's model

Returns:

the TreeViewModel

getCallbackUrl

protected CharSequence getCallbackUrl()

Gets the TreeViewModelBehavior callback url

Returns:

the TreeViewModelBehavior callback url

getTemplateToken

public String getTemplateToken()

Gets the template script token/id

Returns:

the template script token/id

isChangeEventEnabled

public boolean isChangeEventEnabled()

Description copied from interface: ITreeViewListener

Indicates whether the 'change' event is enabled.
If true, the ITreeViewListener.onChange(AjaxRequestTarget, int, String) event will be triggered

Specified by:

isChangeEventEnabled in interface ITreeViewListener

Returns:

false by default

isExpandEventEnabled

public boolean isExpandEventEnabled()

Description copied from interface: ITreeViewListener

Indicates whether the 'expand' event is enabled.
If true, the ITreeViewListener.onExpand(AjaxRequestTarget, int) event will be triggered

Specified by:

isExpandEventEnabled in interface ITreeViewListener

Returns:

false by default

isDropEventEnabled

public boolean isDropEventEnabled()

Description copied from interface: ITreeViewListener

Indicates whether the 'drop' event is enabled.
If true, the ITreeViewListener.onDrop(AjaxRequestTarget, int, int, String) event will be triggered

Specified by:

isDropEventEnabled in interface ITreeViewListener

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(KendoDataSource.HierarchicalDataSource dataSource)

Configure the KendoDataSource.HierarchicalDataSource with additional options

Parameters:

dataSource - the KendoDataSource.HierarchicalDataSource

onRefresh

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

Triggered when refresh(IPartialPageRequestHandler) has been called

Parameters:

handler - the IPartialPageRequestHandler

onExpand

public void onExpand(org.apache.wicket.ajax.AjaxRequestTarget target,
                     int nodeId)

Description copied from interface: ITreeViewListener

Triggered when a node is expanding

Specified by:

onExpand in interface ITreeViewListener

Parameters:

target - the AjaxRequestTarget

nodeId - the node-id

onChange

public void onChange(org.apache.wicket.ajax.AjaxRequestTarget target,
                     int nodeId,
                     String nodePath)

Description copied from interface: ITreeViewListener

Triggered when the selection has changed

Specified by:

onChange in interface ITreeViewListener

Parameters:

target - the AjaxRequestTarget

nodeId - the node-id

nodePath - the node path as array, ie [1,2,3]

onDrop

public void onDrop(org.apache.wicket.ajax.AjaxRequestTarget target,
                   int nodeId,
                   int parentId,
                   String position)

Description copied from interface: ITreeViewListener

Triggered when a node is (drag and) dropped

Specified by:

onDrop in interface ITreeViewListener

Parameters:

target - the AjaxRequestTarget

nodeId - the node-id

parentId - the node that the node-id is being dropped upon.

position - one of the values 'over', 'before', or 'after'.

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

newTemplate

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

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

Returns:

null by default

newTreeNodeFactory

protected TreeNodeFactory newTreeNodeFactory()

Gets a new TreeNodeFactory

Returns:

a new TreeNodeFactory

newTreeViewModelBehavior

protected TreeViewModelBehavior newTreeViewModelBehavior(TreeViewModel model,
                                                         TreeNodeFactory factory)

Gets a new TreeViewModelBehavior

Parameters:

model - the TreeViewModel

factory - the TreeNodeFactory

Returns:

the TreeViewModelBehavior