|
||||||||||
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 org.apache.wicket.markup.repeater.AbstractPageableView
public abstract class AbstractPageableView
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 FormNested 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, 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 |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AbstractPageableView(java.lang.String id, IModel model)
Component.Component(String, IModel)
public AbstractPageableView(java.lang.String id)
Component.Component(String)
Method Detail |
---|
protected java.util.Iterator getItemModels()
getItemModels
in class RefreshingView
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
Component.onBeforeRender()
protected abstract java.util.Iterator getItemModels(int offset, int size)
offset
- index of first item in this pagesize
- number of items that will be shown in the current page
protected final int internalGetRowsPerPage()
protected final void internalSetRowsPerPage(int items)
items
- protected abstract int internalGetItemCount()
public final int 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()
protected int getViewOffset()
protected int getViewSize()
protected void onDetach()
Component
onDetach
in class Component
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |