T
- type of elements contained in the model's listpublic abstract class AbstractPageableView<T> extends RefreshingView<T> implements IPageableItems
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.
RefreshingView
,
IPageable
,
Serialized FormENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING
Constructor and Description |
---|
AbstractPageableView(String id) |
AbstractPageableView(String id,
IModel<? extends Collection<? extends T>> model)
Constructor
|
Modifier and Type | Method and Description |
---|---|
long |
getCurrentPage() |
long |
getFirstItemOffset() |
long |
getItemCount()
Get the item count.
|
protected Iterator<IModel<T>> |
getItemModels()
This method retrieves the subset of models for items in the current page and allows
RefreshingView to generate items.
|
protected abstract Iterator<IModel<T>> |
getItemModels(long offset,
long size)
Returns an iterator over models for items in the current page
|
long |
getItemsPerPage()
maximum number of visible items per page
|
long |
getPageCount()
Gets the total number of pages this pageable object has.
|
long |
getRowCount()
Get the row count.
|
long |
getViewSize() |
protected abstract long |
internalGetItemCount() |
protected void |
onBeforeRender()
Called on all visible components before any component is rendered.
|
protected void |
onDetach()
Called to allow a component to detach resources after use.
|
void |
setCurrentPage(long page)
Sets the a page that should be rendered (page number is zero-based)
|
void |
setItemsPerPage(long items)
Sets the maximum number of items to show per page.
|
addItems, getItemReuseStrategy, getItems, newItem, newItemFactory, onPopulate, populateItem, setItemReuseStrategy
newChildId, renderIterator
dequeue, getMarkup, onRender, renderChild
getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession
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, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren
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, 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
public AbstractPageableView(String id, IModel<? extends Collection<? extends T>> model)
id
- model
- Component.Component(String, IModel)
public AbstractPageableView(String id)
Component.Component(String)
protected Iterator<IModel<T>> getItemModels()
getItemModels
in class RefreshingView<T>
protected void onBeforeRender()
Component
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.
onBeforeRender
in class AbstractRepeater
AbstractRepeater.onBeforeRender()
protected abstract Iterator<IModel<T>> getItemModels(long offset, long size)
offset
- index of first item in this pagesize
- number of items that will be shown in the current pagepublic long getItemsPerPage()
IPageableItems
getItemsPerPage
in interface IPageableItems
public final void setItemsPerPage(long items)
setItemsPerPage
in interface IPageableItems
items
- protected abstract long internalGetItemCount()
public final long getRowCount()
getItemCount()
public final long getItemCount()
getItemCount
in interface IPageableItems
getRowCount()
public final long getCurrentPage()
getCurrentPage
in interface IPageable
IPageable.getCurrentPage()
public final void setCurrentPage(long page)
IPageable
setCurrentPage
in interface IPageable
page
- The page that should be rendered.IPageable.setCurrentPage(long)
public long getPageCount()
IPageable
getPageCount
in interface IPageable
IPageable.getPageCount()
public long getFirstItemOffset()
public long getViewSize()
protected void onDetach()
Component
onDetach
in class MarkupContainer
Component.onDetach()
Copyright © 2006–2019 Apache Software Foundation. All rights reserved.