org.apache.wicket.markup.html.navigation.paging
Interface IPageable

All Superinterfaces:
IClusterable, Serializable
All Known Implementing Classes:
AbstractDataGridView, AbstractPageableView, AjaxFallbackDefaultDataTable, DataGridView, DataTable, DataView, DataViewBase, DefaultDataTable, GridView, PageableListView

public interface IPageable
extends IClusterable

Components that implement this interface will be pageable, they should return the pagecount so that an object/component knows how many pages it can use for the setCurrentPage method. The PageableListView is one example that is Pageable. But also a Form could be pageable so that you can scroll to sets of records that you display in that form with any navigator you want.

Author:
jcompagner

Method Summary
 int getCurrentPage()
           
 int getPageCount()
          Gets the total number of pages this pageable object has.
 void setCurrentPage(int page)
          Sets the a page that should be rendered.
 

Method Detail

getCurrentPage

int getCurrentPage()
Returns:
The current page that is or will be rendered.

setCurrentPage

void setCurrentPage(int page)
Sets the a page that should be rendered.

Parameters:
page - The page that should be rendered.

getPageCount

int getPageCount()
Gets the total number of pages this pageable object has.

Returns:
The total number of pages this pageable object has


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.