|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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>
T
- Model object typepublic abstract class AbstractPageableView<T>
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.
RefreshingView
,
IPageable
,
Serialized FormField Summary |
---|
Fields inherited from class org.apache.wicket.Component |
---|
ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PATH_SEPARATOR, RENDER |
Constructor Summary | |
---|---|
AbstractPageableView(String id)
|
|
AbstractPageableView(String id,
IModel<? extends Collection<? extends T>> model)
Constructor |
Method Summary | |
---|---|
int |
getCurrentPage()
|
int |
getFirstItemOffset()
|
int |
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(int offset,
int size)
Returns an iterator over models for items in the current page |
int |
getItemsPerPage()
maximum number of visible items per page |
int |
getPageCount()
Gets the total number of pages this pageable object has. |
int |
getRowCount()
Get the row count. |
int |
getViewSize()
|
protected abstract int |
internalGetItemCount()
|
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 (page number is zero-based) |
void |
setItemsPerPage(int items)
Sets the maximum number of items to show per page. |
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 |
---|
getMarkup, onRender, renderChild |
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer |
---|
getWebPage, getWebRequest |
Methods inherited from class org.apache.wicket.MarkupContainer |
---|
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupType, hasAssociatedMarkup, internalAdd, iterator, iterator, onComponentTagBody, onMarkupAttached, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AbstractPageableView(String id, IModel<? extends Collection<? extends T>> model)
id
- model
- Component.Component(String, IModel)
public AbstractPageableView(String id)
Component.Component(String)
Method Detail |
---|
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(int offset, int size)
offset
- index of first item in this pagesize
- number of items that will be shown in the current page
public int getItemsPerPage()
IPageableItems
getItemsPerPage
in interface IPageableItems
public final void setItemsPerPage(int items)
items
- protected abstract int internalGetItemCount()
public final int getRowCount()
getItemCount()
public final int getItemCount()
getItemCount
in interface IPageableItems
getRowCount()
public final int getCurrentPage()
getCurrentPage
in interface IPageable
IPageable.getCurrentPage()
public final void setCurrentPage(int page)
IPageable
setCurrentPage
in interface IPageable
page
- The page that should be rendered.IPageable.setCurrentPage(int)
public final int getPageCount()
IPageable
getPageCount
in interface IPageable
IPageable.getPageCount()
public int getFirstItemOffset()
public int getViewSize()
protected void onDetach()
Component
onDetach
in class Component
Component.onDetach()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |