001/* CellEditor.java --
002   Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing;
040
041import java.util.EventObject;
042
043import javax.swing.event.CellEditorListener;
044import javax.swing.event.ChangeEvent;
045
046/**
047 * Provides edit capabilities for components that display cells like
048 * {@link JTable}, {@link JList} and {@link JTree}.
049 *
050 * @author Andrew Selkirk
051 */
052public interface CellEditor
053{
054  /**
055   * Returns the current value for the <code>CellEditor</code>.
056   *
057   * @return The value.
058   */
059  Object getCellEditorValue();
060
061  /**
062   * Returns <code>true</code> if the specified event makes the editor
063   * editable, and <code>false</code> otherwise.
064   *
065   * @param event  the event.
066   *
067   * @return A boolean.
068   */
069  boolean isCellEditable(EventObject event);
070
071  /**
072   * shouldSelectCell
073   * @param event TODO
074   * @return boolean
075   */
076  boolean shouldSelectCell(EventObject event);
077
078  /**
079   * Signals to the <code>CellEditor</code> that it should stop editing,
080   * accepting the current cell value, and returns <code>true</code> if the
081   * editor actually stops editing, and <code>false</code> otherwise.
082   *
083   * @return A boolean.
084   */
085  boolean stopCellEditing();
086
087  /**
088   * Signals to the <code>CellEditor</code> that it should cancel editing.
089   */
090  void cancelCellEditing();
091
092  /**
093   * Registers a listener to receive {@link ChangeEvent} notifications from the
094   * <code>CellEditor</code>.
095   *
096   * @param listener  the listener.
097   */
098  void addCellEditorListener(CellEditorListener listener);
099
100  /**
101   * Deregisters a listener so that it no longer receives {@link ChangeEvent}
102   * notifications from the <code>CellEditor</code>.
103   *
104   * @param listener  the listener.
105   */
106  void removeCellEditorListener(CellEditorListener listener);
107
108}