com.googlecode.wicket.kendo.ui.datatable

Class DataTableBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

com.googlecode.wicket.jquery.core.JQueryAbstractBehavior

com.googlecode.wicket.jquery.core.JQueryBehavior

com.googlecode.wicket.kendo.ui.KendoUIBehavior

com.googlecode.wicket.kendo.ui.datatable.DataTableBehavior

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware, KendoDestroyListener.IDestroyable, Serializable, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public abstract class DataTableBehavior
extends KendoUIBehavior
implements com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware

Provides a "kendoGrid" behavior

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataTableBehavior.CancelEvent Provides an event object that will be broadcasted by the newOnCancelAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware) callback
protected static class	DataTableBehavior.ColumnReorderEvent Provides an event object that will be broadcasted by the newColumnReorderAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware) callback

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHOD

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

method, options, selector

Constructor Summary

Constructors

Constructor and Description
DataTableBehavior(String selector, org.apache.wicket.model.IModel<List<IColumn>> columns, IDataTableListener listener) Constructor
DataTableBehavior(String selector, com.googlecode.wicket.jquery.core.Options options, org.apache.wicket.model.IModel<List<IColumn>> columns, IDataTableListener listener) Constructor

Method Summary

Modifier and Type	Method and Description
void	bind(org.apache.wicket.Component component)
static com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	getCommandAjaxBehavior(CommandButton button, List<CommandAjaxBehavior> behaviors) Gets the CommandAjaxBehavior associated to the CommandButton, if any
protected List<CommandButton>	getCommandButtons() Gets the List of CommandButton
protected abstract CharSequence	getProviderUrl() Gets the data-provider behavior's url
protected abstract long	getRowCount() Gets the row count
protected List<ToolbarButton>	getToolbarButtons() Gets the List of ToolbarButtons
protected List<CommandButton>	getVisibleCommandButtons() Gets the List of visible CommandButtons
protected List<ToolbarButton>	getVisibleToolbarButtons() Gets the List of visible ToolbarButtons
protected boolean	hasVisibleToolbarButtons() Indicates whether toolbar buttons are supplied. Note: if false, the toolbar option can be used (for built-in buttons only)
boolean	isColumnReorderEnabled() Indicates whether the reorderable option is set
protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	newColumnReorderAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source) Gets a new JQueryAjaxBehavior that will be wired to the 'columnReorder' event
protected abstract com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	newCommandAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source, CommandButton button) Gets a new JQueryAjaxBehavior that will be called by a table's button.
protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	newOnCancelAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source) Gets a new JQueryAjaxBehavior that will be wired to the 'update' event
protected DataSourceAjaxBehavior	newOnCreateAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source) Gets a new DataSourceAjaxBehavior that will be wired to the datasource's 'create' event
protected DataSourceAjaxBehavior	newOnDeleteAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source) Gets a new DataSourceAjaxBehavior that will be wired to the datasource's 'delete' event
protected DataSourceAjaxBehavior	newOnUpdateAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source) Gets a new DataSourceAjaxBehavior that will be wired to the datasource's 'update' event
protected com.googlecode.wicket.jquery.core.Options	newSchemaModelOptions(List<IColumn> columns) Get the JSON model of the datasource's schema
protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	newToolbarAjaxBehavior(DataTableBehavior source, ToolbarButton button) Gets the JQueryAjaxBehavior that will be called when the user clicks a toolbar button
void	onAjax(org.apache.wicket.ajax.AjaxRequestTarget target, com.googlecode.wicket.jquery.core.JQueryEvent event)
void	onConfigure(org.apache.wicket.Component component)
protected void	onConfigure(KendoDataSource dataSource) Configure the KendoDataSource with additional options
protected boolean	useCache() Indicates whether the read function should use cache

Methods inherited from class com.googlecode.wicket.kendo.ui.KendoUIBehavior

add, destroy, onDestroy, renderHead, widget, widget, widget, widget

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

$, $, $, $, beforeRender, detach, getMethod, getOption, getOptions, getSelector, off, on, on, register, remove, setOption, setOption, setOption, setOptions, setSelector

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

add, getJQueryLibrarySettings, renderOnDomReadyScript, renderPriorityHeaderItem, toString

Methods inherited from class org.apache.wicket.behavior.Behavior

afterRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onComponentTag, onEvent, onException, onRemove, unbind

Methods inherited from class java.lang.Object

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

Field Detail

METHOD

public static final String METHOD

See Also:

Constant Field Values

Constructor Detail

DataTableBehavior

public DataTableBehavior(String selector,
                         org.apache.wicket.model.IModel<List<IColumn>> columns,
                         IDataTableListener listener)

Constructor

Parameters:

selector - the html selector (ie: "#myId")

columns - the list of IColumn

listener - the IDataTableListener

DataTableBehavior

public DataTableBehavior(String selector,
                         com.googlecode.wicket.jquery.core.Options options,
                         org.apache.wicket.model.IModel<List<IColumn>> columns,
                         IDataTableListener listener)

Constructor

Parameters:

selector - the html selector (ie: "#myId")

options - the Options

columns - the list of IColumn

listener - the IDataTableListener

Method Detail

bind

public void bind(org.apache.wicket.Component component)

Overrides:

bind in class org.apache.wicket.behavior.Behavior

isColumnReorderEnabled

public boolean isColumnReorderEnabled()

Indicates whether the reorderable option is set

Returns:

false by default

getRowCount

protected abstract long getRowCount()

Gets the row count

Returns:

the row count

getProviderUrl

protected abstract CharSequence getProviderUrl()

Gets the data-provider behavior's url

Returns:

the data-provider behavior's url

useCache

protected boolean useCache()

Indicates whether the read function should use cache

Returns:

false by default

See Also:

configuration-transport.read.cache

getToolbarButtons

protected List<ToolbarButton> getToolbarButtons()

Gets the List of ToolbarButtons

Returns:

the List of ToolbarButtons

getVisibleToolbarButtons

protected List<ToolbarButton> getVisibleToolbarButtons()

Gets the List of visible ToolbarButtons

Returns:

the List of visible ToolbarButtons

hasVisibleToolbarButtons

protected boolean hasVisibleToolbarButtons()

Indicates whether toolbar buttons are supplied.
Note: if false, the toolbar option can be used (for built-in buttons only)

Returns:

true or false

getCommandButtons

protected List<CommandButton> getCommandButtons()

Gets the List of CommandButton

Returns:

the List of CommandButton

getVisibleCommandButtons

protected List<CommandButton> getVisibleCommandButtons()

Gets the List of visible CommandButtons

Returns:

the List of visible CommandButtons

getCommandAjaxBehavior

public static com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior getCommandAjaxBehavior(CommandButton button,
                                                                                               List<CommandAjaxBehavior> behaviors)

Gets the CommandAjaxBehavior associated to the CommandButton, if any

Parameters:

behaviors - the List of CommandAjaxBehavior

button - the CommandButton

Returns:

null if no CommandAjaxBehavior is associated to the button

onConfigure

public void onConfigure(org.apache.wicket.Component component)

Overrides:

onConfigure in class KendoUIBehavior

onConfigure

protected void onConfigure(KendoDataSource dataSource)

Configure the KendoDataSource with additional options

Parameters:

dataSource - the KendoDataSource

onAjax

public void onAjax(org.apache.wicket.ajax.AjaxRequestTarget target,
                   com.googlecode.wicket.jquery.core.JQueryEvent event)

Specified by:

onAjax in interface com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware

newSchemaModelOptions

protected com.googlecode.wicket.jquery.core.Options newSchemaModelOptions(List<IColumn> columns)

Get the JSON model of the datasource's schema

Parameters:

columns - the List of IColumns

Returns:

the model, as JSON object

newOnCancelAjaxBehavior

protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newOnCancelAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new JQueryAjaxBehavior that will be wired to the 'update' event

Parameters:

source - the IJQueryAjaxAware

Returns:

a new JQueryAjaxBehavior by default

newColumnReorderAjaxBehavior

protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newColumnReorderAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new JQueryAjaxBehavior that will be wired to the 'columnReorder' event

Parameters:

source - the IJQueryAjaxAware

Returns:

a new JQueryAjaxBehavior by default

newOnCreateAjaxBehavior

protected DataSourceAjaxBehavior newOnCreateAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new DataSourceAjaxBehavior that will be wired to the datasource's 'create' event

Parameters:

source - the IJQueryAjaxAware

Returns:

a new DataSourceAjaxBehavior

newOnUpdateAjaxBehavior

protected DataSourceAjaxBehavior newOnUpdateAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new DataSourceAjaxBehavior that will be wired to the datasource's 'update' event

Parameters:

source - the IJQueryAjaxAware

Returns:

a new DataSourceAjaxBehavior

newOnDeleteAjaxBehavior

protected DataSourceAjaxBehavior newOnDeleteAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new DataSourceAjaxBehavior that will be wired to the datasource's 'delete' event

Parameters:

source - the IJQueryAjaxAware

Returns:

a new DataSourceAjaxBehavior

newToolbarAjaxBehavior

protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newToolbarAjaxBehavior(DataTableBehavior source,
                                                                                           ToolbarButton button)

Gets the JQueryAjaxBehavior that will be called when the user clicks a toolbar button

Parameters:

source - the IJQueryAjaxAware

button - the button that is passed to the behavior so it can be retrieved via the ToolbarAjaxBehavior.ToolbarClickEvent

Returns:

the JQueryAjaxBehavior

newCommandAjaxBehavior

protected abstract com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newCommandAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source,
                                                                                                    CommandButton button)

Gets a new JQueryAjaxBehavior that will be called by a table's button. This method may be overridden to provide additional behaviors

Parameters:

source - the IJQueryAjaxAware

button - the button that is passed to the behavior so it can be retrieved via the CommandAjaxBehavior.CommandClickEvent

Returns:

the JQueryAjaxBehavior