01: /*
02: * $Id: Painter.java,v 1.2 2006/03/23 20:03:07 rbair Exp $
03: *
04: * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
05: * Santa Clara, California 95054, U.S.A. All rights reserved.
06: *
07: * This library is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU Lesser General Public
09: * License as published by the Free Software Foundation; either
10: * version 2.1 of the License, or (at your option) any later version.
11: *
12: * This library is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this library; if not, write to the Free Software
19: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20: */
21:
22: package org.jdesktop.swingx.painter;
23:
24: import java.awt.Graphics2D;
25: import javax.swing.JComponent;
26:
27: /**
28: * <p>Simple API for delegating painting. The JXPanel supports using this class
29: * as a delegate for painting the background of the panel. This allows developers
30: * to be able to customize the background painting of a JXPanel without having
31: * to override it. Since many components within SwingX extend JXPanel, the
32: * developer can implement custom painting on many parts of SwingX.</p>
33: *
34: * <p>Painters are generally expected to work with JComponent or one of its
35: * subclasses. Most painters don't use the component beyond requesting its width
36: * and height, but it is conceivable that certain painters will only work with
37: * specific subclasses (JXTitledPanel, for instance, so that the text can
38: * be extracted and used to paint a glow effect).</p>
39: *
40: * <p>Painters can be combined together by using the CompoundPainter. CompoundPainter
41: * uses an array to store several painters, and the order in which they should be
42: * painted.</p>
43: *
44: * <p>For example, if I want to create a CompoundPainter that started with a blue
45: * background, had pinstripes on it running at a 45 degree angle, and those
46: * pinstripes appeared to "fade in" from left to right, I would write the following:
47: * <pre><code>
48: * Color blue = new Color(0x417DDD);
49: * Color translucent = new Color(blue.getRed(), blue.getGreen(), blue.getBlue(), 0);
50: * panel.setBackground(blue);
51: * panel.setForeground(Color.LIGHT_GRAY);
52: * GradientPaint blueToTranslucent = new GradientPaint(
53: * new Point2D.Double(.4, 0),
54: * blue,
55: * new Point2D.Double(1, 0),
56: * translucent);
57: * Painter veil = new BasicGradientPainter(blueToTranslucent);
58: * Painter pinstripes = new PinstripePainter(45);
59: * Painter backgroundPainter = new BackgroundPainter();
60: * Painter p = new CompoundPainter(backgroundPainter, pinstripes, veil);
61: * panel.setBackgroundPainter(p);
62: * </code></pre></p>
63: *
64: * <p>For convenience, AbstractPainter handles some basic painting chores and
65: * should be extended for most concrete Painter implementations</p>
66: *
67: *
68: * @author rbair
69: */
70: public interface Painter<T extends JComponent> {
71: /**
72: * <p>Paints on the given Graphics2D object some effect which may or may not
73: * be related to the given component. For example, BackgroundPainter will
74: * use the background property of the component and the width/height of the
75: * component to perform a fill rect. Most other Painters will disregard the
76: * component entirely, except to get the component width/height.</p>
77: *
78: * <p>The Graphics2D object must be returned to the same state it started
79: * at by the end of the method. For example, if "setColor(c)" was called
80: * on the graphics object, it should be reset to the original color before
81: * the method returns.</p>
82: *
83: *
84: * @param g The Graphics2D object in which to paint
85: * @param component The JComponent that the Painter is delegate for.
86: */
87: public void paint(Graphics2D g, T component);
88: }
|