All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.JTable

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.JTable

public class JTable

extends JComponent

implements TableModelListener, Scrollable, TableColumnModelListener, ListSelectionListener, CellEditorListener, Accessible

JTable is a user-interface component that presents data in a two-dimensional table format. The JTable has many features 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 = JTable.createScrollPaneForTable(table);
  

Because the JTable is now much easier to set up with custom models the DefaultTableModel is less useful than it was in previous releases. Instead of copying the data in an application into the DefaultTableModel, we recommend wrapping it in the methods of the TableModel interface and passing the real data to the JTable as above. This technique is nearly as concise as using a DefaultTableModel and starting this way has a number of advantages over the longer term. In particular: it is a scalable technique, is easier to handle dynamic or editable tables and often results in much more efficient applications because the model is free to choose the internal representation that best suits the data.

The "Table" directory in the examples/demo area 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.

Instead of using integers and identifiers for the columns, the JTable now uses integers exclusively to refer to both the rows and the columns. As well as simplifying the API considerably by removing all the methods that had to be implemented for both integers and identifiers this has made future rendering optimizations possible behind the same API.

It is still possible to build TableModels which use identifiers, either for the columns or the rows and this can be a good way to give meaning to data values which is independent of position. That said, the JTable no longer requires the model to manage identifiers and these methods have been removed from the TableModel interface. The JTable simply takes a tabular range of cells and uses getValueAt(int, int) to retrieve and display them.

If getTableHeader().setReorderingAllowed(boolean) is used to enable column reordering 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 the model is queried in its own co-ordinate 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 co-ordinate system where the order of the rows is changed, rather than the order of the columns.

The general rule for the JTable API and the APIs of all its associated classes, including the the column model and both the row and column selection models, is the same as it was in previous releases: methods using integer indices for rows and columns always use the co-ordinate system of the view. There are three exceptions to this rule:

• All references to rows and columns in the TableModel interface are in the co-ordinate system of the model.
• The index modelIndex in the TableColumn constructors refers to the index of the column in the model, not the view.
• All constructors for the TableModelEvent, which describes changes that have taken place in a table model, use the co-ordinate system of the model.

The convertColumnIndexToView() and convertColumnIndexToModel() methods have been provided to convert between the two co-ordinate systems but they are rarely needed during normal use.

See How to Use Tables in The Java Tutorial for further documentation.

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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

AUTO_RESIZE_ALL_COLUMNS

Proportionately resize all columns when table is resized

AUTO_RESIZE_LAST_COLUMN

Auto resize last column only when table is resized

AUTO_RESIZE_OFF

Do not auto resize column when table is resized.

autoCreateColumnsFromModel

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

autoResizeMode

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

cellEditor

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

cellSelectionEnabled

If this is true, then both a row selection and a column selection can be non-empty at the same time, the selected cells are the the cells whose row and column are both selected.

columnModel

The TableColumnModel of the table

dataModel

The TableModel of the table

defaultEditorsByColumnClass

A table of objects that display and edit the contents of a cell, indexed by class.

defaultRenderersByColumnClass

A table of objects that display the contents of a cell, indexed by class.

editingColumn

Identifies the column of the cell being edited.

editingRow

Identifies the row of the cell being edited.

editorComp

If editing, Component that is handling the editing.

gridColor

The color of the grid

preferredViewportSize

Used by the Scrollable interface to determine the initial visible area

rowHeight

The height of all rows in the table

rowMargin

The height margin between rows

rowSelectionAllowed

Row selection allowed in this table

selectionBackground

The background color of selected cells

selectionForeground

The foreground color of selected cells

selectionModel

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

showHorizontalLines

The table draws horizontal lines between cells if showHorizontalLines is true

showVerticalLines

The table draws vertical lines between cells if showVerticalLines is true

tableHeader

The TableHeader working with the table

JTable()

Constructs a default JTable which is initialized with a default data model, a default column model, and a default selection model.

JTable(int, int)

Constructs a JTable with numColumns and numRows of empty cells using the DefaultTableModel.

JTable(Object[][], Object[])

Constructs a JTable using a DefaultTableModel and initialize the table with the values in the data array.

JTable(TableModel)

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

JTable(TableModel, TableColumnModel)

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

JTable(TableModel, TableColumnModel, ListSelectionModel)

Constructs a JTable which is initialized with dm as the data model, cm as the column model, and sm as the selection model.

JTable(Vector, Vector)

Constructs a JTable using a DefaultTableModel and initialize the table with the values in the data Vector.

addColumn(TableColumn)

Appends aColumn to the end of the array of columns held by the JTable's column model.

addColumnSelectionInterval(int, int)

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

addRowSelectionInterval(int, int)

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

clearSelection()

Deselects all selected columns and rows.

columnAdded(TableColumnModelEvent)

Tells listeners that a column was added to the model.

columnAtPoint(Point)

Returns the index of the column that point lies in, or -1 if it lies outside the receiver's bounds.

columnMarginChanged(ChangeEvent)

Tells listeners that a column was moved due to a margin change.

columnMoved(TableColumnModelEvent)

Tells listeners that a column was repositioned.

columnRemoved(TableColumnModelEvent)

Tells listeners that a column was removed from the model.

columnSelectionChanged(ListSelectionEvent)

Tells listeners that the selection model of the TableColumnModel changed.

convertColumnIndexToModel(int)

Return the index of the column in the model whose data is being displayed in the column viewColumnIndex in the display.

convertColumnIndexToView(int)

Return the index of the column in the view which is displaying the data from the column modelColumnIndex in the model.

createDefaultColumnModel()

Returns the default column model object which is a DefaultTableColumnModel.

createDefaultColumnsFromModel()

This method will create default columns for the table from the data model using the getColumnCount() and getColumnType() methods defined in the TableModel interface.

createDefaultDataModel()

Returns the default table model object which is a DefaultTableModel.

createDefaultEditors()

Creates default cell editors for Objects, numbers, and boolean values.

createDefaultRenderers()

createDefaultSelectionModel()

Returns the default selection model object which is a DefaultListSelectionModel.

createDefaultTableHeader()

Returns the default table header object which is a JTableHeader.

createScrollPaneForTable(JTable)

This static method is provided to simplify the task of wrapping a JTable in a scroll pane.

editCellAt(int, int)

Programmatically starts editing the cell at row and column, if the cell is editable.

editCellAt(int, int, EventObject)

Programmatically starts editing the cell at row and column, if the cell is editable.

editingCanceled(ChangeEvent)

Invoked when editing is canceled.

editingStopped(ChangeEvent)

Invoked when editing is finished.

getAccessibleContext()

Get the AccessibleContext associated with this JComponent

getAutoCreateColumnsFromModel()

Returns whether the table will create default columns from the model.

getAutoResizeMode()

Returns auto resize mode of the table.

getCellEditor()

Return the cellEditor.

getCellRect(int, int, boolean)

Returns a rectangle locating the cell that lies at the intersection of row and column.

getCellSelectionEnabled()

Returns true if simultaneous row and column selections are allowed

getColumn(Object)

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

getColumnClass(int)

Returns the type of the column at the specified view position.

getColumnCount()

Returns the number of columns in the column model, note this may be different to the number of columns in the table model.

getColumnModel()

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

getColumnName(int)

Returns the name of the column at the specified view position.

getColumnSelectionAllowed()

Returns true if columns can be selected.

getDefaultEditor(Class)

Returns the editor to be used when no editor has been set in a TableColumn.

getDefaultRenderer(Class)

Returns the renderer to be used when no renderer has been set in a TableColumn.

getEditingColumn()

This returns the index of the editing column.

getEditingRow()

Returns the index of the editing row.

getEditorComponent()

If the receiver is currently editing this will return the Component that was returned from the CellEditor.

getGridColor()

Returns the color used to draw grid lines.

getIntercellSpacing()

Returns the horizontal and vertical spacing between cells.

getModel()

Returns the TableModel that provides the data displayed by the receiver.

getPreferredScrollableViewportSize()

Returns the preferred size of the viewport for this table.

getRowCount()

Returns the number of rows in the table.

getRowHeight()

Returns the height of a table row in the receiver.

getRowSelectionAllowed()

Returns true if rows can be selected.

getScrollableBlockIncrement(Rectangle, int, int)

Returns The visibleRect.height or visibleRect.width, depending on the table's orientation.

getScrollableTracksViewportHeight()

Returns false to indicate that the height of the viewport does not determine the height of the table.

getScrollableTracksViewportWidth()

Returns false to indicate that the width of the viewport does not determine the width of the table.

getScrollableUnitIncrement(Rectangle, int, int)

Returns the scroll increment that completely exposes one new row or column (depending on the orientation).

getSelectedColumn()

Returns the index of the last column selected or added to the selection.

getSelectedColumnCount()

Returns the number of selected columns.

getSelectedColumns()

Returns the indices of all selected columns.

getSelectedRow()

Returns the index of the last row selected or added to the selection.

getSelectedRowCount()

Returns the number of selected rows.

getSelectedRows()

Returns the indices of all selected rows.

getSelectionBackground()

Returns the background color for selected cells.

getSelectionForeground()

Returns the foreground color for selected cells.

getSelectionModel()

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

getShowHorizontalLines()

Returns true if the receiver draws horizontal lines between cells, false if it doesn't.

getShowVerticalLines()

Returns true if the receiver draws vertical lines between cells, false if it doesn't.

getTableHeader()

Returns the tableHeader working with this JTable.

getToolTipText(MouseEvent)

Overrides JComponent's setToolTipText method to allow use of the renderer's tips (if the renderer has text set).

getUI()

Returns the L&F object that renders this component.

getUIClassID()

Returns the name of the L&F class that renders this component.

getValueAt(int, int)

Returns the cell value at row and column.

initializeLocalVars()

Initializes table properties to their default values.

isCellEditable(int, int)

Returns true if the cell at row and column is editable.

isCellSelected(int, int)

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

isColumnSelected(int)

Returns true if the column at the specified index is selected

isEditing()

Returns true is the table is editing a cell.

isOpaque()

Returns true to indicate that this component paints every pixel in its range.

isRowSelected(int)

Returns true if the row at the specified index is selected

moveColumn(int, int)

Moves the column column to the position currently occupied by the column targetColumn.

prepareEditor(TableCellEditor, int, int)

Sets up the specified editor using the value at the specified cell.

removeColumn(TableColumn)

Removes aColumn from the JTable's array of columns.

removeColumnSelectionInterval(int, int)

Deselects the columns from index0 to index0 inclusive.

removeEditor()

Discard the editor object and return the real estate it used to cell rendering.

removeRowSelectionInterval(int, int)

Deselects the rows from index0 to index0 inclusive.

resizeAndRepaint()

Properly sizes the receiver and its header view, and marks it as needing display.

rowAtPoint(Point)

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

selectAll()

If a column is selected, then this selects all columns.

setAutoCreateColumnsFromModel(boolean)

Sets the table's autoCreateColumnsFromModel flag.

setAutoResizeMode(int)

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

setCellEditor(TableCellEditor)

Set the cellEditor variable.

setCellSelectionEnabled(boolean)

Sets whether this table allows both a column selection and a row selection to exist at the same time.

setColumnModel(TableColumnModel)

Sets the column model for this table to newModel and registers with for listner notifications from the new column model.

setColumnSelectionAllowed(boolean)

Sets whether the columns in this model can be selected.

setColumnSelectionInterval(int, int)

Selects the columns from index0 to index1 inclusive.

setDefaultEditor(Class, TableCellEditor)

Set a default editor to be used if no editor has been set in a TableColumn.

setDefaultRenderer(Class, TableCellRenderer)

Set a default renderer to be used if no renderer has been set in a TableColumn.

setEditingColumn(int)

Set the editingColumn variable.

setEditingRow(int)

Set the editingRow variable.

setGridColor(Color)

Sets the color used to draw grid lines to color and redisplays the receiver.

setIntercellSpacing(Dimension)

Sets the width and height between cells to newSpacing and redisplays the receiver.

setModel(TableModel)

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

setPreferredScrollableViewportSize(Dimension)

Sets the preferred size of the viewport for this table.

setRowHeight(int)

Sets the height for rows to newRowHeight and invokes tile

setRowSelectionAllowed(boolean)

Sets whether the rows in this model can be selected.

setRowSelectionInterval(int, int)

Selects the rows from index0 to index1 inclusive.

setSelectionBackground(Color)

Set the background color for selected cells.

setSelectionForeground(Color)

Set the foreground color for selected cells.

setSelectionMode(int)

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

setSelectionModel(ListSelectionModel)

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

setShowGrid(boolean)

Sets whether the receiver draws grid lines around cells.

setShowHorizontalLines(boolean)

Sets whether the receiver draws horizontal lines between cells.

setShowVerticalLines(boolean)

Sets whether the receiver draws vertical lines between cells.

setTableHeader(JTableHeader)

Sets the tableHeader working with this JTable to newHeader.

setUI(TableUI)

Sets the L&F object that renders this component.

setValueAt(Object, int, int)

Sets the value for the cell at row and column.

sizeColumnsToFit(boolean)

This method will resize one or more columns of the table so that the sum width of all columns will equal to the width of the table.

tableChanged(TableModelEvent)

The TableModelEvent should be constructed in the co-ordinate system of the model, the appropriate mapping to the view co-ordinate system is performed by the JTable when it recieves the event.

updateUI()

Notification from the UIManager that the L&F has changed.

valueChanged(ListSelectionEvent)

Tells listeners that the selection changed.

 public static final int AUTO_RESIZE_OFF

Do not auto resize column when table is resized.

 public static final int AUTO_RESIZE_LAST_COLUMN

Auto resize last column only when table is resized

 public static final int AUTO_RESIZE_ALL_COLUMNS

Proportionately resize all columns when table is resized

 protected TableModel dataModel

The TableModel of the table

 protected TableColumnModel columnModel

The TableColumnModel of the table

 protected ListSelectionModel selectionModel

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

 protected JTableHeader tableHeader

The TableHeader working with the table

 protected int rowHeight

The height of all rows in the table

 protected int rowMargin

The height margin between rows

 protected Color gridColor

The color of the grid

 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 int autoResizeMode

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

 protected boolean autoCreateColumnsFromModel

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

 protected Dimension preferredViewportSize

Used by the Scrollable interface to determine the initial visible area

 protected boolean rowSelectionAllowed

Row selection allowed in this table

 protected boolean cellSelectionEnabled

If this is true, then both a row selection and a column selection can be non-empty at the same time, the selected cells are the the cells whose row and column are both selected.

 protected transient Component editorComp

If editing, Component that is handling the editing.

 protected transient TableCellEditor cellEditor

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

 protected transient int editingColumn

Identifies the column of the cell being edited.

 protected transient int editingRow

Identifies the row of the cell being edited.

 protected transient Hashtable defaultRenderersByColumnClass

A table of objects that display the contents of a cell, indexed by class.

 protected transient Hashtable defaultEditorsByColumnClass

A table of objects that display and edit the contents of a cell, indexed by class.

 protected Color selectionForeground

The foreground color of selected cells

 protected Color selectionBackground

The background color of selected cells

 public JTable()

Constructs a default JTable which is initialized with a default data model, a default column model, and a default selection model.

See Also:

createDefaultDataModel, createDefaultColumnModel, createDefaultSelectionModel

 public JTable(TableModel dm)

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

 public JTable(TableModel dm,
               TableColumnModel cm)

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

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

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

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

 public JTable(int numColumns,
               int numRows)

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

Parameters:

numColumns - The number of columns the table holds

numRows - The number of rows the table holds

See Also:

DefaultTableModel

 public JTable(Vector data,
               Vector columnNames)

Constructs a JTable using a DefaultTableModel and initialize the table with the values in the data Vector. The vectors contained in the outer vector should each contain a single row of values. In other words, the value of the cell at column 5, row 1 can be obtain with the follow code:

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

Parameters:

data - The data for the new table

columnNames - Names of each column

Throws: IllegalArgumentException

if data is null or if the number of columns in data does not equal the number of names in columnNames.

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

Constructs a JTable using a DefaultTableModel and initialize the table with the values in the data array. The first index in the Object[][] is the row index and the second is the column index.

Parameters:

data - The data for the new table

columnNames - Names of each column

Throws: IllegalArgumentException

if data is null or if the number of columns in data does not equal the number of names in columnNames.

 public static JScrollPane createScrollPaneForTable(JTable aTable)

This static method is provided to simplify the task of wrapping a JTable in a scroll pane. This method will take care of putting the table and its header in the correct place. If aTable is null this will create a default JTable.

Parameters:

aTable - The table to install in a scrollPane.

 public void setTableHeader(JTableHeader newHeader)

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

Parameters:

newHeader - new tableHeader

See Also:

getTableHeader

 public JTableHeader getTableHeader()

Returns the tableHeader working with this JTable.

Returns:

the tableHeader working with the receiver

See Also:

setTableHeader

 public void setRowHeight(int newHeight)

Sets the height for rows to newRowHeight and invokes tile

Parameters:

newRowHeight - new row height

Throws: IllegalArgumentException

If newRowHeight is less than 1.

See Also:

getRowHeight

 public int getRowHeight()

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

Returns:

the height of each row in the receiver

See Also:

setRowHeight

 public void setIntercellSpacing(Dimension newSpacing)

Sets the width and height between cells to newSpacing and redisplays the receiver.

Parameters:

newSpacing - The new width and height intercellSpacing

See Also:

getIntercellSpacing

 public Dimension getIntercellSpacing()

Returns the horizontal and vertical spacing between cells. The default spacing is (3, 2).

Returns:

the horizontal and vertical spacing between cells

See Also:

setIntercellSpacing

 public void setGridColor(Color newColor)

Sets the color used to draw grid lines to color and redisplays the receiver. The default color is gray.

Parameters:

color - new color of the grid

Throws: IllegalArgumentException

if color is null

See Also:

getGridColor

 public Color getGridColor()

Returns the color used to draw grid lines. The default color is gray.

Returns:

the color used to draw grid lines

See Also:

setGridColor

 public void setShowGrid(boolean b)

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

Parameters:

flag - true if table view should draw grid lines

See Also:

setShowVerticalLines, setShowHorizontalLines

 public void setShowHorizontalLines(boolean b)

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

Parameters:

flag - true if table view should draw horizontal lines

See Also:

getShowHorizontalLines, setShowGrid, setShowVerticalLines

 public void setShowVerticalLines(boolean b)

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

Parameters:

flag - true if table view should draw vertical lines

See Also:

getShowVerticalLines, setShowGrid, setShowHorizontalLines

 public boolean getShowHorizontalLines()

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

Returns:

true if the receiver draws horizontal lines between cells, false if it doesn't

See Also:

setShowHorizontalLines

 public boolean getShowVerticalLines()

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

Returns:

true if the receiver draws vertical lines between cells, false if it doesn't

See Also:

setShowVerticalLines

 public void setAutoResizeMode(int mode)

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

Parameters:

mode - One of 3 legal values: AUTO_RESIZE_OFF, AUTO_RESIZE_LAST_COLUMN, AUTO_RESIZE_ALL_COLUMNS

See Also:

getAutoResizeMode, sizeColumnsToFit

 public int getAutoResizeMode()

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

Returns:

the autoResizeMode of the table

See Also:

setAutoResizeMode, sizeColumnsToFit

 public void setAutoCreateColumnsFromModel(boolean createColumns)

Sets the table's autoCreateColumnsFromModel flag. This method will call createDefaultColumnsFromModel() if createColumns is true.

Parameters:

createColumns - true if JTable should auto create columns

See Also:

getAutoCreateColumnsFromModel, createDefaultColumnsFromModel

 public boolean getAutoCreateColumnsFromModel()

Returns whether the table will create default columns from the model. If this is true, setModel() will clear any existing columns and create new columns from the new model. Also if the event in the the tableChanged() notification specified the entired table changed then the columns will be rebuilt. The default is true.

Returns:

the autoCreateColumnsFromModel of the table

See Also:

setAutoCreateColumnsFromModel, createDefaultColumnsFromModel

 public void createDefaultColumnsFromModel()

This method will create default columns for the table from the data model using the getColumnCount() and getColumnType() methods defined in the TableModel interface.

This method will clear any exsiting columns before creating the new columns based on information from the model.

See Also:

getAutoCreateColumnsFromModel

 public void setDefaultRenderer(Class columnClass,
                                TableCellRenderer renderer)

Set a default renderer to be used if no renderer has been set in a TableColumn.

See Also:

getDefaultRenderer, setDefaultEditor

 public TableCellRenderer getDefaultRenderer(Class columnClass)

Returns the 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 which can be modified or replaced.

See Also:

setDefaultRenderer, getColumnClass

 public void setDefaultEditor(Class columnClass,
                              TableCellEditor editor)

Set a default 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 use the isCellEditable() method in the TableModel interface to ensure that the JTable will not start an editor in these columns.

See Also:

isCellEditable, getDefaultEditor, setDefaultRenderer

 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 which can be modified or replaced.

See Also:

setDefaultEditor, getColumnClass

 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 states that is different between rows and columns you can get the columnModel and change that directly.

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

See Also:

setSelectionMode

 public void setRowSelectionAllowed(boolean flag)

Sets whether the rows in this model can be selected.

See Also:

getRowSelectionAllowed

 public boolean getRowSelectionAllowed()

Returns true if rows can be selected.

Returns:

true if rows can be selected

See Also:

setRowSelectionAllowed

 public void setColumnSelectionAllowed(boolean flag)

Sets whether the columns in this model can be selected.

See Also:

getColumnSelectionAllowed

 public boolean getColumnSelectionAllowed()

Returns true if columns can be selected.

Returns:

true if columns can be selected.

See Also:

setColumnSelectionAllowed

 public void setCellSelectionEnabled(boolean flag)

Sets whether this table allows both a column selection and a row selection to exist at the same time. When set, this results in a facility to select a rectangular region of cells in the display. This flag over-rides the row and column selection modes ensuring that cell selection is possible whenever this flag is set.

See Also:

getCellSelectionEnabled

 public boolean getCellSelectionEnabled()

Returns true if simultaneous row and column selections are allowed

Returns:

true if simultaneous row and column selections are allowed

See Also:

setCellSelectionEnabled

 public void selectAll()

If a column is selected, then this selects all columns. Similarly, if a row is selected, then, this selects all rows. If both a column and a row are selected at the time this method is invoked, then all columns and rows are selected.

 public void clearSelection()

Deselects all selected columns and rows. If empty selection is not allowed, then it leaves the first row selected.

 public void setRowSelectionInterval(int index0,
                                     int index1)

Selects the rows from index0 to index1 inclusive.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

 public void setColumnSelectionInterval(int index0,
                                        int index1)

Selects the columns from index0 to index1 inclusive.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

 public void addRowSelectionInterval(int index0,
                                     int index1)

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

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

 public void addColumnSelectionInterval(int index0,
                                        int index1)

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

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

 public void removeRowSelectionInterval(int index0,
                                        int index1)

Deselects the rows from index0 to index0 inclusive.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

 public void removeColumnSelectionInterval(int index0,
                                           int index1)

Deselects the columns from index0 to index0 inclusive.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

 public int getSelectedRow()

Returns the index of the last row selected or added to the selection.

Returns:

the index of the last row selected or added to the selection, (lead selection) or -1 if no row is selected.

See Also:

getSelectedRows

 public int getSelectedColumn()

Returns the index of the last column selected or added to the selection.

Returns:

the index of the last column selected or added to the selection, (lead selection) or -1 if no column is selected.

See Also:

getSelectedColumns

 public int[] getSelectedRows()

Returns the indices of all selected rows.

Returns:

an array of ints containing the indices of all selected rows, or an empty array if no row is selected.

See Also:

getSelectedRow

 public int[] getSelectedColumns()

Returns the indices of all selected columns.

Returns:

an array of ints containing the indices of all selected columns, or an empty array if no column is selected.

See Also:

getSelectedColumn

 public int getSelectedRowCount()

Returns the number of selected rows.

Returns:

the number of selected rows, 0 if no columns are selected

 public int getSelectedColumnCount()

Returns the number of selected columns.

Returns:

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

 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

 public boolean isColumnSelected(int column)

Returns true if the column at the specified index is selected

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

 public boolean isCellSelected(int row,
                               int column)

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

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

 public Color getSelectionForeground()

Returns the foreground color for selected cells.

Returns:

the Color object for the foreground property

See Also:

setSelectionForeground, setSelectionBackground

 public void setSelectionForeground(Color selectionForeground)

Set 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, setForeground, setBackground, setFont

 public Color getSelectionBackground()

Returns the background color for selected cells.

Returns:

the Color used for the background of selected list items

See Also:

setSelectionBackground, setSelectionForeground

 public void setSelectionBackground(Color selectionBackground)

Set 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, setForeground, setBackground, setFont

 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 with matching identifier

Throws: IllegalArgumentException

if identifier is null or no TableColumn has this identifier

 public int convertColumnIndexToModel(int viewColumnIndex)

Return the index of the column in the model whose data is being displayed in the column viewColumnIndex in the display. Returns viewColumnIndex unchanged when viewColumnIndex is less than zero.

See Also:

convertColumnIndexToView

 public int convertColumnIndexToView(int modelColumnIndex)

Return the index of the column in the view which is displaying the data from the column modelColumnIndex in the model. Returns -1 if this column is not being displayed. Returns modelColumnIndex unchanged when modelColumnIndex is less than zero.

See Also:

convertColumnIndexToModel

 public int getRowCount()

Returns the number of rows in the table.

See Also:

getColumnCount

 public int getColumnCount()

Returns the number of columns in the column model, note this may be different to the number of columns in the table model.

Returns:

the number of columns in the table

See Also:

getRowCount

 public String getColumnName(int column)

Returns the name of the column at the specified view position.

Returns:

the name of the column at position column in the view where the first column is column 0.

 public Class getColumnClass(int column)

Returns the type of the column at the specified view position.

Returns:

the type of the column at position column in the view where the first column is column 0.

 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, what is at column 2 changes. Meanwhile the user's actions never affect the model's column ordering.

Parameters:

row - the row whose value is to be looked up

column - the column whose value is to be looked up

Returns:

the Object at the specified cell

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

Sets the value for the cell at row and column. aValue is the new value.

Parameters:

aValue - the new value

row - the row whose value is to be changed

column - the column whose value is to be changed

See Also:

getValueAt

 public boolean isCellEditable(int row,
                               int column)

Returns true if the cell at row and column is editable. Otherwise, setValueAt() on the cell will not change the value of that cell.

Parameters:

row - the row whose value is to be looked up

column - the column whose value is to be looked up

Returns:

true if the cell is editable.

See Also:

setValueAt

 public void addColumn(TableColumn aColumn)

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

To add a column to the 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));
  

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

Parameters:

aColumn - The TableColumn to be added

See Also:

removeColumn

 public void removeColumn(TableColumn aColumn)

Removes aColumn from the 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 displaying it.

Parameters:

aColumn - The TableColumn to be removed

See Also:

addColumn

 public void moveColumn(int column,
                        int targetColumn)

Moves the column column to the position currently occupied by the column targetColumn. 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

 public int columnAtPoint(Point point)

Returns the index of the column that point lies in, or -1 if it lies outside the receiver's bounds.

Returns:

the index of the column that point lies in, or -1 if it lies outside the receiver's bounds

See Also:

rowAtPoint

 public int rowAtPoint(Point point)

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

Returns:

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

See Also:

columnAtPoint

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

Returns a rectangle locating the cell that lies at the intersection of row and column. If includeSpacing is true then the value returned includes the intercellSpacing margin. If it is false, then the returned rect is inset by half of intercellSpacing. (This is the true frame of the cell)

Parameters:

row - the row to compute

column - the column to compute

includeSpacing - if true, the rect returned will include the correct intercellSpacing

Returns:

the rectangle containing the cell at index row,column

Throws: IllegalArgumentException

If row or column are not in the valid range.

 public void sizeColumnsToFit(boolean lastColumnOnly)

This method will resize one or more columns of the table so that the sum width of all columns will equal to the width of the table. If lastColumnOnly is true, then it will try to resize the last column only to make it fit, but if it runs into either the minimum size limit of the column or maximum size limit, then it will change the next to last column also, etc. If lastColumnOnly is false, then it will spread the size delta proportionately to all the columns, while respecting each column's max and min size limits. Also, notifications of each column width change will be sent out as they are resized.

Note: It is possible that even after this method is called, the total width of the columns is still not be equal to the width of the table. eg. A table with a single column, the column has a minimum width of 20, and the tableView has a width of 10. And there is nothing I can do about that.

Parameters:

lastColumnOnly - Try to change the last column only if true

See Also:

setWidth

 public String getToolTipText(MouseEvent event)

Overrides JComponent's setToolTipText method to allow use of the renderer's tips (if the renderer 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:

getToolTipText

 public boolean editCellAt(int row,
                           int column)

Programmatically starts editing the cell at row and column, if the cell is editable.

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 are not in the valid range

 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

Returns:

false if for any reason the cell cannot be edited.

Throws: IllegalArgumentException

If row or column are not in the valid range

 public boolean isEditing()

Returns true is the table is editing a cell.

Returns:

true is the table is editing a cell

See Also:

editingColumn, editingRow

 public Component getEditorComponent()

If the receiver is currently editing this will return the Component that was returned from the CellEditor.

Returns:

Component handling editing session

 public int getEditingColumn()

This returns the index of the editing column.

Returns:

the index of the column being edited

See Also:

editingRow

 public int getEditingRow()

Returns the index of the editing row.

Returns:

the index of the row being edited

See Also:

editingColumn

 public TableUI getUI()

Returns the L&F object that renders this component.

Returns:

the TableUI object that renders this component

 public void setUI(TableUI ui)

Sets the L&F object that renders this component.

Parameters:

ui - the TableUI L&F object

See Also:

getUI

 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:

updateUI

 public String getUIClassID()

Returns the name of the L&F class that renders this component.

Returns:

"TableUI"

Overrides:

getUIClassID in class JComponent

See Also:

getUIClassID, getUI

 public void setModel(TableModel newModel)

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

Parameters:

newModel - the new data source for this table

Throws: IllegalArgumentException

if newModel is null

See Also:

getModel

 public TableModel getModel()

Returns the TableModel that provides the data displayed by the receiver.

Returns:

the object that provides the data displayed by the receiver

See Also:

setModel

 public void setColumnModel(TableColumnModel newModel)

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

Parameters:

newModel - the new data source for this table

Throws: IllegalArgumentException

if newModel is null

See Also:

getColumnModel

 public TableColumnModel getColumnModel()

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

Returns:

the object that provides the column state of the table

See Also:

setColumnModel

 public void setSelectionModel(ListSelectionModel newModel)

Sets the row selection model for this table to newModel and registers with for listner notifications from the new selection model. If newModel is null, it means the rows in this table are not selectable.

Parameters:

newModel - the new selection model

See Also:

getSelectionModel

 public ListSelectionModel getSelectionModel()

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

Returns:

the object that provides row selection state. Or null if row selection is not allowed.

See Also:

setSelectionModel

 public void tableChanged(TableModelEvent e)

The TableModelEvent should be constructed in the co-ordinate system of the model, the appropriate mapping to the view co-ordinate system is performed by the JTable when it recieves the event.

 public void columnAdded(TableColumnModelEvent e)

Tells listeners that a column was added to the model.

See Also:

TableColumnModelListener

 public void columnRemoved(TableColumnModelEvent e)

Tells listeners that a column was removed from the model.

See Also:

TableColumnModelListener

 public void columnMoved(TableColumnModelEvent e)

Tells listeners that a column was repositioned.

See Also:

TableColumnModelListener

 public void columnMarginChanged(ChangeEvent e)

Tells listeners that a column was moved due to a margin change.

See Also:

TableColumnModelListener

 public void columnSelectionChanged(ListSelectionEvent e)

Tells listeners that the selection model of the TableColumnModel changed.

See Also:

TableColumnModelListener

 public void valueChanged(ListSelectionEvent e)

Tells listeners that the selection changed.

See Also:

ListSelectionListener

 public void editingStopped(ChangeEvent e)

Invoked when editing is finished. The changes are saved, the editor object is discarded, and the cell is rendered once again.

See Also:

CellEditorListener

 public void editingCanceled(ChangeEvent e)

Invoked when editing is canceled. The editor object is discarded and the cell is rendered once again.

See Also:

CellEditorListener

 public void setPreferredScrollableViewportSize(Dimension size)

Sets the preferred size of the viewport for this table.

Parameters:

size - a Dimension object specifying the preferredSize of a JViewport whose view is this table

See Also:

getPreferredScrollableViewportSize

 public Dimension getPreferredScrollableViewportSize()

Returns the preferred size of the viewport for this table.

Returns:

a Dimension object containing the preferredSize of the JViewport which displays this table

See Also:

getPreferredScrollableViewportSize

 public int getScrollableUnitIncrement(Rectangle visibleRect,
                                       int orientation,
                                       int direction)

Returns the scroll increment that completely exposes one new row or column (depending on the orientation).

This method is called each time the user requests a unit scroll.

Parameters:

visibleRect - The view area visible within the viewport

orientation - Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.

direction - Less than zero to scroll up/left, greater than zero for down/right.

Returns:

The "unit" increment for scrolling in the specified direction

See Also:

getScrollableUnitIncrement

 public int getScrollableBlockIncrement(Rectangle visibleRect,
                                        int orientation,
                                        int direction)

Returns The visibleRect.height or visibleRect.width, depending on the table's orientation.

Returns:

The visibleRect.height or visibleRect.width per the orientation.

See Also:

getScrollableBlockIncrement

 public boolean getScrollableTracksViewportWidth()

Returns false to indicate that the width of the viewport does not determine the width of the table.

Returns:

false

See Also:

getScrollableTracksViewportWidth

 public boolean getScrollableTracksViewportHeight()

Returns false to indicate that the height of the viewport does not determine the height of the table.

Returns:

false

See Also:

getScrollableTracksViewportHeight

 protected void createDefaultRenderers()

 protected void createDefaultEditors()

Creates default cell editors for Objects, numbers, and boolean values.

 protected void initializeLocalVars()

Initializes table properties to their default values.

 protected TableModel createDefaultDataModel()

Returns the default table model object which is a DefaultTableModel. Subclass can override this method to return a different table model object.

Returns:

the default table model object

 protected TableColumnModel createDefaultColumnModel()

Returns the default column model object which is a DefaultTableColumnModel. Subclass can override this method to return a different column model object

Returns:

the default column model object

 protected ListSelectionModel createDefaultSelectionModel()

Returns the default selection model object which is a DefaultListSelectionModel. Subclass can override this method to return a different selection model object.

Returns:

the default selection model object

 protected JTableHeader createDefaultTableHeader()

Returns the default table header object which is a JTableHeader. Subclass can override this method to return a different table header object

Returns:

the default table header object

 protected void resizeAndRepaint()

Properly sizes the receiver and its header view, and marks it as needing display. Also resets cursor rectangles for the header view and line scroll amounts for the JScrollPane.

 public TableCellEditor getCellEditor()

Return the cellEditor.

Returns:

the TableCellEditor that does the editing

See Also:

cellEditor

 public void setCellEditor(TableCellEditor anEditor)

Set the cellEditor variable.

Parameters:

anEditor - the TableCellEditor that does the editing

See Also:

cellEditor

 public void setEditingColumn(int aColumn)

Set the editingColumn variable.

See Also:

editingColumn

 public void setEditingRow(int aRow)

Set the editingRow variable.

See Also:

editingRow

 public boolean isOpaque()

Returns true to indicate that this component paints every pixel in its range. (In other words, it does not have a transparent background or foreground.)

Returns:

true

Overrides:

isOpaque in class JComponent

See Also:

isOpaque

 public Component prepareEditor(TableCellEditor editor,
                                int row,
                                int column)

Sets up the specified editor using the value at the specified cell.

Parameters:

editor - the TableCellEditor to set up

row - the row of the cell to edit, where 0 is the first

column - the column of the cell to edit, where 0 is the first

 public void removeEditor()

Discard the editor object and return the real estate it used to cell rendering.

 public AccessibleContext getAccessibleContext()

Get the AccessibleContext associated with this JComponent

Returns:

the AccessibleContext of this JComponent

Overrides:

getAccessibleContext in class JComponent

All Packages  Class Hierarchy  This Package  Previous  Next  Index