Source for javax.swing.tree.TreeCellEditor

   1: /* TreeCellEditor.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.tree;
  40: 
  41: import java.awt.Component;
  42: 
  43: import javax.swing.CellEditor;
  44: import javax.swing.JTree;
  45: 
  46: /**
  47:  * A <code>TreeCellEditor</code> is used by the {@link JTree} component to
  48:  * edit individual tree elements (nodes).
  49:  * 
  50:  * @author Andrew Selkirk
  51:  */
  52: public interface TreeCellEditor extends CellEditor
  53: {
  54:   /**
  55:    * Returns a component that has been configured to edit one element (or 
  56:    * node) in a {@link JTree} component.  The arguments to this method are used
  57:    * to pass in the value and state of the element to be edited.
  58:    * 
  59:    * @param tree  the tree.
  60:    * @param value  the value to render.
  61:    * @param isSelected  is the tree element selected?
  62:    * @param expanded  is the tree element expanded?
  63:    * @param leaf  is the tree element a leaf node?
  64:    * @param row  the row index.
  65:    * 
  66:    * @return A component that is configured for editing the tree element.
  67:    */
  68:   Component getTreeCellEditorComponent(JTree tree, Object value,
  69:                        boolean isSelected, boolean expanded,
  70:                        boolean leaf, int row);
  71: }