KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > annotations > XYAnnotation


1 /* ===========================================================
2  * JFreeChart : a free chart library for the Java(tm) platform
3  * ===========================================================
4  *
5  * (C) Copyright 2000-2005, 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 License
20  * along with this library; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
24  * in the United States and other countries.]
25  *
26  * -----------------
27  * XYAnnotation.java
28  * -----------------
29  * (C) Copyright 2002-2005, by Object Refinery Limited.
30  *
31  * Original Author: David Gilbert (for Object Refinery Limited);
32  * Contributor(s): -;
33  *
34  * $Id: XYAnnotation.java,v 1.4 2005/03/29 12:54:56 mungady Exp $
35  *
36  * Changes:
37  * --------
38  * 28-Aug-2002 : Version 1 (DG);
39  * 07-Nov-2002 : Fixed errors reported by Checkstyle (DG);
40  * 13-Jan-2003 : Reviewed Javadocs (DG);
41  * 09-May-2003 : Added plot to draw() method (DG);
42  * 02-Jul-2003 : Eliminated the Annotation base interface (DG);
43  * 29-Sep-2004 : Added 'rendererIndex' and 'info' parameter to draw() method
44  * to support chart entities (tool tips etc) (DG);
45  *
46  */
47
48 package org.jfree.chart.annotations;
49
50 import java.awt.Graphics2D JavaDoc;
51 import java.awt.geom.Rectangle2D JavaDoc;
52
53 import org.jfree.chart.axis.ValueAxis;
54 import org.jfree.chart.plot.PlotRenderingInfo;
55 import org.jfree.chart.plot.XYPlot;
56
57 /**
58  * The interface that must be supported by annotations that are to be added to
59  * an {@link XYPlot}.
60  */
61 public interface XYAnnotation {
62
63     /**
64      * Draws the annotation.
65      *
66      * @param g2 the graphics device.
67      * @param plot the plot.
68      * @param dataArea the data area.
69      * @param domainAxis the domain axis.
70      * @param rangeAxis the range axis.
71      * @param rendererIndex the renderer index.
72      * @param info an optional info object that will be populated with
73      * entity information.
74      */
75     public void draw(Graphics2D JavaDoc g2, XYPlot plot, Rectangle2D JavaDoc dataArea,
76                      ValueAxis domainAxis, ValueAxis rangeAxis,
77                      int rendererIndex,
78                      PlotRenderingInfo info);
79
80 }
81
Popular Tags