001 /* CellEditor.java --
002 Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.swing;
040
041 import java.util.EventObject;
042
043 import javax.swing.event.CellEditorListener;
044 import 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 */
052 public 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 }