org.cruxframework.crux.widgets.client.paging
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.widgets.client.paging.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

Direct Known Subclasses:

NavigationButtonsPager

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

Base implementation for a Pager

Author:

Gesse S. F. Dafe

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

AbstractPager()

Method Summary

com.google.gwt.event.shared.HandlerRegistration	addPageHandler(PageHandler handler)
protected void	checkPageable() If there is no pageable set, throws IllegalStateException
protected void	firstPage() Moves the pageable's cursor to the first page
int	getCurrentPage()
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
protected void	previousPage() Moves the pageable's cursor to the previous page
void	setEnabled(boolean enabled)
void	setPageable(Pageable pageable)
protected abstract void	showLoading() Shows some information to tell user that operation is in progress
void	update(int currentPage, boolean isLastPage)

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

Constructor Detail

AbstractPager

public AbstractPager()

Method Detail

addPageHandler

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

Specified by:

addPageHandler in interface HasPageHandlers

See Also:

HasPageHandlers.addPageHandler(org.cruxframework.crux.widgets.client.event.paging.PageHandler)

update

public void update(int currentPage,
                   boolean isLastPage)

Specified by:

update in interface Pager

See Also:

Pager.update(int, boolean)

onUpdate

protected abstract void onUpdate()

Refreshes the pager

setPageable

public final void setPageable(Pageable pageable)

Specified by:

setPageable in interface Pager

Parameters:

pageable - the pageable to set

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

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 -

checkPageable

protected void checkPageable()

If there is no pageable set, throws IllegalStateException

getCurrentPage

public int getCurrentPage()

Returns:

the currentPage

isLastPage

public boolean isLastPage()

Returns:

the isLastPage

getPageCount

public int getPageCount()

Returns -1 if unknown