/*

 * Copyright 1997-2001 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.swing.event;

import java.util.EventObject;

import javax.swing.table.*;

/**

 * 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: <p>

 *

 * <pre>

 * 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

 * </pre>

 *

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

 * <p>

 * <strong>Warning:</strong>

 * 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<sup><font size="-2">TM</font></sup>

 * has been added to the <code>java.beans</code> package.

 * Please see {@link java.beans.XMLEncoder}.

 *

 * @author Alan Chung

 * @author Philip Milne

 * @see TableModel

 */

public class TableModelEvent extends java.util.EventObject

{

    /** Identifies the addtion of new rows or columns. */

    public static final int INSERT =  1;

    /** Identifies a change to existing data. */

    public static final int UPDATE =  0;

    /** Identifies the removal of rows or columns. */

    public static final int DELETE = -1;

    /** Identifies the header row. */

    public static final int HEADER_ROW = -1;

    /** Specifies all columns in a row or rows. */

    public static final int ALL_COLUMNS = -1;

//

//  Instance Variables

//

    protected int       type;

    protected int       firstRow;

    protected int       lastRow;

    protected int       column;

//

// Constructors

//

    /**

     *  All row data in the table has changed, listeners should discard any state

     *  that was based on the rows and requery the <code>TableModel</code>

     *  to get the new row count and all the appropriate values.

     *  The <code>JTable</code> 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.

     */

    public TableModelEvent(TableModel source) {

        // Use Integer.MAX_VALUE instead of getRowCount() in case rows were deleted.

        this(source, 0, Integer.MAX_VALUE, ALL_COLUMNS, UPDATE);

    }

    /**

     *  This row of data has been updated.

     *  To denote the arrival of a completely new table with a different structure

     *  use <code>HEADER_ROW</code> as the value for the <code>row</code>.

     *  When the <code>JTable</code> receives this event and its

     *  <code>autoCreateColumnsFromModel</code>

     *  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 <code>setModel(TableModel)</code> on the <code>JTable</code>.

     */

    public TableModelEvent(TableModel source, int row) {

        this(source, row, row, ALL_COLUMNS, UPDATE);

    }

    /**

     *  The data in rows [<I>firstRow</I>, <I>lastRow</I>] have been updated.

     */

    public TableModelEvent(TableModel source, int firstRow, int lastRow) {

        this(source, firstRow, lastRow, ALL_COLUMNS, UPDATE);

    }

    /**

     *  The cells in column <I>column</I> in the range

     *  [<I>firstRow</I>, <I>lastRow</I>] have been updated.

     */

    public TableModelEvent(TableModel source, int firstRow, int lastRow, int column) {

        this(source, firstRow, lastRow, column, UPDATE);

    }

    /**

     *  The cells from (firstRow, column) to (lastRow, column) have been changed.

     *  The <I>column</I> refers to the column index of the cell in the model's

     *  co-ordinate system. When <I>column</I> is ALL_COLUMNS, all cells in the

     *  specified range of rows are considered changed.

     *  <p>

     *  The <I>type</I> should be one of: INSERT, UPDATE and DELETE.

     */

    public TableModelEvent(TableModel source, int firstRow, int lastRow, int column, int type) {

        super(source);

        this.firstRow = firstRow;

        this.lastRow = lastRow;

        this.column = column;

        this.type = type;

    }

//

// Querying Methods

//

   /** Returns the first row that changed.  HEADER_ROW means the meta data,

     * ie. names, types and order of the columns.

     */

    public int getFirstRow() { return firstRow; };

    /** Returns the last row that changed. */

    public int getLastRow() { return lastRow; };

    /**

     *  Returns the column for the event.  If the return

     *  value is ALL_COLUMNS; it means every column in the specified

     *  rows changed.

     */

    public int getColumn() { return column; };

    /**

     *  Returns the type of event - one of: INSERT, UPDATE and DELETE.

     */

    public int getType() { return type; }

}