All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.swing.JTable

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

public class JTable

extends JComponent

implements TableModelListener, Scrollable, TableColumnModelListener, ListSelectionListener, CellEditorListener

WARNING: The API of JTable and its associated classes will be changed for the 1.0 Swing release. Please see the associated README with this distribution for more information.

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

columnModel

The TableColumnModel of the table

dataModel

The TableModel of the table

editingColumn

editingRow

editorComp

If editing, Component that is handling the editing.

emptySelectionAllowed

Empty selection allowed in this table

gridColor

The color of the grid

isRowSelected

multipleSelectionAllowed

Multiple rows selected allowed in this table

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

selectionModel

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

showGrid

The table draws a grid between cells if showGrid is true

simultaneousRowColumnSelectionAllowed

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

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(Object, int)

addColumn(Object, int, TableCellRenderer, TableCellEditor)

addColumn(Object, int, TableCellRenderer, TableCellEditor, Vector)

Creates a new column with columnIdentifier, width, renderer, and editor to the end of the JTable's array of columns.

addColumn(Object, Vector)

Add a column to the table.

addColumn(TableColumn)

Appends aColumn to the end of the JTable's array of columns.

addColumnSelectionInterval(int, int)

Adds the columns from index0 to index0 inclusive to the current selection, if column selection and multiple selection is allowed.

addRow(Object[])

Add a row to the table.

addRow(Vector)

Add a row to the table.

addRowSelectionInterval(int, int)

Adds the rows from index0 to index0 inclusive to the current selection, if row selection and multiple selection is allowed.

checkDefaultTableModel()

Checks the table model.

clearSelection()

Deselects all selected columns and rows.

columnAdded(TableColumnModelEvent)

columnAtPoint(Point)

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

columnMarginChanged(ChangeEvent)

columnMoved(TableColumnModelEvent)

columnRemoved(TableColumnModelEvent)

columnSelectionChanged(ListSelectionEvent)

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(), getColumnIdentifier(), and getColumnType() methods defined in the TableModel interface.

createDefaultDataModel()

Returns the default table model object which is a DefaultTableModel.

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.

editColumnRow(int, int)

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

editColumnRow(int, int, EventObject)

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

editColumnRow(Object, int)

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

editingCanceled(ChangeEvent)

editingColumn()

If sent while isEditing() is true, this returns the index of the editing column; otherwise returns -1.

editingRow()

If sent while isEditing() is true, this returns the index of the editing row; otherwise returns -1.

editingStopped(ChangeEvent)

getAutoCreateColumnsFromModel()

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

getAutoResizeMode()

Returns auto resize mode of the table.

getCellEditor()

Set the cellEditor variable

getCellRect(int, int, boolean)

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

getColumn(Object)

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

getColumnCount()

Returns the number of columns in the table

getColumnModel()

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

getColumnSelectionAllowed()

getEditorComponent()

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

getEmptySelectionAllowed()

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.

getMultipleSelectionAllowed()

getPreferredScrollableViewportSize()

getPreferredScrollableViewportSize(Dimension)

getRowCount()

Returns the number of rows in the table.

getRowHeight()

Returns the height of a table row in the receiver.

getRowSelectionAllowed()

getScrollableBlockIncrement(Rectangle, int, int)

getScrollableTracksViewportHeight()

getScrollableTracksViewportWidth()

getScrollableUnitIncrement(Rectangle, int, int)

getSelectedColumn()

getSelectedColumnCount()

getSelectedColumns()

getSelectedRow()

getSelectedRowCount()

getSelectedRows()

getSelectionModel()

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

getShowGrid()

Returns true if the receiver draws grid lines around cells, false if it doesn't.

getSimultaneousRowColumnSelectionAllowed()

getTableHeader()

Returns the tableHeader working with this JTable.

getToolTipText(MouseEvent)

Overriding to allow renderer's tips to be used if it has text set.

getUI()

getUIClassID()

getValueAt(int, int)

Returns the cell value at columnIndex and rowIndex.

getValueAt(Object, int)

Returns the cell value at columnIdentifier and rowIndex.

initializeLocalVars()

insertRow(int, Object[])

Insert a row at rowIndex in the table.

insertRow(int, Vector)

Insert a row at rowIndex in the table.

isCellEditable(int, int)

Returns true if the cell at columnIndex and rowIndex is editable.

isCellEditable(Object, int)

Returns true if the cell at columnIdentifier and rowIndex is editable.

isColumnSelected(int)

isColumnSelected(Object)

isEditing()

isOpaque()

Returns true if this component is completely opaque.

isRowSelected(int)

moveColumn(Object, Object)

Moves the column and heading at with the unique id columnIdentifier to the position currently occupied by the column with the unique id targetColumnIdentifier.

moveRow(int, int, int)

Moves one or more rows starting at startIndex to endIndex in the model to the toIndex.

prepareEditor(TableCellEditor, TableColumn, int)

removeColumn(Object)

Remove the column with an identifier that matches the parameter columnIdentifier.

removeColumn(TableColumn)

Removes aColumn from the JTable's array of columns.

removeColumnSelectionInterval(int, int)

Deselects the columns from index0 to index0 inclusive.

removeEditor()

removeRow(int)

Remove the row at rowIndex from the table.

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.

resizeAndRepaint(int, int, int, int)

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 it lies outside the receiver's bounds.

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.

setBounds(int, int, int, int)

Overriding setBounds() to call sizeColumnsToFit() depending on the setting of autoResizeMode

setCellEditor(TableCellEditor)

Set the cellEditor variable

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, if column selection is allowed.

setDataVector(Object[][], Object[])

setDataVector(Vector, Vector)

setEditingColumn(int)

Set the editingColumn variable

setEditingRow(int)

Set the editingRow variable

setEmptySelectionAllowed(boolean)

Sets whether the user can select zero columns or rows.

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.

setMultipleSelectionAllowed(boolean)

Sets whether the user can select more than one column or row at a time.

setNumRows(int)

Sets the number of rows in the 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, if row selection is allowed.

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.

setSimultaneousRowColumnSelectionAllowed(boolean)

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

setTableHeader(JTableHeader)

Sets the tableHeader working with this JTable to newHeader.

setUI(TableUI)

setValueAt(Object, int, int)

Sets the value for the cell at columnIndex and rowIndex.

setValueAt(Object, Object, int)

Sets the value for the cell at columnIdentifier and rowIndex.

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)

tableRowsInserted(TableModelEvent)

tableRowsRemoved(TableModelEvent)

updateUI()

Called to replace the UI with the latest version from the default UIFactory.

valueChanged(ListSelectionEvent)

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 showGrid

The table draws a grid between cells if showGrid 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 multipleSelectionAllowed

Multiple rows selected allowed in this table

protected boolean emptySelectionAllowed

Empty selection allowed in this table

protected boolean rowSelectionAllowed

Row selection allowed in this table

protected boolean simultaneousRowColumnSelectionAllowed

If this is true, then both a row selection and a column selection can be non-empty at the same time. Typically, when you select one the other is deselected.

protected boolean isRowSelected

protected transient TableCellEditor cellEditor

protected transient int editingColumn

protected transient int editingRow

protected transient Component editorComp

If editing, Component that is handling the editing.

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 "Column0", "Column1", "Column2", 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.

Parameters:

flag - true if table view should draw grid lines

See Also:

getShowGrid

public boolean getShowGrid()

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

Returns:

true if the receiver draws grid lines around cells, false if it doesn't

See Also:

setShowGrid

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(), getColumnIdentifier(), 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 setMultipleSelectionAllowed(boolean flag)

Sets whether the user can select more than one column or row at a time.

See Also:

getMultipleSelectionAllowed

public boolean getMultipleSelectionAllowed()

Returns:

true if the receiver allows more than one column or row selected

See Also:

setMultipleSelectionAllowed

public void setEmptySelectionAllowed(boolean flag)

Sets whether the user can select zero columns or rows.

See Also:

getEmptySelectionAllowed

public boolean getEmptySelectionAllowed()

Returns:

true if the receiver allows zero column or rows selected

See Also:

setEmptySelectionAllowed

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.

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.

See Also:

setColumnSelectionAllowed

public void setSimultaneousRowColumnSelectionAllowed(boolean flag)

Sets whether this table allows both a column selection and a row selection to exist at the same time. The default is false, which means, when the user selects a column all rows are deselected, and vice versa.

See Also:

getSimultaneousRowColumnSelectionAllowed

public boolean getSimultaneousRowColumnSelectionAllowed()

Returns:

true if simultaneous row and column selections are allowed

See Also:

setSimultaneousRowColumnSelectionAllowed

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, if row selection is allowed. If multiple selection is not allowed then it only selects the row at index0.

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, if column selection is allowed. If multiple selection is not allowed then it only selects the column at index0.

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, if row selection and multiple selection is allowed.

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, if column selection and multiple selection is allowed.

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. If empty selection is not allowed then this might leave one row selected.

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. If empty selection is not allowed then this might leave one column selected.

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, (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, (lead selection) or -1 if no column is selected.

See Also:

getSelectedColumns

public int[] getSelectedRows()

Returns:

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

See Also:

getSelectedRow

public int[] getSelectedColumns()

Returns:

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

See Also:

getSelectedColumn

public int getSelectedRowCount()

Returns:

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

public int getSelectedColumnCount()

Returns:

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

public boolean isRowSelected(int row)

Returns:

true if the row at index row is selected

Throws: IllegalArgumentException

if row is not in the valid range

public boolean isColumnSelected(int column)

Returns:

true if the column at index column is selected

Throws: IllegalArgumentException

if column is not in the valid range

public boolean isColumnSelected(Object identifier)

Returns:

true if the column with an identifier matching identifer is selected

public int getColumnCount()

Returns the number of columns in the table

Returns:

the number of columns in the table

See Also:

getRowCount

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(). Returns null if no matching column is found.

Parameters:

identifier - the identifier object

Returns:

the TableColumn object with matching identifier

public int getRowCount()

Returns the number of rows in the table.

See Also:

getColumnCount

public Object getValueAt(Object columnIdentifier,
                         int rowIndex)

Returns the cell value at columnIdentifier and rowIndex.

Parameters:

columnIdentifier - the column whose value is to be looked up

rowIndex - the row whose value is to be looked up

Returns:

the value Object at the specified cell

public Object getValueAt(int columnIndex,
                         int rowIndex)

Returns the cell value at columnIndex and rowIndex.

NOTE: The columnIndex 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 action never effect the model's column ordering.

Parameters:

columnIndex - the column whose value is to be looked up

rowIndex - the row whose value is to be looked up

Returns:

the value Object at the specified cell

public boolean isCellEditable(Object columnIdentifier,
                              int rowIndex)

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

Parameters:

columnIdentifier - the column whose value is to be looked up

rowIndex - the row whose value is to be looked up

Returns:

true if the cell is editable.

See Also:

setValueAt

public boolean isCellEditable(int columnIndex,
                              int rowIndex)

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

Parameters:

columnIndex - the column whose value is to be looked up

rowIndex - the row whose value is to be looked up

Returns:

true if the cell is editable.

See Also:

setValueAt

public void setValueAt(Object aValue,
                       Object columnIdentifier,
                       int rowIndex)

Sets the value for the cell at columnIdentifier and rowIndex. aValue is the new value.

Parameters:

aValue - the new value

columnIdentifier - the column whose value is to be changed

rowIndex - the row whose value is to be changed

See Also:

getValueAt

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

Sets the value for the cell at columnIndex and rowIndex. aValue is the new value.

Parameters:

aValue - the new value

columnIndex - the column whose value is to be changed

rowIndex - the row whose value is to be changed

See Also:

getValueAt

public void addColumn(TableColumn aColumn)

Appends aColumn to the end of the JTable's array of columns.

Parameters:

aColumn - The TableColumn to be added

public TableColumn addColumn(Object columnIdentifier,
                             Vector columnData)

Add a column to the table. The new column will have the unique identifier columnIdentifier. columnData is the optional Vector of data for the column. If it is null the column is filled with null values.

Parameters:

columnIdentifier - the unique object identifier of the column

columnData - optional data of the column being added

Throws: IllegalArgumentException

if columnIdentifier is null

Throws: InternalError

if dataModel is not a DefaultTableModel

public TableColumn addColumn(Object columnIdentifier,
                             int width)

public TableColumn addColumn(Object columnIdentifier,
                             int width,
                             TableCellRenderer renderer,
                             TableCellEditor editor)

public TableColumn addColumn(Object columnIdentifier,
                             int width,
                             TableCellRenderer renderer,
                             TableCellEditor editor,
                             Vector columnData)

Creates a new column with columnIdentifier, width, renderer, and editor to the end of the JTable's array of columns. columnData is the optional Vector of data for the column. If it is null the column is filled with null values.

Note: By default, the columnIdentifier's toString() value is used as the name of the column. If that is not the desired name for the column, the name can be changed using TableColumn's setHeaderValue() method.

Parameters:

columnIdentifier - The unique identifier of the new column

width - The new column's width. Or -1 to use the default width

renderer - The renderer used with the new column. Or null to use the default renderer.

editor - The editor used with the new column. Or null to use the default editor.

columnData - optional data of the column being added

Throws: InternalError

if dataModel is not a DefaultTableModel

public void removeColumn(TableColumn aColumn)

Removes aColumn from the JTable's array of columns.

Parameters:

aColumn - The TableColumn to be removed

public void removeColumn(Object columnIdentifier)

Remove the column with an identifier that matches the parameter columnIdentifier.

Parameters:

columnIdentifier - the identifier of the column being removed

Throws: InternalError

if dataModel is not a DefaultTableModel

public void moveColumn(Object columnIdentifier,
                       Object targetColumnIdentifier)

Moves the column and heading at with the unique id columnIdentifier to the position currently occupied by the column with the unique id targetColumnIdentifier. The old column at targetColumnIdentifier is shifted left or right to make room. This will not move any columns if columnIdentifier equals targetColumnIdentifier.

Parameters:

columnIdentifier - the index of column to be moved

targetColumnIdentifier - New index to move the column

Throws: IllegalArgumentException

if columnIdentifier or targetColumnIdentifier are not found

public void addRow(Vector rowData)

Add a row to the table. The new row will contain empty values unless rowData is specified.

Parameters:

rowData - optional data of the row being added

Throws: InternalError

if dataModel is not a DefaultTableModel

public void addRow(Object[] rowData)

Add a row to the table. The new row will contain empty values unless rowData is specified.

Parameters:

rowData - optional data of the row being added

Throws: InternalError

if dataModel is not a DefaultTableModel

public void insertRow(int rowIndex,
                      Vector rowData)

Insert a row at rowIndex in the table. The new row will contain empty values unless rowData is specified.

Parameters:

rowIndex - the row index of the row to be inserted

rowData - optional data of the row being added

Throws: ArrayIndexOutOfBoundsException

if the rowIndex was invalid.

Throws: InternalError

if dataModel is not a DefaultTableModel

public void insertRow(int rowIndex,
                      Object[] rowData)

Insert a row at rowIndex in the table. The new row will contain empty values unless rowData is specified.

Parameters:

rowIndex - the row index of the row to be inserted

rowData - optional data of the row being added

Throws: ArrayIndexOutOfBoundsException

if the rowIndex was invalid.

Throws: InternalError

if dataModel is not a DefaultTableModel

public void removeRow(int rowIndex)

Remove the row at rowIndex from the table.

Parameters:

rowIndex - the row index of the row to be removed

Throws: ArrayIndexOutOfBoundsException

if the rowIndex was invalid.

Throws: InternalError

if dataModel is not a DefaultTableModel

public void moveRow(int startIndex,
                    int endIndex,
                    int toIndex)

Moves one or more rows starting at startIndex to endIndex in the model to the toIndex.

Parameters:

startIndex - the starting row index to be moved

endIndex - the ending row index to be moved

toIndex - the destination of the rows to be moved

Throws: ArrayIndexOutOfBoundsException

if any of the indices are out of range.

Throws: InternalError

if dataModel is not a DefaultTableModel

public void setNumRows(int newSize)

Sets the number of rows in the table. If the new size is greater than the current size, new rows are added to the end of the model If the new size is less than the current size, all rows at index newSize and greater are discarded.

Parameters:

newSize - the new number of rows

Throws: InternalError

if dataModel is not a DefaultTableModel

public void setDataVector(Vector newData,
                          Vector columnIds)

public void setDataVector(Object[][] newData,
                          Object[] columnIds)

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 it lies outside the receiver's bounds.

Returns:

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

See Also:

columnAtPoint

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

Returns a rectangle locating the cell that lies at the intersection of column and row. 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:

column - the column to compute

row - the row to compute

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

Returns:

the rectangle containing the cell at index column,row

Throws: IllegalArgumentException

If column or row 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 void setBounds(int x,
                      int y,
                      int w,
                      int h)

Overriding setBounds() to call sizeColumnsToFit() depending on the setting of autoResizeMode

Overrides:

setBounds in class JComponent

public String getToolTipText(MouseEvent event)

Overriding to allow 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 if JTable is told setToolTipText(null) it will unregister the table component, and no tips from renderers will display anymore.

Overrides:

getToolTipText in class JComponent

public boolean editColumnRow(int columnIndex,
                             int rowIndex)

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

Parameters:

columnIndex - the index of column to be edited

rowIndex - the index of row to be edited

Returns:

false if for any reason the cell cannot be edited.

Throws: IllegalArgumentException

If column or row are not in the valid range

public boolean editColumnRow(int columnIndex,
                             int rowIndex,
                             EventObject e)

Programmatically starts editing the cell at column and row, if the cell is editable. The EventObject e is passed into the CellEditor's method shouldSelectCell and isCellEditable.

Parameters:

columnIndex - the index of column to be edited

rowIndex - the index of row to be edited

e - event to pass into shouldSelectCell

Returns:

false if for any reason the cell cannot be edited.

Throws: IllegalArgumentException

If column or row are not in the valid range

public boolean editColumnRow(Object identifier,
                             int row)

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

Parameters:

identifier - the index of column to be edited

row - the index of row to be edited

Returns:

false if for any reason the cell cannot be edited.

Throws: IllegalArgumentException

If identifier is not found or row is not in the valid range

public boolean isEditing()

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 editingColumn()

If sent while isEditing() is true, this returns the index of the editing column; otherwise returns -1.

Returns:

the index of the column being edited; otherwise returns -1

See Also:

editingRow

public int editingRow()

If sent while isEditing() is true, this returns the index of the editing row; otherwise returns -1.

Returns:

the index of the row being edited; otherwise returns -1

See Also:

editingColumn

public TableUI getUI()

public void setUI(TableUI ui)

public void updateUI()

Called to replace the UI with the latest version from the default UIFactory.

Overrides:

updateUI in class JComponent

public String getUIClassID()

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.

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)

public void tableRowsInserted(TableModelEvent e)

public void tableRowsRemoved(TableModelEvent e)

public void columnAdded(TableColumnModelEvent e)

public void columnRemoved(TableColumnModelEvent e)

public void columnMoved(TableColumnModelEvent e)

public void columnMarginChanged(ChangeEvent e)

public void columnSelectionChanged(ListSelectionEvent e)

public void valueChanged(ListSelectionEvent e)

public void editingStopped(ChangeEvent e)

public void editingCanceled(ChangeEvent e)

public void getPreferredScrollableViewportSize(Dimension size)

public Dimension getPreferredScrollableViewportSize()

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

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

Returns:

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

public boolean getScrollableTracksViewportWidth()

public boolean getScrollableTracksViewportHeight()

protected void initializeLocalVars()

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.

protected void resizeAndRepaint(int x,
                                int y,
                                int w,
                                int h)

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()

Set the cellEditor variable

public void setCellEditor(TableCellEditor anEditor)

Set the cellEditor variable

public void setEditingColumn(int aColumn)

Set the editingColumn variable

public void setEditingRow(int aRow)

Set the editingRow variable

public boolean isOpaque()

Returns true if this component is completely opaque.

Overrides:

isOpaque in class JComponent

public Component prepareEditor(TableCellEditor editor,
                               TableColumn aColumn,
                               int row)

public void removeEditor()

protected void checkDefaultTableModel()

Checks the table model. If it is not a DefaultTableModel this throws an InternalError exception.

All Packages  Class Hierarchy  This Package  Previous  Next  Index