This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.event
class TableModelEvent

java.lang.Object extended by java.util.EventObject extended by javax.swing.event.TableModelEvent
All Implemented Interfaces:
Serializable

public class TableModelEvent
extends EventObject

TableModelEvent is used to notify listeners that a table model has changed. The model event describes changes to a TableModel and all references to rows and columns are in the co-ordinate system of the model. Depending on the parameters used in the constructors, the TableModelevent can be used to specify the following types of changes:

 TableModelEvent(source);              //  The data, ie. all rows changed 
 TableModelEvent(source, HEADER_ROW);  //  Structure change, reallocate TableColumns
 TableModelEvent(source, 1);           //  Row 1 changed
 TableModelEvent(source, 3, 6);        //  Rows 3 to 6 inclusive changed
 TableModelEvent(source, 2, 2, 6);     //  Cell at (2, 6) changed
 TableModelEvent(source, 3, 6, ALL_COLUMNS, INSERT); // Rows (3, 6) were inserted
 TableModelEvent(source, 3, 6, ALL_COLUMNS, DELETE); // Rows (3, 6) were deleted
 
It is possible to use other combinations of the parameters, not all of them are meaningful. By subclassing, you can add other information, for example: whether the event WILL happen or DID happen. This makes the specification of rows in DELETE events more useful but has not been included in the swing package as the JTable only needs post-event notification.

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}.


Field Summary
static int ALL_COLUMNS
          Specifies all columns in a row or rows.
protected int column
          
static int DELETE
          Identifies the removal of rows or columns.
protected int firstRow
          
static int HEADER_ROW
          Identifies the header row.
static int INSERT
          Identifies the addtion of new rows or columns.
protected int lastRow
          
protected int type
          
static int UPDATE
          Identifies a change to existing data.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary

          All row data in the table has changed, listeners should discard any state that was based on the rows and requery the TableModel to get the new row count and all the appropriate values.
TableModelEvent(TableModel source, int row)

          This row of data has been updated.
TableModelEvent(TableModel source, int firstRow, int lastRow)

          The data in rows [firstRow, lastRow] have been updated.
TableModelEvent(TableModel source, int firstRow, int lastRow, int column)

          The cells in column column in the range [firstRow, lastRow] have been updated.
TableModelEvent(TableModel source, int firstRow, int lastRow, int column, int type)

          The cells from (firstRow, column) to (lastRow, column) have been changed.
 
Method Summary
 int

          Returns the column for the event.
 int

          Returns the first row that changed.
 int

          Returns the last row that changed.
 int

          Returns the type of event - one of: INSERT, UPDATE and DELETE.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL_COLUMNS

public static final int ALL_COLUMNS
Specifies all columns in a row or rows.

column

protected int column

DELETE

public static final int DELETE
Identifies the removal of rows or columns.

firstRow

protected int firstRow

HEADER_ROW

public static final int HEADER_ROW
Identifies the header row.

INSERT

public static final int INSERT
Identifies the addtion of new rows or columns.

lastRow

protected int lastRow

type

protected int type

UPDATE

public static final int UPDATE
Identifies a change to existing data.
Constructor Detail

TableModelEvent

public TableModelEvent(TableModel source)
All row data in the table has changed, listeners should discard any state that was based on the rows and requery the TableModel to get the new row count and all the appropriate values. The JTable will repaint the entire visible region on receiving this event, querying the model for the cell values that are visible. The structure of the table ie, the column names, types and order have not changed.

Parameters:
source

TableModelEvent

public TableModelEvent(TableModel source,
                       int row)
This row of data has been updated. To denote the arrival of a completely new table with a different structure use HEADER_ROW as the value for the row. When the JTable receives this event and its autoCreateColumnsFromModel flag is set it discards any TableColumns that it had and reallocates default ones in the order they appear in the model. This is the same as calling setModel(TableModel) on the JTable.

Parameters:
source
row

TableModelEvent

public TableModelEvent(TableModel source,
                       int firstRow,
                       int lastRow)
The data in rows [firstRow, lastRow] have been updated.

Parameters:
source
firstRow
lastRow

TableModelEvent

public TableModelEvent(TableModel source,
                       int firstRow,
                       int lastRow,
                       int column)
The cells in column column in the range [firstRow, lastRow] have been updated.

Parameters:
source
firstRow
lastRow
column

TableModelEvent

public TableModelEvent(TableModel source,
                       int firstRow,
                       int lastRow,
                       int column,
                       int type)
The cells from (firstRow, column) to (lastRow, column) have been changed. The column refers to the column index of the cell in the model's co-ordinate system. When column is ALL_COLUMNS, all cells in the specified range of rows are considered changed.

The type should be one of: INSERT, UPDATE and DELETE.

Parameters:
source
firstRow
lastRow
column
type
Method Detail

getColumn

public int getColumn()
Returns the column for the event. If the return value is ALL_COLUMNS; it means every column in the specified rows changed.


getFirstRow

public int getFirstRow()
Returns the first row that changed. HEADER_ROW means the meta data, ie. names, types and order of the columns.


getLastRow

public int getLastRow()
Returns the last row that changed.


getType

public int getType()
Returns the type of event - one of: INSERT, UPDATE and DELETE.



This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.