com.sptci.echo.table

Class TableNavigation

java.lang.Object

nextapp.echo.app.Component

nextapp.echo.app.Row

com.sptci.echo.table.TableNavigation

All Implemented Interfaces:

Serializable, RenderIdSupport

public class TableNavigation
extends Row

A navigation component for displaying paging controls for a Table.

The following shows sample localisation of this class:

   com.sptci.echo.table.TableNavigation.resultsPerPage.options 10,25,50,100
   com.sptci.echo.table.TableNavigation.page.label         Page
   com.sptci.echo.table.TableNavigation.pageCount.label    of
   com.sptci.echo.table.TableNavigation.FirstPage.text     First
   com.sptci.echo.table.TableNavigation.FirstPage.tooltip  Go to first page
 

© Copyright 2007 Sans Pareil Technologies, Inc.

Version:

$Id: TableNavigation.java 4951 2010-03-10 20:33:37Z rakesh $

Author:

Rakesh 2007-10-05

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TableNavigation.FirstListener The ActionListener for events triggered by the button to go to the first page.
protected class	TableNavigation.LastListener The ActionListener used to control the navigation to the last available page.
protected class	TableNavigation.NextListener The ActionListener for the control used to navigation to the next page of data.
protected class	TableNavigation.PageSelectListener The ActionListener for events fired by the page select component.
protected class	TableNavigation.PreviousListener The ActionListener for the control used to navigate to the previous page.
protected class	TableNavigation.RowsPerPageListener The ActionListener used to control the number or rows displayed per page.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMUM_PAGE_SIZE The minimum number of rows to hold in a page.

Fields inherited from class nextapp.echo.app.Row

PROPERTY_ALIGNMENT, PROPERTY_BORDER, PROPERTY_CELL_SPACING, PROPERTY_INSETS

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

Constructors

Constructor and Description
TableNavigation(Table table) Create a new instance of the navigation component using the specified table component.

Method Summary

Modifier and Type	Method and Description
protected void	clearSelection() Clear the current selections in the table selection model.
protected void	doLayout()
protected Button	getButton(String name) Create the button used to control navigation among the pages.
protected ActionListener	getListener(String name) Return the ActionListener to use for the specified name.
PageableTableModel	getModel() Return the model backing this navigation component.
protected Label	getPageCountLabel() Create the label used to display the page count indicator to user.
protected Label	getPageLabel() Create the label used to display the page indicator to user.
protected SelectField	getPageSelect() Create a SelectField that displays all the pages of data that are viewable by the user.
protected Label	getResultsPerPageLabel() Create the label used to display the component used to control the number of items displayed on a page.
protected SelectField	getResultsPerPageSelect() Create a SelectField that displays the options for displaying number of rows on a page.
void	init() Re-initialises all the controls for this component.
protected void	reset() Reset the display of this component.
void	setCurrentPage(int page) Set the page that is to be displayed.
protected void	setDisplayedPage(int page) Set the page that is to be displayed.

Methods inherited from class nextapp.echo.app.Row

getAlignment, getBorder, getCellSpacing, getInsets, setAlignment, setBorder, setCellSpacing, setInsets

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_PAGE_SIZE

public static final int MINIMUM_PAGE_SIZE

The minimum number of rows to hold in a page.

Constructor Detail

TableNavigation

public TableNavigation(Table table)
                throws ClassCastException

Create a new instance of the navigation component using the specified table component.

Parameters:

table - The table with which this navigation component is associated.

Throws:

ClassCastException - If the table model associated with the specified table is not an instance of PageableTableModel

Method Detail

init

public void init()

Re-initialises all the controls for this component.

Overrides:

init in class Component

See Also:

Component.init(), reset()

doLayout

protected void doLayout()

See Also:

getButton(java.lang.String), getResultsPerPageSelect(), getPageLabel(), getPageSelect(), getPageCountLabel()

reset

protected void reset()

Reset the display of this component. Removes and readds all the controls.

See Also:

Component.removeAll(), clearSelection(), doLayout()

clearSelection

protected void clearSelection()

Clear the current selections in the table selection model. Preserving selection leads to issues when navigating to another page.

getModel

public PageableTableModel getModel()

Return the model backing this navigation component.

Returns:

The model used to back the navigation component.

setCurrentPage

public void setCurrentPage(int page)

Set the page that is to be displayed. Updates the model to display the specified page of data.

Parameters:

page - The number of the page that is to be displayed.

See Also:

setDisplayedPage(int)

setDisplayedPage

protected void setDisplayedPage(int page)

Set the page that is to be displayed. Does not update the model. Updates only the value selected in pageSelect.

Parameters:

page - The number of the page that is to be displayed.

Since:

2007-11-14

getPageSelect

protected SelectField getPageSelect()

Create a SelectField that displays all the pages of data that are viewable by the user.

Returns:

The select field initialised with all the pages available.

getPageLabel

protected Label getPageLabel()

Create the label used to display the page indicator to user. This value is localised through the com.sptci.echo.table.TableNavigation.page.label key.

Returns:

The label component for the page indicator.

getPageCountLabel

protected Label getPageCountLabel()

Create the label used to display the page count indicator to user. This value is localised through the com.sptci.echo.table.TableNavigation.pageCount.label key.

Returns:

The label component for the page count.

getButton

protected Button getButton(String name)

Create the button used to control navigation among the pages. The value is localised through the com.sptci.echo.table.TableNavigation.<name>Page.text com.sptci.echo.table.TableNavigation.<name>Page.tooltip keys.

Parameters:

name - The name to use to identify the button being created.

Returns:

The button component for navigation.

See Also:

getListener(java.lang.String)

getResultsPerPageLabel

protected Label getResultsPerPageLabel()

Create the label used to display the component used to control the number of items displayed on a page. This value is localised through the com.sptci.echo.table.TableNavigation.resultsPerPage.label key.

Returns:

The label component for the results per page.

getResultsPerPageSelect

protected SelectField getResultsPerPageSelect()

Create a SelectField that displays the options for displaying number of rows on a page.

Returns:

The select field with the options for displaying number of rows on a page.

getListener

protected ActionListener getListener(String name)
                              throws RuntimeException

Return the ActionListener to use for the specified name. The listeners are used to navigate between the pages.

Parameters:

name - The name to use to create the listener.

Returns:

The action listener for the named component.

Throws:

RuntimeException - If errors are encountered while fetching or initialising the Constructor for the action listener via reflection.