Source for javax.swing.CellEditor

   1: /* CellEditor.java --
   2:    Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing;
  40: 
  41: import java.util.EventObject;
  42: 
  43: import javax.swing.event.CellEditorListener;
  44: import javax.swing.event.ChangeEvent;
  45: 
  46: /**
  47:  * Provides edit capabilities for components that display cells like
  48:  * {@link JTable}, {@link JList} and {@link JTree}.
  49:  *
  50:  * @author Andrew Selkirk
  51:  */
  52: public interface CellEditor
  53: {
  54:   /**
  55:    * Returns the current value for the <code>CellEditor</code>.
  56:    * 
  57:    * @return The value.
  58:    */
  59:   Object getCellEditorValue();
  60: 
  61:   /**
  62:    * Returns <code>true</code> if the specified event makes the editor 
  63:    * editable, and <code>false</code> otherwise.
  64:    * 
  65:    * @param event  the event.
  66:    * 
  67:    * @return A boolean.
  68:    */
  69:   boolean isCellEditable(EventObject event);
  70: 
  71:   /**
  72:    * shouldSelectCell
  73:    * @param event TODO
  74:    * @return boolean
  75:    */
  76:   boolean shouldSelectCell(EventObject event);
  77: 
  78:   /**
  79:    * Signals to the <code>CellEditor</code> that it should stop editing, 
  80:    * accepting the current cell value, and returns <code>true</code> if the
  81:    * editor actually stops editing, and <code>false</code> otherwise.
  82:    * 
  83:    * @return A boolean.
  84:    */
  85:   boolean stopCellEditing();
  86: 
  87:   /**
  88:    * Signals to the <code>CellEditor</code> that it should cancel editing.
  89:    */
  90:   void cancelCellEditing();
  91: 
  92:   /**
  93:    * Registers a listener to receive {@link ChangeEvent} notifications from the 
  94:    * <code>CellEditor</code>.
  95:    * 
  96:    * @param listener  the listener.
  97:    */
  98:   void addCellEditorListener(CellEditorListener listener);
  99: 
 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: }