001: /* ===========================================================
002: * JFreeChart : a free chart library for the Java(tm) platform
003: * ===========================================================
004: *
005: * (C) Copyright 2000-2006, 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: * XYBoxAnnotation.java
029: * --------------------
030: * (C) Copyright 2005, 2006, by Object Refinery Limited and Contributors.
031: *
032: * Original Author: David Gilbert (for Object Refinery Limited);
033: * Contributor(s): -;
034: *
035: * $Id: XYBoxAnnotation.java,v 1.5.2.3 2006/08/02 11:49:10 mungady Exp $
036: *
037: * Changes:
038: * --------
039: * 19-Jan-2005 : Version 1 (DG);
040: * 06-Jun-2005 : Fixed equals() method to handle GradientPaint (DG);
041: *
042: */
043:
044: package org.jfree.chart.annotations;
045:
046: import java.awt.BasicStroke;
047: import java.awt.Color;
048: import java.awt.Graphics2D;
049: import java.awt.Paint;
050: import java.awt.Stroke;
051: import java.awt.geom.Rectangle2D;
052: import java.io.IOException;
053: import java.io.ObjectInputStream;
054: import java.io.ObjectOutputStream;
055: import java.io.Serializable;
056:
057: import org.jfree.chart.axis.ValueAxis;
058: import org.jfree.chart.plot.Plot;
059: import org.jfree.chart.plot.PlotOrientation;
060: import org.jfree.chart.plot.PlotRenderingInfo;
061: import org.jfree.chart.plot.XYPlot;
062: import org.jfree.io.SerialUtilities;
063: import org.jfree.ui.RectangleEdge;
064: import org.jfree.util.ObjectUtilities;
065: import org.jfree.util.PaintUtilities;
066: import org.jfree.util.PublicCloneable;
067:
068: /**
069: * A box annotation that can be placed on an {@link XYPlot}. The
070: * box coordinates are specified in data space.
071: */
072: public class XYBoxAnnotation extends AbstractXYAnnotation implements
073: Cloneable, PublicCloneable, Serializable {
074:
075: /** For serialization. */
076: private static final long serialVersionUID = 6764703772526757457L;
077:
078: /** The lower x-coordinate. */
079: private double x0;
080:
081: /** The lower y-coordinate. */
082: private double y0;
083:
084: /** The upper x-coordinate. */
085: private double x1;
086:
087: /** The upper y-coordinate. */
088: private double y1;
089:
090: /** The stroke used to draw the box outline. */
091: private transient Stroke stroke;
092:
093: /** The paint used to draw the box outline. */
094: private transient Paint outlinePaint;
095:
096: /** The paint used to fill the box. */
097: private transient Paint fillPaint;
098:
099: /**
100: * Creates a new annotation (where, by default, the box is drawn
101: * with a black outline).
102: *
103: * @param x0 the lower x-coordinate of the box (in data space).
104: * @param y0 the lower y-coordinate of the box (in data space).
105: * @param x1 the upper x-coordinate of the box (in data space).
106: * @param y1 the upper y-coordinate of the box (in data space).
107: */
108: public XYBoxAnnotation(double x0, double y0, double x1, double y1) {
109: this (x0, y0, x1, y1, new BasicStroke(1.0f), Color.black);
110: }
111:
112: /**
113: * Creates a new annotation where the box is drawn as an outline using
114: * the specified <code>stroke</code> and <code>outlinePaint</code>.
115: *
116: * @param x0 the lower x-coordinate of the box (in data space).
117: * @param y0 the lower y-coordinate of the box (in data space).
118: * @param x1 the upper x-coordinate of the box (in data space).
119: * @param y1 the upper y-coordinate of the box (in data space).
120: * @param stroke the shape stroke (<code>null</code> permitted).
121: * @param outlinePaint the shape color (<code>null</code> permitted).
122: */
123: public XYBoxAnnotation(double x0, double y0, double x1, double y1,
124: Stroke stroke, Paint outlinePaint) {
125: this (x0, y0, x1, y1, stroke, outlinePaint, null);
126: }
127:
128: /**
129: * Creates a new annotation.
130: *
131: * @param x0 the lower x-coordinate of the box (in data space).
132: * @param y0 the lower y-coordinate of the box (in data space).
133: * @param x1 the upper x-coordinate of the box (in data space).
134: * @param y1 the upper y-coordinate of the box (in data space).
135: * @param stroke the shape stroke (<code>null</code> permitted).
136: * @param outlinePaint the shape color (<code>null</code> permitted).
137: * @param fillPaint the paint used to fill the shape (<code>null</code>
138: * permitted).
139: */
140: public XYBoxAnnotation(double x0, double y0, double x1, double y1,
141: Stroke stroke, Paint outlinePaint, Paint fillPaint) {
142: this .x0 = x0;
143: this .y0 = y0;
144: this .x1 = x1;
145: this .y1 = y1;
146: this .stroke = stroke;
147: this .outlinePaint = outlinePaint;
148: this .fillPaint = fillPaint;
149: }
150:
151: /**
152: * Draws the annotation. This method is usually called by the
153: * {@link XYPlot} class, you shouldn't need to call it directly.
154: *
155: * @param g2 the graphics device.
156: * @param plot the plot.
157: * @param dataArea the data area.
158: * @param domainAxis the domain axis.
159: * @param rangeAxis the range axis.
160: * @param rendererIndex the renderer index.
161: * @param info the plot rendering info.
162: */
163: public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea,
164: ValueAxis domainAxis, ValueAxis rangeAxis,
165: int rendererIndex, PlotRenderingInfo info) {
166:
167: PlotOrientation orientation = plot.getOrientation();
168: RectangleEdge domainEdge = Plot.resolveDomainAxisLocation(plot
169: .getDomainAxisLocation(), orientation);
170: RectangleEdge rangeEdge = Plot.resolveRangeAxisLocation(plot
171: .getRangeAxisLocation(), orientation);
172:
173: double transX0 = domainAxis.valueToJava2D(this .x0, dataArea,
174: domainEdge);
175: double transY0 = rangeAxis.valueToJava2D(this .y0, dataArea,
176: rangeEdge);
177: double transX1 = domainAxis.valueToJava2D(this .x1, dataArea,
178: domainEdge);
179: double transY1 = rangeAxis.valueToJava2D(this .y1, dataArea,
180: rangeEdge);
181:
182: Rectangle2D box = null;
183: if (orientation == PlotOrientation.HORIZONTAL) {
184: box = new Rectangle2D.Double(transY0, transX1, transY1
185: - transY0, transX0 - transX1);
186: } else if (orientation == PlotOrientation.VERTICAL) {
187: box = new Rectangle2D.Double(transX0, transY1, transX1
188: - transX0, transY0 - transY1);
189: }
190:
191: if (this .fillPaint != null) {
192: g2.setPaint(this .fillPaint);
193: g2.fill(box);
194: }
195:
196: if (this .stroke != null && this .outlinePaint != null) {
197: g2.setPaint(this .outlinePaint);
198: g2.setStroke(this .stroke);
199: g2.draw(box);
200: }
201: addEntity(info, box, rendererIndex, getToolTipText(), getURL());
202:
203: }
204:
205: /**
206: * Tests this annotation for equality with an arbitrary object.
207: *
208: * @param obj the object (<code>null</code> permitted).
209: *
210: * @return A boolean.
211: */
212: public boolean equals(Object obj) {
213: if (obj == this ) {
214: return true;
215: }
216: // now try to reject equality
217: if (!super .equals(obj)) {
218: return false;
219: }
220: if (!(obj instanceof XYBoxAnnotation)) {
221: return false;
222: }
223: XYBoxAnnotation that = (XYBoxAnnotation) obj;
224: if (!(this .x0 == that.x0)) {
225: return false;
226: }
227: if (!(this .y0 == that.y0)) {
228: return false;
229: }
230: if (!(this .x1 == that.x1)) {
231: return false;
232: }
233: if (!(this .y1 == that.y1)) {
234: return false;
235: }
236: if (!ObjectUtilities.equal(this .stroke, that.stroke)) {
237: return false;
238: }
239: if (!PaintUtilities.equal(this .outlinePaint, that.outlinePaint)) {
240: return false;
241: }
242: if (!PaintUtilities.equal(this .fillPaint, that.fillPaint)) {
243: return false;
244: }
245: // seem to be the same
246: return true;
247: }
248:
249: /**
250: * Returns a hash code.
251: *
252: * @return A hash code.
253: */
254: public int hashCode() {
255: int result;
256: long temp;
257: temp = Double.doubleToLongBits(this .x0);
258: result = (int) (temp ^ (temp >>> 32));
259: temp = Double.doubleToLongBits(this .x1);
260: result = 29 * result + (int) (temp ^ (temp >>> 32));
261: temp = Double.doubleToLongBits(this .y0);
262: result = 29 * result + (int) (temp ^ (temp >>> 32));
263: temp = Double.doubleToLongBits(this .y1);
264: result = 29 * result + (int) (temp ^ (temp >>> 32));
265: return result;
266: }
267:
268: /**
269: * Returns a clone.
270: *
271: * @return A clone.
272: *
273: * @throws CloneNotSupportedException not thrown by this class, but may be
274: * by subclasses.
275: */
276: public Object clone() throws CloneNotSupportedException {
277: return super .clone();
278: }
279:
280: /**
281: * Provides serialization support.
282: *
283: * @param stream the output stream (<code>null</code> not permitted).
284: *
285: * @throws IOException if there is an I/O error.
286: */
287: private void writeObject(ObjectOutputStream stream)
288: throws IOException {
289: stream.defaultWriteObject();
290: SerialUtilities.writeStroke(this .stroke, stream);
291: SerialUtilities.writePaint(this .outlinePaint, stream);
292: SerialUtilities.writePaint(this .fillPaint, stream);
293: }
294:
295: /**
296: * Provides serialization support.
297: *
298: * @param stream the input stream (<code>null</code> not permitted).
299: *
300: * @throws IOException if there is an I/O error.
301: * @throws ClassNotFoundException if there is a classpath problem.
302: */
303: private void readObject(ObjectInputStream stream)
304: throws IOException, ClassNotFoundException {
305:
306: stream.defaultReadObject();
307: this.stroke = SerialUtilities.readStroke(stream);
308: this.outlinePaint = SerialUtilities.readPaint(stream);
309: this.fillPaint = SerialUtilities.readPaint(stream);
310: }
311:
312: }
|