| /* CellEditor.java -- |
| Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc. |
| |
| This file is part of GNU Classpath. |
| |
| GNU Classpath is free software; you can redistribute it and/or modify |
| it under the terms of the GNU General Public License as published by |
| the Free Software Foundation; either version 2, or (at your option) |
| any later version. |
| |
| GNU Classpath 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 for more details. |
| |
| You should have received a copy of the GNU General Public License |
| along with GNU Classpath; see the file COPYING. If not, write to the |
| Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
| 02110-1301 USA. |
| |
| Linking this library statically or dynamically with other modules is |
| making a combined work based on this library. Thus, the terms and |
| conditions of the GNU General Public License cover the whole |
| combination. |
| |
| As a special exception, the copyright holders of this library give you |
| permission to link this library with independent modules to produce an |
| executable, regardless of the license terms of these independent |
| modules, and to copy and distribute the resulting executable under |
| terms of your choice, provided that you also meet, for each linked |
| independent module, the terms and conditions of the license of that |
| module. An independent module is a module which is not derived from |
| or based on this library. If you modify this library, you may extend |
| this exception to your version of the library, but you are not |
| obligated to do so. If you do not wish to do so, delete this |
| exception statement from your version. */ |
| |
| |
| package javax.swing; |
| |
| import java.util.EventObject; |
| |
| import javax.swing.event.CellEditorListener; |
| import javax.swing.event.ChangeEvent; |
| |
| /** |
| * Provides edit capabilities for components that display cells like |
| * {@link JTable}, {@link JList} and {@link JTree}. |
| * |
| * @author Andrew Selkirk |
| */ |
| public interface CellEditor |
| { |
| /** |
| * Returns the current value for the <code>CellEditor</code>. |
| * |
| * @return The value. |
| */ |
| Object getCellEditorValue(); |
| |
| /** |
| * Returns <code>true</code> if the specified event makes the editor |
| * editable, and <code>false</code> otherwise. |
| * |
| * @param event the event. |
| * |
| * @return A boolean. |
| */ |
| boolean isCellEditable(EventObject event); |
| |
| /** |
| * shouldSelectCell |
| * @param event TODO |
| * @return boolean |
| */ |
| boolean shouldSelectCell(EventObject event); |
| |
| /** |
| * Signals to the <code>CellEditor</code> that it should stop editing, |
| * accepting the current cell value, and returns <code>true</code> if the |
| * editor actually stops editing, and <code>false</code> otherwise. |
| * |
| * @return A boolean. |
| */ |
| boolean stopCellEditing(); |
| |
| /** |
| * Signals to the <code>CellEditor</code> that it should cancel editing. |
| */ |
| void cancelCellEditing(); |
| |
| /** |
| * Registers a listener to receive {@link ChangeEvent} notifications from the |
| * <code>CellEditor</code>. |
| * |
| * @param listener the listener. |
| */ |
| void addCellEditorListener(CellEditorListener listener); |
| |
| /** |
| * Deregisters a listener so that it no longer receives {@link ChangeEvent} |
| * notifications from the <code>CellEditor</code>. |
| * |
| * @param listener the listener. |
| */ |
| void removeCellEditorListener(CellEditorListener listener); |
| |
| } |