Package nl.colorize.util.swing

Class Table<R>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

nl.colorize.util.swing.Table<R>

Type Parameters:

R - The type of object used as row keys.

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, TableModel

public class Table<R>
extends JPanel
implements TableModel

Wrapper around JTable that allows rows to be identified by key, instead of only by index. It also improves the appearance of the standard JTable by adding column borders and a striped background, both depending on the platform look-and-feel.

See Also:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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	Description
Table(String... columns)
Table(List<String> columns)

Method Summary

Modifier and Type	Method	Description
void	addActionListener(ActionListener al)
void	addRow(R key, String firstCell, Object... otherCells)	Adds a row to this table.
void	addRow(R key, List<?> cells)	Adds a row to this table.
void	addTableModelListener(TableModelListener tml)
Class<?>	getColumnClass(int columnIndex)
int	getColumnCount()
String	getColumnName(int columnIndex)
Subscribable<Table<R>>	getDoubleClick()	Deprecated. Use onDoubleClick() instead, which passes the double-clicked row as the event.
int	getRowCount()
String	getRowTooltip(R row)
int	getSelectedRowIndex()	Deprecated. Use getSelectedRowKey() instead.
R	getSelectedRowKey()	Returns the key of the row that is currently selected, or null when no row is selected.
Object	getValueAt(int rowIndex, int columnIndex)
boolean	isCellEditable(int rowIndex, int columnIndex)
Subscribable<R>	onDoubleClick()	Returns a Subscribable that can be used to subscribe to events whenever the selected row is double-clicked.
Subscribable<R>	onSelect()	Returns a Subscribable that can be used to subscribe to events whenever the selected row changes.
void	removeAllRows()
void	removeRow(int rowIndex)
void	removeRow(R rowKey)
void	removeTableModelListener(TableModelListener tml)
void	replaceColumns(List<String> newColumns)	Replaces the table's columns with the specified values.
void	setColumnSorter(int columnIndex, Comparator<String> columnSorter)
void	setColumnWidth(int columnIndex, int width)
void	setRowTooltip(R row, String tooltip)
void	setSelectedRowKey(R rowKey)	Changes the selected row to the row associated with the specified key.
void	setTableCellRenderer(int columnIndex, TableCellRenderer renderer)
void	setValueAt(Object value, int rowIndex, int columnIndex)

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, hide, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

Table

public Table(List<String> columns)

Table

public Table(String... columns)

Method Details

getColumnName

public String getColumnName(int columnIndex)

Specified by:

getColumnName in interface TableModel

getColumnClass

public Class<?> getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface TableModel

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableModel

setValueAt

public void setValueAt(Object value,
 int rowIndex,
 int columnIndex)

Specified by:

setValueAt in interface TableModel

getValueAt

public Object getValueAt(int rowIndex,
 int columnIndex)

Specified by:

getValueAt in interface TableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
 int columnIndex)

Specified by:

isCellEditable in interface TableModel

addRow

public void addRow(R key,
 List<?> cells)

Adds a row to this table. The key will be used to identify the row, cells is used to populate the table.

Throws:

IllegalArgumentException - if the number of cells does not match the number of columns in this table.

addRow

public void addRow(R key,
 String firstCell,
 Object... otherCells)

Adds a row to this table. The key will be used to identify the row, cells is used to populate the table.

Throws:

IllegalArgumentException - if the number of cells does not match the number of columns in this table.

removeRow

public void removeRow(R rowKey)

removeRow

public void removeRow(int rowIndex)

removeAllRows

public void removeAllRows()

replaceColumns

public void replaceColumns(List<String> newColumns)

Replaces the table's columns with the specified values. Note that this will also remove all rows from the table.

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getSelectedRowIndex

@Deprecated
public int getSelectedRowIndex()

Deprecated.

Use getSelectedRowKey() instead. Using the row index is an unreliable way of identifying towsr, as sorting the table will actually change the row order.

Returns the index of the row that is currently selected, or -1 when no row is selected.

setSelectedRowKey

public void setSelectedRowKey(R rowKey)

Changes the selected row to the row associated with the specified key. If the key does not match any of the rows currently displayed in this table, this method does nothing.

getSelectedRowKey

public R getSelectedRowKey()

Returns the key of the row that is currently selected, or null when no row is selected.

setColumnSorter

public void setColumnSorter(int columnIndex,
 Comparator<String> columnSorter)

setColumnWidth

public void setColumnWidth(int columnIndex,
 int width)

setTableCellRenderer

public void setTableCellRenderer(int columnIndex,
 TableCellRenderer renderer)

addTableModelListener

public void addTableModelListener(TableModelListener tml)

Specified by:

addTableModelListener in interface TableModel

removeTableModelListener

public void removeTableModelListener(TableModelListener tml)

Specified by:

removeTableModelListener in interface TableModel

setRowTooltip

public void setRowTooltip(R row,
 String tooltip)

getRowTooltip

public String getRowTooltip(R row)

addActionListener

public void addActionListener(ActionListener al)

onSelect

public Subscribable<R> onSelect()

Returns a Subscribable that can be used to subscribe to events whenever the selected row changes.

onDoubleClick

public Subscribable<R> onDoubleClick()

Returns a Subscribable that can be used to subscribe to events whenever the selected row is double-clicked. The event passed to subscribers is the currently selected row key, i.e. the row that was double-clicked.

getDoubleClick

@Deprecated
public Subscribable<Table<R>> getDoubleClick()

Deprecated.

Use onDoubleClick() instead, which passes the double-clicked row as the event.

Returns a Subscribable that can be used to subscribe to events whenever the selected row is double-clicked. The event passed to subscribers represents the currently selected row key.