com.sencha.gxt.widget.core.client.toolbar

Class PagingToolBar

java.lang.Object

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

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

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.container.Container

com.sencha.gxt.widget.core.client.container.ResizeContainer

com.sencha.gxt.widget.core.client.container.InsertResizeContainer

com.sencha.gxt.widget.core.client.container.BoxLayoutContainer

com.sencha.gxt.widget.core.client.container.HBoxLayoutContainer

com.sencha.gxt.widget.core.client.toolbar.ToolBar

com.sencha.gxt.widget.core.client.toolbar.PagingToolBar

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasEnabled, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, InsertPanel, InsertPanel.ForIsWidget, IsWidget, ProvidesResize, RequiresResize, HasLayout, AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, ContainerHandler.HasContainerHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, OverflowEvent.HasOverflowHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId, Iterable<Widget>

public class PagingToolBar
extends ToolBar

A specialized toolbar that is bound to a PagingLoader and provides automatic paging controls.

The tool bar is "bound" to the loader using the bind(PagingLoader) method.

Enabling & disabling child toolbar items: The paging toolbar setEnable overrides any child toolbar items setEnable. Given the paging toolbar overrides the child toolbar items setEnable, deferring child toolbar enablement is needed after the onload. So when the paging toolbar is enabled the has a child toolbar the items enablement can be overridden by scheduling their enablement. The example below shows an example of scheduling child toolbar item enablement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PagingToolBar.PagingToolBarAppearance
static interface	PagingToolBar.PagingToolBarMessages

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.toolbar.ToolBar

ToolBar.ToolBarAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.container.HBoxLayoutContainer

HBoxLayoutContainer.HBoxLayoutAlign, HBoxLayoutContainer.HBoxLayoutContainerAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.container.BoxLayoutContainer

BoxLayoutContainer.BoxLayoutContainerAppearance, BoxLayoutContainer.BoxLayoutData, BoxLayoutContainer.BoxLayoutPack

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 inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
PagingToolBar(int pageSize) Creates a new paging tool bar.
PagingToolBar(ToolBar.ToolBarAppearance toolBarAppearance, PagingToolBar.PagingToolBarAppearance appearance, int pageSize) Creates a new tool bar.

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(PagingLoader<? extends PagingLoadConfig,?> loader) Binds the toolbar to the loader.
void	clear() Clears the current toolbar text.
void	first() Moves to the first page.
int	getActivePage() Returns the active page.
PagingToolBar.PagingToolBarMessages	getMessages() Returns the toolbar messages.
int	getPageSize() Returns the current page size.
PagingToolBar.PagingToolBarAppearance	getPagingToolbarAppearance() Returns the toolbar appearance.
int	getTotalPages() Returns the total number of pages.
boolean	isButtonsEnabled() Returns true if the paging toolbar buttons are enabled.
boolean	isReuseConfig() Returns true if the previous load config is reused.
boolean	isShowToolTips() Returns true if tooltip are enabled.
void	last() Moves to the last page.
void	next() Moves to the last page.
void	previous() Moves the the previous page.
void	refresh() Refreshes the data using the current configuration.
void	setActivePage(int page) Sets the active page (1 to page count inclusive).
void	setMessages(PagingToolBar.PagingToolBarMessages messages) Sets the toolbar messages.
void	setPageSize(int pageSize) Sets the current page size.
void	setReuseConfig(boolean reuseConfig) True to reuse the previous load config (defaults to true).
void	setShowToolTips(boolean showToolTips) Sets if the button tool tips should be displayed (defaults to true, pre-render).

Methods inherited from class com.sencha.gxt.widget.core.client.toolbar.ToolBar

getAppearance, getHorizontalSpacing, getMinButtonWidth, getVerticalSpacing, setHorizontalSpacing, setMinButtonWidth, setSpacing, setVerticalSpacing

Methods inherited from class com.sencha.gxt.widget.core.client.container.HBoxLayoutContainer

addOverflowHandler, getHBoxLayoutAlign, isEnableOverflow, setEnableOverflow, setHBoxLayoutAlign

Methods inherited from class com.sencha.gxt.widget.core.client.container.BoxLayoutContainer

add, getPack, getPadding, getScrollOffset, insert, isAdjustForFlexRemainder, setAdjustForFlexRemainder, setPack, setPadding, setScrollOffset

Methods inherited from class com.sencha.gxt.widget.core.client.container.InsertResizeContainer

insert, insert

Methods inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

forceLayout, isLayoutRunning, isOrWasLayoutRunning, onResize

Methods inherited from class com.sencha.gxt.widget.core.client.container.Container

add, add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, disable, enable, findWidget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, remove, remove, remove

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disableEvents, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, onBrowserEvent, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

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

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

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

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.InsertPanel

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

Constructor Detail

PagingToolBar

@UiConstructor
public PagingToolBar(int pageSize)

Creates a new paging tool bar.

Parameters:

pageSize - the page size

PagingToolBar

public PagingToolBar(ToolBar.ToolBarAppearance toolBarAppearance,
             PagingToolBar.PagingToolBarAppearance appearance,
             int pageSize)

Creates a new tool bar.

Parameters:

toolBarAppearance - the tool bar appearance

appearance - the paging tool bar appearance

pageSize - the page size

Method Detail

bind

public void bind(PagingLoader<? extends PagingLoadConfig,?> loader)

Binds the toolbar to the loader.

Parameters:

loader - the loader

clear

public void clear()

Clears the current toolbar text.

Specified by:

clear in interface HasWidgets

Overrides:

clear in class Container

first

public void first()

Moves to the first page.

getActivePage

public int getActivePage()

Returns the active page.

Returns:

the active page

getPagingToolbarAppearance

public PagingToolBar.PagingToolBarAppearance getPagingToolbarAppearance()

Returns the toolbar appearance.

Returns:

the appearance

getMessages

public PagingToolBar.PagingToolBarMessages getMessages()

Returns the toolbar messages.

Returns:

the messages

getPageSize

public int getPageSize()

Returns the current page size.

Returns:

the page size

getTotalPages

public int getTotalPages()

Returns the total number of pages.

Returns:

the total pages

isButtonsEnabled

public boolean isButtonsEnabled()

Returns true if the paging toolbar buttons are enabled.

Returns:

the buttons enabled.

isReuseConfig

public boolean isReuseConfig()

Returns true if the previous load config is reused.

Returns:

the reuse config state

isShowToolTips

public boolean isShowToolTips()

Returns true if tooltip are enabled.

Returns:

the show tooltip state

last

public void last()

Moves to the last page.

next

public void next()

Moves to the last page.

previous

public void previous()

Moves the the previous page.

refresh

public void refresh()

Refreshes the data using the current configuration.

setActivePage

public void setActivePage(int page)

Sets the active page (1 to page count inclusive).

Parameters:

page - the page

setMessages

public void setMessages(PagingToolBar.PagingToolBarMessages messages)

Sets the toolbar messages.

Parameters:

messages - the messages

setPageSize

public void setPageSize(int pageSize)

Sets the current page size. This method does not effect the data currently being displayed. The new page size will not be used until the next load request.

Parameters:

pageSize - the new page size

setReuseConfig

public void setReuseConfig(boolean reuseConfig)

True to reuse the previous load config (defaults to true).

Parameters:

reuseConfig - true to reuse the load config

setShowToolTips

public void setShowToolTips(boolean showToolTips)

Sets if the button tool tips should be displayed (defaults to true, pre-render).

Parameters:

showToolTips - true to show tool tips