1 /* ===========================================================
2 * JFreeChart : a free chart library for the Java(tm) platform
3 * ===========================================================
4 *
5 * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
6 *
7 * Project Info: http://www.jfree.org/jfreechart/index.html
8 *
9 * 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-2007, by Object Refinery Limited.
31 *
32 * Original Author: David Gilbert (for Object Refinery Limited);
33 * Contributor(s): -;
34 *
35 * Changes:
36 * --------
37 * 28-Aug-2002 : Version 1 (DG);
38 * 07-Nov-2002 : Fixed errors reported by Checkstyle (DG);
39 * 13-Jan-2003 : Reviewed Javadocs (DG);
40 * 09-May-2003 : Added plot to draw() method (DG);
41 * 02-Jul-2003 : Eliminated the Annotation base interface (DG);
42 * 29-Sep-2004 : Added 'rendererIndex' and 'info' parameter to draw() method
43 * to support chart entities (tool tips etc) (DG);
44 *
45 */
46
47 package org.jfree.chart.annotations;
48
49 import java.awt.Graphics2D;
50 import java.awt.geom.Rectangle2D;
51
52 import org.jfree.chart.axis.ValueAxis;
53 import org.jfree.chart.plot.PlotRenderingInfo;
54 import org.jfree.chart.plot.XYPlot;
55
56 /**
57 * The interface that must be supported by annotations that are to be added to
58 * an {@link XYPlot}.
59 */
60 public interface XYAnnotation {
61
62 /**
63 * Draws the annotation.
64 *
65 * @param g2 the graphics device.
66 * @param plot the plot.
67 * @param dataArea the data area.
68 * @param domainAxis the domain axis.
69 * @param rangeAxis the range axis.
70 * @param rendererIndex the renderer index.
71 * @param info an optional info object that will be populated with
72 * entity information.
73 */
74 public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea,
75 ValueAxis domainAxis, ValueAxis rangeAxis,
76 int rendererIndex,
77 PlotRenderingInfo info);
78
79 }
Save This Page