com.evrencoskun.tableview.pagination

Class Pagination

java.lang.Object

com.evrencoskun.tableview.pagination.Pagination

All Implemented Interfaces:

IPagination

public class Pagination
extends java.lang.Object
implements IPagination

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Pagination.OnTableViewPageTurnedListener Listener interface for changing of TableView page.

Constructor Summary

Constructors

Constructor and Description
Pagination(ITableView tableView) Basic constructor, TableView instance is required.
Pagination(ITableView tableView, int itemsPerPage) Applies pagination to the supplied TableView with number of items per page.
Pagination(ITableView tableView, int itemsPerPage, Pagination.OnTableViewPageTurnedListener listener) Applies pagination to the supplied TableView with number of items per page and an OnTableViewPageTurnedListener for handling changes in the TableView pagination.

Method Summary

Modifier and Type	Method and Description
int	getCurrentPage()
int	getItemsPerPage()
int	getPageCount()
void	goToPage(int page) Loads the data set of the specified page to the table view.
boolean	isPaginated()
void	nextPage() Loads the next page of the data set to the table view.
void	previousPage() Loads the previous page of the data set to the table view.
void	removeOnTableViewPageTurnedListener() Removes the OnTableViewPageTurnedListener for this Pagination.
void	setItemsPerPage(int numItems) Sets the number of items (rows) per page to be displayed in the table view.
void	setOnTableViewPageTurnedListener(Pagination.OnTableViewPageTurnedListener onTableViewPageTurnedListener) Sets the OnTableViewPageTurnedListener for this Pagination.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pagination

public Pagination(@NonNull
                  ITableView tableView)

Basic constructor, TableView instance is required.

Parameters:

tableView - The TableView to be paginated.

Pagination

public Pagination(@NonNull
                  ITableView tableView,
                  int itemsPerPage)

Applies pagination to the supplied TableView with number of items per page.

Parameters:

tableView - The TableView to be paginated.

itemsPerPage - The number of items per page.

Pagination

public Pagination(@NonNull
                  ITableView tableView,
                  int itemsPerPage,
                  @Nullable
                  Pagination.OnTableViewPageTurnedListener listener)

Applies pagination to the supplied TableView with number of items per page and an OnTableViewPageTurnedListener for handling changes in the TableView pagination.

Parameters:

tableView - The TableView to be paginated.

itemsPerPage - The number of items per page.

listener - The OnTableViewPageTurnedListener for the TableView.

Method Detail

nextPage

public void nextPage()

Description copied from interface: IPagination

Loads the next page of the data set to the table view.

Specified by:

nextPage in interface IPagination

previousPage

public void previousPage()

Description copied from interface: IPagination

Loads the previous page of the data set to the table view.

Specified by:

previousPage in interface IPagination

goToPage

public void goToPage(int page)

Description copied from interface: IPagination

Loads the data set of the specified page to the table view.

Specified by:

goToPage in interface IPagination

Parameters:

page - The page to be loaded.

setItemsPerPage

public void setItemsPerPage(int numItems)

Description copied from interface: IPagination

Sets the number of items (rows) per page to be displayed in the table view.

Specified by:

setItemsPerPage in interface IPagination

Parameters:

numItems - The number of items per page.

setOnTableViewPageTurnedListener

public void setOnTableViewPageTurnedListener(@Nullable
                                             Pagination.OnTableViewPageTurnedListener onTableViewPageTurnedListener)

Description copied from interface: IPagination

Sets the OnTableViewPageTurnedListener for this Pagination.

Specified by:

setOnTableViewPageTurnedListener in interface IPagination

Parameters:

onTableViewPageTurnedListener - The OnTableViewPageTurnedListener.

removeOnTableViewPageTurnedListener

public void removeOnTableViewPageTurnedListener()

Description copied from interface: IPagination

Removes the OnTableViewPageTurnedListener for this Pagination.

Specified by:

removeOnTableViewPageTurnedListener in interface IPagination

getCurrentPage

public int getCurrentPage()

Specified by:

getCurrentPage in interface IPagination

Returns:

The current page loaded to the table view.

getItemsPerPage

public int getItemsPerPage()

Specified by:

getItemsPerPage in interface IPagination

Returns:

The number of items per page loaded to the table view.

getPageCount

public int getPageCount()

Specified by:

getPageCount in interface IPagination

Returns:

The number of pages in the pagination.

isPaginated

public boolean isPaginated()

Specified by:

isPaginated in interface IPagination

Returns:

Current pagination state of the table view.