Package org.silverpeas.core.web.util.viewgenerator.html.arraypanes.pagination

Interface WADataPaginator

public interface WADataPaginator

This interface is used when pagination of large result sets is needed, mostly as part of the rendering process.

Version:

Author:

jpouyadou

Method Summary

Modifier and Type	Method	Description
WADataPage	getCurrentPage()	this method returns the current page of data, or null is there is no such page.
int	getCurrentPageNumber()	This method retuns the current, 0-base page number, or -1 if there is no current page
WADataPage	getFirstPage()	this method returns the first page of data, or null is there is no such page.
WADataPaginatorHeader	getHeader()
int	getItemCount()	this method returns the total count of items
WADataPage	getLastPage()	this method returns the last page of data, or null is there is no such page.
WADataPage	getNextPage()	this method returns the next page of data, or null is there is no such page
int	getPageCount()	this method returns the count of pages in this set
WADataPage	getPreviousPage()	this method returns the previous page of data, or null is there is no such page
void	setHeader(WADataPaginatorHeader h)	This method sets the header.
void	setPageSize(int size)	This method sets the page size, that is, the count of items that fit on one page.

Method Detail

getNextPage

WADataPage getNextPage()

this method returns the next page of data, or null is there is no such page

See Also:

getPreviousPage()

getPreviousPage

WADataPage getPreviousPage()

this method returns the previous page of data, or null is there is no such page

See Also:

getNextPage()

getFirstPage

WADataPage getFirstPage()

this method returns the first page of data, or null is there is no such page. The next call to getNextPage will thus return the second page.

See Also:

getNextPage(), getPreviousPage()

getCurrentPage

WADataPage getCurrentPage()

this method returns the current page of data, or null is there is no such page.

See Also:

getNextPage(), getPreviousPage()

getLastPage

WADataPage getLastPage()

this method returns the last page of data, or null is there is no such page. T

See Also:

getNextPage(), #getpreviousPage

getPageCount

int getPageCount()

this method returns the count of pages in this set

See Also:

getNextPage(), getPreviousPage()

getItemCount

int getItemCount()

this method returns the total count of items

getCurrentPageNumber

int getCurrentPageNumber()

This method retuns the current, 0-base page number, or -1 if there is no current page

setPageSize

void setPageSize(int size)

This method sets the page size, that is, the count of items that fit on one page. Usually called from the rendering process.

setHeader

void setHeader(WADataPaginatorHeader h)

This method sets the header. The header is used mostly to know how to sort items

getHeader

WADataPaginatorHeader getHeader()