FileDocCategorySizeDatePackage
AbstractTableModel.javaAPI DocJava SE 5 API10800Fri Aug 26 14:58:14 BST 2005javax.swing.table

AbstractTableModel

public abstract class AbstractTableModel extends Object implements Serializable, TableModel
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 JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

version
1.41 05/05/04
author
Alan Chung
author
Philip Milne

Fields Summary
protected EventListenerList
listenerList
List of listeners
Constructors Summary
Methods Summary
public voidaddTableModelListener(javax.swing.event.TableModelListener l)
Adds a listener to the list that's notified each time a change to the data model occurs.

param
l the TableModelListener

	listenerList.add(TableModelListener.class, l);
    
public intfindColumn(java.lang.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.

param
columnName string containing name of column to be located
return
the column with columnName, or -1 if not found

        for (int i = 0; i < getColumnCount(); i++) {
            if (columnName.equals(getColumnName(i))) {
                return i;
            }
        }
        return -1;
    
public voidfireTableCellUpdated(int row, int column)
Notifies all listeners that the value of the cell at [row, column] has been updated.

param
row row of cell which has been updated
param
column column of cell which has been updated
see
TableModelEvent
see
EventListenerList

        fireTableChanged(new TableModelEvent(this, row, row, column));
    
public voidfireTableChanged(javax.swing.event.TableModelEvent e)
Forwards the given notification event to all TableModelListeners that registered themselves as listeners for this table model.

param
e the event to be forwarded
see
#addTableModelListener
see
TableModelEvent
see
EventListenerList

	// Guaranteed to return a non-null array
	Object[] listeners = listenerList.getListenerList();
	// Process the listeners last to first, notifying
	// those that are interested in this event
	for (int i = listeners.length-2; i>=0; i-=2) {
	    if (listeners[i]==TableModelListener.class) {
		((TableModelListener)listeners[i+1]).tableChanged(e);
	    }
	}
    
public voidfireTableDataChanged()
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
TableModelEvent
see
EventListenerList
see
javax.swing.JTable#tableChanged(TableModelEvent)

        fireTableChanged(new TableModelEvent(this));
    
public voidfireTableRowsDeleted(int firstRow, int lastRow)
Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been deleted.

param
firstRow the first row
param
lastRow the last row
see
TableModelEvent
see
EventListenerList

        fireTableChanged(new TableModelEvent(this, firstRow, lastRow,
                             TableModelEvent.ALL_COLUMNS, TableModelEvent.DELETE));
    
public voidfireTableRowsInserted(int firstRow, int lastRow)
Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been inserted.

param
firstRow the first row
param
lastRow the last row
see
TableModelEvent
see
EventListenerList

        fireTableChanged(new TableModelEvent(this, firstRow, lastRow,
                             TableModelEvent.ALL_COLUMNS, TableModelEvent.INSERT));
    
public voidfireTableRowsUpdated(int firstRow, int lastRow)
Notifies all listeners that rows in the range [firstRow, lastRow], inclusive, have been updated.

param
firstRow the first row
param
lastRow the last row
see
TableModelEvent
see
EventListenerList

        fireTableChanged(new TableModelEvent(this, firstRow, lastRow,
                             TableModelEvent.ALL_COLUMNS, TableModelEvent.UPDATE));
    
public voidfireTableStructureChanged()
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
TableModelEvent
see
EventListenerList

        fireTableChanged(new TableModelEvent(this, TableModelEvent.HEADER_ROW));
    
public java.lang.ClassgetColumnClass(int columnIndex)
Returns Object.class regardless of columnIndex.

param
columnIndex the column being queried
return
the Object.class

	return Object.class;
    
public java.lang.StringgetColumnName(int column)
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.

param
column the column being queried
return
a string containing the default name of column


//
// Default Implementation of the Interface
//

                                                        
        
	String result = "";
	for (; column >= 0; column = column / 26 - 1) {
	    result = (char)((char)(column%26)+'A") + result;
	}
        return result;
    
public T[]getListeners(java.lang.Class 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.

param
listenerType the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
return
an array of all objects registered as FooListeners on this component, or an empty array if no such listeners have been added
exception
ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener
see
#getTableModelListeners
since
1.3

 
	return listenerList.getListeners(listenerType); 
    
public javax.swing.event.TableModelListener[]getTableModelListeners()
Returns an array of all the table model listeners registered on this model.

return
all of this model's TableModelListeners or an empty array if no table model listeners are currently registered
see
#addTableModelListener
see
#removeTableModelListener
since
1.4

        return (TableModelListener[])listenerList.getListeners(
                TableModelListener.class);
    
public booleanisCellEditable(int rowIndex, int columnIndex)
Returns false. This is the default implementation for all cells.

param
rowIndex the row being queried
param
columnIndex the column being queried
return
false

	return false;
    
public voidremoveTableModelListener(javax.swing.event.TableModelListener l)
Removes a listener from the list that's notified each time a change to the data model occurs.

param
l the TableModelListener

	listenerList.remove(TableModelListener.class, l);
    
public voidsetValueAt(java.lang.Object aValue, int rowIndex, int columnIndex)
This empty implementation is provided so users don't have to implement this method if their data model is not editable.

param
aValue value to assign to cell
param
rowIndex row of cell
param
columnIndex column of cell