org.dominokit.domino.ui.pagination

Interface HasPagination

All Known Implementing Classes:

AdvancedPagination, BasePagination, ScrollingPagination, SimplePagination

public interface HasPagination

An interface providing component with pagination

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HasPagination.PageChangedCallBack A listener that will be called when the page is changed

Method Summary

Modifier and Type	Method and Description
int	activePage()
int	getPagesCount()
int	getPageSize()
int	getTotalCount()
HasPagination	gotoFirst() Go to the first page
HasPagination	gotoFirst(boolean silent) Go to the first page with boolean for notifying listeners or not
HasPagination	gotoLast() Go to the last page
HasPagination	gotoLast(boolean silent) Go to the last page with boolean for notifying listeners or not
HasPagination	gotoPage(int page) Go to a specific page number
HasPagination	gotoPage(int page, boolean silent) Go to a specific page number with boolean for notifying listeners or not
HasPagination	markActivePage() Marks the current page as active
HasPagination	nextPage() Go to the next page of the current page
HasPagination	nextPage(boolean silent) Go to the next page of the current page with boolean for notifying listeners or not
HasPagination	onPageChanged(HasPagination.PageChangedCallBack pageChangedCallBack) Adds listener that will be called when a page is changed
HasPagination	previousPage() Go to the previous page of the current page
HasPagination	previousPage(boolean silent) Go to the previous page of the current page with boolean for notifying listeners or not
HasPagination	setPageSize(int pageSize) Sets the page size
HasPagination	updatePages(int pages) Updates the number of pages for this pagination
HasPagination	updatePages(int pages, boolean silent) Updates the number of pages for this pagination
HasPagination	updatePages(int pages, int pageSize) Updates the number of pages and the page size for this pagination
HasPagination	updatePages(int pages, int pageSize, boolean silent) Updates the number of pages and the page size for this pagination
HasPagination	updatePagesByTotalCount(int totalCount) Updates the number of pages by providing the total number of items, the calculation will be based on the page size
HasPagination	updatePagesByTotalCount(int totalCount, boolean silent) Updates the number of pages by providing the total number of items, the calculation will be based on the page size
HasPagination	updatePagesByTotalCount(int totalCount, int pageSize) Updates the number of pages by providing the total number of items and the page size
HasPagination	updatePagesByTotalCount(int totalCount, int pageSize, boolean silent) Updates the number of pages by providing the total number of items and the page size

Method Detail

gotoPage

HasPagination gotoPage(int page)

Go to a specific page number

Parameters:

page - the number of the page

Returns:

same instance

gotoPage

HasPagination gotoPage(int page,
                       boolean silent)

Go to a specific page number with boolean for notifying listeners or not

Parameters:

page - the number of the page

silent - true to not notifying listeners

Returns:

same instance

nextPage

HasPagination nextPage()

Go to the next page of the current page

Returns:

same instance

previousPage

HasPagination previousPage()

Go to the previous page of the current page

Returns:

same instance

nextPage

HasPagination nextPage(boolean silent)

Go to the next page of the current page with boolean for notifying listeners or not

Parameters:

silent - true to not notifying listeners

Returns:

same instance

previousPage

HasPagination previousPage(boolean silent)

Go to the previous page of the current page with boolean for notifying listeners or not

Parameters:

silent - true to not notifying listeners

Returns:

same instance

gotoFirst

HasPagination gotoFirst()

Go to the first page

Returns:

same instance

gotoLast

HasPagination gotoLast()

Go to the last page

Returns:

same instance

gotoFirst

HasPagination gotoFirst(boolean silent)

Go to the first page with boolean for notifying listeners or not

Parameters:

silent - true to not notifying listeners

Returns:

same instance

gotoLast

HasPagination gotoLast(boolean silent)

Go to the last page with boolean for notifying listeners or not

Parameters:

silent - true to not notifying listeners

Returns:

same instance

markActivePage

HasPagination markActivePage()

Marks the current page as active

Returns:

same instance

updatePages

HasPagination updatePages(int pages)

Updates the number of pages for this pagination

Parameters:

pages - the new number of pages

Returns:

same instance

updatePages

HasPagination updatePages(int pages,
                          boolean silent)

Updates the number of pages for this pagination

Parameters:

pages - the new number of pages

silent - boolean flag to switch triggering the callback on/off for this call

Returns:

same instance

updatePages

HasPagination updatePages(int pages,
                          int pageSize)

Updates the number of pages and the page size for this pagination

Parameters:

pages - the new number of pages

pageSize - the new page size

Returns:

same instance

updatePages

HasPagination updatePages(int pages,
                          int pageSize,
                          boolean silent)

Updates the number of pages and the page size for this pagination

Parameters:

pages - the new number of pages

pageSize - the new page size

silent - boolean flag to switch triggering the callback on/off for this call

Returns:

same instance

updatePagesByTotalCount

HasPagination updatePagesByTotalCount(int totalCount)

Updates the number of pages by providing the total number of items, the calculation will be based on the page size

Parameters:

totalCount - the total number of items

Returns:

same instance

updatePagesByTotalCount

HasPagination updatePagesByTotalCount(int totalCount,
                                      boolean silent)

Updates the number of pages by providing the total number of items, the calculation will be based on the page size

Parameters:

totalCount - the total number of items

silent - boolean flag to switch triggering the callback on/off for this call

Returns:

same instance

updatePagesByTotalCount

HasPagination updatePagesByTotalCount(int totalCount,
                                      int pageSize)

Updates the number of pages by providing the total number of items and the page size

Parameters:

totalCount - the total number of items

pageSize - the new page size

Returns:

same instance

updatePagesByTotalCount

HasPagination updatePagesByTotalCount(int totalCount,
                                      int pageSize,
                                      boolean silent)

Updates the number of pages by providing the total number of items and the page size

Parameters:

totalCount - the total number of items

pageSize - the new page size

silent - boolean flag to switch triggering the callback on/off for this call

Returns:

same instance

getTotalCount

int getTotalCount()

Returns:

the total number of items

setPageSize

HasPagination setPageSize(int pageSize)

Sets the page size

Parameters:

pageSize - the page size

Returns:

same instance

getPageSize

int getPageSize()

Returns:

the page size

activePage

int activePage()

Returns:

the active page number

getPagesCount

int getPagesCount()

Returns:

the total number of pages

onPageChanged

HasPagination onPageChanged(HasPagination.PageChangedCallBack pageChangedCallBack)

Adds listener that will be called when a page is changed

Parameters:

pageChangedCallBack - A HasPagination.PageChangedCallBack

Returns:

same instance