org.cruxframework.crux.core.client.dataprovider

Class AbstractHasPagedDataProvider<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>

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.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, HasDataProvider<PagedDataProvider<T>>, HasPagedDataProvider<PagedDataProvider<T>>

Direct Known Subclasses:

AbstractPageable, AbstractPager

public abstract class AbstractHasPagedDataProvider<T>
extends com.google.gwt.user.client.ui.Composite
implements HasPagedDataProvider<PagedDataProvider<T>>

Author:

thiago

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 inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractHasPagedDataProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addDataProviderHandler()
protected void	checkDataProvider() If there is no dataProvider set, raises an error
void	firstPage() Moves the dataProvider's cursor to the first page
int	getCurrentPage()
PagedDataProvider<T>	getDataProvider() Retrieve the dataProvider bound to this component
int	getPageCount() Return the total number of pages
int	getPageSize() Retrieve the page size of the dataProvider
void	goToPage(int page) Moves the dataProvider's cursor to an arbitrary page
boolean	hasNextPage()
boolean	hasPreviousPage()
boolean	isDataLoaded() Checks if dataProvider data is already available
void	lastPage() Moves the dataProvider's cursor to the last page
void	nextPage() Moves the dataProvider's cursor to the next page
void	previousPage() Moves the dataProvider's cursor to the previous page
protected abstract void	removeDataProviderHandler()
void	setDataProvider(PagedDataProvider<T> dataProvider, boolean autoLoadData) Bind a dataProvider to this component
void	setPageSize(int pageSize) Set the page size of the 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

Constructor Detail

AbstractHasPagedDataProvider

public AbstractHasPagedDataProvider()

Method Detail

getDataProvider

public PagedDataProvider<T> getDataProvider()

Description copied from interface: HasDataProvider

Retrieve the dataProvider bound to this component

Specified by:

getDataProvider in interface HasDataProvider<PagedDataProvider<T>>

Returns:

the dataProvider

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>>

Parameters:

dataProvider - dataProvider to use

autoLoadData - if true fire the dataProvider load event.

isDataLoaded

public boolean isDataLoaded()

Description copied from interface: HasPagedDataProvider

Checks if dataProvider data is already available

Specified by:

isDataLoaded in interface HasPagedDataProvider<PagedDataProvider<T>>

nextPage

public void nextPage()

Description copied from interface: HasPagedDataProvider

Moves the dataProvider's cursor to the next page

Specified by:

nextPage in interface HasPagedDataProvider<PagedDataProvider<T>>

setPageSize

public void setPageSize(int pageSize)

Description copied from interface: HasPagedDataProvider

Set the page size of the dataProvider

Specified by:

setPageSize in interface HasPagedDataProvider<PagedDataProvider<T>>

Parameters:

pageSize - page size

getPageSize

public int getPageSize()

Description copied from interface: HasPagedDataProvider

Retrieve the page size of the dataProvider

Specified by:

getPageSize in interface HasPagedDataProvider<PagedDataProvider<T>>

Returns:

page size

goToPage

public void goToPage(int page)

Description copied from interface: HasPagedDataProvider

Moves the dataProvider's cursor to an arbitrary page

Specified by:

goToPage in interface HasPagedDataProvider<PagedDataProvider<T>>

Parameters:

page - page number

getPageCount

public int getPageCount()

Description copied from interface: HasPagedDataProvider

Return the total number of pages

Specified by:

getPageCount in interface HasPagedDataProvider<PagedDataProvider<T>>

Returns:

number of pages, -1 if unknown.

previousPage

public void previousPage()

Description copied from interface: HasPagedDataProvider

Moves the dataProvider's cursor to the previous page

Specified by:

previousPage in interface HasPagedDataProvider<PagedDataProvider<T>>

getCurrentPage

public int getCurrentPage()

Specified by:

getCurrentPage in interface HasPagedDataProvider<PagedDataProvider<T>>

Returns:

the currentPage

hasNextPage

public boolean hasNextPage()

Specified by:

hasNextPage in interface HasPagedDataProvider<PagedDataProvider<T>>

Returns:

true if has more pages

hasPreviousPage

public boolean hasPreviousPage()

Specified by:

hasPreviousPage in interface HasPagedDataProvider<PagedDataProvider<T>>

Returns:

true if has previous pages

firstPage

public void firstPage()

Description copied from interface: HasPagedDataProvider

Moves the dataProvider's cursor to the first page

Specified by:

firstPage in interface HasPagedDataProvider<PagedDataProvider<T>>

lastPage

public void lastPage()

Description copied from interface: HasPagedDataProvider

Moves the dataProvider's cursor to the last page

Specified by:

lastPage in interface HasPagedDataProvider<PagedDataProvider<T>>

addDataProviderHandler

protected abstract void addDataProviderHandler()

removeDataProviderHandler

protected abstract void removeDataProviderHandler()

checkDataProvider

protected void checkDataProvider()

If there is no dataProvider set, raises an error