org.apache.wicket.markup.repeater
Class AbstractPageableView

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

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IPageable

Direct Known Subclasses:

DataViewBase

public abstract class AbstractPageableView
extends RefreshingView
implements IPageable

An abstract repeater view that provides paging functionality to its subclasses.

The view is populated by overriding the getItemModels(int offset, int count) method and providing an iterator that returns models for items in the current page. The AbstractPageableView builds the items that will be rendered by looping over the models and calling the newItem(String id, int index, IModel model) to generate the child item container followed by populateItem(Component item) to let the user populate the newly created item container with with custom components.

Author:

Igor Vaynberg (ivaynberg)

See Also:

RefreshingView, IPageable, 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

AbstractPageableView(java.lang.String id)

AbstractPageableView(java.lang.String id, IModel model)

Method Summary

int	getCurrentPage()
protected java.util.Iterator	getItemModels() This method retrieves the subset of models for items in the current page and allows RefreshingView to generate items.
protected abstract java.util.Iterator	getItemModels(int offset, int size) Returns an iterator over models for items in the current page
int	getPageCount() Gets the total number of pages this pageable object has.
int	getRowCount()
protected int	getViewOffset()
protected int	getViewSize()
protected abstract int	internalGetItemCount()
protected int	internalGetRowsPerPage()
protected void	internalSetRowsPerPage(int items) Sets the maximum number of items to show per page.
protected void	onBeforeRender() Called just before a component is rendered.
protected void	onDetach() Called to allow a component to detach resources after use.
void	setCurrentPage(int page) Sets the a page that should be rendered.

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

addItems, getItemReuseStrategy, getItems, newItem, 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

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, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, 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, 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, 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

AbstractPageableView

public AbstractPageableView(java.lang.String id,
                            IModel model)

See Also:

Component.Component(String, IModel)

AbstractPageableView

public AbstractPageableView(java.lang.String id)

See Also:

Component.Component(String)

Method Detail

getItemModels

protected java.util.Iterator getItemModels()

This method retrieves the subset of models for items in the current page and allows RefreshingView to generate items.

Specified by:

getItemModels in class RefreshingView

Returns:

iterator over models for items in the current page

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called just before a component is rendered.

*NOTE* If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Overrides:

onBeforeRender in class AbstractRepeater

See Also:

Component.onBeforeRender()

getItemModels

protected abstract java.util.Iterator getItemModels(int offset,
                                                    int size)

Returns an iterator over models for items in the current page

Parameters:

offset - index of first item in this page

size - number of items that will be shown in the current page

Returns:

an iterator over models for items in the current page

internalGetRowsPerPage

protected final int internalGetRowsPerPage()

Returns:

maximum number of items that will be shown per page

internalSetRowsPerPage

protected final void internalSetRowsPerPage(int items)

Sets the maximum number of items to show per page. The current page will also be set to zero

Parameters:

items -

internalGetItemCount

protected abstract int internalGetItemCount()

Returns:

total item count

getRowCount

public final int getRowCount()

Returns:

total item count

getCurrentPage

public final int getCurrentPage()

Specified by:

getCurrentPage in interface IPageable

Returns:

The current page that is or will be rendered rendered.

See Also:

IPageable.getCurrentPage()

setCurrentPage

public final void setCurrentPage(int page)

Description copied from interface: IPageable

Sets the a page that should be rendered.

Specified by:

setCurrentPage in interface IPageable

Parameters:

page - The page that should be rendered.

See Also:

IPageable.setCurrentPage(int)

getPageCount

public final int getPageCount()

Description copied from interface: IPageable

Gets the total number of pages this pageable object has.

Specified by:

getPageCount in interface IPageable

Returns:

The total number of pages this pageable object has

See Also:

IPageable.getPageCount()

getViewOffset

protected int getViewOffset()

Returns:

the index of the first visible item

getViewSize

protected int getViewSize()

Returns:

the number of items visible

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 Component