libjava/classpath/javax/swing/tree/TreeCellRenderer.java

   1 /* TreeCellRenderer.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.JTree;
  44
  45 /**
  46  * A <code>TreeCellRenderer</code> is used by the {@link JTree} component to
  47  * paint individual tree elements (nodes).
  48  *
  49  * @author Andrew Selkirk
  50  */
  51 public interface TreeCellRenderer
  52 {
  53   /**
  54    * Returns a component that has been configured to display one element (or
  55    * node) in a {@link JTree} component.  The arguments to this method are used
  56    * to pass in the value and state of the element to be rendered.
  57    *
  58    * @param tree  the tree.
  59    * @param value  the value to render.
  60    * @param selected  is the tree element selected?
  61    * @param expanded  is the tree element expanded?
  62    * @param leaf  is the tree element a leaf node?
  63    * @param row  the row index.
  64    * @param hasFocus  does the tree element have the focus?
  65    *
  66    * @return A component that is configured for rendering the tree element.
  67    */
  68   Component getTreeCellRendererComponent(JTree tree, Object value,
  69                                          boolean selected, boolean expanded,
  70                                          boolean leaf, int row,
  71                                          boolean hasFocus);
  72
  73 }