Menu
▾
▴
[Jfreechart-commit] SF.net SVN: jfreechart:[1965] trunk
|
From: <mu...@us...> - 2009-04-07 19:26:05
|
Revision: 1965
http://jfreechart.svn.sourceforge.net/jfreechart/?rev=1965&view=rev
Author: mungady
Date: 2009-04-07 19:25:07 +0000 (Tue, 07 Apr 2009)
Log Message:
-----------
Added XYTitleAnnotation plus tests.
Modified Paths:
--------------
trunk/tests/org/jfree/chart/annotations/junit/AnnotationsPackageTests.java
Added Paths:
-----------
trunk/source/org/jfree/chart/annotations/XYTitleAnnotation.java
trunk/tests/org/jfree/chart/annotations/junit/XYTitleAnnotationTests.java
Added: trunk/source/org/jfree/chart/annotations/XYTitleAnnotation.java
===================================================================
--- trunk/source/org/jfree/chart/annotations/XYTitleAnnotation.java (rev 0)
+++ trunk/source/org/jfree/chart/annotations/XYTitleAnnotation.java 2009-04-07 19:25:07 UTC (rev 1965)
@@ -0,0 +1,393 @@
+/* ===========================================================
+ * JFreeChart : a free chart library for the Java(tm) platform
+ * ===========================================================
+ *
+ * (C) Copyright 2000-2008, by Object Refinery Limited and Contributors.
+ *
+ * Project Info: http://www.jfree.org/jfreechart/index.html
+ *
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA.
+ *
+ * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
+ * in the United States and other countries.]
+ *
+ * ----------------------
+ * XYTitleAnnotation.java
+ * ----------------------
+ * (C) Copyright 2007, 2008, by Object Refinery Limited and Contributors.
+ *
+ * Original Author: David Gilbert (for Object Refinery Limited);
+ * Contributor(s): Andrew Mickish;
+ *
+ * Changes:
+ * --------
+ * 02-Feb-2007 : Version 1 (DG);
+ * 30-Apr-2007 : Fixed equals() method (DG);
+ * 26-Feb-2008 : Fixed NullPointerException when drawing chart with a null
+ * ChartRenderingInfo - see patch 1901599 by Andrew Mickish (DG);
+ * 03-Sep-2008 : Moved from experimental to main (DG);
+ *
+ */
+
+package org.jfree.chart.annotations;
+
+import java.awt.Graphics2D;
+import java.awt.geom.Point2D;
+import java.awt.geom.Rectangle2D;
+import java.io.Serializable;
+import org.jfree.chart.axis.AxisLocation;
+import org.jfree.chart.axis.ValueAxis;
+import org.jfree.chart.block.BlockParams;
+import org.jfree.chart.block.EntityBlockResult;
+import org.jfree.chart.block.RectangleConstraint;
+import org.jfree.chart.plot.Plot;
+import org.jfree.chart.plot.PlotOrientation;
+import org.jfree.chart.plot.PlotRenderingInfo;
+import org.jfree.chart.plot.XYPlot;
+import org.jfree.chart.title.Title;
+import org.jfree.chart.util.HashUtilities;
+import org.jfree.chart.util.ObjectUtilities;
+import org.jfree.chart.util.PublicCloneable;
+import org.jfree.chart.util.RectangleAnchor;
+import org.jfree.chart.util.RectangleEdge;
+import org.jfree.chart.util.Size2D;
+import org.jfree.data.Range;
+import org.jfree.experimental.chart.util.XYCoordinateType;
+
+/**
+ * An annotation that allows any {@link Title} to be placed at a location on
+ * an {@link XYPlot}.
+ *
+ * @since 1.0.11
+ */
+public class XYTitleAnnotation extends AbstractXYAnnotation
+ implements Cloneable, PublicCloneable, Serializable {
+
+ /** For serialization. */
+ private static final long serialVersionUID = -4364694501921559958L;
+
+ /** The coordinate type. */
+ private XYCoordinateType coordinateType;
+
+ /** The x-coordinate (in data space). */
+ private double x;
+
+ /** The y-coordinate (in data space). */
+ private double y;
+
+ /** The maximum width. */
+ private double maxWidth;
+
+ /** The maximum height. */
+ private double maxHeight;
+
+ /** The title. */
+ private Title title;
+
+ /**
+ * The title anchor point.
+ */
+ private RectangleAnchor anchor;
+
+ /**
+ * Creates a new annotation to be displayed at the specified (x, y)
+ * location.
+ *
+ * @param x the x-coordinate (in data space).
+ * @param y the y-coordinate (in data space).
+ * @param title the title (<code>null</code> not permitted).
+ */
+ public XYTitleAnnotation(double x, double y, Title title) {
+ this(x, y, title, RectangleAnchor.CENTER);
+ }
+
+ /**
+ * Creates a new annotation to be displayed at the specified (x, y)
+ * location.
+ *
+ * @param x the x-coordinate (in data space).
+ * @param y the y-coordinate (in data space).
+ * @param title the title (<code>null</code> not permitted).
+ * @param anchor the title anchor (<code>null</code> not permitted).
+ */
+ public XYTitleAnnotation(double x, double y, Title title,
+ RectangleAnchor anchor) {
+ if (title == null) {
+ throw new IllegalArgumentException("Null 'title' argument.");
+ }
+ if (anchor == null) {
+ throw new IllegalArgumentException("Null 'anchor' argument.");
+ }
+ this.coordinateType = XYCoordinateType.RELATIVE;
+ this.x = x;
+ this.y = y;
+ this.maxWidth = 0.0;
+ this.maxHeight = 0.0;
+ this.title = title;
+ this.anchor = anchor;
+ }
+
+ /**
+ * Returns the coordinate type (set in the constructor).
+ *
+ * @return The coordinate type (never <code>null</code>).
+ */
+ public XYCoordinateType getCoordinateType() {
+ return this.coordinateType;
+ }
+
+ /**
+ * Returns the x-coordinate for the annotation.
+ *
+ * @return The x-coordinate.
+ */
+ public double getX() {
+ return this.x;
+ }
+
+ /**
+ * Returns the y-coordinate for the annotation.
+ *
+ * @return The y-coordinate.
+ */
+ public double getY() {
+ return this.y;
+ }
+
+ /**
+ * Returns the title for the annotation.
+ *
+ * @return The title.
+ */
+ public Title getTitle() {
+ return this.title;
+ }
+
+ /**
+ * Returns the title anchor for the annotation.
+ *
+ * @return The title anchor.
+ */
+ public RectangleAnchor getTitleAnchor() {
+ return this.anchor;
+ }
+
+ /**
+ * Returns the maximum width.
+ *
+ * @return The maximum width.
+ */
+ public double getMaxWidth() {
+ return this.maxWidth;
+ }
+
+ /**
+ * Sets the maximum width.
+ *
+ * @param max the maximum width (0.0 or less means no maximum).
+ */
+ public void setMaxWidth(double max) {
+ this.maxWidth = max;
+ }
+
+ /**
+ * Returns the maximum height.
+ *
+ * @return The maximum height.
+ */
+ public double getMaxHeight() {
+ return this.maxHeight;
+ }
+
+ /**
+ * Sets the maximum height.
+ *
+ * @param max the maximum height.
+ */
+ public void setMaxHeight(double max) {
+ this.maxHeight = max;
+ }
+
+ /**
+ * Draws the annotation. This method is called by the drawing code in the
+ * {@link XYPlot} class, you don't normally need to call this method
+ * directly.
+ *
+ * @param g2 the graphics device.
+ * @param plot the plot.
+ * @param dataArea the data area.
+ * @param domainAxis the domain axis.
+ * @param rangeAxis the range axis.
+ * @param rendererIndex the renderer index.
+ * @param info if supplied, this info object will be populated with
+ * entity information.
+ */
+ public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea,
+ ValueAxis domainAxis, ValueAxis rangeAxis,
+ int rendererIndex,
+ PlotRenderingInfo info) {
+
+ PlotOrientation orientation = plot.getOrientation();
+ AxisLocation domainAxisLocation = plot.getDomainAxisLocation();
+ AxisLocation rangeAxisLocation = plot.getRangeAxisLocation();
+ RectangleEdge domainEdge = Plot.resolveDomainAxisLocation(
+ domainAxisLocation, orientation);
+ RectangleEdge rangeEdge = Plot.resolveRangeAxisLocation(
+ rangeAxisLocation, orientation);
+ Range xRange = domainAxis.getRange();
+ Range yRange = rangeAxis.getRange();
+ double anchorX = 0.0;
+ double anchorY = 0.0;
+ if (this.coordinateType == XYCoordinateType.RELATIVE) {
+ anchorX = xRange.getLowerBound() + (this.x * xRange.getLength());
+ anchorY = yRange.getLowerBound() + (this.y * yRange.getLength());
+ }
+ else {
+ anchorX = domainAxis.valueToJava2D(this.x, dataArea, domainEdge);
+ anchorY = rangeAxis.valueToJava2D(this.y, dataArea, rangeEdge);
+ }
+
+ float j2DX = (float) domainAxis.valueToJava2D(anchorX, dataArea,
+ domainEdge);
+ float j2DY = (float) rangeAxis.valueToJava2D(anchorY, dataArea,
+ rangeEdge);
+ float xx = 0.0f;
+ float yy = 0.0f;
+ if (orientation == PlotOrientation.HORIZONTAL) {
+ xx = j2DY;
+ yy = j2DX;
+ }
+ else if (orientation == PlotOrientation.VERTICAL) {
+ xx = j2DX;
+ yy = j2DY;
+ }
+
+ double maxW = dataArea.getWidth();
+ double maxH = dataArea.getHeight();
+ if (this.coordinateType == XYCoordinateType.RELATIVE) {
+ if (this.maxWidth > 0.0) {
+ maxW = maxW * this.maxWidth;
+ }
+ if (this.maxHeight > 0.0) {
+ maxH = maxH * this.maxHeight;
+ }
+ }
+ if (this.coordinateType == XYCoordinateType.DATA) {
+ maxW = this.maxWidth;
+ maxH = this.maxHeight;
+ }
+ RectangleConstraint rc = new RectangleConstraint(
+ new Range(0, maxW), new Range(0, maxH));
+
+ Size2D size = this.title.arrange(g2, rc);
+ Rectangle2D titleRect = new Rectangle2D.Double(0, 0, size.width,
+ size.height);
+ Point2D anchorPoint = RectangleAnchor.coordinates(titleRect,
+ this.anchor);
+ xx = xx - (float) anchorPoint.getX();
+ yy = yy - (float) anchorPoint.getY();
+ titleRect.setRect(xx, yy, titleRect.getWidth(), titleRect.getHeight());
+ BlockParams p = new BlockParams();
+ if (info != null) {
+ if (info.getOwner().getEntityCollection() != null) {
+ p.setGenerateEntities(true);
+ }
+ }
+ Object result = this.title.draw(g2, titleRect, p);
+ if (info != null) {
+ if (result instanceof EntityBlockResult) {
+ EntityBlockResult ebr = (EntityBlockResult) result;
+ info.getOwner().getEntityCollection().addAll(
+ ebr.getEntityCollection());
+ }
+ String toolTip = getToolTipText();
+ String url = getURL();
+ if (toolTip != null || url != null) {
+ addEntity(info, new Rectangle2D.Float(xx, yy,
+ (float) size.width, (float) size.height),
+ rendererIndex, toolTip, url);
+ }
+ }
+ }
+
+ /**
+ * Tests this object for equality with an arbitrary object.
+ *
+ * @param obj the object (<code>null</code> permitted).
+ *
+ * @return A boolean.
+ */
+ public boolean equals(Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof XYTitleAnnotation)) {
+ return false;
+ }
+ XYTitleAnnotation that = (XYTitleAnnotation) obj;
+ if (this.coordinateType != that.coordinateType) {
+ return false;
+ }
+ if (this.x != that.x) {
+ return false;
+ }
+ if (this.y != that.y) {
+ return false;
+ }
+ if (this.maxWidth != that.maxWidth) {
+ return false;
+ }
+ if (this.maxHeight != that.maxHeight) {
+ return false;
+ }
+ if (!ObjectUtilities.equal(this.title, that.title)) {
+ return false;
+ }
+ if (!this.anchor.equals(that.anchor)) {
+ return false;
+ }
+ return super.equals(obj);
+ }
+
+ /**
+ * Returns a hash code for this object.
+ *
+ * @return A hash code.
+ */
+ public int hashCode() {
+ int result = 193;
+ result = HashUtilities.hashCode(result, this.anchor);
+ result = HashUtilities.hashCode(result, this.coordinateType);
+ result = HashUtilities.hashCode(result, this.x);
+ result = HashUtilities.hashCode(result, this.y);
+ result = HashUtilities.hashCode(result, this.maxWidth);
+ result = HashUtilities.hashCode(result, this.maxHeight);
+ result = HashUtilities.hashCode(result, this.title);
+ return result;
+ }
+
+ /**
+ * Returns a clone of the annotation.
+ *
+ * @return A clone.
+ *
+ * @throws CloneNotSupportedException if the annotation can't be cloned.
+ */
+ public Object clone() throws CloneNotSupportedException {
+ return super.clone();
+ }
+
+}
Modified: trunk/tests/org/jfree/chart/annotations/junit/AnnotationsPackageTests.java
===================================================================
--- trunk/tests/org/jfree/chart/annotations/junit/AnnotationsPackageTests.java 2009-04-07 19:19:19 UTC (rev 1964)
+++ trunk/tests/org/jfree/chart/annotations/junit/AnnotationsPackageTests.java 2009-04-07 19:25:07 UTC (rev 1965)
@@ -74,6 +74,7 @@
suite.addTestSuite(XYPolygonAnnotationTests.class);
suite.addTestSuite(XYShapeAnnotationTests.class);
suite.addTestSuite(XYTextAnnotationTests.class);
+ suite.addTestSuite(XYTitleAnnotationTests.class);
return suite;
}
Added: trunk/tests/org/jfree/chart/annotations/junit/XYTitleAnnotationTests.java
===================================================================
--- trunk/tests/org/jfree/chart/annotations/junit/XYTitleAnnotationTests.java (rev 0)
+++ trunk/tests/org/jfree/chart/annotations/junit/XYTitleAnnotationTests.java 2009-04-07 19:25:07 UTC (rev 1965)
@@ -0,0 +1,207 @@
+/* ===========================================================
+ * JFreeChart : a free chart library for the Java(tm) platform
+ * ===========================================================
+ *
+ * (C) Copyright 2000-2008, by Object Refinery Limited and Contributors.
+ *
+ * Project Info: http://www.jfree.org/jfreechart/index.html
+ *
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA.
+ *
+ * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
+ * in the United States and other countries.]
+ *
+ * ---------------------------
+ * XYTitleAnnotationTests.java
+ * ---------------------------
+ * (C) Copyright 2007, 2008, by Object Refinery Limited.
+ *
+ * Original Author: David Gilbert (for Object Refinery Limited);
+ * Contributor(s): -;
+ *
+ * Changes
+ * -------
+ * 30-Apr-2007 : Version 1 (DG);
+ * 26-Feb-2008 : Added testDrawWithNullInfo() (DG);
+ *
+ */
+
+package org.jfree.chart.annotations.junit;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.ObjectInput;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutput;
+import java.io.ObjectOutputStream;
+
+import junit.framework.Test;
+import junit.framework.TestCase;
+import junit.framework.TestSuite;
+
+import org.jfree.chart.JFreeChart;
+import org.jfree.chart.annotations.XYTitleAnnotation;
+import org.jfree.chart.axis.NumberAxis;
+import org.jfree.chart.plot.XYPlot;
+import org.jfree.chart.renderer.xy.XYLineAndShapeRenderer;
+import org.jfree.chart.title.TextTitle;
+import org.jfree.data.xy.DefaultTableXYDataset;
+import org.jfree.data.xy.XYSeries;
+
+/**
+ * Tests for the {@link XYTitleAnnotation} class.
+ */
+public class XYTitleAnnotationTests extends TestCase {
+
+ /**
+ * Returns the tests as a test suite.
+ *
+ * @return The test suite.
+ */
+ public static Test suite() {
+ return new TestSuite(XYTitleAnnotationTests.class);
+ }
+
+ /**
+ * Constructs a new set of tests.
+ *
+ * @param name the name of the tests.
+ */
+ public XYTitleAnnotationTests(String name) {
+ super(name);
+ }
+
+ /**
+ * Confirm that the equals method can distinguish all the required fields.
+ */
+ public void testEquals() {
+ TextTitle t = new TextTitle("Title");
+ XYTitleAnnotation a1 = new XYTitleAnnotation(1.0, 2.0, t);
+ XYTitleAnnotation a2 = new XYTitleAnnotation(1.0, 2.0, t);
+ assertTrue(a1.equals(a2));
+
+ a1 = new XYTitleAnnotation(1.1, 2.0, t);
+ assertFalse(a1.equals(a2));
+ a2 = new XYTitleAnnotation(1.1, 2.0, t);
+ assertTrue(a1.equals(a2));
+
+ a1 = new XYTitleAnnotation(1.1, 2.2, t);
+ assertFalse(a1.equals(a2));
+ a2 = new XYTitleAnnotation(1.1, 2.2, t);
+ assertTrue(a1.equals(a2));
+
+ TextTitle t2 = new TextTitle("Title 2");
+ a1 = new XYTitleAnnotation(1.1, 2.2, t2);
+ assertFalse(a1.equals(a2));
+ a2 = new XYTitleAnnotation(1.1, 2.2, t2);
+ assertTrue(a1.equals(a2));
+ }
+
+ /**
+ * Two objects that are equal are required to return the same hashCode.
+ */
+ public void testHashCode() {
+ TextTitle t = new TextTitle("Title");
+ XYTitleAnnotation a1 = new XYTitleAnnotation(1.0, 2.0, t);
+ XYTitleAnnotation a2 = new XYTitleAnnotation(1.0, 2.0, t);
+ assertTrue(a1.equals(a2));
+ int h1 = a1.hashCode();
+ int h2 = a2.hashCode();
+ assertEquals(h1, h2);
+ }
+
+ /**
+ * Confirm that cloning works.
+ */
+ public void testCloning() {
+ TextTitle t = new TextTitle("Title");
+ XYTitleAnnotation a1 = new XYTitleAnnotation(1.0, 2.0, t);
+ XYTitleAnnotation a2 = null;
+ try {
+ a2 = (XYTitleAnnotation) a1.clone();
+ }
+ catch (CloneNotSupportedException e) {
+ e.printStackTrace();
+ }
+ assertTrue(a1 != a2);
+ assertTrue(a1.getClass() == a2.getClass());
+ assertTrue(a1.equals(a2));
+ }
+
+ /**
+ * Serialize an instance, restore it, and check for equality.
+ */
+ public void testSerialization() {
+ TextTitle t = new TextTitle("Title");
+ XYTitleAnnotation a1 = new XYTitleAnnotation(1.0, 2.0, t);
+ XYTitleAnnotation a2 = null;
+ try {
+ ByteArrayOutputStream buffer = new ByteArrayOutputStream();
+ ObjectOutput out = new ObjectOutputStream(buffer);
+ out.writeObject(a1);
+ out.close();
+
+ ObjectInput in = new ObjectInputStream(new ByteArrayInputStream(
+ buffer.toByteArray()));
+ a2 = (XYTitleAnnotation) in.readObject();
+ in.close();
+ }
+ catch (Exception e) {
+ e.printStackTrace();
+ }
+ assertEquals(a1, a2);
+ }
+
+ /**
+ * Draws the chart with a <code>null</code> info object to make sure that
+ * no exceptions are thrown.
+ */
+ public void testDrawWithNullInfo() {
+ boolean success = false;
+ try {
+ DefaultTableXYDataset dataset = new DefaultTableXYDataset();
+
+ XYSeries s1 = new XYSeries("Series 1", true, false);
+ s1.add(5.0, 5.0);
+ s1.add(10.0, 15.5);
+ s1.add(15.0, 9.5);
+ s1.add(20.0, 7.5);
+ dataset.addSeries(s1);
+
+ XYSeries s2 = new XYSeries("Series 2", true, false);
+ s2.add(5.0, 5.0);
+ s2.add(10.0, 15.5);
+ s2.add(15.0, 9.5);
+ s2.add(20.0, 3.5);
+ dataset.addSeries(s2);
+ XYPlot plot = new XYPlot(dataset,
+ new NumberAxis("X"), new NumberAxis("Y"),
+ new XYLineAndShapeRenderer());
+ plot.addAnnotation(new XYTitleAnnotation(5.0, 6.0,
+ new TextTitle("Hello World!")));
+ JFreeChart chart = new JFreeChart(plot);
+ /* BufferedImage image = */ chart.createBufferedImage(300, 200,
+ null);
+ success = true;
+ }
+ catch (NullPointerException e) {
+ e.printStackTrace();
+ success = false;
+ }
+ assertTrue(success);
+ }
+
+}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|