TableModel.java

/*
 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. 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. Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

packagejavax.swing.table;

importjavax.swing.*;
importjavax.swing.event.*;

/**
 * The <code>TableModel</code> interface specifies the methods the
 * <code>JTable</code> will use to interrogate a tabular data model. <p>
 *
 * The <code>JTable</code> can be set up to display any data
 * model which implements the
 * <code>TableModel</code> interface with a couple of lines of code:
 * <pre>
 * TableModel myData = new MyTableModel();
 * JTable table = new JTable(myData);
 * </pre><p>
 *
 * For further documentation, see <a href="https://docs.oracle.com/javase/tutorial/uiswing/components/table.html#data">Creating a Table Model</a>
 * in <em>The Java Tutorial</em>.
 *
 * @author Philip Milne
 * @see JTable
 */

publicinterfaceTableModel
{
/**
 * Returns the number of rows in the model. A
 * <code>JTable</code> uses this method to determine how many rows it
 * should display. This method should be quick, as it
 * is called frequently during rendering.
 *
 * @return the number of rows in the model
 * @see #getColumnCount
 */
publicintgetRowCount();

/**
 * Returns the number of columns in the model. A
 * <code>JTable</code> uses this method to determine how many columns it
 * should create and display by default.
 *
 * @return the number of columns in the model
 * @see #getRowCount
 */
publicintgetColumnCount();

/**
 * Returns the name of the column at <code>columnIndex</code>. This is used
 * to initialize the table's column header name. Note: this name does
 * not need to be unique; two columns in a table can have the same name.
 *
 * @param columnIndex the index of the column
 * @return the name of the column
 */
publicStringgetColumnName(intcolumnIndex);

/**
 * Returns the most specific superclass for all the cell values
 * in the column. This is used by the <code>JTable</code> to set up a
 * default renderer and editor for the column.
 *
 * @param columnIndex the index of the column
 * @return the common ancestor class of the object values in the model.
 */
publicClass<?> getColumnClass(intcolumnIndex);

/**
 * Returns true if the cell at <code>rowIndex</code> and
 * <code>columnIndex</code>
 * is editable. Otherwise, <code>setValueAt</code> on the cell will not
 * change the value of that cell.
 *
 * @param rowIndex the row whose value to be queried
 * @param columnIndex the column whose value to be queried
 * @return true if the cell is editable
 * @see #setValueAt
 */
publicbooleanisCellEditable(introwIndex, intcolumnIndex);

/**
 * Returns the value for the cell at <code>columnIndex</code> and
 * <code>rowIndex</code>.
 *
 * @param rowIndex the row whose value is to be queried
 * @param columnIndex the column whose value is to be queried
 * @return the value Object at the specified cell
 */
publicObjectgetValueAt(introwIndex, intcolumnIndex);

/**
 * Sets the value in the cell at <code>columnIndex</code> and
 * <code>rowIndex</code> to <code>aValue</code>.
 *
 * @param aValue the new value
 * @param rowIndex the row whose value is to be changed
 * @param columnIndex the column whose value is to be changed
 * @see #getValueAt
 * @see #isCellEditable
 */
publicvoidsetValueAt(ObjectaValue, introwIndex, intcolumnIndex);

/**
 * Adds a listener to the list that is notified each time a change
 * to the data model occurs.
 *
 * @param l the TableModelListener
 */
publicvoidaddTableModelListener(TableModelListenerl);

/**
 * Removes a listener from the list that is notified each time a
 * change to the data model occurs.
 *
 * @param l the TableModelListener
 */
publicvoidremoveTableModelListener(TableModelListenerl);
}