oracle.javatools.controls.nicetable
Class NiceTable

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JTable
                  oracle.javatools.controls.nicetable.NiceTable

All Implemented Interfaces:

javax.accessibility.Accessible, javax.swing.event.CellEditorListener, java.util.EventListener, java.awt.image.ImageObserver, javax.swing.event.ListSelectionListener, java.awt.MenuContainer, javax.swing.Scrollable, java.io.Serializable, javax.swing.event.TableColumnModelListener, javax.swing.event.TableModelListener

public class NiceTable

extends javax.swing.JTable

NiceTable is a subclass of JTable with a number of nice features and a cleaner UI.

Features provided by this table:

• Double click column resizing: When the user double-clicks on the separator between two columns, the column to the left of the separator will be resized to the width of the widest cell in that column. You can turn this behavior on and off using the setResizeColumnOnDoubleClick() method.
• Tooltip for truncated cells: Cells which are horizontally truncated will display a tooltip containing the toString() value of the object for the cell from the model. You can switch this behavior on and off using the setShowToolTips() method.
• Context menu for showing / hiding columns: A context menu is displayed on the column header which contains checkbox menu items allowing the user to hide and show columns. This is handled regardless of the table model by adding and removing columns from the TableColumnModel. You can switch this behavior on and off using the setColumnSelectorAvailable() method.
• Sorting support: The NiceTable will sort rows based on comparators provided by the NiceTableModel for each column. You can switch on sorting by calling setSorted( true ).
• JavaBean persistence of view state: You can retrieve a javabean from this class via the getPersistentSettings() which can be persisted via some external persistence mechanism to store view settings such as any hidden columns and the current width of all the columns
• ScrollPane with table background color: The scroll pane viewport for this table has the same background color as the table. This gets rid of the ugly grey area in the scrollpane when there are a small number of rows. The viewport also has support for extending the sorted column highlight below the last vertical row.
• Cleaner column header appearance: The column header renderer used by this table (NiceTableHeaderRenderer) has a flatter, cleaner, more modern appearance than the default "button-like" header renderer used by Swing.
• Column alignment support: If your table model implements the NiceTableModel interface, the cell and header renderer used by this table will align the header and cell contents either left, right or center. Unlike the base JTable, the column header will always have the same alignment as the cells in the column.
• Sort column icon: A column sort icon is displayed if your table model implements the NiceTableModel interface. The appearance of this icon is less distracting than the icons used for this purpose elsewhere (i.e. it isn't a garish bright green faux-3d thing that looks like it escaped from a 1991 Borland product), and is closer in appearance to the icon used by one particular operating system for this purpose.
• Sort column highlighting: If the table model is NiceTableModel and the NiceTableCellRenderer is used, the column currently being used to sort the table is highlighted in a slightly different color from the other columns in the table. This makes it easier to see which column is the sort column. You can cusomize the color used for the sorted column highlight using the

  See Also:

  Serialized Form

  Nested Class Summary

  Nested classes inherited from class javax.swing.JTable

  javax.swing.JTable.AccessibleJTable

  Nested classes inherited from class javax.swing.JComponent

  javax.swing.JComponent.AccessibleJComponent

  Nested classes inherited from class java.awt.Container

  java.awt.Container.AccessibleAWTContainer

  Nested classes inherited from class java.awt.Component

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

  Field Summary

  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

  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

  NiceTable()
  

  NiceTable(javax.swing.table.TableModel model)
  

  Method Summary

  void	autoSizeColumnsToFit() Utility method that will set the preferred size of all columns in this table so that they are just big enough to display their contents.
  protected void	configureEnclosingScrollPane()
  int	convertRowToModelIndex(int viewRow) Convert a row index in the view to a row index in the model.
  javax.swing.table.TableModel	getBaseModel() Get the "base" model of the table.
  int[]	getHiddenColumns() Get columns that are hidden.
  NiceTablePersistentSettings	getPersistentSettings() Get a javabean storing persistent settings of this NiceTable which you can serialize in order to restore the visible appearance of the table next time it is used.
  javax.swing.JScrollPane	getScrollPaneForTable() Get a scroll pane for this table.
  int[]	getSelectedRowsInModel() Get the selected rows as model rows, regardless of whether this table is currently sorted.
  int	getSortColumn() Get the (model) sort column
  java.awt.Color	getSortColumnBackgroundColor() Get the background color of the sorted column.
  java.lang.String	getToolTipText(java.awt.event.MouseEvent event) Override to provide a tooltip for cells that are obscured because they are too small to display their renderer properly.
  boolean	isColumnSelectorAvailable() Get whether the context menu for hiding and showing columns is available on this instance of NiceTable
  boolean	isResizeColumnOnDoubleClick() Get whether the user can resize columns in this table by double clicking the resize divider between two columns.
  boolean	isShowToolTips() Get whether tooltips are being shown for truncated cells.
  boolean	isSortAscending() Is the sorted column being sorted in ascending order?
  boolean	isSorted() Is the table sorted?
  void	setBackground(java.awt.Color c) Overridden to make sure the highlighted column is repainted properly.
  void	setColumnSelectorAvailable(boolean isAvailable) Set whether this NiceTable will display a context menu on the table headers allowing the user to hide and show columns.
  void	setHiddenColumns(int[] hiddenColumns) Set columns that are hidden.
  void	setPersistentSettings(NiceTablePersistentSettings settings) Set the persistent view settings of this NiceTable.
  void	setResizeColumnOnDoubleClick(boolean isOn) Set whether the user can resize columns in this table by double clicking the resize divider between two columns.
  void	setShowToolTips(boolean showToolTips) Controls whether this NiceTable will show tooltips for cells that are truncated due to reduced column width.
  void	setSortColumn(int modelColumn, boolean isSortAscending) Set the column to sort the view by.
  void	setSortColumnBackgroundColor(java.awt.Color c) Set the background color used to highlight the sorted column.
  void	setSorted(boolean isSorted) Set whether this NiceTable is sorted.
  void	updateUI() Overridden to make sure look and feel changes cause the highlighted column to be repainted in the right color.

  Methods inherited from class javax.swing.JTable

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

  Methods inherited from class javax.swing.JComponent

  addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  NiceTable

  public NiceTable()

  NiceTable

  public NiceTable(javax.swing.table.TableModel model)

  Method Detail

  convertRowToModelIndex

  public int convertRowToModelIndex(int viewRow)

  Convert a row index in the view to a row index in the model. The view row index will differ from the model row index if the table is sorted. The index you recieve in the cell renderer is a view index, so you should convert it.

  Parameters:

  viewRow - a row index in the view

  Returns:

  the row index in the base model

  getSortColumnBackgroundColor

  public java.awt.Color getSortColumnBackgroundColor()

  Get the background color of the sorted column. By default, this is a slightly darker shade than the background color of the table. You can change this by calling setSortColumnBackgroundColor().

  Returns:

  the background color of the sort column

  setSortColumnBackgroundColor

  public void setSortColumnBackgroundColor(java.awt.Color c)

  Set the background color used to highlight the sorted column.

  Parameters:

  c - the color to paint the background of the sorted column

  setBackground

  public void setBackground(java.awt.Color c)

  Overridden to make sure the highlighted column is repainted properly.

  Parameters:

  c -

  updateUI

  public void updateUI()

  Overridden to make sure look and feel changes cause the highlighted column to be repainted in the right color.

  setSorted

  public void setSorted(boolean isSorted)

  Set whether this NiceTable is sorted. If the table is sorted, its model will be changed to an internal model decorator which sorts the columns. You should avoid using getModel(): instead use getBaseModel() to get the real model of the table.

  Parameters:

  isSorted - if true, the NiceTable is sorted.

  isSorted

  public boolean isSorted()

  Is the table sorted?

  getBaseModel

  public javax.swing.table.TableModel getBaseModel()

  Get the "base" model of the table. For unsorted tables, this just returns getModel(). For sorted tables, this returns the "real" model of the table instead of the decorator being used to sort the rows.

  Returns:

  a table model for the table.

  getSelectedRowsInModel

  public int[] getSelectedRowsInModel()

  Get the selected rows as model rows, regardless of whether this table is currently sorted.

  getPersistentSettings

  public NiceTablePersistentSettings getPersistentSettings()

  Get a javabean storing persistent settings of this NiceTable which you can serialize in order to restore the visible appearance of the table next time it is used. At the moment, the stored settings are:

  • Which columns are hidden
  • The width of each column

  setPersistentSettings

  public void setPersistentSettings(NiceTablePersistentSettings settings)

  Set the persistent view settings of this NiceTable.

  Parameters:

  settings -

  setSortColumn

  public void setSortColumn(int modelColumn,
                            boolean isSortAscending)

  Set the column to sort the view by.

  Parameters:

  modelColumn - the column to sort by

  isSortAscending - if true, the table is sorted in ascending order

  getSortColumn

  public int getSortColumn()

  Get the (model) sort column

  Returns:

  the column in the model that the table view is being sorted by

  isSortAscending

  public boolean isSortAscending()

  Is the sorted column being sorted in ascending order?

  setHiddenColumns

  public void setHiddenColumns(int[] hiddenColumns)

  Set columns that are hidden. You should only call this after setting the model.

  Parameters:

  hiddenColumns - columns which are currently hidden

  getHiddenColumns

  public int[] getHiddenColumns()

  Get columns that are hidden. You should only call this after setting the model.

  Returns:

  an array of model column indices

  setColumnSelectorAvailable

  public void setColumnSelectorAvailable(boolean isAvailable)

  Set whether this NiceTable will display a context menu on the table headers allowing the user to hide and show columns.

  Parameters:

  isAvailable - if true, a context menu will be provided on the header of this table with checkbox menu items for each column. The user can use these to hide and show columns.

  isColumnSelectorAvailable

  public boolean isColumnSelectorAvailable()

  Get whether the context menu for hiding and showing columns is available on this instance of NiceTable

  Returns:

  whether the context menu is available.

  getScrollPaneForTable

  public javax.swing.JScrollPane getScrollPaneForTable()

  Get a scroll pane for this table. Use this in preference to new JScrollPane( JTable ) to ensure that the viewport background color is the same as the table background color. no longer necessary to do this. The scrollpane will be configured automatically when you construct a JScrollPane(this).

  configureEnclosingScrollPane

  protected void configureEnclosingScrollPane()

  setShowToolTips

  public void setShowToolTips(boolean showToolTips)

  Controls whether this NiceTable will show tooltips for cells that are truncated due to reduced column width.

  isShowToolTips

  public boolean isShowToolTips()

  Get whether tooltips are being shown for truncated cells.

  Returns:

  true if tooltips are being shown for truncated cells.

  getToolTipText

  public java.lang.String getToolTipText(java.awt.event.MouseEvent event)

  Override to provide a tooltip for cells that are obscured because they are too small to display their renderer properly. This functionality only really works well for tables where the objects in the cell have a sensible toString() method. If this isn't the case, you may want to switch this behavior off by calling setShowToolTips( false ).

  Returns:

  tooltip

  autoSizeColumnsToFit

  public void autoSizeColumnsToFit()

  Utility method that will set the preferred size of all columns in this table so that they are just big enough to display their contents. This method works best when the column auto-resizing behavior is turned off. You can turn it off using:

     m_table.setAutoResizeMode( NiceTable.AUTO_RESIZE_OFF );
   

  setResizeColumnOnDoubleClick

  public void setResizeColumnOnDoubleClick(boolean isOn)

  Set whether the user can resize columns in this table by double clicking the resize divider between two columns. This behavior is ON by default. This property works best if the column auto-resizing behavior is turned off in the table. You can turn it off using:

     m_table.setAutoResizeMode( NiceTable.AUTO_RESIZE_OFF );
   

  Parameters:

  isOn - if true, the user can resize columns

  isResizeColumnOnDoubleClick

  public boolean isResizeColumnOnDoubleClick()

  Get whether the user can resize columns in this table by double clicking the resize divider between two columns. This behavior is ON by default.