org.cruxframework.crux.core.client.dataprovider.pager

Interface Pager

All Superinterfaces:

com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.event.shared.HasHandlers, HasPageHandlers, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

All Known Implementing Classes:

AbstractPager

public interface Pager
extends com.google.gwt.user.client.ui.IsWidget, HasPageHandlers, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasEnabled

A pager is a component to navigate on pages of a Pageable widget.

Author:

Thiago da Rosa de Bustamante

Method Summary

Methods

Modifier and Type	Method and Description
<T extends PagedDataProvider<?>> Pageable<T>	getPageable() Retrieves the bound pageable
void	prepareTransaction(int startRecord) Allow the pager to prepare itself for a new transaction, starting on the given record
void	setPageable(Pageable<?> pageable) Bind this pager to a Pageable widget
boolean	supportsInfiniteScroll() Inform if the pager supports that multiple pages are rendered into the pageable widget.
void	update(int currentPage, boolean isLastPage) Update the pager after a page navigation on pageable DataProvider.

Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

asWidget

Methods inherited from interface org.cruxframework.crux.core.client.dataprovider.pager.HasPageHandlers

addPageHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.HasVisibility

isVisible, setVisible

Methods inherited from interface com.google.gwt.user.client.ui.HasEnabled

isEnabled, setEnabled

Method Detail

update

void update(int currentPage,
          boolean isLastPage)

Update the pager after a page navigation on pageable DataProvider.

Parameters:

currentPage - current page on DataProvider

isLastPage - true if this is the last page

setPageable

void setPageable(Pageable<?> pageable)

Bind this pager to a Pageable widget

Parameters:

pageable -

getPageable

<T extends PagedDataProvider<?>> Pageable<T> getPageable()

Retrieves the bound pageable

Returns:

the pageable bound to this pager

supportsInfiniteScroll

boolean supportsInfiniteScroll()

Inform if the pager supports that multiple pages are rendered into the pageable widget. If this method returns false, the pageable widget will first clear its content panel before render any new page data. If it return true, this panel will not be cleared, allowing infinit scrolling.

Returns:

true if infinite scroll is supported

prepareTransaction

void prepareTransaction(int startRecord)

Allow the pager to prepare itself for a new transaction, starting on the given record

Parameters:

startRecord - first record on the transaction