org.gwt.advanced.client.datamodel

Interface Pageable

All Known Subinterfaces:

Composite, Editable, GridDataModel, Hierarchical

All Known Implementing Classes:

EditableGridDataModel, GridPagerModel, HierarchicalGridDataModel, LazyGridDataModel, LazyHierarchicalGridDataModel, LazyTreeGridDataModel, LazyTreeGridDataModel.DelegateLazyGridDataModel, LazyTreeGridRow, SimpleGridDataModel, TreeGridDataModel, TreeGridDataModel.DelegateEditableGridDataModel, TreeGridRow

public interface Pageable

This interface describes pageable object (normally a row set of the grid).

Implementations of this interface are usually used by pagers.

Since:

1.0.0

Author:

Sergey Skladchikov

Method Summary

Methods

Modifier and Type	Method and Description
int	getCurrentPageNumber() This method gets a current page number.
int	getDisplayedPages() This method gets the number of pages links to be displayed.
int	getEndPage() This method returns an end page number.
int	getPageSize() This method returns a page size.
int	getStartPage() This method returns a start page number.
int	getTotalPagesNumber() This method returns a number of existing pages.
void	setCurrentPageNumber(int currentPageNumber) This method sets the current page number.
void	setDisplayedPages(int displayedPages) This method sets the number of pages links to be displayed.
void	setPageSize(int pageSize) This method sets a page size.

Method Detail

setPageSize

void setPageSize(int pageSize)

This method sets a page size.

Parameters:

pageSize - is a page size.

setCurrentPageNumber

void setCurrentPageNumber(int currentPageNumber)
                          throws IllegalArgumentException

This method sets the current page number.

Parameters:

currentPageNumber - is a current page number.

Throws:

IllegalArgumentException - if current page number less then zero or greater then actual number of pages.

getTotalPagesNumber

int getTotalPagesNumber()

This method returns a number of existing pages.

Returns:

a total pages number.

getStartPage

int getStartPage()

This method returns a start page number.

Returns:

is a start page number.

getEndPage

int getEndPage()

This method returns an end page number.

Returns:

is an end page number.

getDisplayedPages

int getDisplayedPages()

This method gets the number of pages links to be displayed.

Returns:

is a number of pages.

setDisplayedPages

void setDisplayedPages(int displayedPages)

This method sets the number of pages links to be displayed.

Parameters:

displayedPages - is a number of pages.

getPageSize

int getPageSize()

This method returns a page size.

Returns:

a page size (number of displayable rows).

getCurrentPageNumber

int getCurrentPageNumber()

This method gets a current page number.

Returns:

a current page number.