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

Class AbstractPageable<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.AbstractPageable<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>>, Pageable<T>

public abstract class AbstractPageable<T>
extends AbstractHasPagedDataProvider<T>
implements Pageable<T>

Base implementation for Pageable widgets

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractPageable.RenderCallback

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 boolean	allowRefreshAfterDataChange
protected com.google.gwt.event.shared.HandlerRegistration	dataChangedHandler
protected com.google.gwt.event.shared.HandlerRegistration	dataFilterHandler
protected com.google.gwt.event.shared.HandlerRegistration	loadStoppedHandler
protected com.google.gwt.event.shared.HandlerRegistration	pageLoadedHandler
protected HasPageable<T>	pager
protected DataProvider.DataReader<T>	reader
protected com.google.gwt.event.shared.HandlerRegistration	transactionEndHandler

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractPageable()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(T object)
protected void	addDataProviderHandler()
protected abstract void	clear()
protected abstract void	clearRange(int startRecord)
void	commit()
protected abstract com.google.gwt.user.client.ui.Panel	getContentPanel()
protected abstract DataProvider.DataReader<T>	getDataReader()
protected abstract com.google.gwt.user.client.ui.IsWidget	getPagePanel() Retrieve the panel that will contain all the page data.
int	indexOf(T object)
protected void	initializeAndUpdatePagePanel(boolean forward)
protected abstract com.google.gwt.user.client.ui.IsWidget	initializePagePanel() Creates the panel that will contain all the page data.
protected boolean	isAllowRefreshAfterDataChange()
boolean	isDirty()
void	loadData()
protected void	onTransactionCompleted(boolean commited)
void	refresh()
protected void	refresh(boolean goToFirstPage)
protected void	refreshPage(int startRecord)
void	remove(int index)
protected void	removeDataProviderHandler()
protected void	render(boolean refresh, AbstractPageable.RenderCallback callback)
void	reset()
void	reset(boolean reloadData)
void	rollback()
void	set(int index, T object)
protected void	setAllowRefreshAfterDataChange(boolean allowRefreshAfterDataChange)
void	setHeight(String height)
void	setPager(HasPageable<T> pager) Sets the pager to c

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

checkDataProvider, firstPage, getCurrentPage, getDataProvider, getPageCount, getPageSize, goToPage, hasNextPage, hasPreviousPage, isDataLoaded, lastPage, nextPage, previousPage, setDataProvider, 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, 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 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, setDataProvider

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

asWidget

Field Detail

pager

protected HasPageable<T> pager

reader

protected DataProvider.DataReader<T> reader

allowRefreshAfterDataChange

protected boolean allowRefreshAfterDataChange

pageLoadedHandler

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

loadStoppedHandler

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

transactionEndHandler

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

dataChangedHandler

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

dataFilterHandler

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

Constructor Detail

AbstractPageable

public AbstractPageable()

Method Detail

add

public void add(T object)

clear

protected abstract void clear()

clearRange

protected abstract void clearRange(int startRecord)

commit

public void commit()

getDataReader

protected abstract DataProvider.DataReader<T> getDataReader()

indexOf

public int indexOf(T object)

isAllowRefreshAfterDataChange

protected boolean isAllowRefreshAfterDataChange()

Returns:

true if is allowed to refresh the page after the data provider changes some of their values. This generally happens after a commit.

isDirty

public boolean isDirty()

loadData

public void loadData()

onTransactionCompleted

protected void onTransactionCompleted(boolean commited)

refresh

public void refresh()

refresh

protected void refresh(boolean goToFirstPage)

refreshPage

protected void refreshPage(int startRecord)

remove

public void remove(int index)

render

protected void render(boolean refresh,
          AbstractPageable.RenderCallback callback)

reset

public void reset()

reset

public void reset(boolean reloadData)

rollback

public void rollback()

set

public void set(int index,
       T object)

setAllowRefreshAfterDataChange

protected void setAllowRefreshAfterDataChange(boolean allowRefreshAfterDataChange)

Parameters:

allowRefreshAfterDataChange - indicate if is allowed to refresh the page after the data provider changes some of their values. This generally happens after a commit.

addDataProviderHandler

protected void addDataProviderHandler()

Specified by:

addDataProviderHandler in class AbstractHasPagedDataProvider<T>

removeDataProviderHandler

protected void removeDataProviderHandler()

Specified by:

removeDataProviderHandler in class AbstractHasPagedDataProvider<T>

initializeAndUpdatePagePanel

protected void initializeAndUpdatePagePanel(boolean forward)

initializePagePanel

protected abstract com.google.gwt.user.client.ui.IsWidget initializePagePanel()

Creates the panel that will contain all the page data.

Returns:

getPagePanel

protected abstract com.google.gwt.user.client.ui.IsWidget getPagePanel()

Retrieve the panel that will contain all the page data.

Returns:

setHeight

public void setHeight(String height)

Overrides:

setHeight in class com.google.gwt.user.client.ui.UIObject

setPager

public void setPager(HasPageable<T> pager)

Description copied from interface: Pageable

Sets the pager to c

Specified by:

setPager in interface Pageable<T>

getContentPanel

protected abstract com.google.gwt.user.client.ui.Panel getContentPanel()