1 /*
2 * File: HeaderRenderer.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.TimeBarRowHeader;
25 import de.jaret.util.ui.timebars.swing.TimeBarViewer;
26
27 /**
28 * Renderer for row headers.
29 *
30 * @author Peter Kliem
31 * @version $Id: HeaderRenderer.java 800 2008-12-27 22:27:33Z kliem $
32 */
33 public interface HeaderRenderer {
34 /**
35 * Provide a JComponent configured to render the header object supplied as value.
36 *
37 * @param tbv the calling TimeBarViewer
38 * @param value the header object to render
39 * @param isSelected if true draw the selectd state
40 * @return a configured JComponent ready to be painted
41 */
42 JComponent getHeaderRendererComponent(TimeBarViewer tbv, TimeBarRowHeader value, boolean isSelected);
43
44 /**
45 * Return the width required by the header renderer. The value will only be read once by the TimeBarViewer when the
46 * rendderer ist set. There is no support for dynamic change of the header width initiated by the renderer.
47 *
48 * @return the width of the header
49 */
50 int getWidth();
51 }