001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2008, 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 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025 * in the United States and other countries.]
026 *
027 * ----------------
028 * BlockBorder.java
029 * ----------------
030 * (C) Copyright 2004-2008, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes:
036 * --------
037 * 22-Oct-2004 : Version 1 (DG);
038 * 04-Feb-2005 : Added equals() and implemented Serializable (DG);
039 * 23-Feb-2005 : Added attribute for border color (DG);
040 * 06-May-2005 : Added new convenience constructors (DG);
041 * ------------- JFREECHART 1.0.x ---------------------------------------------
042 * 16-Mar-2007 : Implemented BlockFrame (DG);
043 *
044 */
045
046package org.jfree.chart.block;
047
048import java.awt.Color;
049import java.awt.Graphics2D;
050import java.awt.Paint;
051import java.awt.geom.Rectangle2D;
052import java.io.IOException;
053import java.io.ObjectInputStream;
054import java.io.ObjectOutputStream;
055import java.io.Serializable;
056
057import org.jfree.io.SerialUtilities;
058import org.jfree.ui.RectangleInsets;
059import org.jfree.util.PaintUtilities;
060
061/**
062 * A border for a block.  This class is immutable.
063 */
064public class BlockBorder implements BlockFrame, Serializable {
065
066    /** For serialization. */
067    private static final long serialVersionUID = 4961579220410228283L;
068
069    /** An empty border. */
070    public static final BlockBorder NONE = new BlockBorder(
071            RectangleInsets.ZERO_INSETS, Color.white);
072
073    /** The space reserved for the border. */
074    private RectangleInsets insets;
075
076    /** The border color. */
077    private transient Paint paint;
078
079    /**
080     * Creates a default border.
081     */
082    public BlockBorder() {
083        this(Color.black);
084    }
085
086    /**
087     * Creates a new border with the specified color.
088     *
089     * @param paint  the color (<code>null</code> not permitted).
090     */
091    public BlockBorder(Paint paint) {
092        this(new RectangleInsets(1, 1, 1, 1), paint);
093    }
094
095    /**
096     * Creates a new border with the specified line widths (in black).
097     *
098     * @param top  the width of the top border.
099     * @param left  the width of the left border.
100     * @param bottom  the width of the bottom border.
101     * @param right  the width of the right border.
102     */
103    public BlockBorder(double top, double left, double bottom, double right) {
104        this(new RectangleInsets(top, left, bottom, right), Color.black);
105    }
106
107    /**
108     * Creates a new border with the specified line widths (in black).
109     *
110     * @param top  the width of the top border.
111     * @param left  the width of the left border.
112     * @param bottom  the width of the bottom border.
113     * @param right  the width of the right border.
114     * @param paint  the border paint (<code>null</code> not permitted).
115     */
116    public BlockBorder(double top, double left, double bottom, double right,
117                       Paint paint) {
118        this(new RectangleInsets(top, left, bottom, right), paint);
119    }
120
121    /**
122     * Creates a new border.
123     *
124     * @param insets  the border insets (<code>null</code> not permitted).
125     * @param paint  the paint (<code>null</code> not permitted).
126     */
127    public BlockBorder(RectangleInsets insets, Paint paint) {
128        if (insets == null) {
129            throw new IllegalArgumentException("Null 'insets' argument.");
130        }
131        if (paint == null) {
132            throw new IllegalArgumentException("Null 'paint' argument.");
133        }
134        this.insets = insets;
135        this.paint = paint;
136    }
137
138    /**
139     * Returns the space reserved for the border.
140     *
141     * @return The space (never <code>null</code>).
142     */
143    public RectangleInsets getInsets() {
144        return this.insets;
145    }
146
147    /**
148     * Returns the paint used to draw the border.
149     *
150     * @return The paint (never <code>null</code>).
151     */
152    public Paint getPaint() {
153        return this.paint;
154    }
155
156    /**
157     * Draws the border by filling in the reserved space.
158     *
159     * @param g2  the graphics device.
160     * @param area  the area.
161     */
162    public void draw(Graphics2D g2, Rectangle2D area) {
163        // this default implementation will just fill the available
164        // border space with a single color
165        double t = this.insets.calculateTopInset(area.getHeight());
166        double b = this.insets.calculateBottomInset(area.getHeight());
167        double l = this.insets.calculateLeftInset(area.getWidth());
168        double r = this.insets.calculateRightInset(area.getWidth());
169        double x = area.getX();
170        double y = area.getY();
171        double w = area.getWidth();
172        double h = area.getHeight();
173        g2.setPaint(this.paint);
174        Rectangle2D rect = new Rectangle2D.Double();
175        if (t > 0.0) {
176            rect.setRect(x, y, w, t);
177            g2.fill(rect);
178        }
179        if (b > 0.0) {
180            rect.setRect(x, y + h - b, w, b);
181            g2.fill(rect);
182        }
183        if (l > 0.0) {
184            rect.setRect(x, y, l, h);
185            g2.fill(rect);
186        }
187        if (r > 0.0) {
188            rect.setRect(x + w - r, y, r, h);
189            g2.fill(rect);
190        }
191    }
192
193    /**
194     * Tests this border for equality with an arbitrary instance.
195     *
196     * @param obj  the object (<code>null</code> permitted).
197     *
198     * @return A boolean.
199     */
200    public boolean equals(Object obj) {
201        if (obj == this) {
202            return true;
203        }
204        if (!(obj instanceof BlockBorder)) {
205            return false;
206        }
207        BlockBorder that = (BlockBorder) obj;
208        if (!this.insets.equals(that.insets)) {
209            return false;
210        }
211        if (!PaintUtilities.equal(this.paint, that.paint)) {
212            return false;
213        }
214        return true;
215    }
216
217    /**
218     * Provides serialization support.
219     *
220     * @param stream  the output stream.
221     *
222     * @throws IOException  if there is an I/O error.
223     */
224    private void writeObject(ObjectOutputStream stream) throws IOException {
225        stream.defaultWriteObject();
226        SerialUtilities.writePaint(this.paint, stream);
227    }
228
229    /**
230     * Provides serialization support.
231     *
232     * @param stream  the input stream.
233     *
234     * @throws IOException  if there is an I/O error.
235     * @throws ClassNotFoundException  if there is a classpath problem.
236     */
237    private void readObject(ObjectInputStream stream)
238        throws IOException, ClassNotFoundException {
239        stream.defaultReadObject();
240        this.paint = SerialUtilities.readPaint(stream);
241    }
242
243}