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

Class AbstractPager<T>

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.AbstractHasPagedDataProvider<T>

org.cruxframework.crux.core.client.dataprovider.pager.AbstractPager<T>

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, HasDataProvider<PagedDataProvider<T>>, HasPagedDataProvider<PagedDataProvider<T>>, HasPageHandlers, Pager<T>

public abstract class AbstractPager<T>
extends AbstractHasPagedDataProvider<T>
implements Pager<T>

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 com.google.gwt.event.shared.HandlerRegistration	dataChangedHandler
protected com.google.gwt.event.shared.HandlerRegistration	dataFilterHandler
protected static String	DISABLED
protected boolean	enabled
protected com.google.gwt.event.shared.HandlerRegistration	loadStoppedHandler
protected com.google.gwt.event.shared.HandlerRegistration	pageLoadedHandler
protected com.google.gwt.event.shared.HandlerRegistration	pageRequestedHandler
protected com.google.gwt.event.shared.HandlerRegistration	resetHandler
protected com.google.gwt.event.shared.HandlerRegistration	transactionEndHandler
protected boolean	transactionRunning
protected com.google.gwt.event.shared.HandlerRegistration	transactionStartHandler

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
protected void	addDataProviderHandler()
com.google.gwt.event.shared.HandlerRegistration	addPageHandler(PageHandler handler)
protected abstract void	hideLoading() Hides the loading information
boolean	isEnabled()
protected boolean	isInteractionEnabled()
protected void	onTransactionCompleted(boolean commited)
protected void	onTransactionStarted(int startRecord)
protected abstract void	onUpdate() Refreshes the pager
protected void	removeDataProviderHandler()
void	setDataProvider(PagedDataProvider<T> dataProvider, boolean autoLoadData) Bind a dataProvider to this component
void	setEnabled(boolean enabled)
protected void	setInteractionEnabled(boolean enabled)
protected abstract void	showLoading() Shows some information to tell user that operation is in progress

Methods inherited from class org.cruxframework.crux.core.client.dataprovider.AbstractHasPagedDataProvider

checkDataProvider, firstPage, getCurrentPage, getDataProvider, getPageCount, getPageSize, goToPage, hasNextPage, hasPreviousPage, isDataLoaded, lastPage, nextPage, previousPage, setPageSize

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 org.cruxframework.crux.core.client.dataprovider.HasPagedDataProvider

firstPage, getCurrentPage, getPageCount, getPageSize, goToPage, hasNextPage, hasPreviousPage, isDataLoaded, lastPage, nextPage, previousPage, setPageSize

Methods inherited from interface org.cruxframework.crux.core.client.dataprovider.HasDataProvider

getDataProvider

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

enabled

protected boolean enabled

transactionRunning

protected boolean transactionRunning

transactionEndHandler

protected com.google.gwt.event.shared.HandlerRegistration transactionEndHandler

transactionStartHandler

protected com.google.gwt.event.shared.HandlerRegistration transactionStartHandler

loadStoppedHandler

protected com.google.gwt.event.shared.HandlerRegistration loadStoppedHandler

dataChangedHandler

protected com.google.gwt.event.shared.HandlerRegistration dataChangedHandler

dataFilterHandler

protected com.google.gwt.event.shared.HandlerRegistration dataFilterHandler

pageLoadedHandler

protected com.google.gwt.event.shared.HandlerRegistration pageLoadedHandler

pageRequestedHandler

protected com.google.gwt.event.shared.HandlerRegistration pageRequestedHandler

resetHandler

protected com.google.gwt.event.shared.HandlerRegistration resetHandler

Constructor Detail

AbstractPager

public AbstractPager()

Method Detail

addPageHandler

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

Specified by:

addPageHandler in interface HasPageHandlers

isEnabled

public boolean isEnabled()

Specified by:

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

Returns:

the enabled

setEnabled

public void setEnabled(boolean enabled)

Specified by:

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

Parameters:

enabled -

setDataProvider

public void setDataProvider(PagedDataProvider<T> dataProvider,
                   boolean autoLoadData)

Description copied from interface: HasDataProvider

Bind a dataProvider to this component

Specified by:

setDataProvider in interface HasDataProvider<PagedDataProvider<T>>

Overrides:

setDataProvider in class AbstractHasPagedDataProvider<T>

Parameters:

dataProvider - dataProvider to use

autoLoadData - if true fire the dataProvider load event.

addDataProviderHandler

protected void addDataProviderHandler()

Specified by:

addDataProviderHandler in class AbstractHasPagedDataProvider<T>

removeDataProviderHandler

protected void removeDataProviderHandler()

Specified by:

removeDataProviderHandler in class AbstractHasPagedDataProvider<T>

isInteractionEnabled

protected boolean isInteractionEnabled()

onTransactionCompleted

protected void onTransactionCompleted(boolean commited)

onTransactionStarted

protected void onTransactionStarted(int startRecord)

setInteractionEnabled

protected void setInteractionEnabled(boolean enabled)

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