meka.gui.core

Class SortableAndSearchableTable

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTable

meka.gui.core.MekaTable

meka.gui.core.SortableAndSearchableTable

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, CellEditorListener, ListSelectionListener, RowSorterListener, TableColumnModelListener, TableModelListener, Scrollable, SearchableTable, SortableTable

public class SortableAndSearchableTable
extends MekaTable
implements SortableTable, SearchableTable

A specialized JTable that allows double-clicking on header for resizing to optimal width, as well as being searchable and sortable.

Version:

$Revision: 8807 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JTable.AccessibleJTable, JTable.DropLocation, JTable.PrintMode

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

Modifier and Type	Field and Description
static String	KEY_SEARCHREGEXP the key for the regular expression search flag.
static String	KEY_SEARCHSTRING the key for the search string.
static String	KEY_SORTCOL the key for the sort column setting.
static String	KEY_SORTORDER the key for the sort oder.
protected SortableAndSearchableWrapperTableModel	m_Model the sortable/searchable model.
protected boolean	m_SortNewTableModel whether to automatically sort table models that get set via setModel.
protected boolean	m_UseOptimalColumnWidths whether to automatically set optimal column widths.

Fields inherited from class meka.gui.core.MekaTable

m_TableHelper

Fields inherited from class javax.swing.JTable

AUTO_RESIZE_ALL_COLUMNS, AUTO_RESIZE_LAST_COLUMN, AUTO_RESIZE_NEXT_COLUMN, AUTO_RESIZE_OFF, AUTO_RESIZE_SUBSEQUENT_COLUMNS, autoCreateColumnsFromModel, autoResizeMode, cellEditor, cellSelectionEnabled, columnModel, dataModel, defaultEditorsByColumnClass, defaultRenderersByColumnClass, editingColumn, editingRow, editorComp, gridColor, preferredViewportSize, rowHeight, rowMargin, rowSelectionAllowed, selectionBackground, selectionForeground, selectionModel, showHorizontalLines, showVerticalLines, tableHeader

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 and Description
SortableAndSearchableTable() Constructs a default SortedBaseTable that is initialized with a default data model, a default column model, and a default selection model.
SortableAndSearchableTable(int numRows, int numColumns) Constructs a SortedBaseTable with numRows and numColumns of empty cells using DefaultTableModel.
SortableAndSearchableTable(Object[][] rowData, Object[] columnNames) Constructs a SortedBaseTable to display the values in the two dimensional array, rowData, with column names, columnNames.
SortableAndSearchableTable(TableModel dm) Constructs a SortedBaseTable that is initialized with dm as the data model, a default column model, and a default selection model.
SortableAndSearchableTable(TableModel dm, TableColumnModel cm) Constructs a SortedBaseTable that is initialized with dm as the data model, cm as the column model, and a default selection model.
SortableAndSearchableTable(TableModel dm, TableColumnModel cm, ListSelectionModel sm) Constructs a SortedBaseTable that is initialized with dm as the data model, cm as the column model, and sm as the selection model.
SortableAndSearchableTable(Vector rowData, Vector columnNames) Constructs a SortedBaseTable to display the values in the Vector of Vectors, rowData, with column names, columnNames.

Method Summary

Modifier and Type	Method and Description
protected Hashtable<String,Object>	backupModelSettings(TableModel model) Backs up the settings from the old model.
int	getActualRow(int visibleRow) Returns the actual underlying row the given visible one represents.
int	getActualRowCount() Returns the actual row count in the model.
int	getDisplayRow(int internalRow) Returns the "visible" row derived from row in the actual table model.
String	getSeachString() Returns the current search string.
int	getSortColumn() Returns the sort column.
boolean	getSortNewTableModel() Returns whether to sort new models.
protected Class	getTableModelClass() Returns the class of the table model that the models need to be derived from.
TableModel	getUnsortedModel() returns the underlying model, can be null.
boolean	getUseOptimalColumnWidths() Returns whether to automatically set optimal column widths.
protected void	initGUI() Initializes some GUI-related things.
protected boolean	initialSortNewTableModel() Returns the initial setting of whether to sort new models.
protected boolean	initialUseOptimalColumnWidths() Returns the initial setting of whether to set optimal column widths.
boolean	isAscending() Returns whether sorting is ascending or not.
boolean	isRegExpSearch() Returns whether the last search was a regular expression based one.
boolean	isSorted() returns whether the table was sorted.
protected void	restoreModelSettings(TableModel model, Hashtable<String,Object> settings) Restores the settings previously backed up.
void	search(String searchString, boolean regexp) Performs a search for the given string.
void	setModel(TableModel model) Sets the model to display - only getTableModelClass().
void	setSortNewTableModel(boolean value) Sets whether to sort new models.
void	setUnsortedModel(TableModel value) Sets the base model to use.
void	setUnsortedModel(TableModel value, boolean restoreSorting) Sets the base model to use.
void	setUseOptimalColumnWidhts(boolean value) Sets whether to automatically set optimal column widths.
void	sort(int columnIndex) sorts the table over the given column (ascending).
void	sort(int columnIndex, boolean ascending) sorts the table over the given column, either ascending or descending.

Methods inherited from class meka.gui.core.MekaTable

copyToClipboard, getTableHelper, scrollColumnToVisible, scrollRowToVisible, setOptimalColumnWidth, setOptimalColumnWidth, showCell

Methods inherited from class javax.swing.JTable

addColumn, addColumnSelectionInterval, addNotify, addRowSelectionInterval, changeSelection, clearSelection, columnAdded, columnAtPoint, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged, configureEnclosingScrollPane, convertColumnIndexToModel, convertColumnIndexToView, convertRowIndexToModel, convertRowIndexToView, createDefaultColumnModel, createDefaultColumnsFromModel, createDefaultDataModel, createDefaultEditors, createDefaultRenderers, createDefaultSelectionModel, createDefaultTableHeader, createScrollPaneForTable, doLayout, editCellAt, editCellAt, editingCanceled, editingStopped, getAccessibleContext, getAutoCreateColumnsFromModel, getAutoCreateRowSorter, getAutoResizeMode, getCellEditor, getCellEditor, getCellRect, getCellRenderer, getCellSelectionEnabled, getColumn, getColumnClass, getColumnCount, getColumnModel, getColumnName, getColumnSelectionAllowed, getDefaultEditor, getDefaultRenderer, getDragEnabled, getDropLocation, getDropMode, getEditingColumn, getEditingRow, getEditorComponent, getFillsViewportHeight, getGridColor, getIntercellSpacing, getModel, getPreferredScrollableViewportSize, getPrintable, getRowCount, getRowHeight, getRowHeight, getRowMargin, getRowSelectionAllowed, getRowSorter, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionForeground, getSelectionModel, getShowHorizontalLines, getShowVerticalLines, getSurrendersFocusOnKeystroke, getTableHeader, getToolTipText, getUI, getUIClassID, getUpdateSelectionOnSort, getValueAt, initializeLocalVars, isCellEditable, isCellSelected, isColumnSelected, isEditing, isRowSelected, moveColumn, paramString, prepareEditor, prepareRenderer, print, print, print, print, print, processKeyBinding, removeColumn, removeColumnSelectionInterval, removeEditor, removeNotify, removeRowSelectionInterval, resizeAndRepaint, rowAtPoint, selectAll, setAutoCreateColumnsFromModel, setAutoCreateRowSorter, setAutoResizeMode, setCellEditor, setCellSelectionEnabled, setColumnModel, setColumnSelectionAllowed, setColumnSelectionInterval, setDefaultEditor, setDefaultRenderer, setDragEnabled, setDropMode, setEditingColumn, setEditingRow, setFillsViewportHeight, setGridColor, setIntercellSpacing, setPreferredScrollableViewportSize, setRowHeight, setRowHeight, setRowMargin, setRowSelectionAllowed, setRowSelectionInterval, setRowSorter, setSelectionBackground, setSelectionForeground, setSelectionMode, setSelectionModel, setShowGrid, setShowHorizontalLines, setShowVerticalLines, setSurrendersFocusOnKeystroke, setTableHeader, setUI, setUpdateSelectionOnSort, setValueAt, sizeColumnsToFit, sizeColumnsToFit, sorterChanged, tableChanged, unconfigureEnclosingScrollPane, updateUI, valueChanged

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, 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, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KEY_SORTCOL

public static final String KEY_SORTCOL

the key for the sort column setting.

See Also:

Constant Field Values

KEY_SORTORDER

public static final String KEY_SORTORDER

the key for the sort oder.

See Also:

Constant Field Values

KEY_SEARCHSTRING

public static final String KEY_SEARCHSTRING

the key for the search string.

See Also:

Constant Field Values

KEY_SEARCHREGEXP

public static final String KEY_SEARCHREGEXP

the key for the regular expression search flag.

See Also:

Constant Field Values

m_Model

protected SortableAndSearchableWrapperTableModel m_Model

the sortable/searchable model.

m_UseOptimalColumnWidths

protected boolean m_UseOptimalColumnWidths

whether to automatically set optimal column widths.

m_SortNewTableModel

protected boolean m_SortNewTableModel

whether to automatically sort table models that get set via setModel.

Constructor Detail

SortableAndSearchableTable

public SortableAndSearchableTable()

Constructs a default SortedBaseTable that is initialized with a default data model, a default column model, and a default selection model.

SortableAndSearchableTable

public SortableAndSearchableTable(int numRows,
                                  int numColumns)

Constructs a SortedBaseTable with numRows and numColumns of empty cells using DefaultTableModel. The columns will have names of the form "A", "B", "C", etc.

Parameters:

numRows - the number of rows the table holds

numColumns - the number of columns the table holds

SortableAndSearchableTable

public SortableAndSearchableTable(Object[][] rowData,
                                  Object[] columnNames)

Constructs a SortedBaseTable to display the values in the two dimensional array, rowData, with column names, columnNames. rowData is an array of rows, so the value of the cell at row 1, column 5 can be obtained with the following code:

 rowData[1][5]; 

All rows must be of the same length as columnNames.

Parameters:

rowData - the data for the new table

columnNames - names of each column

SortableAndSearchableTable

public SortableAndSearchableTable(Vector rowData,
                                  Vector columnNames)

Constructs a SortedBaseTable to display the values in the Vector of Vectors, rowData, with column names, columnNames. The Vectors contained in rowData should contain the values for that row. In other words, the value of the cell at row 1, column 5 can be obtained with the following code:

((Vector)rowData.elementAt(1)).elementAt(5);

Parameters:

rowData - the data for the new table

columnNames - names of each column

SortableAndSearchableTable

public SortableAndSearchableTable(TableModel dm)

Constructs a SortedBaseTable that is initialized with dm as the data model, a default column model, and a default selection model.

Parameters:

dm - the data model for the table

SortableAndSearchableTable

public SortableAndSearchableTable(TableModel dm,
                                  TableColumnModel cm)

Constructs a SortedBaseTable that is initialized with dm as the data model, cm as the column model, and a default selection model.

Parameters:

dm - the data model for the table

cm - the column model for the table

SortableAndSearchableTable

public SortableAndSearchableTable(TableModel dm,
                                  TableColumnModel cm,
                                  ListSelectionModel sm)

Constructs a SortedBaseTable that is initialized with dm as the data model, cm as the column model, and sm as the selection model. If any of the parameters are null this method will initialize the table with the corresponding default model. The autoCreateColumnsFromModel flag is set to false if cm is non-null, otherwise it is set to true and the column model is populated with suitable TableColumns for the columns in dm.

Parameters:

dm - the data model for the table

cm - the column model for the table

sm - the row selection model for the table

Method Detail

initialUseOptimalColumnWidths

protected boolean initialUseOptimalColumnWidths()

Returns the initial setting of whether to set optimal column widths. Default implementation returns "false", since large tables might take too long to be displayed otherwise.

Returns:

true if optimal column widths are used by default

setUseOptimalColumnWidhts

public void setUseOptimalColumnWidhts(boolean value)

Sets whether to automatically set optimal column widths.

Parameters:

value - if true then optimal column widths are used

getUseOptimalColumnWidths

public boolean getUseOptimalColumnWidths()

Returns whether to automatically set optimal column widths. Default implementation is initialized with "false".

Returns:

true if optimal column widths are to be used

initialSortNewTableModel

protected boolean initialSortNewTableModel()

Returns the initial setting of whether to sort new models. Default implementation returns "false".

Returns:

true if new models need to be sorted

setSortNewTableModel

public void setSortNewTableModel(boolean value)

Sets whether to sort new models.

Parameters:

value - if true then new models get sorted

getSortNewTableModel

public boolean getSortNewTableModel()

Returns whether to sort new models. Default implementation is initialized with "false".

Returns:

true if new models get sorted

initGUI

protected void initGUI()

Initializes some GUI-related things.

Overrides:

initGUI in class MekaTable

getTableModelClass

protected Class getTableModelClass()

Returns the class of the table model that the models need to be derived from. The default implementation just returns TableModel.class

Returns:

the class the models must be derived from

backupModelSettings

protected Hashtable<String,Object> backupModelSettings(TableModel model)

Backs up the settings from the old model.

Parameters:

model - the old model (the model stored within the SortedModel)

Returns:

the backed up settings

restoreModelSettings

protected void restoreModelSettings(TableModel model,
                                    Hashtable<String,Object> settings)

Restores the settings previously backed up.

Parameters:

model - the new model (the model stored within the SortedModel)

settings - the old settings, null if no settings were available

setModel

public void setModel(TableModel model)

Sets the model to display - only getTableModelClass().

Overrides:

setModel in class JTable

Parameters:

model - the model to display

setUnsortedModel

public void setUnsortedModel(TableModel value)

Sets the base model to use. Discards any sorting.

Specified by:

setUnsortedModel in interface SortableTable

Parameters:

value - the base model

setUnsortedModel

public void setUnsortedModel(TableModel value,
                             boolean restoreSorting)

Sets the base model to use.

Parameters:

value - the base model

restoreSorting - whether to restore the sorting

getUnsortedModel

public TableModel getUnsortedModel()

returns the underlying model, can be null.

Specified by:

getUnsortedModel in interface SortableTable

Returns:

the current model

getActualRow

public int getActualRow(int visibleRow)

Returns the actual underlying row the given visible one represents. Useful for retrieving "non-visual" data that is also stored in a TableModel.

Specified by:

getActualRow in interface SearchableTable

Parameters:

visibleRow - the displayed row to retrieve the original row for

Returns:

the original row

getDisplayRow

public int getDisplayRow(int internalRow)

Returns the "visible" row derived from row in the actual table model.

Parameters:

internalRow - the row in the actual model

Returns:

the row in the sorted model, -1 in case of an error

isSorted

public boolean isSorted()

returns whether the table was sorted.

Specified by:

isSorted in interface SortableTable

Returns:

true if the table was sorted

getSortColumn

public int getSortColumn()

Returns the sort column.

Specified by:

getSortColumn in interface SortableTable

Returns:

the sort column

isAscending

public boolean isAscending()

Returns whether sorting is ascending or not.

Specified by:

isAscending in interface SortableTable

Returns:

true if ascending

See Also:

isSorted(), getSortColumn()

sort

public void sort(int columnIndex)

sorts the table over the given column (ascending).

Specified by:

sort in interface SortableTable

Parameters:

columnIndex - the column to sort over

sort

public void sort(int columnIndex,
                 boolean ascending)

sorts the table over the given column, either ascending or descending.

Specified by:

sort in interface SortableTable

Parameters:

columnIndex - the column to sort over

ascending - ascending if true, otherwise descending

getActualRowCount

public int getActualRowCount()

Returns the actual row count in the model.

Specified by:

getActualRowCount in interface SearchableTable

Returns:

the row count in the underlying data

search

public void search(String searchString,
                   boolean regexp)

Performs a search for the given string. Limits the display of rows to ones containing the search string.

Specified by:

search in interface SearchableTable

Parameters:

searchString - the string to search for

regexp - whether to perform regular expression matching or just plain string comparison

getSeachString

public String getSeachString()

Returns the current search string.

Specified by:

getSeachString in interface SearchableTable

Returns:

the search string, null if not filtered

isRegExpSearch

public boolean isRegExpSearch()

Returns whether the last search was a regular expression based one.

Specified by:

isRegExpSearch in interface SearchableTable

Returns:

true if last search was a reg exp one