/*

 * Copyright (c) 1997, 1999, 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.

 */

package javax.swing.table;

import java.awt.Component;

import javax.swing.CellEditor;

import javax.swing.*;

/**

 * This interface defines the method any object that would like to be

 * an editor of values for components such as <code>JListBox</code>,

 * <code>JComboBox</code>, <code>JTree</code>, or <code>JTable</code>

 * needs to implement.

 *

 * @author Alan Chung

 */

public interface TableCellEditor extends CellEditor {

    /**

     *  Sets an initial <code>value</code> for the editor.  This will cause

     *  the editor to <code>stopEditing</code> and lose any partially

     *  edited value if the editor is editing when this method is called. <p>

     *

     *  Returns the component that should be added to the client's

     *  <code>Component</code> hierarchy.  Once installed in the client's

     *  hierarchy this component will then be able to draw and receive

     *  user input.

     *

     * @param   table           the <code>JTable</code> that is asking the

     *                          editor to edit; can be <code>null</code>

     * @param   value           the value of the cell to be edited; it is

     *                          up to the specific editor to interpret

     *                          and draw the value.  For example, if value is

     *                          the string "true", it could be rendered as a

     *                          string or it could be rendered as a check

     *                          box that is checked.  <code>null</code>

     *                          is a valid value

     * @param   isSelected      true if the cell is to be rendered with

     *                          highlighting

     * @param   row             the row of the cell being edited

     * @param   column          the column of the cell being edited

     * @return  the component for editing

     */

    Component getTableCellEditorComponent(JTable table, Object value,

                                          boolean isSelected,

                                          int row, int column);

}