com.lf.commons.table

Class TableNavigation

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.table.TableNavigation

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class TableNavigation
extends javax.swing.JPanel
implements java.awt.event.ActionListener

Component to configure how a TablePanel is displayed.

Possible settings are the number of rows to be displayed (paged mode or "all") and to directly navigate to a specific page if the paged mode is active. If the user choosses "all" rows, then the underlying table (or tree table) fetches all rows from a database and show them. If the user chooses a certain number of rows like 5, 20, 15 etc. then the underlying data is divided into portions to be displayed. This can save resources especially for those programs that do not need to display whole table contents.

Like Google also this component allows to directly navigate to a certain page by clicking a link. Users can also navigate to the first, previous, next, or to the last page. This kind of navigation is well-known and inituitive to use.

Since:

1.6

Version:

$Revision: 1.32 $, $Date: 2016/01/01 15:43:01 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
TableNavigation() Constructor of this form.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) Called whenever one of the components was activated.
void	addChangeListener(TableNavigationChangeListener listener) Adds a TableNavigationChangeListener to the components.
protected void	finalize() Clean-up method to help the gc.
javax.swing.JButton	getButtonFirst() Provides the reference for the "First" button.
javax.swing.JButton	getButtonLast() Provides the reference for the "Last" button.
javax.swing.JButton	getButtonNext() Provides the reference for the "Next" button.
javax.swing.JButton	getButtonPrevious() Provides the reference for the "Previous" button.
javax.swing.JComboBox	getComboBoxItems() Provides the combo box to adjust the number of entries per page.
int	getCurrentPage() Provides the index of the current page (1-based).
int	getFirstItem() Provides the first item to be displayed (1-based).
int	getItemsPerPage() Provides the number of rows shown by a single page.
int	getLastItem() Provides the last item to be displayed (1-based).
int	getLastPage() Provides the index of the current page (1-based).
int	getLinkCount() Provides the number of page indexes displayed as hyperlinks (default is 10).
int	getMaxItemCount() Provides the number of visible items (e.g. rows from an SQL result set).
int[][]	getPages() Provides the list of page definitions.
int	getPageSize() Provides the number of rows shown by a single page.
boolean	getShowAll() Does the navigation show all items?
int	getTotalItemCount() Provides the total number of items (e.g. rows from an SQL result set).
boolean	getUnknownTotalCount() Provides the flag indicating that the total item count may not be proper (e.g. lazy loaders).
int	getVisibleItemCount() Provides the number of items to be displayed.
static void	populateWithListItems(javax.swing.JComboBox box, java.util.Hashtable<java.lang.Integer,ComboBoxItem> items) Populates the given box with list item count values.
void	removeChangeListener(TableNavigationChangeListener listener) Removes a TableNavigationChangeListener from the components.
void	setItemCount(int maxcount, int totalcount) Sets the number of visible items (e.g. rows from an SQL result set).
void	setItemsPerPage(int count) Sets the number of rows shown by a single page.
void	setLinkCount(int value) Sets the number of page indexes displayed as hyperlinks (default is 10).
void	setSelectedPage(int index) Activates the index of the given page (1-based) if available.
void	setShowAll() Show all items (convenience method)?
void	setUnknownTotalCount(boolean enable) Sets the flag indicating that the total item count may not be proper (e.g. lazy loaders).
void	setVisibleItemCount(int count) Sets the number of items to be displayed (unchanged if key does not exist).
protected void	updateComps(boolean forcelinks) Cares for the proper state of the components.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

TableNavigation

public TableNavigation()

Constructor of this form.

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Error indication

Since:

1.5

getVisibleItemCount

public int getVisibleItemCount()

Provides the number of items to be displayed.

Returns:

The current number of items, -1 = all (default)

Since:

1.6

setVisibleItemCount

public void setVisibleItemCount(int count)

Sets the number of items to be displayed (unchanged if key does not exist).

Parameters:

count - The current number of items, -1 = all (default)

Since:

1.6

addChangeListener

public void addChangeListener(TableNavigationChangeListener listener)

Adds a TableNavigationChangeListener to the components.

Parameters:

listener - The listener

Since:

1.6

removeChangeListener

public void removeChangeListener(TableNavigationChangeListener listener)

Removes a TableNavigationChangeListener from the components.

Parameters:

listener - The listener

Since:

1.6

setItemCount

public void setItemCount(int maxcount,
                int totalcount)

Sets the number of visible items (e.g. rows from an SQL result set).

Parameters:

maxcount - The number of visible items >= 0

totalcount - The total number of items >= 0

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

getMaxItemCount

public int getMaxItemCount()

Provides the number of visible items (e.g. rows from an SQL result set).

Returns:

The total number of items >= 0

Since:

1.6

getTotalItemCount

public int getTotalItemCount()

Provides the total number of items (e.g. rows from an SQL result set).

Returns:

The total number of items >= 0

Since:

1.6

setLinkCount

public void setLinkCount(int value)

Sets the number of page indexes displayed as hyperlinks (default is 10).

Parameters:

value - The number of links >= 0, 0 disables hyperlinks

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

getLinkCount

public int getLinkCount()

Provides the number of page indexes displayed as hyperlinks (default is 10).

Returns:

The number of links >= 0, 0 disables hyperlinks

Since:

1.6

getFirstItem

public int getFirstItem()

Provides the first item to be displayed (1-based).

Returns:

First item, 0 if no items are available

Since:

1.6

getLastItem

public int getLastItem()

Provides the last item to be displayed (1-based).

Returns:

Last item, 0 if no items are available

Since:

1.6

updateComps

protected void updateComps(boolean forcelinks)

Cares for the proper state of the components.

Parameters:

forcelinks - Create new links?

Since:

1.6

setShowAll

public void setShowAll()

Show all items (convenience method)?

Since:

1.6

getShowAll

public boolean getShowAll()

Does the navigation show all items?

Returns:

All items?

Since:

1.6

getCurrentPage

public int getCurrentPage()

Provides the index of the current page (1-based).

Returns:

The page index

Since:

1.6

getButtonFirst

public javax.swing.JButton getButtonFirst()

Provides the reference for the "First" button.

Returns:

The button

Since:

1.6

getButtonPrevious

public javax.swing.JButton getButtonPrevious()

Provides the reference for the "Previous" button.

Returns:

The button

Since:

1.6

getButtonNext

public javax.swing.JButton getButtonNext()

Provides the reference for the "Next" button.

Returns:

The button

Since:

1.6

getButtonLast

public javax.swing.JButton getButtonLast()

Provides the reference for the "Last" button.

Returns:

The button

Since:

1.6

getPages

public int[][] getPages()

Provides the list of page definitions.

Returns:

The page index pairs, index 0=pages, index 1[0] = first index, index 1[1] = last index

Since:

1.6

getLastPage

public int getLastPage()

Provides the index of the current page (1-based).

Returns:

The page index

Since:

1.6

setSelectedPage

public void setSelectedPage(int index)

Activates the index of the given page (1-based) if available.

Parameters:

index - The page index

Since:

1.6

getPageSize

public int getPageSize()

Provides the number of rows shown by a single page.

Returns:

The page size or -1 if paging is not active (all items)

Since:

1.6

getItemsPerPage

public int getItemsPerPage()

Provides the number of rows shown by a single page.

Returns:

The page size or -1 if paging is not active (all items)

Since:

1.6

setItemsPerPage

public void setItemsPerPage(int count)

Sets the number of rows shown by a single page.

Parameters:

count - The page size or -1 if paging is not active (all items)

Since:

1.6

setUnknownTotalCount

public void setUnknownTotalCount(boolean enable)

Sets the flag indicating that the total item count may not be proper (e.g. lazy loaders).

Parameters:

enable - Set the flag

Since:

1.6

getUnknownTotalCount

public boolean getUnknownTotalCount()

Provides the flag indicating that the total item count may not be proper (e.g. lazy loaders).

Returns:

The flag value

Since:

1.6

getComboBoxItems

public javax.swing.JComboBox getComboBoxItems()

Provides the combo box to adjust the number of entries per page.

Returns:

The component

Since:

1.6

populateWithListItems

public static void populateWithListItems(javax.swing.JComboBox box,
                         java.util.Hashtable<java.lang.Integer,ComboBoxItem> items)

Populates the given box with list item count values.

ComboBoxItem.object = Integer -> PrintingPage.PAPER_A4, ...
ComboBoxItem.text = Paper size name

Parameters:

box - The combo box to be populated

items - The container for the items (optional)

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Called whenever one of the components was activated.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - The event object

Since:

1.6