org.jfree.chart.annotations.AbstractXYAnnotation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D APIs, it currently supports bar charts, pie charts,
line charts, XY-plots and time series plots.
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2013, 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.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* -------------------------
* AbstractXYAnnotation.java
* -------------------------
* (C) Copyright 2004-2013, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): Peter Kolb (patch 2809117);
*
* Changes:
* --------
* 29-Sep-2004 : Version 1 (DG);
* ------------- JFREECHART 1.0.x ---------------------------------------------
* 06-Mar-2007 : Implemented hashCode() (DG);
* 24-Jun-2009 : Now extends AbstractAnnotation (see patch 2809117 by PK) (DG);
*
*/
package org.jfree.chart.annotations;
import java.awt.Graphics2D;
import java.awt.Shape;
import java.awt.geom.Rectangle2D;
import org.jfree.chart.axis.ValueAxis;
import org.jfree.chart.entity.EntityCollection;
import org.jfree.chart.entity.XYAnnotationEntity;
import org.jfree.chart.plot.PlotRenderingInfo;
import org.jfree.chart.plot.XYPlot;
import org.jfree.util.ObjectUtilities;
/**
* The interface that must be supported by annotations that are to be added to
* an {@link XYPlot}.
*/
public abstract class AbstractXYAnnotation extends AbstractAnnotation
implements XYAnnotation {
/** The tool tip text. */
private String toolTipText;
/** The URL. */
private String url;
/**
* Creates a new instance that has no tool tip or URL specified.
*/
protected AbstractXYAnnotation() {
super();
this.toolTipText = null;
this.url = null;
}
/**
* Returns the tool tip text for the annotation. This will be displayed in
* a {@link org.jfree.chart.ChartPanel} when the mouse pointer hovers over
* the annotation.
*
* @return The tool tip text (possibly null).
*
* @see #setToolTipText(String)
*/
public String getToolTipText() {
return this.toolTipText;
}
/**
* Sets the tool tip text for the annotation.
*
* @param text the tool tip text (null permitted).
*
* @see #getToolTipText()
*/
public void setToolTipText(String text) {
this.toolTipText = text;
}
/**
* Returns the URL for the annotation. This URL will be used to provide
* hyperlinks when an HTML image map is created for the chart.
*
* @return The URL (possibly null).
*
* @see #setURL(String)
*/
public String getURL() {
return this.url;
}
/**
* Sets the URL for the annotation.
*
* @param url the URL (null permitted).
*
* @see #getURL()
*/
public void setURL(String url) {
this.url = url;
}
/**
* Draws the annotation.
*
* @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.
*/
@Override
public abstract void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea,
ValueAxis domainAxis, ValueAxis rangeAxis,
int rendererIndex,
PlotRenderingInfo info);
/**
* A utility method for adding an {@link XYAnnotationEntity} to
* a {@link PlotRenderingInfo} instance.
*
* @param info the plot rendering info (null permitted).
* @param hotspot the hotspot area.
* @param rendererIndex the renderer index.
* @param toolTipText the tool tip text.
* @param urlText the URL text.
*/
protected void addEntity(PlotRenderingInfo info,
Shape hotspot, int rendererIndex,
String toolTipText, String urlText) {
if (info == null) {
return;
}
EntityCollection entities = info.getOwner().getEntityCollection();
if (entities == null) {
return;
}
XYAnnotationEntity entity = new XYAnnotationEntity(hotspot,
rendererIndex, toolTipText, urlText);
entities.add(entity);
}
/**
* Tests this annotation for equality with an arbitrary object.
*
* @param obj the object (null permitted).
*
* @return A boolean.
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof AbstractXYAnnotation)) {
return false;
}
AbstractXYAnnotation that = (AbstractXYAnnotation) obj;
if (!ObjectUtilities.equal(this.toolTipText, that.toolTipText)) {
return false;
}
if (!ObjectUtilities.equal(this.url, that.url)) {
return false;
}
return true;
}
/**
* Returns a hash code for this instance.
*
* @return A hash code.
*/
@Override
public int hashCode() {
int result = 193;
if (this.toolTipText != null) {
result = 37 * result + this.toolTipText.hashCode();
}
if (this.url != null) {
result = 37 * result + this.url.hashCode();
}
return result;
}
}