com.extjs.gxt.ui.client.widget.toolbar
Class PagingToolBar

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Container<Component>
                      extended by com.extjs.gxt.ui.client.widget.toolbar.ToolBar
                          extended by com.extjs.gxt.ui.client.widget.toolbar.PagingToolBar
All Implemented Interfaces:
Observable, 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.IsWidget

public class PagingToolBar
extends ToolBar

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

Inherited Events:
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState


Nested Class Summary
static class PagingToolBar.PagingToolBarImages
          PagingToolBar images.
static class PagingToolBar.PagingToolBarMessages
          PagingToolBar messages.
 
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
protected  int activePage
           
protected  LabelToolItem afterText
           
protected  LabelToolItem beforePage
           
protected  PagingLoadConfig config
           
protected  LabelToolItem displayText
           
protected  Button first
           
protected  PagingToolBar.PagingToolBarImages images
           
protected  Button last
           
protected  Listener<ComponentEvent> listener
           
protected  PagingLoader<?> loader
           
protected  LoadListener loadListener
           
protected  PagingToolBar.PagingToolBarMessages msgs
           
protected  Button next
           
protected  int pages
           
protected  int pageSize
           
protected  com.google.gwt.user.client.ui.TextBox pageText
           
protected  Button prev
           
protected  Button refresh
           
protected  boolean showToolTips
           
protected  int start
           
protected  int totalLength
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
PagingToolBar(int pageSize)
          Creates a new paging tool bar with the given page size.
 
Method Summary
 void bind(PagingLoader<?> loader)
          Binds the toolbar to the loader.
 void clear()
          Clears the current toolbar text.
protected  void doLoadRequest(int offset, int limit)
           
 void first()
          Moves to the first page.
 int getActivePage()
          Returns the active page.
 PagingToolBar.PagingToolBarImages getImages()
           
 PagingToolBar.PagingToolBarMessages getMessages()
          Returns the tool bar's messages.
 int getPageSize()
          Returns the current page size.
 int getTotalPages()
          Returns the total number of pages.
 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.
protected  void onLoad(LoadEvent event)
           
protected  void onPageChange()
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 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 setImages(PagingToolBar.PagingToolBarImages images)
           
 void setMessages(PagingToolBar.PagingToolBarMessages messages)
          Sets the tool bar's 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.extjs.gxt.ui.client.widget.toolbar.ToolBar
add, createComponentEvent, createContainerEvent, getAlignment, getLayout, getMinButtonWidth, getSpacing, insert, isEnableOverflow, layout, onComponentEvent, onFocus, remove, setAlignment, setEnableOverflow, setMinButtonWidth, setSpacing
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
adjustIndex, adopt, disable, doAttachChildren, doDetachChildren, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getLayoutTarget, getWidget, indexOf, isLayoutNeeded, iterator, layout, notifyHide, notifyShow, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, removeAll, removeAll, scrollIntoView, setLayout, setLayoutNeeded, setLayoutOnChange, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, afterRender, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, onDetach, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

activePage

protected int activePage

pages

protected int pages

afterText

protected LabelToolItem afterText

beforePage

protected LabelToolItem beforePage

config

protected PagingLoadConfig config

displayText

protected LabelToolItem displayText

first

protected Button first

prev

protected Button prev

next

protected Button next

last

protected Button last

refresh

protected Button refresh

images

protected PagingToolBar.PagingToolBarImages images

listener

protected Listener<ComponentEvent> listener

loader

protected PagingLoader<?> loader

loadListener

protected LoadListener loadListener

msgs

protected PagingToolBar.PagingToolBarMessages msgs

pageText

protected com.google.gwt.user.client.ui.TextBox pageText

showToolTips

protected boolean showToolTips

start

protected int start

pageSize

protected int pageSize

totalLength

protected int totalLength
Constructor Detail

PagingToolBar

public PagingToolBar(int pageSize)
Creates a new paging tool bar with the given page size.

Parameters:
pageSize - the page size
Method Detail

bind

public void bind(PagingLoader<?> loader)
Binds the toolbar to the loader.

Parameters:
loader - the loader

clear

public void clear()
Clears the current toolbar text.


first

public void first()
Moves to the first page.


getActivePage

public int getActivePage()
Returns the active page.

Returns:
the active page

getImages

public PagingToolBar.PagingToolBarImages getImages()

getMessages

public PagingToolBar.PagingToolBarMessages getMessages()
Returns the tool bar's 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

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

setImages

public void setImages(PagingToolBar.PagingToolBarImages images)

setMessages

public void setMessages(PagingToolBar.PagingToolBarMessages messages)
Sets the tool bar's 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

doLoadRequest

protected void doLoadRequest(int offset,
                             int limit)

onLoad

protected void onLoad(LoadEvent event)

onPageChange

protected void onPageChange()

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class ToolBar
Parameters:
target - the target element
index - the insert location