JTable (Java 2 Platform SE v1.4.2)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Std. Ed. v1.4.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
Class JTable

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JTable

All Implemented Interfaces:: Accessible, CellEditorListener, EventListener, ImageObserver, ListSelectionListener, MenuContainer, Scrollable, Serializable, TableColumnModelListener, TableModelListener

public class JTable
extends JComponent
implements TableModelListener, Scrollable, TableColumnModelListener, ListSelectionListener, CellEditorListener, Accessible

The JTable is used to display and edit regular two-dimensional tables of cells. See How to Use Tables in The Java Tutorial for task-oriented documentation and examples of using JTable.

The JTable has many facilities that make it possible to customize its rendering and editing but provides defaults for these features so that simple tables can be set up easily. For example, to set up a table with 10 rows and 10 columns of numbers:

      TableModel dataModel = new AbstractTableModel() {
          public int getColumnCount() { return 10; }
          public int getRowCount() { return 10;}
          public Object getValueAt(int row, int col) { return new Integer(row*col); }
      };
      JTable table = new JTable(dataModel);
      JScrollPane scrollpane = new JScrollPane(table);

Note that if you wish to use a JTable in a standalone view (outside of a JScrollPane) and want the header displayed, you can get it using getTableHeader() and display it separately.

When designing applications that use the JTable it is worth paying close attention to the data structures that will represent the table's data. The DefaultTableModel is a model implementation that uses a Vector of Vectors of Objects to store the cell values. As well as copying the data from an application into the DefaultTableModel, it is also possible to wrap the data in the methods of the TableModel interface so that the data can be passed to the JTable directly, as in the example above. This often results in more efficient applications because the model is free to choose the internal representation that best suits the data. A good rule of thumb for deciding whether to use the AbstractTableModel or the DefaultTableModel is to use the AbstractTableModel as the base class for creating subclasses and the DefaultTableModel when subclassing is not required.

The "TableExample" directory in the demo area of the source distribution gives a number of complete examples of JTable usage, covering how the JTable can be used to provide an editable view of data taken from a database and how to modify the columns in the display to use specialized renderers and editors.

The JTable uses integers exclusively to refer to both the rows and the columns of the model that it displays. The JTable simply takes a tabular range of cells and uses getValueAt(int, int) to retrieve the values from the model during painting.

By default, columns may be rearranged in the JTable so that the view's columns appear in a different order to the columns in the model. This does not affect the implementation of the model at all: when the columns are reordered, the JTable maintains the new order of the columns internally and converts its column indices before querying the model.

So, when writing a TableModel, it is not necessary to listen for column reordering events as the model will be queried in its own coordinate system regardless of what is happening in the view. In the examples area there is a demonstration of a sorting algorithm making use of exactly this technique to interpose yet another coordinate system where the order of the rows is changed, rather than the order of the columns.

As for all JComponent classes, you can use InputMap and ActionMap to associate an Action object with a KeyStroke and execute the action under specified conditions.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JTable key assignments.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder.

Nested Class Summary
`protected class`	`JTable.AccessibleJTable` This class implements accessibility support for the `JTable` class.

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary
`static int`	`AUTO_RESIZE_ALL_COLUMNS` During all resize operations, proportionately resize all columns.
`static int`	`AUTO_RESIZE_LAST_COLUMN` During all resize operations, apply adjustments to the last column only.
`static int`	`AUTO_RESIZE_NEXT_COLUMN` When a column is adjusted in the UI, adjust the next column the opposite way.
`static int`	`AUTO_RESIZE_OFF` Do not adjust column widths automatically; use a scrollbar.
`static int`	`AUTO_RESIZE_SUBSEQUENT_COLUMNS` During UI adjustment, change subsequent columns to preserve the total width; this is the default behavior.
`protected boolean`	`autoCreateColumnsFromModel` The table will query the `TableModel` to build the default set of columns if this is true.
`protected int`	`autoResizeMode` Determines if the table automatically resizes the width of the table's columns to take up the entire width of the table, and how it does the resizing.
`protected TableCellEditor`	`cellEditor` The object that overwrites the screen real estate occupied by the current cell and allows the user to change its contents.
`protected boolean`	`cellSelectionEnabled` Obsolete as of Java 2 platform v1.3.
`protected TableColumnModel`	`columnModel` The `TableColumnModel` of the table.
`protected TableModel`	`dataModel` The `TableModel` of the table.
`protected Hashtable`	`defaultEditorsByColumnClass` A table of objects that display and edit the contents of a cell, indexed by class as declared in `getColumnClass` in the `TableModel` interface.
`protected Hashtable`	`defaultRenderersByColumnClass` A table of objects that display the contents of a cell, indexed by class as declared in `getColumnClass` in the `TableModel` interface.
`protected int`	`editingColumn` Identifies the column of the cell being edited.
`protected int`	`editingRow` Identifies the row of the cell being edited.
`protected Component`	`editorComp` If editing, the `Component` that is handling the editing.
`protected Color`	`gridColor` The color of the grid.
`protected Dimension`	`preferredViewportSize` Used by the `Scrollable` interface to determine the initial visible area.
`protected int`	`rowHeight` The height in pixels of each row in the table.
`protected int`	`rowMargin` The height in pixels of the margin between the cells in each row.
`protected boolean`	`rowSelectionAllowed` True if row selection is allowed in this table.
`protected Color`	`selectionBackground` The background color of selected cells.
`protected Color`	`selectionForeground` The foreground color of selected cells.
`protected ListSelectionModel`	`selectionModel` The `ListSelectionModel` of the table, used to keep track of row selections.
`protected boolean`	`showHorizontalLines` The table draws horizontal lines between cells if `showHorizontalLines` is true.
`protected boolean`	`showVerticalLines` The table draws vertical lines between cells if `showVerticalLines` is true.
`protected JTableHeader`	`tableHeader` The `TableHeader` working with the table.

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

Method Summary
`void`	`addColumn(TableColumn aColumn)` Appends `aColumn` to the end of the array of columns held by this `JTable`'s column model.
`void`	`addColumnSelectionInterval(int index0, int index1)` Adds the columns from `index0` to `index1`, inclusive, to the current selection.
`void`	`addNotify()` Calls the `configureEnclosingScrollPane` method.
`void`	`addRowSelectionInterval(int index0, int index1)` Adds the rows from `index0` to `index1`, inclusive, to the current selection.
`void`	`changeSelection(int rowIndex, int columnIndex, boolean toggle, boolean extend)` Updates the selection models of the table, depending on the state of the two flags: `toggle` and `extend`.
`void`	`clearSelection()` Deselects all selected columns and rows.
`void`	`columnAdded(TableColumnModelEvent e)` Invoked when a column is added to the table column model.
`int`	`columnAtPoint(Point point)` Returns the index of the column that `point` lies in, or -1 if the result is not in the range [0, `getColumnCount()`-1].
`void`	`columnMarginChanged(ChangeEvent e)` Invoked when a column is moved due to a margin change.
`void`	`columnMoved(TableColumnModelEvent e)` Invoked when a column is repositioned.
`void`	`columnRemoved(TableColumnModelEvent e)` Invoked when a column is removed from the table column model.
`void`	`columnSelectionChanged(ListSelectionEvent e)` Invoked when the selection model of the `TableColumnModel` is changed.
`protected void`	`configureEnclosingScrollPane()` If this `JTable` is the `viewportView` of an enclosing `JScrollPane` (the usual situation), configure this `ScrollPane` by, amongst other things, installing the table's `tableHeader` as the `columnHeaderView` of the scroll pane.
`int`	`convertColumnIndexToModel(int viewColumnIndex)` Maps the index of the column in the view at `viewColumnIndex` to the index of the column in the table model.
`int`	`convertColumnIndexToView(int modelColumnIndex)` Maps the index of the column in the table model at `modelColumnIndex` to the index of the column in the view.
`protected TableColumnModel`	`createDefaultColumnModel()` Returns the default column model object, which is a `DefaultTableColumnModel`.
`void`	`createDefaultColumnsFromModel()` Creates default columns for the table from the data model using the `getColumnCount` method defined in the `TableModel` interface.
`protected TableModel`	`createDefaultDataModel()` Returns the default table model object, which is a `DefaultTableModel`.
`protected void`	`createDefaultEditors()` Creates default cell editors for objects, numbers, and boolean values.
`protected void`	`createDefaultRenderers()` Creates default cell renderers for objects, numbers, doubles, dates, booleans, and icons.
`protected ListSelectionModel`	`createDefaultSelectionModel()` Returns the default selection model object, which is a `DefaultListSelectionModel`.
`protected JTableHeader`	`createDefaultTableHeader()` Returns the default table header object, which is a `JTableHeader`.
`static JScrollPane`	`createScrollPaneForTable(JTable aTable)` Deprecated. As of Swing version 1.0.2, replaced by `new JScrollPane(aTable)`.
`void`	`doLayout()` Causes this table to lay out its rows and columns.
`boolean`	`editCellAt(int row, int column)` Programmatically starts editing the cell at `row` and `column`, if the cell is editable.
`boolean`	`editCellAt(int row, int column, EventObject e)` Programmatically starts editing the cell at `row` and `column`, if the cell is editable.
`void`	`editingCanceled(ChangeEvent e)` Invoked when editing is canceled.
`void`	`editingStopped(ChangeEvent e)` Invoked when editing is finished.
`AccessibleContext`	`getAccessibleContext()` Gets the AccessibleContext associated with this JTable.
`boolean`	`getAutoCreateColumnsFromModel()` Determines whether the table will create default columns from the model.
`int`	`getAutoResizeMode()` Returns the auto resize mode of the table.
`TableCellEditor`	`getCellEditor()` Returns the cell editor.
`TableCellEditor`	`getCellEditor(int row, int column)` Returns an appropriate editor for the cell specified by `row` and `column`.
`Rectangle`	`getCellRect(int row, int column, boolean includeSpacing)` Returns a rectangle for the cell that lies at the intersection of `row` and `column`.
`TableCellRenderer`	`getCellRenderer(int row, int column)` Returns an appropriate renderer for the cell specified by this row and column.
`boolean`	`getCellSelectionEnabled()` Returns true if both row and column selection models are enabled.
`TableColumn`	`getColumn(Object identifier)` Returns the `TableColumn` object for the column in the table whose identifier is equal to `identifier`, when compared using `equals`.
`Class`	`getColumnClass(int column)` Returns the type of the column appearing in the view at column position `column`.
`int`	`getColumnCount()` Returns the number of columns in the column model.
`TableColumnModel`	`getColumnModel()` Returns the `TableColumnModel` that contains all column information of this table.
`String`	`getColumnName(int column)` Returns the name of the column appearing in the view at column position `column`.
`boolean`	`getColumnSelectionAllowed()` Returns true if columns can be selected.
`TableCellEditor`	`getDefaultEditor(Class columnClass)` Returns the editor to be used when no editor has been set in a `TableColumn`.
`TableCellRenderer`	`getDefaultRenderer(Class columnClass)` Returns the cell renderer to be used when no renderer has been set in a `TableColumn`.
`boolean`	`getDragEnabled()` Gets the value of the `dragEnabled` property.
`int`	`getEditingColumn()` Returns the index of the column that contains the cell currently being edited.
`int`	`getEditingRow()` Returns the index of the row that contains the cell currently being edited.
`Component`	`getEditorComponent()` Returns the component that is handling the editing session.
`Color`	`getGridColor()` Returns the color used to draw grid lines.
`Dimension`	`getIntercellSpacing()` Returns the horizontal and vertical space between cells.
`TableModel`	`getModel()` Returns the `TableModel` that provides the data displayed by this `JTable`.
`Dimension`	`getPreferredScrollableViewportSize()` Returns the preferred size of the viewport for this table.
`int`	`getRowCount()` Returns the number of rows in this table's model.
`int`	`getRowHeight()` Returns the height of a table row, in pixels.
`int`	`getRowHeight(int row)` Returns the height, in pixels, of the cells in `row`.
`int`	`getRowMargin()` Gets the amount of empty space, in pixels, between cells.
`boolean`	`getRowSelectionAllowed()` Returns true if rows can be selected.
`int`	`getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)` Returns `visibleRect.height` or `visibleRect.width`, depending on this table's orientation.
`boolean`	`getScrollableTracksViewportHeight()` Returns false to indicate that the height of the viewport does not determine the height of the table.
`boolean`	`getScrollableTracksViewportWidth()` Returns false if `autoResizeMode` is set to `AUTO_RESIZE_OFF`, which indicates that the width of the viewport does not determine the width of the table.
`int`	`getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)` Returns the scroll increment (in pixels) that completely exposes one new row or column (depending on the orientation).
`int`	`getSelectedColumn()` Returns the index of the first selected column, -1 if no column is selected.
`int`	`getSelectedColumnCount()` Returns the number of selected columns.
`int[]`	`getSelectedColumns()` Returns the indices of all selected columns.
`int`	`getSelectedRow()` Returns the index of the first selected row, -1 if no row is selected.
`int`	`getSelectedRowCount()` Returns the number of selected rows.
`int[]`	`getSelectedRows()` Returns the indices of all selected rows.
`Color`	`getSelectionBackground()` Returns the background color for selected cells.
`Color`	`getSelectionForeground()` Returns the foreground color for selected cells.
`ListSelectionModel`	`getSelectionModel()` Returns the `ListSelectionModel` that is used to maintain row selection state.
`boolean`	`getShowHorizontalLines()` Returns true if the table draws horizontal lines between cells, false if it doesn't.
`boolean`	`getShowVerticalLines()` Returns true if the table draws vertical lines between cells, false if it doesn't.
`boolean`	`getSurrendersFocusOnKeystroke()` Returns true if the editor should get the focus when keystrokes cause the editor to be activated
`JTableHeader`	`getTableHeader()` Returns the `tableHeader` used by this `JTable`.
`String`	`getToolTipText(MouseEvent event)` Overrides `JComponent`'s `getToolTipText` method in order to allow the renderer's tips to be used if it has text set.
`TableUI`	`getUI()` Returns the L&F object that renders this component.
`String`	`getUIClassID()` Returns the suffix used to construct the name of the L&F class used to render this component.
`Object`	`getValueAt(int row, int column)` Returns the cell value at `row` and `column`.
`protected void`	`initializeLocalVars()` Initializes table properties to their default values.
`boolean`	`isCellEditable(int row, int column)` Returns true if the cell at `row` and `column` is editable.
`boolean`	`isCellSelected(int row, int column)` Returns true if the cell at the specified position is selected.
`boolean`	`isColumnSelected(int column)` Returns true if the column at the specified index is selected.
`boolean`	`isEditing()` Returns true if a cell is being edited.
`boolean`	`isRowSelected(int row)` Returns true if the row at the specified index is selected.
`void`	`moveColumn(int column, int targetColumn)` Moves the column `column` to the position currently occupied by the column `targetColumn` in the view.
`protected String`	`paramString()` Returns a string representation of this table.
`Component`	`prepareEditor(TableCellEditor editor, int row, int column)` Prepares the editor by querying the data model for the value and selection state of the cell at `row`, `column`.
`Component`	`prepareRenderer(TableCellRenderer renderer, int row, int column)` Prepares the renderer by querying the data model for the value and selection state of the cell at `row`, `column`.
`protected boolean`	`processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)` Invoked to process the key bindings for `ks` as the result of the `KeyEvent` `e`.
`void`	`removeColumn(TableColumn aColumn)` Removes `aColumn` from this `JTable`'s array of columns.
`void`	`removeColumnSelectionInterval(int index0, int index1)` Deselects the columns from `index0` to `index1`, inclusive.
`void`	`removeEditor()` Discards the editor object and frees the real estate it used for cell rendering.
`void`	`removeNotify()` Calls the `unconfigureEnclosingScrollPane` method.
`void`	`removeRowSelectionInterval(int index0, int index1)` Deselects the rows from `index0` to `index1`, inclusive.
`protected void`	`resizeAndRepaint()` Equivalent to `revalidate` followed by `repaint`.
`int`	`rowAtPoint(Point point)` Returns the index of the row that `point` lies in, or -1 if the result is not in the range [0, `getRowCount()`-1].
`void`	`selectAll()` Selects all rows, columns, and cells in the table.
`void`	`setAutoCreateColumnsFromModel(boolean autoCreateColumnsFromModel)` Sets this table's `autoCreateColumnsFromModel` flag.
`void`	`setAutoResizeMode(int mode)` Sets the table's auto resize mode when the table is resized.
`void`	`setCellEditor(TableCellEditor anEditor)` Sets the `cellEditor` variable.
`void`	`setCellSelectionEnabled(boolean cellSelectionEnabled)` Sets whether this table allows both a column selection and a row selection to exist simultaneously.
`void`	`setColumnModel(TableColumnModel columnModel)` Sets the column model for this table to `newModel` and registers for listener notifications from the new column model.
`void`	`setColumnSelectionAllowed(boolean columnSelectionAllowed)` Sets whether the columns in this model can be selected.
`void`	`setColumnSelectionInterval(int index0, int index1)` Selects the columns from `index0` to `index1`, inclusive.
`void`	`setDefaultEditor(Class columnClass, TableCellEditor editor)` Sets a default cell editor to be used if no editor has been set in a `TableColumn`.
`void`	`setDefaultRenderer(Class columnClass, TableCellRenderer renderer)` Sets a default cell renderer to be used if no renderer has been set in a `TableColumn`.
`void`	`setDragEnabled(boolean b)` Sets the `dragEnabled` property, which must be `true` to enable automatic drag handling (the first part of drag and drop) on this component.
`void`	`setEditingColumn(int aColumn)` Sets the `editingColumn` variable.
`void`	`setEditingRow(int aRow)` Sets the `editingRow` variable.
`void`	`setGridColor(Color gridColor)` Sets the color used to draw grid lines to `gridColor` and redisplays.
`void`	`setIntercellSpacing(Dimension intercellSpacing)` Sets the `rowMargin` and the `columnMargin` -- the height and width of the space between cells -- to `intercellSpacing`.
`void`	`setModel(TableModel dataModel)` Sets the data model for this table to `newModel` and registers with it for listener notifications from the new data model.
`void`	`setPreferredScrollableViewportSize(Dimension size)` Sets the preferred size of the viewport for this table.
`void`	`setRowHeight(int rowHeight)` Sets the height, in pixels, of all cells to `rowHeight`, revalidates, and repaints.
`void`	`setRowHeight(int row, int rowHeight)` Sets the height for `row` to `rowHeight`, revalidates, and repaints.
`void`	`setRowMargin(int rowMargin)` Sets the amount of empty space between cells in adjacent rows.
`void`	`setRowSelectionAllowed(boolean rowSelectionAllowed)` Sets whether the rows in this model can be selected.
`void`	`setRowSelectionInterval(int index0, int index1)` Selects the rows from `index0` to `index1`, inclusive.
`void`	`setSelectionBackground(Color selectionBackground)` Sets the background color for selected cells.
`void`	`setSelectionForeground(Color selectionForeground)` Sets the foreground color for selected cells.
`void`	`setSelectionMode(int selectionMode)` Sets the table's selection mode to allow only single selections, a single contiguous interval, or multiple intervals.
`void`	`setSelectionModel(ListSelectionModel newModel)` Sets the row selection model for this table to `newModel` and registers for listener notifications from the new selection model.
`void`	`setShowGrid(boolean showGrid)` Sets whether the table draws grid lines around cells.
`void`	`setShowHorizontalLines(boolean showHorizontalLines)` Sets whether the table draws horizontal lines between cells.
`void`	`setShowVerticalLines(boolean showVerticalLines)` Sets whether the table draws vertical lines between cells.
`void`	`setSurrendersFocusOnKeystroke(boolean surrendersFocusOnKeystroke)` Sets whether editors in this JTable get the keyboard focus when an editor is activated as a result of the JTable forwarding keyboard events for a cell.
`void`	`setTableHeader(JTableHeader tableHeader)` Sets the `tableHeader` working with this `JTable` to `newHeader`.
`void`	`setUI(TableUI ui)` Sets the L&F object that renders this component and repaints.
`void`	`setValueAt(Object aValue, int row, int column)` Sets the value for the cell in the table model at `row` and `column`.
`void`	`sizeColumnsToFit(boolean lastColumnOnly)` Deprecated. As of Swing version 1.0.3, replaced by `doLayout()`.
`void`	`sizeColumnsToFit(int resizingColumn)` Obsolete as of Java 2 platform v1.4.
`void`	`tableChanged(TableModelEvent e)` Invoked when this table's `TableModel` generates a `TableModelEvent`.
`protected void`	`unconfigureEnclosingScrollPane()` Reverses the effect of `configureEnclosingScrollPane` by replacing the `columnHeaderView` of the enclosing scroll pane with `null`.
`void`	`updateUI()` Notification from the `UIManager` that the L&F has changed.
`void`	`valueChanged(ListSelectionEvent e)` Invoked when the row selection changes -- repaints to show the new selection.

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, setBackground, 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

Field Detail

AUTO_RESIZE_OFF

public static final int AUTO_RESIZE_OFF

Do not adjust column widths automatically; use a scrollbar.

See Also:: Constant Field Values

AUTO_RESIZE_NEXT_COLUMN

public static final int AUTO_RESIZE_NEXT_COLUMN

When a column is adjusted in the UI, adjust the next column the opposite way.

See Also:: Constant Field Values

AUTO_RESIZE_SUBSEQUENT_COLUMNS

public static final int AUTO_RESIZE_SUBSEQUENT_COLUMNS

During UI adjustment, change subsequent columns to preserve the total width; this is the default behavior.

See Also:: Constant Field Values

AUTO_RESIZE_LAST_COLUMN

public static final int AUTO_RESIZE_LAST_COLUMN

During all resize operations, apply adjustments to the last column only.

See Also:: Constant Field Values

AUTO_RESIZE_ALL_COLUMNS

public static final int AUTO_RESIZE_ALL_COLUMNS

During all resize operations, proportionately resize all columns.

See Also:: Constant Field Values

dataModel

protected TableModel dataModel

The TableModel of the table.

columnModel

protected TableColumnModel columnModel

The TableColumnModel of the table.

selectionModel

protected ListSelectionModel selectionModel

The ListSelectionModel of the table, used to keep track of row selections.

tableHeader

protected JTableHeader tableHeader

The TableHeader working with the table.

rowHeight

protected int rowHeight

The height in pixels of each row in the table.

rowMargin

protected int rowMargin

The height in pixels of the margin between the cells in each row.

gridColor

protected Color gridColor

The color of the grid.

showHorizontalLines

protected boolean showHorizontalLines

The table draws horizontal lines between cells if showHorizontalLines is true.

showVerticalLines

protected boolean showVerticalLines

The table draws vertical lines between cells if showVerticalLines is true.

autoResizeMode

protected int autoResizeMode

Determines if the table automatically resizes the width of the table's columns to take up the entire width of the table, and how it does the resizing.

autoCreateColumnsFromModel

protected boolean autoCreateColumnsFromModel

The table will query the TableModel to build the default set of columns if this is true.

preferredViewportSize

protected Dimension preferredViewportSize

Used by the Scrollable interface to determine the initial visible area.

rowSelectionAllowed

protected boolean rowSelectionAllowed

True if row selection is allowed in this table.

cellSelectionEnabled

protected boolean cellSelectionEnabled

Obsolete as of Java 2 platform v1.3. Please use the rowSelectionAllowed property and the columnSelectionAllowed property of the columnModel instead. Or use the method getCellSelectionEnabled.

editorComp

protected transient Component editorComp

If editing, the Component that is handling the editing.

cellEditor

protected transient TableCellEditor cellEditor

The object that overwrites the screen real estate occupied by the current cell and allows the user to change its contents.

editingColumn

protected transient int editingColumn

Identifies the column of the cell being edited.

editingRow

protected transient int editingRow

Identifies the row of the cell being edited.

defaultRenderersByColumnClass

protected transient Hashtable defaultRenderersByColumnClass

A table of objects that display the contents of a cell, indexed by class as declared in getColumnClass in the TableModel interface.

defaultEditorsByColumnClass

protected transient Hashtable defaultEditorsByColumnClass

A table of objects that display and edit the contents of a cell, indexed by class as declared in getColumnClass in the TableModel interface.

selectionForeground

protected Color selectionForeground

The foreground color of selected cells.

selectionBackground

protected Color selectionBackground

The background color of selected cells.

Constructor Detail

JTable

public JTable()

Constructs a default JTable that is initialized with a default data model, a default column model, and a default selection model.
See Also:: createDefaultDataModel(), createDefaultColumnModel(), createDefaultSelectionModel()

JTable

public JTable(TableModel dm)

Constructs a JTable 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
See Also:: createDefaultColumnModel(), createDefaultSelectionModel()

JTable

public JTable(TableModel dm,
              TableColumnModel cm)

Constructs a JTable 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
See Also:: createDefaultSelectionModel()

JTable

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

Constructs a JTable 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
See Also:: createDefaultDataModel(), createDefaultColumnModel(), createDefaultSelectionModel()

JTable

public JTable(int numRows,
              int numColumns)

Constructs a JTable 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
See Also:: DefaultTableModel

JTable

public JTable(Vector rowData,
              Vector columnNames)

Constructs a JTable 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

JTable

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

Constructs a JTable 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

Method Detail

addNotify

public void addNotify()

Calls the configureEnclosingScrollPane method.

Overrides:: addNotify in class JComponent

See Also:: configureEnclosingScrollPane()

configureEnclosingScrollPane

protected void configureEnclosingScrollPane()

If this JTable is the viewportView of an enclosing JScrollPane (the usual situation), configure this ScrollPane by, amongst other things, installing the table's tableHeader as the columnHeaderView of the scroll pane. When a JTable is added to a JScrollPane in the usual way, using new JScrollPane(myTable), addNotify is called in the JTable (when the table is added to the viewport). JTable's addNotify method in turn calls this method, which is protected so that this default installation procedure can be overridden by a subclass.

See Also:: addNotify()

removeNotify

public void removeNotify()

Calls the unconfigureEnclosingScrollPane method.

Overrides:: removeNotify in class JComponent

See Also:: unconfigureEnclosingScrollPane()

unconfigureEnclosingScrollPane

protected void unconfigureEnclosingScrollPane()

Reverses the effect of configureEnclosingScrollPane by replacing the columnHeaderView of the enclosing scroll pane with null. JTable's removeNotify method calls this method, which is protected so that this default uninstallation procedure can be overridden by a subclass.

See Also:: removeNotify(), configureEnclosingScrollPane()

createScrollPaneForTable

public static JScrollPane createScrollPaneForTable(JTable aTable)

Deprecated. As of Swing version 1.0.2, replaced by new JScrollPane(aTable).

Equivalent to new JScrollPane(aTable).

setTableHeader

public void setTableHeader(JTableHeader tableHeader)

Sets the tableHeader working with this JTable to newHeader. It is legal to have a null tableHeader.

Parameters:: tableHeader - new tableHeader
See Also:: getTableHeader()

getTableHeader

public JTableHeader getTableHeader()

Returns the tableHeader used by this JTable.

Returns:: the tableHeader used by this table
See Also:: setTableHeader(javax.swing.table.JTableHeader)

setRowHeight

public void setRowHeight(int rowHeight)

Sets the height, in pixels, of all cells to rowHeight, revalidates, and repaints. The height of the cells will be equal to the row height minus the row margin.

Parameters:: rowHeight - new row height
Throws:: IllegalArgumentException - if rowHeight is less than 1
See Also:: getRowHeight()

getRowHeight

public int getRowHeight()

Returns the height of a table row, in pixels. The default row height is 16.0.

Returns:: the height in pixels of a table row
See Also:: setRowHeight(int)

setRowHeight

public void setRowHeight(int row,
                         int rowHeight)

Sets the height for row to rowHeight, revalidates, and repaints. The height of the cells in this row will be equal to the row height minus the row margin.

Parameters:: row - the row whose height is being changed; rowHeight - new row height, in pixels
Throws:: IllegalArgumentException - if rowHeight is less than 1

getRowHeight

public int getRowHeight(int row)

Returns the height, in pixels, of the cells in row.

Parameters:: row - the row whose height is to be returned
Returns:: the height, in pixels, of the cells in the row

setRowMargin

public void setRowMargin(int rowMargin)

Sets the amount of empty space between cells in adjacent rows.

Parameters:: rowMargin - the number of pixels between cells in a row
See Also:: getRowMargin()

getRowMargin

public int getRowMargin()

Gets the amount of empty space, in pixels, between cells. Equivalent to: getIntercellSpacing().height.

Returns:: the number of pixels between cells in a row
See Also:: setRowMargin(int)

setIntercellSpacing

public void setIntercellSpacing(Dimension intercellSpacing)

Sets the rowMargin and the columnMargin -- the height and width of the space between cells -- to intercellSpacing.

Parameters:: intercellSpacing - a Dimension specifying the new width and height between cells
See Also:: getIntercellSpacing()

getIntercellSpacing

public Dimension getIntercellSpacing()

Returns the horizontal and vertical space between cells. The default spacing is (1, 1), which provides room to draw the grid.

Returns:: the horizontal and vertical spacing between cells
See Also:: setIntercellSpacing(java.awt.Dimension)

setGridColor

public void setGridColor(Color gridColor)

Sets the color used to draw grid lines to gridColor and redisplays. The default color is look and feel dependent.

Parameters:: gridColor - the new color of the grid lines
Throws:: IllegalArgumentException - if gridColor is null
See Also:: getGridColor()

getGridColor

public Color getGridColor()

Returns the color used to draw grid lines. The default color is look and feel dependent.

Returns:: the color used to draw grid lines
See Also:: setGridColor(java.awt.Color)

setShowGrid

public void setShowGrid(boolean showGrid)

Sets whether the table draws grid lines around cells. If showGrid is true it does; if it is false it doesn't. There is no getShowGrid method as this state is held in two variables -- showHorizontalLines and showVerticalLines -- each of which can be queried independently.

Parameters:: showGrid - true if table view should draw grid lines
See Also:: setShowVerticalLines(boolean), setShowHorizontalLines(boolean)

setShowHorizontalLines

public void setShowHorizontalLines(boolean showHorizontalLines)

Sets whether the table draws horizontal lines between cells. If showHorizontalLines is true it does; if it is false it doesn't.

Parameters:: showHorizontalLines - true if table view should draw horizontal lines
See Also:: getShowHorizontalLines(), setShowGrid(boolean), setShowVerticalLines(boolean)

setShowVerticalLines

public void setShowVerticalLines(boolean showVerticalLines)

Sets whether the table draws vertical lines between cells. If showVerticalLines is true it does; if it is false it doesn't.

Parameters:: showVerticalLines - true if table view should draw vertical lines
See Also:: getShowVerticalLines(), setShowGrid(boolean), setShowHorizontalLines(boolean)

getShowHorizontalLines

public boolean getShowHorizontalLines()

Returns true if the table draws horizontal lines between cells, false if it doesn't. The default is true.

Returns:: true if the table draws horizontal lines between cells, false if it doesn't
See Also:: setShowHorizontalLines(boolean)

getShowVerticalLines

public boolean getShowVerticalLines()

Returns true if the table draws vertical lines between cells, false if it doesn't. The default is true.

Returns:: true if the table draws vertical lines between cells, false if it doesn't
See Also:: setShowVerticalLines(boolean)

setAutoResizeMode

public void setAutoResizeMode(int mode)

Sets the table's auto resize mode when the table is resized.

Parameters:: mode - One of 5 legal values: AUTO_RESIZE_OFF, AUTO_RESIZE_NEXT_COLUMN, AUTO_RESIZE_SUBSEQUENT_COLUMNS, AUTO_RESIZE_LAST_COLUMN, AUTO_RESIZE_ALL_COLUMNS
See Also:: getAutoResizeMode(), doLayout()

getAutoResizeMode

public int getAutoResizeMode()

Returns the auto resize mode of the table. The default mode is AUTO_RESIZE_SUBSEQUENT_COLUMNS.

Returns:: the autoResizeMode of the table
See Also:: setAutoResizeMode(int), doLayout()

setAutoCreateColumnsFromModel

public void setAutoCreateColumnsFromModel(boolean autoCreateColumnsFromModel)

Sets this table's autoCreateColumnsFromModel flag. This method calls createDefaultColumnsFromModel if autoCreateColumnsFromModel changes from false to true.

Parameters:: autoCreateColumnsFromModel - true if JTable should automatically create columns
See Also:: getAutoCreateColumnsFromModel(), createDefaultColumnsFromModel()

getAutoCreateColumnsFromModel

public boolean getAutoCreateColumnsFromModel()

Determines whether the table will create default columns from the model. If true, setModel will clear any existing columns and create new columns from the new model. Also, if the event in the tableChanged notification specifies that the entire table changed, then the columns will be rebuilt. The default is true.

Returns:: the autoCreateColumnsFromModel of the table
See Also:: setAutoCreateColumnsFromModel(boolean), createDefaultColumnsFromModel()

createDefaultColumnsFromModel

public void createDefaultColumnsFromModel()

Creates default columns for the table from the data model using the getColumnCount method defined in the TableModel interface.

Clears any existing columns before creating the new columns based on information from the model.

See Also:: getAutoCreateColumnsFromModel()

setDefaultRenderer

public void setDefaultRenderer(Class columnClass,
                               TableCellRenderer renderer)

Sets a default cell renderer to be used if no renderer has been set in a TableColumn. If renderer is null, removes the default renderer for this column class.

Parameters:: columnClass - set the default cell renderer for this columnClass; renderer - default cell renderer to be used for this columnClass
See Also:: getDefaultRenderer(java.lang.Class), setDefaultEditor(java.lang.Class, javax.swing.table.TableCellEditor)

getDefaultRenderer

public TableCellRenderer getDefaultRenderer(Class columnClass)

Returns the cell renderer to be used when no renderer has been set in a TableColumn. During the rendering of cells the renderer is fetched from a Hashtable of entries according to the class of the cells in the column. If there is no entry for this columnClass the method returns the entry for the most specific superclass. The JTable installs entries for Object, Number, and Boolean, all of which can be modified or replaced.

Parameters:: columnClass - return the default cell renderer for this columnClass
Returns:: the renderer for this columnClass
See Also:: setDefaultRenderer(java.lang.Class, javax.swing.table.TableCellRenderer), getColumnClass(int)

setDefaultEditor

public void setDefaultEditor(Class columnClass,
                             TableCellEditor editor)

Sets a default cell editor to be used if no editor has been set in a TableColumn. If no editing is required in a table, or a particular column in a table, uses the isCellEditable method in the TableModel interface to ensure that this JTable will not start an editor in these columns. If editor is null, removes the default editor for this column class.

Parameters:: columnClass - set the default cell editor for this columnClass; editor - default cell editor to be used for this columnClass
See Also:: TableModel.isCellEditable(int, int), getDefaultEditor(java.lang.Class), setDefaultRenderer(java.lang.Class, javax.swing.table.TableCellRenderer)

getDefaultEditor

public TableCellEditor getDefaultEditor(Class columnClass)

Returns the editor to be used when no editor has been set in a TableColumn. During the editing of cells the editor is fetched from a Hashtable of entries according to the class of the cells in the column. If there is no entry for this columnClass the method returns the entry for the most specific superclass. The JTable installs entries for Object, Number, and Boolean, all of which can be modified or replaced.

Parameters:: columnClass - return the default cell editor for this columnClass
Returns:: the default cell editor to be used for this columnClass
See Also:: setDefaultEditor(java.lang.Class, javax.swing.table.TableCellEditor), getColumnClass(int)

setDragEnabled

public void setDragEnabled(boolean b)

Sets the dragEnabled property, which must be true to enable automatic drag handling (the first part of drag and drop) on this component. The transferHandler property needs to be set to a non-null value for the drag to do anything. The default value of the dragEnabledfalse.

When automatic drag handling is enabled, most look and feels begin a drag-and-drop operation whenever the user presses the mouse button over a selection and then moves the mouse a few pixels. Setting this property to true can therefore have a subtle effect on how selections behave.

Some look and feels might not support automatic drag and drop; they will ignore this property. You can work around such look and feels by modifying the component to directly call the exportAsDrag method of a TransferHandler.

Parameters:: b - the value to set the dragEnabled property to
Throws:: HeadlessException - if b is true and GraphicsEnvironment.isHeadless() returns true
Since:: 1.4
See Also:: GraphicsEnvironment.isHeadless(), getDragEnabled(), JComponent.setTransferHandler(javax.swing.TransferHandler), TransferHandler

getDragEnabled

public boolean getDragEnabled()

Gets the value of the dragEnabled property.

Returns:: the value of the dragEnabled property
Since:: 1.4
See Also:: setDragEnabled(boolean)

setSelectionMode

public void setSelectionMode(int selectionMode)

Sets the table's selection mode to allow only single selections, a single contiguous interval, or multiple intervals.

Note: JTable provides all the methods for handling column and row selection. When setting states, such as setSelectionMode, it not only updates the mode for the row selection model but also sets similar values in the selection model of the columnModel. If you want to have the row and column selection models operating in different modes, set them both directly.

Both the row and column selection models for JTable default to using a DefaultListSelectionModel so that JTable works the same way as the JList. See the setSelectionMode method in JList for details about the modes.

See Also:: JList.setSelectionMode(int)

setRowSelectionAllowed

public void setRowSelectionAllowed(boolean rowSelectionAllowed)

Sets whether the rows in this model can be selected.

Parameters:: rowSelectionAllowed - true if this model will allow row selection
See Also:: getRowSelectionAllowed()

getRowSelectionAllowed

public boolean getRowSelectionAllowed()

Returns true if rows can be selected.

Returns:: true if rows can be selected, otherwise false
See Also:: setRowSelectionAllowed(boolean)

setColumnSelectionAllowed

public void setColumnSelectionAllowed(boolean columnSelectionAllowed)

Sets whether the columns in this model can be selected.

Parameters:: columnSelectionAllowed - true if this model will allow column selection
See Also:: getColumnSelectionAllowed()

getColumnSelectionAllowed

public boolean getColumnSelectionAllowed()

Returns true if columns can be selected.

Returns:: true if columns can be selected, otherwise false
See Also:: setColumnSelectionAllowed(boolean)

setCellSelectionEnabled

public void setCellSelectionEnabled(boolean cellSelectionEnabled)

Sets whether this table allows both a column selection and a row selection to exist simultaneously. When set, the table treats the intersection of the row and column selection models as the selected cells. Override isCellSelected to change this default behavior. This method is equivalent to setting both the rowSelectionAllowed property and columnSelectionAllowed property of the columnModel to the supplied value.

Parameters:: cellSelectionEnabled - true if simultaneous row and column selection is allowed
See Also:: getCellSelectionEnabled(), isCellSelected(int, int)

getCellSelectionEnabled

public boolean getCellSelectionEnabled()

Returns true if both row and column selection models are enabled. Equivalent to

getRowSelectionAllowed() &&
 getColumnSelectionAllowed()

Returns:: true if both row and column selection models are enabled
See Also:: setCellSelectionEnabled(boolean)

selectAll

public void selectAll()

Selects all rows, columns, and cells in the table.

clearSelection

public void clearSelection()

Deselects all selected columns and rows.

setRowSelectionInterval

public void setRowSelectionInterval(int index0,
                                    int index1)

Selects the rows from index0 to index1, inclusive.

Parameters:: index0 - one end of the interval; index1 - the other end of the interval
Throws:: IllegalArgumentException - if index0 or index1 lie outside [0, getRowCount()-1]

setColumnSelectionInterval

public void setColumnSelectionInterval(int index0,
                                       int index1)

Selects the columns from index0 to index1, inclusive.

Parameters:: index0 - one end of the interval; index1 - the other end of the interval
Throws:: IllegalArgumentException - if index0 or index1 lie outside [0, getColumnCount()-1]

addRowSelectionInterval

public void addRowSelectionInterval(int index0,
                                    int index1)

Adds the rows from index0 to index1, inclusive, to the current selection.

Parameters:: index0 - one end of the interval; index1 - the other end of the interval
Throws:: IllegalArgumentException - if index0 or index1 lie outside [0, getRowCount()-1]

addColumnSelectionInterval

public void addColumnSelectionInterval(int index0,
                                       int index1)

Adds the columns from index0 to index1, inclusive, to the current selection.

Parameters:: index0 - one end of the interval; index1 - the other end of the interval
Throws:: IllegalArgumentException - if index0 or index1 lie outside [0, getColumnCount()-1]

removeRowSelectionInterval

public void removeRowSelectionInterval(int index0,
                                       int index1)

Deselects the rows from index0 to index1, inclusive.

Parameters:: index0 - one end of the interval; index1 - the other end of the interval
Throws:: IllegalArgumentException - if index0 or index1 lie outside [0, getRowCount()-1]

removeColumnSelectionInterval

public void removeColumnSelectionInterval(int index0,
                                          int index1)

Deselects the columns from index0 to index1, inclusive.

Parameters:: index0 - one end of the interval; index1 - the other end of the interval
Throws:: IllegalArgumentException - if index0 or index1 lie outside [0, getColumnCount()-1]

getSelectedRow

public int getSelectedRow()

Returns the index of the first selected row, -1 if no row is selected.

Returns:: the index of the first selected row

getSelectedColumn

public int getSelectedColumn()

Returns the index of the first selected column, -1 if no column is selected.

Returns:: the index of the first selected column

getSelectedRows

public int[] getSelectedRows()

Returns the indices of all selected rows.

Returns:: an array of integers containing the indices of all selected rows, or an empty array if no row is selected
See Also:: getSelectedRow()

getSelectedColumns

public int[] getSelectedColumns()

Returns the indices of all selected columns.

Returns:: an array of integers containing the indices of all selected columns, or an empty array if no column is selected
See Also:: getSelectedColumn()

getSelectedRowCount

public int getSelectedRowCount()

Returns the number of selected rows.

Returns:: the number of selected rows, 0 if no rows are selected

getSelectedColumnCount

public int getSelectedColumnCount()

Returns the number of selected columns.

Returns:: the number of selected columns, 0 if no columns are selected

isRowSelected

public boolean isRowSelected(int row)

Returns true if the row at the specified index is selected.

Returns:: true if the row at index row is selected, where 0 is the first row
Throws:: IllegalArgumentException - if row is not in the valid range

isColumnSelected

public boolean isColumnSelected(int column)

Returns true if the column at the specified index is selected.

Parameters:: column - the column in the column model
Returns:: true if the column at index column is selected, where 0 is the first column
Throws:: IllegalArgumentException - if column is not in the valid range

isCellSelected

public boolean isCellSelected(int row,
                              int column)

Returns true if the cell at the specified position is selected.

Parameters:: row - the row being queried; column - the column being queried
Returns:: true if the cell at index (row, column) is selected, where the first row and first column are at index 0
Throws:: IllegalArgumentException - if row or column are not in the valid range

changeSelection

public void changeSelection(int rowIndex,
                            int columnIndex,
                            boolean toggle,
                            boolean extend)

Updates the selection models of the table, depending on the state of the two flags: toggle and extend. All changes to the selection that are the result of keyboard or mouse events received by the UI are channeled through this method so that the behavior may be overridden by a subclass.

This implementation uses the following conventions:

toggle: false, extend: false. Clear the previous selection and ensure the new cell is selected.
toggle: false, extend: true. Extend the previous selection to include the specified cell.
toggle: true, extend: false. If the specified cell is selected, deselect it. If it is not selected, select it.
toggle: true, extend: true. Leave the selection state as it is, but move the anchor index to the specified location.

Parameters:: rowIndex - affects the selection at row; columnIndex - affects the selection at column; toggle - see description above; extend - if true, extend the current selection

getSelectionForeground

public Color getSelectionForeground()

Returns the foreground color for selected cells.

Returns:: the Color object for the foreground property
See Also:: setSelectionForeground(java.awt.Color), setSelectionBackground(java.awt.Color)

setSelectionForeground

public void setSelectionForeground(Color selectionForeground)

Sets the foreground color for selected cells. Cell renderers can use this color to render text and graphics for selected cells.

The default value of this property is defined by the look and feel implementation.

This is a JavaBeans bound property.

Parameters:: selectionForeground - the Color to use in the foreground for selected list items
See Also:: getSelectionForeground(), setSelectionBackground(java.awt.Color), JComponent.setForeground(java.awt.Color), JComponent.setBackground(java.awt.Color), JComponent.setFont(java.awt.Font)

getSelectionBackground

public Color getSelectionBackground()

Returns the background color for selected cells.

Returns:: the Color used for the background of selected list items
See Also:: setSelectionBackground(java.awt.Color), setSelectionForeground(java.awt.Color)

setSelectionBackground

public void setSelectionBackground(Color selectionBackground)

Sets the background color for selected cells. Cell renderers can use this color to the fill selected cells.

The default value of this property is defined by the look and feel implementation.

This is a JavaBeans bound property.

Parameters:: selectionBackground - the Color to use for the background of selected cells
See Also:: getSelectionBackground(), setSelectionForeground(java.awt.Color), JComponent.setForeground(java.awt.Color), JComponent.setBackground(java.awt.Color), JComponent.setFont(java.awt.Font)

getColumn

public TableColumn getColumn(Object identifier)

Returns the TableColumn object for the column in the table whose identifier is equal to identifier, when compared using equals.

Parameters:: identifier - the identifier object
Returns:: the TableColumn object that matches the identifier
Throws:: IllegalArgumentException - if identifier is null or no TableColumn has this identifier

convertColumnIndexToModel

public int convertColumnIndexToModel(int viewColumnIndex)

Maps the index of the column in the view at viewColumnIndex to the index of the column in the table model. Returns the index of the corresponding column in the model. If viewColumnIndex is less than zero, returns viewColumnIndex.

Parameters:: viewColumnIndex - the index of the column in the view
Returns:: the index of the corresponding column in the model
See Also:: convertColumnIndexToView(int)

convertColumnIndexToView

public int convertColumnIndexToView(int modelColumnIndex)

Maps the index of the column in the table model at modelColumnIndex to the index of the column in the view. Returns the index of the corresponding column in the view; returns -1 if this column is not being displayed. If modelColumnIndex is less than zero, returns modelColumnIndex.

Parameters:: modelColumnIndex - the index of the column in the model
Returns:: the index of the corresponding column in the view
See Also:: convertColumnIndexToModel(int)

getRowCount

public int getRowCount()

Returns the number of rows in this table's model.

Returns:: the number of rows in this table's model
See Also:: getColumnCount()

getColumnCount

public int getColumnCount()

Returns the number of columns in the column model. Note that this may be different from the number of columns in the table model.

Returns:: the number of columns in the table
See Also:: getRowCount(), removeColumn(javax.swing.table.TableColumn)

getColumnName

public String getColumnName(int column)

Returns the name of the column appearing in the view at column position column.

Parameters:: column - the column in the view being queried
Returns:: the name of the column at position column in the view where the first column is column 0

getColumnClass

public Class getColumnClass(int column)

Returns the type of the column appearing in the view at column position column.

Parameters:: column - the column in the view being queried
Returns:: the type of the column at position column in the view where the first column is column 0

getValueAt

public Object getValueAt(int row,
                         int column)

Returns the cell value at row and column.

Note: The column is specified in the table view's display order, and not in the TableModel's column order. This is an important distinction because as the user rearranges the columns in the table, the column at a given index in the view will change. Meanwhile the user's actions never affect the model's column ordering.

Parameters:: row - the row whose value is to be queried; column - the column whose value is to be queried
Returns:: the Object at the specified cell

setValueAt

public void setValueAt(Object aValue,
                       int row,
                       int column)

Sets the value for the cell in the table model at row and column.

Parameters:: aValue - the new value; row - the row of the cell to be changed; column - the column of the cell to be changed
See Also:: getValueAt(int, int)

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Returns true if the cell at row and column is editable. Otherwise, invoking setValueAt on the cell will have no effect.

Parameters:: row - the row whose value is to be queried; column - the column whose value is to be queried
Returns:: true if the cell is editable
See Also:: setValueAt(java.lang.Object, int, int)

addColumn

public void addColumn(TableColumn aColumn)

Appends aColumn to the end of the array of columns held by this JTable's column model. If the column name of aColumn is null, sets the column name of aColumn to the name returned by getModel().getColumnName().

To add a column to this JTable to display the modelColumn'th column of data in the model with a given width, cellRenderer, and cellEditor you can use:


      addColumn(new TableColumn(modelColumn, width, cellRenderer, cellEditor));

[Any of the TableColumn constructors can be used instead of this one.] The model column number is stored inside the TableColumn and is used during rendering and editing to locate the appropriates data values in the model. The model column number does not change when columns are reordered in the view.

Parameters:: aColumn - the TableColumn to be added
See Also:: removeColumn(javax.swing.table.TableColumn)

removeColumn

public void removeColumn(TableColumn aColumn)

Removes aColumn from this JTable's array of columns. Note: this method does not remove the column of data from the model; it just removes the TableColumn that was responsible for displaying it.

Parameters:: aColumn - the TableColumn to be removed
See Also:: addColumn(javax.swing.table.TableColumn)

moveColumn

public void moveColumn(int column,
                       int targetColumn)

Moves the column column to the position currently occupied by the column targetColumn in the view. The old column at targetColumn is shifted left or right to make room.

Parameters:: column - the index of column to be moved; targetColumn - the new index of the column

columnAtPoint

public int columnAtPoint(Point point)

Returns the index of the column that point lies in, or -1 if the result is not in the range [0, getColumnCount()-1].

Parameters:: point - the location of interest
Returns:: the index of the column that point lies in, or -1 if the result is not in the range [0, getColumnCount()-1]
See Also:: rowAtPoint(java.awt.Point)

rowAtPoint

public int rowAtPoint(Point point)

Returns the index of the row that point lies in, or -1 if the result is not in the range [0, getRowCount()-1].

Parameters:: point - the location of interest
Returns:: the index of the row that point lies in, or -1 if the result is not in the range [0, getRowCount()-1]
See Also:: columnAtPoint(java.awt.Point)

getCellRect

public Rectangle getCellRect(int row,
                             int column,
                             boolean includeSpacing)

Returns a rectangle for the cell that lies at the intersection of row and column. If includeSpacing is true then the value returned has the full height and width of the row and column specified. If it is false, the returned rectangle is inset by the intercell spacing to return the true bounds of the rendering or editing component as it will be set during rendering.

If the column index is valid but the row index is less than zero the method returns a rectangle with the y and height values set appropriately and the x and width values both set to zero. In general, when either the row or column indices indicate a cell outside the appropriate range, the method returns a rectangle depicting the closest edge of the closest cell that is within the table's range. When both row and column indices are out of range the returned rectangle covers the closest point of the closest cell.

In all cases, calculations that use this method to calculate results along one axis will not fail because of anomalies in calculations along the other axis. When the cell is not valid the includeSpacing parameter is ignored.

Parameters:: row - the row index where the desired cell is located; column - the column index where the desired cell is located in the display; this is not necessarily the same as the column index in the data model for the table; the convertColumnIndexToView(int) method may be used to convert a data model column index to a display column index; includeSpacing - if false, return the true cell bounds - computed by subtracting the intercell spacing from the height and widths of the column and row models
Returns:: the rectangle containing the cell at location row,column

doLayout

public void doLayout()

Causes this table to lay out its rows and columns. Overridden so that columns can be resized to accomodate a change in the size of a containing parent. Resizes one or more of the columns in the table so that the total width of all of this JTable's columns is equal to the width of the table.

Before the layout begins the method gets the resizingColumn of the tableHeader. When the method is called as a result of the resizing of an enclosing window, the resizingColumn is null. This means that resizing has taken place "outside" the JTable and the change - or "delta" - should be distributed to all of the columns regardless of this JTable's automatic resize mode.

If the resizingColumn is not null, it is one of the columns in the table that has changed size rather than the table itself. In this case the auto-resize modes govern the way the extra (or deficit) space is distributed amongst the available columns.

The modes are:

AUTO_RESIZE_OFF: Don't automatically adjust the column's widths at all. Use a horizontal scrollbar to accomodate the columns when their sum exceeds the width of the Viewport. If the JTable is not enclosed in a JScrollPane this may leave parts of the table invisible.
AUTO_RESIZE_NEXT_COLUMN: Use just the column after the resizing column. This results in the "boundary" or divider between adjacent cells being independently adjustable.
AUTO_RESIZE_SUBSEQUENT_COLUMNS: Use all columns after the one being adjusted to absorb the changes. This is the default behavior.
AUTO_RESIZE_LAST_COLUMN: Automatically adjust the size of the last column only. If the bounds of the last column prevent the desired size from being allocated, set the width of the last column to the appropriate limit and make no further adjustments.
AUTO_RESIZE_ALL_COLUMNS: Spread the delta amongst all the columns in the JTable, including the one that is being adjusted.

Note: When a JTable makes adjustments to the widths of the columns it respects their minimum and maximum values absolutely. It is therefore possible that, even after this method is called, the total width of the columns is still not equal to the width of the table. When this happens the JTable does not put itself in AUTO_RESIZE_OFF mode to bring up a scroll bar, or break other commitments of its current auto-resize mode -- instead it allows its bounds to be set larger (or smaller) than the total of the column minimum or maximum, meaning, either that there will not be enough room to display all of the columns, or that the columns will not fill the JTable's bounds. These respectively, result in the clipping of some columns or an area being painted in the JTable's background color during painting.

The mechanism for distributing the delta amongst the available columns is provided in a private method in the JTable class:

   adjustSizes(long targetSize, final Resizable3 r, boolean inverse)

an explanation of which is provided in the following section. Resizable3 is a private interface that allows any data structure containing a collection of elements with a size, preferred size, maximum size and minimum size to have its elements manipulated by the algorithm.

Distributing the delta

Overview

Call "DELTA" the difference between the target size and the sum of the preferred sizes of the elements in r. The individual sizes are calculated by taking the original preferred sizes and adding a share of the DELTA - that share being based on how far each preferred size is from its limiting bound (minimum or maximum).

Definition

Call the individual constraints min[i], max[i], and pref[i].

Call their respective sums: MIN, MAX, and PREF.

Each new size will be calculated using:

          size[i] = pref[i] + delta[i]

where each individual delta[i] is calculated according to:

If (DELTA < 0) we are in shrink mode where:

                        DELTA
          delta[i] = ------------ * (pref[i] - min[i])
                     (PREF - MIN)

If (DELTA > 0) we are in expand mode where:

                        DELTA
          delta[i] = ------------ * (max[i] - pref[i])
                      (MAX - PREF)

The overall effect is that the total size moves that same percentage, k, towards the total minimum or maximum and that percentage guarantees accomodation of the required space, DELTA.

Details

Naive evaluation of the formulae presented here would be subject to the aggregated rounding errors caused by doing this operation in finite precision (using ints). To deal with this, the multiplying factor above, is constantly recalculated and this takes account of the rounding errors in the previous iterations. The result is an algorithm that produces a set of integers whose values exactly sum to the supplied targetSize, and does so by spreading the rounding errors evenly over the given elements.

When the MAX and MIN bounds are hit

When targetSize is outside the [MIN, MAX] range, the algorithm sets all sizes to their appropriate limiting value (maximum or minimum).

Overrides:: doLayout in class Container

See Also:: LayoutManager.layoutContainer(java.awt.Container), Container.setLayout(java.awt.LayoutManager), Container.validate()

sizeColumnsToFit

public void sizeColumnsToFit(boolean lastColumnOnly)

Deprecated. As of Swing version 1.0.3, replaced by doLayout().

Sizes the table columns to fit the available space.

See Also:: doLayout()

sizeColumnsToFit

public void sizeColumnsToFit(int resizingColumn)

Obsolete as of Java 2 platform v1.4. Please use the doLayout() method instead.

Parameters:: resizingColumn - the column whose resizing made this adjustment necessary or -1 if there is no such column
See Also:: doLayout()

getToolTipText

public String getToolTipText(MouseEvent event)

Overrides JComponent's getToolTipText method in order to allow the renderer's tips to be used if it has text set.

Note: For JTable to properly display tooltips of its renderers JTable must be a registered component with the ToolTipManager. This is done automatically in initializeLocalVars, but if at a later point JTable is told setToolTipText(null) it will unregister the table component, and no tips from renderers will display anymore.

Overrides:: getToolTipText in class JComponent

See Also:: JComponent.getToolTipText()

setSurrendersFocusOnKeystroke

public void setSurrendersFocusOnKeystroke(boolean surrendersFocusOnKeystroke)

Sets whether editors in this JTable get the keyboard focus when an editor is activated as a result of the JTable forwarding keyboard events for a cell. By default, this property is false, and the JTable retains the focus unless the cell is clicked.

Parameters:: surrendersFocusOnKeystroke - true if the editor should get the focus when keystrokes cause the editor to be activated
See Also:: getSurrendersFocusOnKeystroke()

getSurrendersFocusOnKeystroke

public boolean getSurrendersFocusOnKeystroke()

Returns true if the editor should get the focus when keystrokes cause the editor to be activated

Returns:: true if the editor should get the focus when keystrokes cause the editor to be activated
See Also:: setSurrendersFocusOnKeystroke(boolean)

editCellAt

public boolean editCellAt(int row,
                          int column)

Programmatically starts editing the cell at row and column, if the cell is editable. Note that this is a convenience method for editCellAt(int, int, null).

Parameters:: row - the row to be edited; column - the column to be edited
Returns:: false if for any reason the cell cannot be edited
Throws:: IllegalArgumentException - if row or column is not in the valid range

editCellAt

public boolean editCellAt(int row,
                          int column,
                          EventObject e)

Programmatically starts editing the cell at row and column, if the cell is editable. To prevent the JTable from editing a particular table, column or cell value, return false from the isCellEditable method in the TableModel interface.

Parameters:: row - the row to be edited; column - the column to be edited; e - event to pass into shouldSelectCell; note that as of Java 2 platform v1.2, the call to shouldSelectCell is no longer made
Returns:: false if for any reason the cell cannot be edited
Throws:: IllegalArgumentException - if row or column is not in the valid range

isEditing

public boolean isEditing()

Returns true if a cell is being edited.

Returns:: true if the table is editing a cell
See Also:: editingColumn, editingRow

getEditorComponent

public Component getEditorComponent()

Returns the component that is handling the editing session. If nothing is being edited, returns null.

Returns:: Component handling editing session

getEditingColumn

public int getEditingColumn()

Returns the index of the column that contains the cell currently being edited. If nothing is being edited, returns -1.

Returns:: the index of the column that contains the cell currently being edited; returns -1 if nothing being edited
See Also:: editingRow

getEditingRow

public int getEditingRow()

Returns the index of the row that contains the cell currently being edited. If nothing is being edited, returns -1.

Returns:: the index of the row that contains the cell currently being edited; returns -1 if nothing being edited
See Also:: editingColumn

getUI

public TableUI getUI()

Returns the L&F object that renders this component.

Returns:: the TableUI object that renders this component

setUI

public void setUI(TableUI ui)

Sets the L&F object that renders this component and repaints.

Parameters:: ui - the TableUI L&F object
See Also:: UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.

Overrides:: updateUI in class JComponent

See Also:: JComponent.updateUI()

getUIClassID

public String getUIClassID()

Returns the suffix used to construct the name of the L&F class used to render this component.

Overrides:: getUIClassID in class JComponent

Returns:: the string "TableUI"
See Also:: JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setModel

public void setModel(TableModel dataModel)

Sets the data model for this table to newModel and registers with it for listener notifications from the new data model.

Parameters:: dataModel - the new data source for this table
Throws:: IllegalArgumentException - if newModel is null
See Also:: getModel()

getModel

public TableModel getModel()

Returns the TableModel that provides the data displayed by this JTable.

Returns:: the TableModel that provides the data displayed by this JTable
See Also:: setModel(javax.swing.table.TableModel)

setColumnModel

public void setColumnModel(TableColumnModel columnModel)

Sets the column model for this table to newModel and registers for listener notifications from the new column model. Also sets the column model of the JTableHeader to columnModel.

Parameters:: columnModel - the new data source for this table
Throws:: IllegalArgumentException - if columnModel is null
See Also:: getColumnModel()

getColumnModel

public TableColumnModel getColumnModel()

Returns the TableColumnModel that contains all column information of this table.

Returns:: the object that provides the column state of the table
See Also:: setColumnModel(javax.swing.table.TableColumnModel)

setSelectionModel

public void setSelectionModel(ListSelectionModel newModel)

Sets the row selection model for this table to newModel and registers for listener notifications from the new selection model.

Parameters:: newModel - the new selection model
Throws:: IllegalArgumentException - if newModel is null
See Also:: getSelectionModel()

getSelectionModel

public ListSelectionModel getSelectionModel()

Returns the ListSelectionModel that is used to maintain row selection state.

Returns:: the object that provides row selection state, null if row selection is not allowed
See Also:: setSelectionModel(javax.swing.ListSelectionModel)

tableChanged

public void tableChanged(TableModelEvent e)

Invoked when this table's TableModel generates a TableModelEvent. The TableModelEvent should be constructed in the coordinate system of the model; the appropriate mapping to the view coordinate system is performed by this JTable when it receives the event.

Application code will not use these methods explicitly, they are used internally by JTable.

Note that as of 1.3, this method clears the selection, if any.

Specified by:: tableChanged in interface TableModelListener