org.apache.wicket.markup.repeater.data
Class DataView<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.markup.repeater.data.DataView<T>

Type Parameters:

T - The Model type.

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator, IPageable

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

DataView is a basic implementation of AbstractDataView. Data views aim to make it very simple to populate your repeating view from a database by utilizing IDataProvider to act as an interface between the database and the dataview.

Example:

     <tbody>
       <tr wicket:id="rows">
         <td><span wicket:id="id">Test ID</span></td>
         ...
 

Though this example is about a HTML table, DataView is not at all limited to HTML tables. Any kind of list can be rendered using DataView.

And the related Java code:

 add(new DataView<UserDetails>("rows", dataProvider)
 {
        public void populateItem(final Item<UserDetails> item)
        {
                final UserDetails user = item.getModelObject();
                item.add(new Label("id", user.getId()));
        }
 });
 

Author:

Igor Vaynberg (ivaynberg)

See Also:

IDataProvider, IPageable, Serialized Form

Nested Class Summary

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

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

protected	DataView(String id, IDataProvider<T> dataProvider)
protected	DataView(String id, IDataProvider<T> dataProvider, int itemsPerPage)

Method Summary

IDataProvider<T>	getDataProvider()
int	getItemsPerPage()
void	setItemsPerPage(int items) Sets the number of items to be displayed per page

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

getItemModels, internalGetDataProvider, internalGetItemCount, onDetach

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

getCurrentPage, getItemCount, getItemModels, getPageCount, getRowCount, getViewOffset, getViewSize, internalGetRowsPerPage, internalSetRowsPerPage, onBeforeRender, setCurrentPage

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

addItems, getItemReuseStrategy, getItems, newItem, newItemFactory, onPopulate, populateItem, 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, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

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

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, 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, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeginRequest, onComponentTag, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, 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

DataView

protected DataView(String id,
                   IDataProvider<T> dataProvider)

Parameters:

id - component id

dataProvider - data provider

DataView

protected DataView(String id,
                   IDataProvider<T> dataProvider,
                   int itemsPerPage)

Parameters:

id - component id

dataProvider - data provider

itemsPerPage - items per page

Method Detail

setItemsPerPage

public void setItemsPerPage(int items)

Sets the number of items to be displayed per page

Parameters:

items - number of items to display per page

getItemsPerPage

public int getItemsPerPage()

Returns:

number of items displayed per page

getDataProvider

public IDataProvider<T> getDataProvider()

Returns:

data provider