org.wicketstuff.egrid.component

Class EditableDataTable<T,S>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.wicketstuff.egrid.component.EditableDataTable<T,S>

Type Parameters:

T - The model object type

S - the type of the sorting parameter

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.markup.html.navigation.paging.IPageable, org.apache.wicket.markup.html.navigation.paging.IPageableItems, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable, IColumnProvider<T,S>

public class EditableDataTable<T,S>
extends org.apache.wicket.markup.html.panel.Panel
implements org.apache.wicket.markup.html.navigation.paging.IPageableItems, IColumnProvider<T,S>

Copied from org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable

Author:

Nadeem

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditableDataTable.CssAttributeBehavior
static class	EditableDataTable.RowItem<RI>

Field Summary

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

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
EditableDataTable(String id, List<? extends org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,S>> newColumns, IEditableDataProvider<T,S> dataProvider, long rowsPerPage, Class<T> clazz) Constructor

Method Summary

tag.

Methods

Modifier and Type	Method and Description
void	addBottomToolbar(AbstractEditableGridToolbar toolbar) Adds a toolbar to the datatable that will be displayed after the data
void	addTopToolbar(AbstractEditableGridToolbar toolbar) Adds a toolbar to the datatable that will be displayed before the data
org.apache.wicket.markup.html.WebMarkupContainer	getBody()
org.wicketstuff.egrid.component.EditableDataTable.ToolbarsContainer	getBottomToolbars()
org.wicketstuff.egrid.component.EditableDataTable.Caption	getCaption()
protected org.apache.wicket.model.IModel<String>	getCaptionModel() Returns the model for table's caption.
List<? extends org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,S>>	getColumns()
long	getCurrentPage()
IEditableDataProvider<T,S>	getDataProvider()
long	getItemCount()
long	getItemsPerPage()
long	getPageCount()
long	getRowCount()
org.wicketstuff.egrid.component.EditableDataTable.ToolbarsContainer	getTopToolbars()
protected org.apache.wicket.markup.html.WebMarkupContainer	newBodyContainer(String id) Create the MarkupContainer for the
protected org.apache.wicket.markup.repeater.Item<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,S>>	newCellItem(String id, int index, org.apache.wicket.model.IModel<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,S>> model) Factory method for Item container that represents a cell in the underlying DataGridView
protected org.apache.wicket.markup.repeater.Item<T>	newRowItem(String id, int index, org.apache.wicket.model.IModel<T> model)
protected void	onDetach()
protected void	onError(org.apache.wicket.ajax.AjaxRequestTarget target)
void	onEvent(org.apache.wicket.event.IEvent<?> event)
protected void	onPageChanged() Event listener for page-changed event
void	setCurrentPage(long page)
EditableDataTable<T,S>	setItemReuseStrategy(org.apache.wicket.markup.repeater.IItemReuseStrategy strategy) Sets the item reuse strategy.
void	setItemsPerPage(long items) Sets the number of items to be displayed per page
void	setTableBodyCss(String cssStyle) Set the 'class' attribute for the tbody tag.

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

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

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onInitialize, 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, 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, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, 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 org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Constructor Detail

EditableDataTable

public EditableDataTable(String id,
                 List<? extends org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,S>> newColumns,
                 IEditableDataProvider<T,S> dataProvider,
                 long rowsPerPage,
                 Class<T> clazz)

Constructor

Parameters:

id - component id

newColumns - list of IColumn objects

dataProvider - imodel for data provider

rowsPerPage - number of rows per page

Method Detail

getCaptionModel

protected org.apache.wicket.model.IModel<String> getCaptionModel()

Returns the model for table's caption. The caption wont be rendered if the model has empty value.

Returns:

the model for table's caption

newBodyContainer

protected org.apache.wicket.markup.html.WebMarkupContainer newBodyContainer(String id)

Create the MarkupContainer for the tag. Users may subclass it to provide their own (modified) implementation.

Parameters:

id -

Returns:

A new markup container

setTableBodyCss

public final void setTableBodyCss(String cssStyle)

Set the 'class' attribute for the tbody tag.

Parameters:

cssStyle -

addBottomToolbar

public void addBottomToolbar(AbstractEditableGridToolbar toolbar)

Adds a toolbar to the datatable that will be displayed after the data

Parameters:

toolbar - toolbar to be added

See Also:

AbstractToolbar

addTopToolbar

public void addTopToolbar(AbstractEditableGridToolbar toolbar)

Adds a toolbar to the datatable that will be displayed before the data

Parameters:

toolbar - toolbar to be added

See Also:

AbstractToolbar

getTopToolbars

public final org.wicketstuff.egrid.component.EditableDataTable.ToolbarsContainer getTopToolbars()

Returns:

the container with the toolbars at the top

getBottomToolbars

public final org.wicketstuff.egrid.component.EditableDataTable.ToolbarsContainer getBottomToolbars()

Returns:

the container with the toolbars at the bottom

getBody

public final org.apache.wicket.markup.html.WebMarkupContainer getBody()

Returns:

the container used for the table body

getCaption

public final org.wicketstuff.egrid.component.EditableDataTable.Caption getCaption()

Returns:

the component used for the table caption

getDataProvider

public final IEditableDataProvider<T,S> getDataProvider()

Returns:

dataprovider

getColumns

public final List<? extends org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,S>> getColumns()

Specified by:

getColumns in interface IColumnProvider<T,S>

Returns:

array of column objects this table displays

getCurrentPage

public final long getCurrentPage()

Specified by:

getCurrentPage in interface org.apache.wicket.markup.html.navigation.paging.IPageable

See Also:

IPageable.getCurrentPage()

getPageCount

public final long getPageCount()

Specified by:

getPageCount in interface org.apache.wicket.markup.html.navigation.paging.IPageable

See Also:

IPageable.getPageCount()

getRowCount

public final long getRowCount()

Returns:

total number of rows in this table

getItemsPerPage

public final long getItemsPerPage()

Specified by:

getItemsPerPage in interface org.apache.wicket.markup.html.navigation.paging.IPageableItems

Returns:

number of rows per page

setCurrentPage

public final void setCurrentPage(long page)

Specified by:

setCurrentPage in interface org.apache.wicket.markup.html.navigation.paging.IPageable

See Also:

IPageable.setCurrentPage(long)

setItemReuseStrategy

public final EditableDataTable<T,S> setItemReuseStrategy(org.apache.wicket.markup.repeater.IItemReuseStrategy strategy)

Sets the item reuse strategy. This strategy controls the creation of Items.

Parameters:

strategy - item reuse strategy

Returns:

this for chaining

See Also:

RefreshingView.setItemReuseStrategy(IItemReuseStrategy), IItemReuseStrategy

setItemsPerPage

public void setItemsPerPage(long items)

Sets the number of items to be displayed per page

Specified by:

setItemsPerPage in interface org.apache.wicket.markup.html.navigation.paging.IPageableItems

Parameters:

items - number of items to display per page

getItemCount

public long getItemCount()

Specified by:

getItemCount in interface org.apache.wicket.markup.html.navigation.paging.IPageableItems

See Also:

IPageableItems.getItemCount()

newCellItem

protected org.apache.wicket.markup.repeater.Item<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,S>> newCellItem(String id,
                                                                                                                            int index,
                                                                                                                            org.apache.wicket.model.IModel<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<T,S>> model)

Factory method for Item container that represents a cell in the underlying DataGridView

Parameters:

id - component id for the new data item

index - the index of the new data item

model - the model for the new data item

Returns:

DataItem created DataItem

See Also:

Item

newRowItem

protected org.apache.wicket.markup.repeater.Item<T> newRowItem(String id,
                                                   int index,
                                                   org.apache.wicket.model.IModel<T> model)

onDetach

protected void onDetach()

Overrides:

onDetach in class org.apache.wicket.MarkupContainer

See Also:

Component.onDetach()

onPageChanged

protected void onPageChanged()

Event listener for page-changed event

onEvent

public void onEvent(org.apache.wicket.event.IEvent<?> event)

Specified by:

onEvent in interface org.apache.wicket.event.IEventSink

Overrides:

onEvent in class org.apache.wicket.Component

onError

protected void onError(org.apache.wicket.ajax.AjaxRequestTarget target)