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

Class AbstractPager

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

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

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, HasPageHandlers, Pager

public abstract class AbstractPager
extends com.google.gwt.user.client.ui.Composite
implements Pager

Base implementation for a Pager

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DISABLED

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractPager()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addPageHandler(PageHandler handler)
protected void	checkPageable() If there is no pageable set, raises an error
protected void	firstPage() Moves the pageable's cursor to the first page
int	getCurrentPage()
<T extends PagedDataProvider<?>> Pageable<T>	getPageable() Retrieves the bound pageable
int	getPageCount() Returns -1 if unknown
protected void	goToPage(int page) Moves the pageable's cursor to the an arbitrary page
protected abstract void	hideLoading() Hides the loading information
boolean	isEnabled()
boolean	isLastPage()
protected void	lastPage() Moves the pageable's cursor to the last page
protected void	nextPage() Moves the pageable's cursor to the next page
protected abstract void	onUpdate() Refreshes the pager
void	prepareTransaction(int startRecord) Allow the pager to prepare itself for a new transaction, starting on the given record
protected void	previousPage() Moves the pageable's cursor to the previous page
void	setEnabled(boolean enabled)
void	setPageable(Pageable<?> pageable) Bind this pager to a Pageable widget
protected abstract void	showLoading() Shows some information to tell user that operation is in progress
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 class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

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

asWidget

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

fireEvent

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

isVisible, setVisible

Field Detail

DISABLED

protected static final String DISABLED

See Also:

Constant Field Values

Constructor Detail

AbstractPager

public AbstractPager()

Method Detail

addPageHandler

public com.google.gwt.event.shared.HandlerRegistration addPageHandler(PageHandler handler)

Specified by:

addPageHandler in interface HasPageHandlers

update

public void update(int currentPage,
          boolean isLastPage)

Description copied from interface: Pager

Update the pager after a page navigation on pageable DataProvider.

Specified by:

update in interface Pager

Parameters:

currentPage - current page on DataProvider

isLastPage - true if this is the last page

supportsInfiniteScroll

public boolean supportsInfiniteScroll()

Description copied from interface: Pager

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.

Specified by:

supportsInfiniteScroll in interface Pager

Returns:

true if infinite scroll is supported

prepareTransaction

public void prepareTransaction(int startRecord)

Description copied from interface: Pager

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

Specified by:

prepareTransaction in interface Pager

Parameters:

startRecord - first record on the transaction

setPageable

public void setPageable(Pageable<?> pageable)

Description copied from interface: Pager

Bind this pager to a Pageable widget

Specified by:

setPageable in interface Pager

Parameters:

pageable - the pageable to set

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Returns:

the enabled

setEnabled

public final void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Parameters:

enabled -

getPageable

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

Description copied from interface: Pager

Retrieves the bound pageable

Specified by:

getPageable in interface Pager

Returns:

the pageable

getCurrentPage

public int getCurrentPage()

Returns:

the currentPage

isLastPage

public boolean isLastPage()

Returns:

the isLastPage

getPageCount

public int getPageCount()

Returns -1 if unknown

checkPageable

protected void checkPageable()

If there is no pageable set, raises an error

previousPage

protected void previousPage()

Moves the pageable's cursor to the previous page

nextPage

protected void nextPage()

Moves the pageable's cursor to the next page

firstPage

protected void firstPage()

Moves the pageable's cursor to the first page

lastPage

protected void lastPage()

Moves the pageable's cursor to the last page

goToPage

protected void goToPage(int page)

Moves the pageable's cursor to the an arbitrary page

showLoading

protected abstract void showLoading()

Shows some information to tell user that operation is in progress

hideLoading

protected abstract void hideLoading()

Hides the loading information

onUpdate

protected abstract void onUpdate()

Refreshes the pager