01: /* ===========================================================
02: * JFreeChart : a free chart library for the Java(tm) platform
03: * ===========================================================
04: *
05: * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
06: *
07: * Project Info: http://www.jfree.org/jfreechart/index.html
08: *
09: * This library is free software; you can redistribute it and/or modify it
10: * under the terms of the GNU Lesser General Public License as published by
11: * the Free Software Foundation; either version 2.1 of the License, or
12: * (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful, but
15: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
17: * License for more details.
18: *
19: * You should have received a copy of the GNU Lesser General Public
20: * License along with this library; if not, write to the Free Software
21: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22: * USA.
23: *
24: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
25: * in the United States and other countries.]
26: *
27: * -----------------
28: * XYAnnotation.java
29: * -----------------
30: * (C) Copyright 2002-2005, by Object Refinery Limited.
31: *
32: * Original Author: David Gilbert (for Object Refinery Limited);
33: * Contributor(s): -;
34: *
35: * $Id: XYAnnotation.java,v 1.4.2.1 2005/10/25 16:51:15 mungady Exp $
36: *
37: * Changes:
38: * --------
39: * 28-Aug-2002 : Version 1 (DG);
40: * 07-Nov-2002 : Fixed errors reported by Checkstyle (DG);
41: * 13-Jan-2003 : Reviewed Javadocs (DG);
42: * 09-May-2003 : Added plot to draw() method (DG);
43: * 02-Jul-2003 : Eliminated the Annotation base interface (DG);
44: * 29-Sep-2004 : Added 'rendererIndex' and 'info' parameter to draw() method
45: * to support chart entities (tool tips etc) (DG);
46: *
47: */
48:
49: package org.jfree.chart.annotations;
50:
51: import java.awt.Graphics2D;
52: import java.awt.geom.Rectangle2D;
53:
54: import org.jfree.chart.axis.ValueAxis;
55: import org.jfree.chart.plot.PlotRenderingInfo;
56: import org.jfree.chart.plot.XYPlot;
57:
58: /**
59: * The interface that must be supported by annotations that are to be added to
60: * an {@link XYPlot}.
61: */
62: public interface XYAnnotation {
63:
64: /**
65: * Draws the annotation.
66: *
67: * @param g2 the graphics device.
68: * @param plot the plot.
69: * @param dataArea the data area.
70: * @param domainAxis the domain axis.
71: * @param rangeAxis the range axis.
72: * @param rendererIndex the renderer index.
73: * @param info an optional info object that will be populated with
74: * entity information.
75: */
76: public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea,
77: ValueAxis domainAxis, ValueAxis rangeAxis,
78: int rendererIndex, PlotRenderingInfo info);
79:
80: }
|