001/* TreeCellRenderer.java --
002   Copyright (C) 2002, 2004, 2006,  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing.tree;
040
041import java.awt.Component;
042
043import javax.swing.JTree;
044
045/**
046 * A <code>TreeCellRenderer</code> is used by the {@link JTree} component to
047 * paint individual tree elements (nodes).
048 * 
049 * @author Andrew Selkirk
050 */
051public interface TreeCellRenderer
052{
053  /**
054   * Returns a component that has been configured to display one element (or 
055   * node) in a {@link JTree} component.  The arguments to this method are used
056   * to pass in the value and state of the element to be rendered.
057   * 
058   * @param tree  the tree.
059   * @param value  the value to render.
060   * @param selected  is the tree element selected?
061   * @param expanded  is the tree element expanded?
062   * @param leaf  is the tree element a leaf node?
063   * @param row  the row index.
064   * @param hasFocus  does the tree element have the focus?
065   * 
066   * @return A component that is configured for rendering the tree element.
067   */
068  Component getTreeCellRendererComponent(JTree tree, Object value,
069                                         boolean selected, boolean expanded,
070                                         boolean leaf, int row,
071                                         boolean hasFocus);
072
073}