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

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

Base implementation for Pageable widgets

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractPageable.Renderer<T> Define a renderer, called when a record from DataProvider needs to be rendered by this widget

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 PagedDataProvider<T>	dataProvider
protected Pager	pager
protected int	pageSize
protected AbstractPageable.Renderer<T>	renderer

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 abstract void	clear()
protected abstract void	clearRange(int startRecord)
void	commit()
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 this pageable widget
protected abstract AbstractPageable.Renderer<T>	getRenderer()
void	goToPage(int page) Moves the pageable's cursor to an arbitrary page
int	indexOf(T object)
boolean	isDataLoaded() Checks if pageable data is already available
boolean	isDirty()
void	loadData()
void	nextPage() Moves the pageable's cursor to the next page
protected void	onTransactionCompleted(boolean commited)
protected void	onTransactionStarted(int startRecord)
void	previousPage() Moves the pageable's cursor to the previous page
void	refresh()
protected void	refresh(boolean clearPreviousData)
protected void	refreshPage(int startRecord)
void	remove(int index)
protected void	render(boolean refresh)
void	reset()
void	reset(boolean reloadData)
void	rollback()
void	set(int index, T object)
void	setDataProvider(PagedDataProvider<T> dataProvider, boolean autoLoadData) Bind a dataProvider to this component
void	setPager(Pager pager) Sets the pager for call back
void	setPageSize(int pageSize) Set the page size of this pageable widget
protected void	updatePager()
protected void	updatePagerState()

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

Field Detail

pager

protected Pager pager

dataProvider

protected PagedDataProvider<T> dataProvider

pageSize

protected int pageSize

renderer

protected AbstractPageable.Renderer<T> renderer

Constructor Detail

AbstractPageable

public AbstractPageable()

Method Detail

getPageSize

public int getPageSize()

Description copied from interface: Pageable

Retrieve the page size of this pageable widget

Specified by:

getPageSize in interface Pageable<PagedDataProvider<T>>

Returns:

page size

setPageSize

public void setPageSize(int pageSize)

Description copied from interface: Pageable

Set the page size of this pageable widget

Specified by:

setPageSize in interface Pageable<PagedDataProvider<T>>

Parameters:

pageSize - page size

nextPage

public void nextPage()

Description copied from interface: Pageable

Moves the pageable's cursor to the next page

Specified by:

nextPage in interface Pageable<PagedDataProvider<T>>

previousPage

public void previousPage()

Description copied from interface: Pageable

Moves the pageable's cursor to the previous page

Specified by:

previousPage in interface Pageable<PagedDataProvider<T>>

getPageCount

public int getPageCount()

Description copied from interface: Pageable

Return the total number of pages

Specified by:

getPageCount in interface Pageable<PagedDataProvider<T>>

Returns:

number of pages, -1 if unknown.

setPager

public void setPager(Pager pager)

Description copied from interface: Pageable

Sets the pager for call back

Specified by:

setPager in interface Pageable<PagedDataProvider<T>>

goToPage

public void goToPage(int page)

Description copied from interface: Pageable

Moves the pageable's cursor to an arbitrary page

Specified by:

goToPage in interface Pageable<PagedDataProvider<T>>

Parameters:

page - page number

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.

loadData

public void loadData()

isDirty

public boolean isDirty()

add

public void add(T object)

remove

public void remove(int index)

set

public void set(int index,
       T object)

indexOf

public int indexOf(T object)

commit

public void commit()

rollback

public void rollback()

isDataLoaded

public boolean isDataLoaded()

Description copied from interface: Pageable

Checks if pageable data is already available

Specified by:

isDataLoaded in interface Pageable<PagedDataProvider<T>>

reset

public void reset()

reset

public void reset(boolean reloadData)

refresh

public void refresh()

refresh

protected void refresh(boolean clearPreviousData)

refreshPage

protected void refreshPage(int startRecord)

clearRange

protected abstract void clearRange(int startRecord)

clear

protected abstract void clear()

onTransactionCompleted

protected void onTransactionCompleted(boolean commited)

onTransactionStarted

protected void onTransactionStarted(int startRecord)

render

protected void render(boolean refresh)

updatePager

protected void updatePager()

updatePagerState

protected void updatePagerState()

getRenderer

protected abstract AbstractPageable.Renderer<T> getRenderer()