org.apache.wicket.extensions.markup.html.repeater.data.grid
Class AbstractDataGridView

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
                          org.apache.wicket.markup.repeater.AbstractPageableView
                              org.apache.wicket.markup.repeater.data.DataViewBase
                                  org.apache.wicket.extensions.markup.html.repeater.data.grid.AbstractDataGridView

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IPageable

Direct Known Subclasses:

DataGridView

public abstract class AbstractDataGridView
extends DataViewBase

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

AbstractDataGridView(java.lang.String id, ICellPopulator[] populators, IDataProvider dataProvider)
Constructor

Method Summary

protected ICellPopulator[]	internalGetPopulators()
protected Item	newCellItem(java.lang.String id, int index, IModel model) Factory method for Item container that represents a cell.
protected Item	newItem(java.lang.String id, int index, IModel model) Factory method for Item container.
protected Item	newRowItem(java.lang.String id, int index, IModel 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 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, getItemModels, getPageCount, getRowCount, getViewOffset, getViewSize, internalGetRowsPerPage, internalSetRowsPerPage, onBeforeRender, setCurrentPage

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

onRender, renderChild

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

getMarkupType, getWebPage

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeginRequest, onComponentTag, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataGridView

public AbstractDataGridView(java.lang.String id,
                            ICellPopulator[] populators,
                            IDataProvider 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 ICellPopulator[] internalGetPopulators()

newCellItem

protected Item newCellItem(java.lang.String id,
                           int index,
                           IModel 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 newItem(java.lang.String id,
                             int index,
                             IModel 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

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 newRowItem(java.lang.String id,
                          int index,
                          IModel 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

See Also:

DataViewBase.onDetach()

populateItem

protected final void populateItem(Item item)

Description copied from class: RefreshingView

Populate the given Item container.

be carefull 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

Parameters:

item - The item to populate

See Also:

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