Package org.apache.wicket.extensions.markup.html.repeater.data.grid

Class AbstractDataGridView<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.repeater.AbstractRepeater

org.apache.wicket.markup.repeater.RepeatingView

org.apache.wicket.markup.repeater.RefreshingView<T>

org.apache.wicket.markup.repeater.AbstractPageableView<T>

org.apache.wicket.markup.repeater.data.DataViewBase<T>

org.apache.wicket.extensions.markup.html.repeater.data.grid.AbstractDataGridView<T>

Type Parameters:

T - Model object type

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IHeaderContributor, IPageable, IPageableItems, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

DataGridView

public abstract class AbstractDataGridView<T>
extends DataViewBase<T>

Acts as a base for data-grid views. Unlike a data view a data-grid view populates both rows and columns. The columns are populated by an array of provided ICellPopulator objects.

Author:

Igor Vaynberg (ivaynberg)

See Also:

DataGridView, Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

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

Constructor Summary

Constructors

Constructor	Description
AbstractDataGridView(String id, List<? extends ICellPopulator<T>> populators, IDataProvider<T> dataProvider)	Constructor

Method Summary

Modifier and Type	Method	Description
protected List<? extends ICellPopulator<T>>	internalGetPopulators()
protected Item<ICellPopulator<T>>	newCellItem(String id, int index, IModel<ICellPopulator<T>> model)	Factory method for Item container that represents a cell.
protected Item<T>	newItem(String id, int index, IModel<T> model)	Factory method for Item container.
protected Item<T>	newRowItem(String id, int index, IModel<T> model)	Factory method for Item container that represents a row.
protected void	onDetach()	Called to allow a component to detach resources after use.
protected void	populateItem(Item<T> item)	Populate the given Item container.

Methods inherited from class org.apache.wicket.markup.repeater.data.DataViewBase

getItemModels, internalGetDataProvider, internalGetItemCount

Methods inherited from class org.apache.wicket.markup.repeater.AbstractPageableView

getCurrentPage, getFirstItemOffset, getItemCount, getItemModels, getItemsPerPage, getPageCount, getRowCount, getViewSize, onBeforeRender, setCurrentPage, setItemsPerPage

Methods inherited from class org.apache.wicket.markup.repeater.RefreshingView

addItems, getItemReuseStrategy, getItems, newItemFactory, onPopulate, setItemReuseStrategy

Methods inherited from class org.apache.wicket.markup.repeater.RepeatingView

newChildId, renderIterator

Methods inherited from class org.apache.wicket.markup.repeater.AbstractRepeater

dequeue, getMarkup, onRender, renderChild

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, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onInitialize, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, 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

Constructor Detail

AbstractDataGridView

public AbstractDataGridView(String id,
                            List<? extends ICellPopulator<T>> populators,
                            IDataProvider<T> dataProvider)

Constructor

Parameters:

id - component id

populators - array of ICellPopulator objects that will be used to populate cell items

dataProvider - data provider

Method Detail

internalGetPopulators

protected final List<? extends ICellPopulator<T>> internalGetPopulators()

newCellItem

protected Item<ICellPopulator<T>> newCellItem(String id,
                                              int index,
                                              IModel<ICellPopulator<T>> model)

Factory method for Item container that represents a cell.

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, RefreshingView.newItem(String, int, IModel)

newItem

protected final Item<T> newItem(String id,
                                int index,
                                IModel<T> model)

Description copied from class: RefreshingView

Factory method for Item container. Item containers are simple MarkupContainer used to aggregate the user added components for a row inside the view.

Overrides:

newItem in class RefreshingView<T>

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 Item<T> newRowItem(String id,
                             int index,
                             IModel<T> model)

Factory method for Item container that represents a row.

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, RefreshingView.newItem(String, int, IModel)

onDetach

protected void onDetach()

Description copied from class: Component

Called to allow a component to detach resources after use. Overrides of this method MUST call the super implementation, the most logical place to do this is the last line of the override method.

Overrides:

onDetach in class DataViewBase<T>

See Also:

DataViewBase.onDetach()

populateItem

protected final void populateItem(Item<T> item)

Description copied from class: RefreshingView

Populate the given Item container.

be careful to add any components to the item and not the view itself. So, don't do:

 add(new Label("foo", "bar"));
 

but:

 item.add(new Label("foo", "bar"));
 

Specified by:

populateItem in class RefreshingView<T>

Parameters:

item - The item to populate

See Also:

RefreshingView.populateItem(org.apache.wicket.markup.repeater.Item)