Top Description Fields Constructors Methods
javax.swing.table

public abstract Class AbstractTableModel

extends Object
implements TableModel, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, javax.swing.table.TableModel
Known Direct Subclasses
javax.swing.table.DefaultTableModel, sun.swing.FilePane.DetailsTableModel
Annotations
@SuppressWarnings:serial
Imports
javax.swing.*, javax.swing.event.*, java.io.Serializable, java.util.EventListener
This abstract class provides default implementations for most of the methods in the TableModel interface. It takes care of the management of listeners and provides some conveniences for generating TableModelEvents and dispatching them to the listeners. To create a concrete TableModel as a subclass of AbstractTableModel you need only provide implementations for the following three methods: 
 public int getRowCount();
 public int getColumnCount();
 public Object getValueAt(int row, int column);

Warning

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

Authors
Alan Chung, Philip Milne

Field Summary

Modifier and TypeField and Description
protected EventListenerList
listenerList

List of listeners

Constructor Summary

AccessConstructor and Description
protected
AbstractTableModel()

Constructor for subclasses to call.

Method Summary

Modifier and TypeMethod and Description
public void
addTableModelListener(TableModelListener
the TableModelListener
l)

Implements javax.swing.table.TableModel.addTableModelListener.

Adds a listener to the list that's notified each time a change to the data model occurs.

public int

Returns:

the column with columnName, or -1 if not found
findColumn(String
string containing name of column to be located
columnName)

Returns a column given its name.

public void
fireTableCellUpdated(int
row of cell which has been updated
row, int
column of cell which has been updated
column)

Notifies all listeners that the value of the cell at [row, column] has been updated.

public void
fireTableChanged(TableModelEvent
the event to be forwarded
e)

Forwards the given notification event to all TableModelListeners that registered themselves as listeners for this table model.

public void
fireTableDataChanged()

Notifies all listeners that all cell values in the table's rows may have changed.

public void
fireTableRowsDeleted(int
the first row
firstRow, int
the last row
lastRow)

Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been deleted.

public void
fireTableRowsInserted(int
the first row
firstRow, int
the last row
lastRow)

Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been inserted.

public void
fireTableRowsUpdated(int
the first row
firstRow, int
the last row
lastRow)

Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been updated.

public void
fireTableStructureChanged()

Notifies all listeners that the table's structure has changed.

public Class<?>

Returns:

the Object.class
getColumnClass(int
the column being queried
columnIndex)

Implements javax.swing.table.TableModel.getColumnClass.

Returns Object.class regardless of columnIndex.

public String

Returns:

a string containing the default name of column
getColumnName(int
the column being queried
column)

Implements javax.swing.table.TableModel.getColumnName.

Returns a default name for the column using spreadsheet conventions: A, B, C, ...

public <
the listener type
T extends EventListener> T[]

Returns:

an array of all objects registered as FooListeners on this component, or an empty array if no such listeners have been added
getListeners(Class<T>
the type of listeners requested
listenerType)

Returns an array of all the objects currently registered as FooListeners upon this AbstractTableModel.

public TableModelListener[]

Returns:

all of this model's TableModelListeners or an empty array if no table model listeners are currently registered
getTableModelListeners()

Returns an array of all the table model listeners registered on this model.

public boolean

Returns:

false
isCellEditable(int
the row being queried
rowIndex, int
the column being queried
columnIndex)

Implements javax.swing.table.TableModel.isCellEditable.

Returns false.

public void
removeTableModelListener(TableModelListener
the TableModelListener
l)

Implements javax.swing.table.TableModel.removeTableModelListener.

Removes a listener from the list that's notified each time a change to the data model occurs.

public void
setValueAt(Object
value to assign to cell
aValue, int
row of cell
rowIndex, int
column of cell
columnIndex)

Implements javax.swing.table.TableModel.setValueAt.

This empty implementation is provided so users don't have to implement this method if their data model is not editable.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

listenerListback to summary
protected EventListenerList listenerList

List of listeners

Constructor Detail

AbstractTableModelback to summary
protected AbstractTableModel()

Constructor for subclasses to call.

Method Detail

addTableModelListenerback to summary
public void addTableModelListener(TableModelListener l)

Implements javax.swing.table.TableModel.addTableModelListener.

Adds a listener to the list that's notified each time a change to the data model occurs.

Parameters
l:TableModelListener

the TableModelListener

findColumnback to summary
public int findColumn(String columnName)

Returns a column given its name. Implementation is naive so this should be overridden if this method is to be called often. This method is not in the TableModel interface and is not used by the JTable.

Parameters
columnName:String

string containing name of column to be located

Returns:int

the column with columnName, or -1 if not found

fireTableCellUpdatedback to summary
public void fireTableCellUpdated(int row, int column)

Notifies all listeners that the value of the cell at [row, column] has been updated.

Parameters
row:int

row of cell which has been updated

column:int

column of cell which has been updated

See Also
TableModelEvent, EventListenerList
fireTableChangedback to summary
public void fireTableChanged(TableModelEvent e)

Forwards the given notification event to all TableModelListeners that registered themselves as listeners for this table model.

Parameters
e:TableModelEvent

the event to be forwarded

See Also
addTableModelListener, TableModelEvent, EventListenerList
fireTableDataChangedback to summary
public void fireTableDataChanged()

Notifies all listeners that all cell values in the table's rows may have changed. The number of rows may also have changed and the JTable should redraw the table from scratch. The structure of the table (as in the order of the columns) is assumed to be the same.

See Also
TableModelEvent, EventListenerList, javax.swing.JTable#tableChanged(TableModelEvent)
fireTableRowsDeletedback to summary
public void fireTableRowsDeleted(int firstRow, int lastRow)

Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been deleted.

Parameters
firstRow:int

the first row

lastRow:int

the last row

See Also
TableModelEvent, EventListenerList
fireTableRowsInsertedback to summary
public void fireTableRowsInserted(int firstRow, int lastRow)

Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been inserted.

Parameters
firstRow:int

the first row

lastRow:int

the last row

See Also
TableModelEvent, EventListenerList
fireTableRowsUpdatedback to summary
public void fireTableRowsUpdated(int firstRow, int lastRow)

Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been updated.

Parameters
firstRow:int

the first row

lastRow:int

the last row

See Also
TableModelEvent, EventListenerList
fireTableStructureChangedback to summary
public void fireTableStructureChanged()

Notifies all listeners that the table's structure has changed. The number of columns in the table, and the names and types of the new columns may be different from the previous state. If the JTable receives this event and its autoCreateColumnsFromModel flag is set it discards any table columns that it had and reallocates default columns in the order they appear in the model. This is the same as calling setModel(TableModel) on the JTable.

See Also
TableModelEvent, EventListenerList
getColumnClassback to summary
public Class<?> getColumnClass(int columnIndex)

Implements javax.swing.table.TableModel.getColumnClass.

Returns Object.class regardless of columnIndex.

Parameters
columnIndex:int

the column being queried

Returns:Class<?>

the Object.class

getColumnNameback to summary
public String getColumnName(int column)

Implements javax.swing.table.TableModel.getColumnName.

Returns a default name for the column using spreadsheet conventions: A, B, C, ... Z, AA, AB, etc. If column cannot be found, returns an empty string.

Parameters
column:int

the column being queried

Returns:String

a string containing the default name of column

getListenersback to summary
public <T extends EventListener> T[] getListeners(Class<T> listenerType)

Returns an array of all the objects currently registered as FooListeners upon this AbstractTableModel. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a model m for its table model listeners with the following code: 

TableModelListener[] tmls = (TableModelListener[])(m.getListeners(TableModelListener.class));
If no such listeners exist, this method returns an empty array.
Parameters
<T>
the listener type
listenerType:Class<T>

the type of listeners requested

Returns:T[]

an array of all objects registered as FooListeners on this component, or an empty array if no such listeners have been added

Exceptions
ClassCastException:
if listenerType doesn't specify a class or interface that implements java.util.EventListener
Since
1.3
See Also
getTableModelListeners
getTableModelListenersback to summary
public TableModelListener[] getTableModelListeners()

Returns an array of all the table model listeners registered on this model.

Returns:TableModelListener[]

all of this model's TableModelListeners or an empty array if no table model listeners are currently registered

Since
1.4
See Also
addTableModelListener, removeTableModelListener
isCellEditableback to summary
public boolean isCellEditable(int rowIndex, int columnIndex)

Implements javax.swing.table.TableModel.isCellEditable.

Returns false. This is the default implementation for all cells.

Parameters
rowIndex:int

the row being queried

columnIndex:int

the column being queried

Returns:boolean

false

removeTableModelListenerback to summary
public void removeTableModelListener(TableModelListener l)

Implements javax.swing.table.TableModel.removeTableModelListener.

Removes a listener from the list that's notified each time a change to the data model occurs.

Parameters
l:TableModelListener

the TableModelListener

setValueAtback to summary
public void setValueAt(Object aValue, int rowIndex, int columnIndex)

Implements javax.swing.table.TableModel.setValueAt.

This empty implementation is provided so users don't have to implement this method if their data model is not editable.

Parameters
aValue:Object

value to assign to cell

rowIndex:int

row of cell

columnIndex:int

column of cell