com.threerings.gwt.ui

Class PagedWidget<T>

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.FlowPanel

com.threerings.gwt.ui.PagedWidget<T>

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, InsertPanel, InsertPanel.ForIsWidget, IsWidget, Iterable<Widget>

Direct Known Subclasses:

PagedGrid, PagedTable

public abstract class PagedWidget<T>
extends FlowPanel

Displays a paginated collection of UI elements.

Nested Class Summary

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAV_ON_BOTTOM
static int	NAV_ON_TOP

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
PagedWidget(int resultsPerPage)
PagedWidget(int resultsPerPage, int navLoc)

Method Summary

Methods

Modifier and Type	Method and Description
void	displayPage(int page, boolean forceRefresh) Displays the specified page.
DataModel<T>	getModel() Returns the model in use by this panel or null if we have no model.
int	getOffset() Returns the index in the complete list of the first element we're currently displaying.
int	getPage() Returns the page we're currently displaying.
boolean	hasModel() Returns true if this panel is configured with its model.
void	removeItem(T item) Removes the specified item from the panel.
void	setModel(DataModel<T> model, int page) Configures this panel with a DataModel and kicks the data retrieval off by requesting the specified page to be displayed.

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

add, clear, insert, insert

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

getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, remove, remove

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

add, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, fireEvent, getLayoutData, getParent, isAttached, onBrowserEvent, removeFromParent, setLayoutData, sinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

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

getWidget, getWidgetCount, getWidgetIndex, remove

Field Detail

NAV_ON_TOP

public static final int NAV_ON_TOP

See Also:

Constant Field Values

NAV_ON_BOTTOM

public static final int NAV_ON_BOTTOM

See Also:

Constant Field Values

Constructor Detail

PagedWidget

public PagedWidget(int resultsPerPage)

PagedWidget

public PagedWidget(int resultsPerPage,
           int navLoc)

Method Detail

getPage

public int getPage()

Returns the page we're currently displaying.

getOffset

public int getOffset()

Returns the index in the complete list of the first element we're currently displaying.

hasModel

public boolean hasModel()

Returns true if this panel is configured with its model.

setModel

public void setModel(DataModel<T> model,
            int page)

Configures this panel with a DataModel and kicks the data retrieval off by requesting the specified page to be displayed.

getModel

public DataModel<T> getModel()

Returns the model in use by this panel or null if we have no model.

displayPage

public void displayPage(int page,
               boolean forceRefresh)

Displays the specified page. Does nothing if we are already displaying that page unless forceRefresh is true.

removeItem

public void removeItem(T item)

Removes the specified item from the panel. If the item is currently being displayed, its interface element will be removed as well.