1 /*
2 * File: HierarchyRenderer.java
3 * Copyright (c) 2004-2007 Peter Kliem (Peter.Kliem@jaret.de)
4 * A commercial license is available, see http://www.jaret.de.
5 *
6 * This program 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 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20 package de.jaret.util.ui.timebars.swing.renderer;
21
22 import javax.swing.JComponent;
23
24 import de.jaret.util.ui.timebars.model.TimeBarRow;
25 import de.jaret.util.ui.timebars.swing.TimeBarViewer;
26
27 /**
28 * This interface describes a renderer used to render the hierarchy column.
29 *
30 * @author Peter Kliem
31 * @version $Id: HierarchyRenderer.java 800 2008-12-27 22:27:33Z kliem $
32 */
33 public interface HierarchyRenderer {
34 /**
35 * Provide a configured JComponent for rendering the hierarchy.
36 *
37 * @param tbv the requesting timebar viewer
38 * @param row the row (node) for which the hierarchy should be painted
39 * @param selected wehether the row is selscted or not
40 * @param expanded expanded status of the row
41 * @param leaf if true the row is a leaf
42 * @param level level in the tree of the current element
43 * @param depth depth of the tree. If the depth is not known a value of -1 will indicate this fact.
44 * @return the configured JComponent for rendering
45 */
46 JComponent getHierarchyRendererComponent(TimeBarViewer tbv, TimeBarRow row, boolean selected, boolean expanded,
47 boolean leaf, int level, int depth);
48
49 /**
50 * Return the preferred width for the hierachy display.
51 *
52 * @return preferred with or -1 for "don't care"
53 */
54 int getWidth();
55
56 }