001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -------------------
028 * DialBackground.java
029 * -------------------
030 * (C) Copyright 2006-2013, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes
036 * -------
037 * 03-Nov-2006 : Version 1 (DG);
038 * 16-Oct-2007 : The equals() method needs to call super.equals() (DG);
039 * 03-Jul-2013 : Use ParamChecks (DG);
040 *
041 */
042
043package org.jfree.chart.plot.dial;
044
045import java.awt.Color;
046import java.awt.GradientPaint;
047import java.awt.Graphics2D;
048import java.awt.Paint;
049import java.awt.geom.Rectangle2D;
050import java.io.IOException;
051import java.io.ObjectInputStream;
052import java.io.ObjectOutputStream;
053import java.io.Serializable;
054
055import org.jfree.chart.HashUtilities;
056import org.jfree.chart.util.ParamChecks;
057import org.jfree.io.SerialUtilities;
058import org.jfree.ui.GradientPaintTransformer;
059import org.jfree.ui.StandardGradientPaintTransformer;
060import org.jfree.util.PaintUtilities;
061import org.jfree.util.PublicCloneable;
062
063/**
064 * A regular dial layer that can be used to draw the background for a dial.
065 *
066 * @since 1.0.7
067 */
068public class DialBackground extends AbstractDialLayer implements DialLayer,
069        Cloneable, PublicCloneable, Serializable {
070
071    /** For serialization. */
072    static final long serialVersionUID = -9019069533317612375L;
073
074    /**
075     * The background paint.  This field is transient because serialization
076     * requires special handling.
077     */
078    private transient Paint paint;
079
080    /**
081     * The transformer used when the background paint is an instance of
082     * <code>GradientPaint</code>.
083     */
084    private GradientPaintTransformer gradientPaintTransformer;
085
086    /**
087     * Creates a new instance of <code>DialBackground</code>.  The
088     * default background paint is <code>Color.white</code>.
089     */
090    public DialBackground() {
091        this(Color.white);
092    }
093
094    /**
095     * Creates a new instance of <code>DialBackground</code>.  The
096     *
097     * @param paint  the paint (<code>null</code> not permitted).
098     *
099     * @throws IllegalArgumentException if <code>paint</code> is
100     *     <code>null</code>.
101     */
102    public DialBackground(Paint paint) {
103        ParamChecks.nullNotPermitted(paint, "paint");
104        this.paint = paint;
105        this.gradientPaintTransformer = new StandardGradientPaintTransformer();
106    }
107
108    /**
109     * Returns the paint used to fill the background.
110     *
111     * @return The paint (never <code>null</code>).
112     *
113     * @see #setPaint(Paint)
114     */
115    public Paint getPaint() {
116        return this.paint;
117    }
118
119    /**
120     * Sets the paint for the dial background and sends a
121     * {@link DialLayerChangeEvent} to all registered listeners.
122     *
123     * @param paint  the paint (<code>null</code> not permitted).
124     *
125     * @see #getPaint()
126     */
127    public void setPaint(Paint paint) {
128        ParamChecks.nullNotPermitted(paint, "paint");
129        this.paint = paint;
130        notifyListeners(new DialLayerChangeEvent(this));
131    }
132
133    /**
134     * Returns the transformer used to adjust the coordinates of any
135     * <code>GradientPaint</code> instance used for the background paint.
136     *
137     * @return The transformer (never <code>null</code>).
138     *
139     * @see #setGradientPaintTransformer(GradientPaintTransformer)
140     */
141    public GradientPaintTransformer getGradientPaintTransformer() {
142        return this.gradientPaintTransformer;
143    }
144
145    /**
146     * Sets the transformer used to adjust the coordinates of any
147     * <code>GradientPaint</code> instance used for the background paint, and
148     * sends a {@link DialLayerChangeEvent} to all registered listeners.
149     *
150     * @param t  the transformer (<code>null</code> not permitted).
151     *
152     * @see #getGradientPaintTransformer()
153     */
154    public void setGradientPaintTransformer(GradientPaintTransformer t) {
155        ParamChecks.nullNotPermitted(t, "t");
156        this.gradientPaintTransformer = t;
157        notifyListeners(new DialLayerChangeEvent(this));
158    }
159
160    /**
161     * Returns <code>true</code> to indicate that this layer should be
162     * clipped within the dial window.
163     *
164     * @return <code>true</code>.
165     */
166    @Override
167    public boolean isClippedToWindow() {
168        return true;
169    }
170
171    /**
172     * Draws the background to the specified graphics device.  If the dial
173     * frame specifies a window, the clipping region will already have been
174     * set to this window before this method is called.
175     *
176     * @param g2  the graphics device (<code>null</code> not permitted).
177     * @param plot  the plot (ignored here).
178     * @param frame  the dial frame (ignored here).
179     * @param view  the view rectangle (<code>null</code> not permitted).
180     */
181    @Override
182    public void draw(Graphics2D g2, DialPlot plot, Rectangle2D frame,
183            Rectangle2D view) {
184
185        Paint p = this.paint;
186        if (p instanceof GradientPaint) {
187            p = this.gradientPaintTransformer.transform((GradientPaint) p,
188                    view);
189        }
190        g2.setPaint(p);
191        g2.fill(view);
192    }
193
194    /**
195     * Tests this instance for equality with an arbitrary object.
196     *
197     * @param obj  the object (<code>null</code> permitted).
198     *
199     * @return A boolean.
200     */
201    @Override
202    public boolean equals(Object obj) {
203        if (obj == this) {
204            return true;
205        }
206        if (!(obj instanceof DialBackground)) {
207            return false;
208        }
209        DialBackground that = (DialBackground) obj;
210        if (!PaintUtilities.equal(this.paint, that.paint)) {
211            return false;
212        }
213        if (!this.gradientPaintTransformer.equals(
214                that.gradientPaintTransformer)) {
215            return false;
216        }
217        return super.equals(obj);
218    }
219
220    /**
221     * Returns a hash code for this instance.
222     *
223     * @return The hash code.
224     */
225    @Override
226    public int hashCode() {
227        int result = 193;
228        result = 37 * result + HashUtilities.hashCodeForPaint(this.paint);
229        result = 37 * result + this.gradientPaintTransformer.hashCode();
230        return result;
231    }
232
233    /**
234     * Returns a clone of this instance.
235     *
236     * @return The clone.
237     *
238     * @throws CloneNotSupportedException if some attribute of this instance
239     *     cannot be cloned.
240     */
241    @Override
242    public Object clone() throws CloneNotSupportedException {
243        return super.clone();
244    }
245
246    /**
247     * Provides serialization support.
248     *
249     * @param stream  the output stream.
250     *
251     * @throws IOException  if there is an I/O error.
252     */
253    private void writeObject(ObjectOutputStream stream) throws IOException {
254        stream.defaultWriteObject();
255        SerialUtilities.writePaint(this.paint, stream);
256    }
257
258    /**
259     * Provides serialization support.
260     *
261     * @param stream  the input stream.
262     *
263     * @throws IOException  if there is an I/O error.
264     * @throws ClassNotFoundException  if there is a classpath problem.
265     */
266    private void readObject(ObjectInputStream stream)
267            throws IOException, ClassNotFoundException {
268        stream.defaultReadObject();
269        this.paint = SerialUtilities.readPaint(stream);
270    }
271
272}