org.pm4j.core.pm.pageable
Interface PmPager

All Known Implementing Classes:
PmPagerImpl

public interface PmPager

PM for a control that allows to switch between pages.

Author:
olaf boede

Method Summary
 PmCommand getCmdDeSelectAll()
           
 PmCommand getCmdDeSelectAllOnPage()
           
 PmCommand getCmdFirstPage()
           
 PmCommand getCmdLastPage()
           
 PmCommand getCmdNextPage()
           
 PmCommand getCmdPrevPage()
           
 PmCommand getCmdSelectAll()
           
 PmCommand getCmdSelectAllOnPage()
           
 PmAttrInteger getCurrentPageIdx()
           
 PmLabel getItemXtillYofZ()
           
 int getNumOfItems()
           
 int getNumOfPages()
           
 int getPageSize()
           
 void setPageSize(int pageSize)
          Adjusts the page size.
 

Method Detail

getCmdFirstPage

PmCommand getCmdFirstPage()
Returns:
A command that navigates to the first page.

getCmdPrevPage

PmCommand getCmdPrevPage()
Returns:
A command that navigates to the previous page.

getCmdNextPage

PmCommand getCmdNextPage()
Returns:
A command that navigates to the next page.

getCmdLastPage

PmCommand getCmdLastPage()
Returns:
A command that navigates to the last page.

getItemXtillYofZ

PmLabel getItemXtillYofZ()
Returns:
A label presenting a text like 'Element 5 - 10 of 54'.

getNumOfItems

int getNumOfItems()
Returns:
The total number of items (on all pages).

getCurrentPageIdx

PmAttrInteger getCurrentPageIdx()
Returns:
An attribute that can be used to jump to an entered page number.

setPageSize

void setPageSize(int pageSize)
Adjusts the page size.

Parameters:
The - new page size. Should be greater than zero.

getPageSize

int getPageSize()
Returns:
The maximal number of items on a single page.

getNumOfPages

int getNumOfPages()
Returns:
The total number of pages.

getCmdSelectAllOnPage

PmCommand getCmdSelectAllOnPage()
Returns:
A command that allows to select all items on the current page.

getCmdDeSelectAllOnPage

PmCommand getCmdDeSelectAllOnPage()
Returns:
A command that allows to de-select all items on the current page.

getCmdSelectAll

PmCommand getCmdSelectAll()
Returns:
A command that allows to select all items across all pages.

getCmdDeSelectAll

PmCommand getCmdDeSelectAll()
Returns:
A command that allows to de-select all items.