com.github.gwtbootstrap.client.ui

Class SimplePager

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.google.gwt.user.cellview.client.AbstractPager

com.github.gwtbootstrap.client.ui.SimplePager

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsRenderable, IsWidget

public class SimplePager
extends AbstractPager

A pager for controlling a HasRows that only supports simple page navigation.

Example

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimplePager.ImageButtonsConstants Constant for labeling the simple pager navigational ImageButtons
static interface	SimplePager.Resources A ClientBundle that provides styles for this widget.
static class	SimplePager.TextLocation The location of the text relative to the paging buttons.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
SimplePager() Construct a SimplePager with the default text location.
SimplePager(SimplePager.TextLocation location) Construct a SimplePager with the specified text location.
SimplePager(SimplePager.TextLocation location, boolean showFastForwardButton, boolean showLastPageButton) Construct a SimplePager with the default resources, fast forward rows and default image button names.
SimplePager(SimplePager.TextLocation location, boolean showFastForwardButton, int fastForwardRows, boolean showLastPageButton) Construct a SimplePager with the default resources and default image button names.
SimplePager(SimplePager.TextLocation location, SimplePager.Resources resources, boolean showFastForwardButton, int fastForwardRows, boolean showLastPageButton) Construct a SimplePager with the specified resources and default image button names.
SimplePager(SimplePager.TextLocation location, SimplePager.Resources resources, boolean showFastForwardButton, int fastForwardRows, boolean showLastPageButton, SimplePager.ImageButtonsConstants imageButtonConstants) Construct a SimplePager with the specified resources.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createText() Get the text to display in the pager that reflects the state of the pager.
void	firstPage()
int	getFastForwardRows()
int	getPage()
int	getPageCount()
boolean	hasNextPage()
boolean	hasNextPages(int pages)
boolean	hasPage(int index)
boolean	hasPreviousPage()
boolean	hasPreviousPages(int pages)
void	lastPage()
void	lastPageStart()
void	nextPage()
protected void	onRangeOrRowCountChanged()
void	previousPage()
void	setDisplay(HasRows display)
void	setFastForwardRows(int fastForwardRows)
void	setPage(int index)
void	setPageSize(int pageSize)
void	setPageStart(int index)
void	startLoading() Let the page know that the table is loading.

Methods inherited from class com.google.gwt.user.cellview.client.AbstractPager

getDisplay, getPageSize, getPageStart, isRangeLimited, setRangeLimited

Methods inherited from class com.google.gwt.user.client.ui.Composite

getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, performDetachedInitialization, render, render, resolvePotentialElement, setWidget, wrapElement

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimplePager

public SimplePager()

Construct a SimplePager with the default text location.

SimplePager

@UiConstructor
public SimplePager(SimplePager.TextLocation location)

Construct a SimplePager with the specified text location.

Parameters:

location - the location of the text relative to the buttons

SimplePager

public SimplePager(SimplePager.TextLocation location,
           boolean showFastForwardButton,
           boolean showLastPageButton)

Construct a SimplePager with the default resources, fast forward rows and default image button names.

Parameters:

location - the location of the text relative to the buttons

showFastForwardButton - if true, show a fast-forward button that advances by a larger increment than a single page

showLastPageButton - if true, show a button to go the the last page

SimplePager

public SimplePager(SimplePager.TextLocation location,
           boolean showFastForwardButton,
           int fastForwardRows,
           boolean showLastPageButton)

Construct a SimplePager with the default resources and default image button names.

Parameters:

location - the location of the text relative to the buttons

showFastForwardButton - if true, show a fast-forward button that advances by a larger increment than a single page

fastForwardRows - the number of rows to jump when fast forwarding

showLastPageButton - if true, show a button to go the the last page

SimplePager

public SimplePager(SimplePager.TextLocation location,
           SimplePager.Resources resources,
           boolean showFastForwardButton,
           int fastForwardRows,
           boolean showLastPageButton,
           SimplePager.ImageButtonsConstants imageButtonConstants)

Construct a SimplePager with the specified resources.

Parameters:

location - the location of the text relative to the buttons

resources - the SimplePager.Resources to use

showFastForwardButton - if true, show a fast-forward button that advances by a larger increment than a single page

fastForwardRows - the number of rows to jump when fast forwarding

showLastPageButton - if true, show a button to go the the last page

imageButtonConstants - Constants that contain the image button names

SimplePager

public SimplePager(SimplePager.TextLocation location,
           SimplePager.Resources resources,
           boolean showFastForwardButton,
           int fastForwardRows,
           boolean showLastPageButton)

Construct a SimplePager with the specified resources and default image button names.

Parameters:

location - the location of the text relative to the buttons

resources - the SimplePager.Resources to use

showFastForwardButton - if true, show a fast-forward button that advances by a larger increment than a single page

fastForwardRows - the number of rows to jump when fast forwarding

showLastPageButton - if true, show a button to go the the last page

Method Detail

firstPage

public void firstPage()

Overrides:

firstPage in class AbstractPager

getPage

public int getPage()

Overrides:

getPage in class AbstractPager

getPageCount

public int getPageCount()

Overrides:

getPageCount in class AbstractPager

hasNextPage

public boolean hasNextPage()

Overrides:

hasNextPage in class AbstractPager

hasNextPages

public boolean hasNextPages(int pages)

Overrides:

hasNextPages in class AbstractPager

hasPage

public boolean hasPage(int index)

Overrides:

hasPage in class AbstractPager

hasPreviousPage

public boolean hasPreviousPage()

Overrides:

hasPreviousPage in class AbstractPager

hasPreviousPages

public boolean hasPreviousPages(int pages)

Overrides:

hasPreviousPages in class AbstractPager

lastPage

public void lastPage()

Overrides:

lastPage in class AbstractPager

lastPageStart

public void lastPageStart()

Overrides:

lastPageStart in class AbstractPager

nextPage

public void nextPage()

Overrides:

nextPage in class AbstractPager

previousPage

public void previousPage()

Overrides:

previousPage in class AbstractPager

setDisplay

public void setDisplay(HasRows display)

Overrides:

setDisplay in class AbstractPager

setPage

public void setPage(int index)

Overrides:

setPage in class AbstractPager

setPageSize

public void setPageSize(int pageSize)

Overrides:

setPageSize in class AbstractPager

setPageStart

public void setPageStart(int index)

Overrides:

setPageStart in class AbstractPager

startLoading

public void startLoading()

Let the page know that the table is loading. Call this method to clear all data from the table and hide the current range when new data is being loaded into the table.

createText

protected String createText()

Get the text to display in the pager that reflects the state of the pager.

Returns:

the text

onRangeOrRowCountChanged

protected void onRangeOrRowCountChanged()

Specified by:

onRangeOrRowCountChanged in class AbstractPager

getFastForwardRows

public int getFastForwardRows()

setFastForwardRows

public void setFastForwardRows(int fastForwardRows)