echopoint.table
Class PagedTableController

java.lang.Object
  nextapp.echo.Component
      nextapp.echo.Container
          echopoint.table.PagedTableController

All Implemented Interfaces:

Borderable, ReflectionSetter, java.io.Serializable

public class PagedTableController

extends nextapp.echo.Container

implements Borderable, ReflectionSetter

PagedTableController is a component that can control the scrolling of a PagedTabelModel. Use it as the visual artefact that allows the user to control what page is currently seen in a Table.

This component provides a compound component that looks as follows :

[next button]     'Page' [currentPage TextField] 'Of' [ maxPage TextField]  [rowsPerPage SelectField] 'Per Page'   [previous Button]

You can gain access to each of these child components to customise what the PagedTableController looks like.

Author:

jp

See Also:

PagedTableModel, SortableTableModel, TableModel, Serialized Form

Nested Class Summary

Nested classes inherited from class echopoint.positionable.Borderable

Borderable.NestedStyleInfo

Field Summary

java.lang.String

PAGED_TABLE_SCROLLER_CHANGED_PROPERTY

Fields inherited from class nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, listenerList, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.Borderable

BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_GROOVE, BORDER_INSET, BORDER_NONE, BORDER_OUTSET, BORDER_RIDGE, BORDER_SOLID, borderStyleSymbolics, STYLE_BORDER_COLOR, STYLE_BORDER_SIZE, STYLE_BORDER_STYLE, STYLE_BOTTOM_BORDER_COLOR, STYLE_BOTTOM_BORDER_SIZE, STYLE_BOTTOM_BORDER_STYLE, STYLE_LEFT_BORDER_COLOR, STYLE_LEFT_BORDER_SIZE, STYLE_LEFT_BORDER_STYLE, STYLE_RIGHT_BORDER_COLOR, STYLE_RIGHT_BORDER_SIZE, STYLE_RIGHT_BORDER_STYLE, STYLE_TOP_BORDER_COLOR, STYLE_TOP_BORDER_SIZE, STYLE_TOP_BORDER_STYLE

Constructor Summary

PagedTableController()
Constructs a PagedTableController that controls no PagedTableModel.

PagedTableController(nextapp.echo.table.TableModel tableModel)
Constructs a PagedTableController that pages the provided TableModel.

Method Summary

void	applyStyle(nextapp.echo.Style style) This will apply the borderColor, borderWidth and borderStyle properties first followed by the left, top, right and bottom borer properties.
nextapp.echo.Color	getBackground()
nextapp.echo.Color	getBorderColor()
int	getBorderSize()
int	getBorderStyle() Returns the border style of the Borderable.
nextapp.echo.Color	getBottomBorderColor()
int	getBottomBorderSize()
int	getBottomBorderStyle()
nextapp.echo.TextField	getCurrentPage() Returns the current page TextField
nextapp.echo.Font	getFont()
nextapp.echo.Color	getForeground()
nextapp.echo.Color	getLeftBorderColor()
int	getLeftBorderSize()
int	getLeftBorderStyle()
nextapp.echo.TextField	getMaxPages() Returns the maxPages TextField
nextapp.echo.table.TableModel	getModel() Returns the TableModel in use
nextapp.echo.Button	getNext() Returns the Next Button
java.lang.String	getOfText() Returns the text value for 'Of' as in Page 1 'Of' 10
java.lang.String	getPageText() Returns the text value for 'Page' as in 'Page' 1 Of 10
java.lang.String	getPerPageText() Returns the text value for 'Per Page' as in 10 'Per Page'
nextapp.echo.Button	getPrevious() Returns the Previous Button
nextapp.echo.Color	getRightBorderColor()
int	getRightBorderSize()
int	getRightBorderStyle()
nextapp.echo.SelectField	getRowsPerPage() Returns the Rows Per Page SelectField
nextapp.echo.Color	getTopBorderColor()
int	getTopBorderSize()
int	getTopBorderStyle()
protected void	init()
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setBackground(nextapp.echo.Color newValue)
void	setBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's border.
void	setBorderSize(int borderSize) Sets the size of the Borderables's border.
void	setBorderStyle(int borderStyle) Sets the border style of the Borderable.
void	setBottomBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's bottom border.
void	setBottomBorderSize(int borderSize) Sets the size of the Borderables's bottom border.
void	setBottomBorderStyle(int borderStyle) Sets the border style of the Borderables's bottom border.
void	setCurrentPage(nextapp.echo.TextField field) Sets the CurrentPage TextField
void	setFont(nextapp.echo.Font newValue)
void	setForeground(nextapp.echo.Color newValue)
void	setLeftBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's left border.
void	setLeftBorderSize(int borderSize) Sets the size of the Borderables's left border.
void	setLeftBorderStyle(int borderStyle) Sets the border style of the Borderables's left border.
void	setMaxPages(nextapp.echo.TextField field) Sets the MaxPages TextField
void	setModel(nextapp.echo.table.TableModel tableModel) Sets the PagedTableModel to use.
void	setNext(nextapp.echo.Button button) Sets the Next Button
void	setOfText(java.lang.String string) Sets the text value for 'Of' as in Page 1 'Of' 10
void	setPageText(java.lang.String string) Sets the text value for 'Page' as in 'Page' 1 Of 10
void	setPerPageText(java.lang.String string) Sets the text value for 'Per Page' as in 10 'Per Page'
void	setPrevious(nextapp.echo.Button button) Sets the Previous Button
void	setRightBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's right border.
void	setRightBorderSize(int borderSize) Sets the size of the Borderables's right border.
void	setRightBorderStyle(int borderStyle) Sets the border style of the Borderables's right border.
void	setRowsPerPage(nextapp.echo.SelectField field) Sets the Rows Per Page SelectField.
void	setTopBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's top border.
void	setTopBorderSize(int borderSize) Sets the size of the Borderables's top border.
void	setTopBorderStyle(int borderStyle) Sets the border style of the Borderables's top border.

Methods inherited from class nextapp.echo.Component

add, add, addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getComponent, getComponentCount, getComponents, getEchoInstance, getIdentifier, getLocale, getParent, indexOf, isAncestorOf, isEnabled, isRegistered, isShowing, isVisible, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setEnabled, setIdentifier, setLocale, setVisible, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

PAGED_TABLE_SCROLLER_CHANGED_PROPERTY

public final java.lang.String PAGED_TABLE_SCROLLER_CHANGED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

PagedTableController

public PagedTableController()

Constructs a PagedTableController that controls no PagedTableModel.

PagedTableController

public PagedTableController(nextapp.echo.table.TableModel tableModel)

Constructs a PagedTableController that pages the provided TableModel. If the TableModel does not implement PagedTableModel, then it is wrapped in one.

Parameters:

tableModel - - the TableModel to use

Method Detail

init

protected void init()

See Also:

Component.init()

getCurrentPage

public nextapp.echo.TextField getCurrentPage()

Returns the current page TextField

Returns:

the current page TextField

getMaxPages

public nextapp.echo.TextField getMaxPages()

Returns the maxPages TextField

Returns:

the maxPages TextField

getModel

public nextapp.echo.table.TableModel getModel()

Returns the TableModel in use

Returns:

the TableModel in use

getNext

public nextapp.echo.Button getNext()

Returns the Next Button

Returns:

the Next Button

getOfText

public java.lang.String getOfText()

Returns the text value for 'Of' as in Page 1 'Of' 10

Returns:

the text value for 'Of' as in Page 1 'Of' 10

getPageText

public java.lang.String getPageText()

Returns the text value for 'Page' as in 'Page' 1 Of 10

Returns:

the text value for 'Page' as in 'Page' 1 Of 10

getPerPageText

public java.lang.String getPerPageText()

Returns the text value for 'Per Page' as in 10 'Per Page'

Returns:

the text value for 'Per Page' as in 10 'Per Page'

getPrevious

public nextapp.echo.Button getPrevious()

Returns the Previous Button

Returns:

the Previous Button

getRowsPerPage

public nextapp.echo.SelectField getRowsPerPage()

Returns the Rows Per Page SelectField

Returns:

the Rows Per Page SelectField

setCurrentPage

public void setCurrentPage(nextapp.echo.TextField field)

Sets the CurrentPage TextField

Parameters:

field - a TextField

setMaxPages

public void setMaxPages(nextapp.echo.TextField field)

Sets the MaxPages TextField

Parameters:

field - a TextField

setModel

public void setModel(nextapp.echo.table.TableModel tableModel)

Sets the PagedTableModel to use. If the TableModel does not implement PagedTableModel, then it is wrapped in one.

Parameters:

tableModel - the TableModel to use

setNext

public void setNext(nextapp.echo.Button button)

Sets the Next Button

Parameters:

button - - the next button

setOfText

public void setOfText(java.lang.String string)

Sets the text value for 'Of' as in Page 1 'Of' 10

Parameters:

string - the text value

setPageText

public void setPageText(java.lang.String string)

Sets the text value for 'Page' as in 'Page' 1 Of 10

Parameters:

string - the text value

setPerPageText

public void setPerPageText(java.lang.String string)

Sets the text value for 'Per Page' as in 10 'Per Page'

Parameters:

string - the text value

setPrevious

public void setPrevious(nextapp.echo.Button button)

Sets the Previous Button

Parameters:

button - the Previous Button

setRowsPerPage

public void setRowsPerPage(nextapp.echo.SelectField field)

Sets the Rows Per Page SelectField. This must return only integer values.

Parameters:

field - the Rows Per Page SelectField

applyStyle

public void applyStyle(nextapp.echo.Style style)

Description copied from interface: Borderable

This will apply the borderColor, borderWidth and borderStyle properties first followed by the left, top, right and bottom borer properties.

Specified by:

applyStyle in interface Borderable

See Also:

Borderable.applyStyle(nextapp.echo.Style)

getBackground

public nextapp.echo.Color getBackground()

See Also:

Component.getBackground()

getFont

public nextapp.echo.Font getFont()

See Also:

Component.getFont()

getForeground

public nextapp.echo.Color getForeground()

See Also:

Component.getForeground()

setBackground

public void setBackground(nextapp.echo.Color newValue)

See Also:

Component.setBackground(nextapp.echo.Color)

setFont

public void setFont(nextapp.echo.Font newValue)

See Also:

Component.setFont(nextapp.echo.Font)

setForeground

public void setForeground(nextapp.echo.Color newValue)

See Also:

Component.setForeground(nextapp.echo.Color)

getBorderColor

public nextapp.echo.Color getBorderColor()

Specified by:

getBorderColor in interface Borderable

Returns:

The Color of the Borderable's border.

See Also:

Borderable.getBorderColor()

getBorderSize

public int getBorderSize()

Specified by:

getBorderSize in interface Borderable

Returns:

The size of the Borderables's border.

See Also:

Borderable.getBorderSize()

getBorderStyle

public int getBorderStyle()

Description copied from interface: Borderable

Returns the border style of the Borderable. This will be one of the following values :

• BORDER_DOTTED - a dotted border
• BORDER_DASHED - dashed border
• BORDER_SOLID - a solid border
• BORDER_DOUBLE - a double border
• BORDER_GROOVE - a 3D grooved border
• BORDER_RIDGE - a 3D ridge border
• BORDER_INSET - a 3D inset border
• BORDER_OUTSET - a 3D outset border

Specified by:

getBorderStyle in interface Borderable

Returns:

int the current border style

See Also:

Borderable.getBorderStyle()

setBorderColor

public void setBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's border. This will also set the left, top, right and bottom border color.

Specified by:

setBorderColor in interface Borderable

See Also:

Borderable.setBorderColor(nextapp.echo.Color)

setBorderSize

public void setBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's border. This will also set the left, top, right and bottom border size.

Specified by:

setBorderSize in interface Borderable

See Also:

Borderable.setBorderSize(int)

setBorderStyle

public void setBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderable. This must be one of the following values :

• BORDER_DOTTED - a dotted border
• BORDER_DASHED - dashed border
• BORDER_SOLID - a solid border
• BORDER_DOUBLE - a double border
• BORDER_GROOVE - a 3D grooved border
• BORDER_RIDGE - a 3D ridge border
• BORDER_INSET - a 3D inset border
• BORDER_OUTSET - a 3D outset border

This will also set the left, top, right and bottom border style.

Specified by:

setBorderStyle in interface Borderable

See Also:

Borderable.setBorderStyle(int)

getLeftBorderColor

public nextapp.echo.Color getLeftBorderColor()

Specified by:

getLeftBorderColor in interface Borderable

Returns:

The Color of the Borderable's left border.

See Also:

Borderable.getLeftBorderColor()

getLeftBorderSize

public int getLeftBorderSize()

Specified by:

getLeftBorderSize in interface Borderable

Returns:

The size of the Borderables's left border.

See Also:

Borderable.getLeftBorderSize()

getLeftBorderStyle

public int getLeftBorderStyle()

Specified by:

getLeftBorderStyle in interface Borderable

Returns:

The style of the Borderables's left border.

See Also:

Borderable.getLeftBorderStyle()

setLeftBorderColor

public void setLeftBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's left border.

Specified by:

setLeftBorderColor in interface Borderable

See Also:

Borderable.setLeftBorderColor(nextapp.echo.Color)

setLeftBorderSize

public void setLeftBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's left border.

Specified by:

setLeftBorderSize in interface Borderable

See Also:

Borderable.setLeftBorderSize(int)

setLeftBorderStyle

public void setLeftBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's left border.

Specified by:

setLeftBorderStyle in interface Borderable

See Also:

Borderable.setLeftBorderStyle(int)

getTopBorderColor

public nextapp.echo.Color getTopBorderColor()

Specified by:

getTopBorderColor in interface Borderable

Returns:

The Color of the Borderable's top border.

See Also:

Borderable.getTopBorderColor()

getTopBorderSize

public int getTopBorderSize()

Specified by:

getTopBorderSize in interface Borderable

Returns:

The size of the Borderables's top border.

See Also:

Borderable.getTopBorderSize()

getTopBorderStyle

public int getTopBorderStyle()

Specified by:

getTopBorderStyle in interface Borderable

Returns:

The style of the Borderables's top border.

See Also:

Borderable.getTopBorderStyle()

setTopBorderColor

public void setTopBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's top border.

Specified by:

setTopBorderColor in interface Borderable

See Also:

Borderable.setTopBorderColor(nextapp.echo.Color)

setTopBorderSize

public void setTopBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's top border.

Specified by:

setTopBorderSize in interface Borderable

See Also:

Borderable.setTopBorderSize(int)

setTopBorderStyle

public void setTopBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's top border.

Specified by:

setTopBorderStyle in interface Borderable

See Also:

Borderable.setTopBorderStyle(int)

getRightBorderColor

public nextapp.echo.Color getRightBorderColor()

Specified by:

getRightBorderColor in interface Borderable

Returns:

The Color of the Borderable's right border.

See Also:

Borderable.getRightBorderColor()

getRightBorderSize

public int getRightBorderSize()

Specified by:

getRightBorderSize in interface Borderable

Returns:

The size of the Borderables's right border.

See Also:

Borderable.getRightBorderSize()

getRightBorderStyle

public int getRightBorderStyle()

Specified by:

getRightBorderStyle in interface Borderable

Returns:

The style of the Borderables's right border.

See Also:

Borderable.getRightBorderStyle()

setRightBorderColor

public void setRightBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's right border.

Specified by:

setRightBorderColor in interface Borderable

See Also:

Borderable.setRightBorderColor(nextapp.echo.Color)

setRightBorderSize

public void setRightBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's right border.

Specified by:

setRightBorderSize in interface Borderable

See Also:

Borderable.setRightBorderSize(int)

setRightBorderStyle

public void setRightBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's right border.

Specified by:

setRightBorderStyle in interface Borderable

See Also:

Borderable.setRightBorderStyle(int)

getBottomBorderColor

public nextapp.echo.Color getBottomBorderColor()

Specified by:

getBottomBorderColor in interface Borderable

Returns:

The Color of the Borderable's bottom border.

See Also:

Borderable.getBottomBorderColor()

getBottomBorderSize

public int getBottomBorderSize()

Specified by:

getBottomBorderSize in interface Borderable

Returns:

The size of the Borderables's bottom border.

See Also:

Borderable.getBottomBorderSize()

getBottomBorderStyle

public int getBottomBorderStyle()

Specified by:

getBottomBorderStyle in interface Borderable

Returns:

The style of the Borderables's bottom border.

See Also:

Borderable.getBottomBorderStyle()

setBottomBorderColor

public void setBottomBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's bottom border.

Specified by:

setBottomBorderColor in interface Borderable

See Also:

Borderable.setBottomBorderColor(nextapp.echo.Color)

setBottomBorderSize

public void setBottomBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's bottom border.

Specified by:

setBottomBorderSize in interface Borderable

See Also:

Borderable.setBottomBorderSize(int)

setBottomBorderStyle

public void setBottomBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's bottom border.

Specified by:

setBottomBorderStyle in interface Borderable

See Also:

Borderable.setBottomBorderStyle(int)

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Parameters:

field - - the field to be set

newValue - - the new value to be set

Returns:

the oldValue of the field

Throws:

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)