001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -----------------
028 * XYAnnotation.java
029 * -----------------
030 * (C) Copyright 2002-present, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   Peter Kolb (patch 2809117);
034 *
035 */
036
037package org.jfree.chart.annotations;
038
039import java.awt.Graphics2D;
040import java.awt.geom.Rectangle2D;
041
042import org.jfree.chart.axis.ValueAxis;
043import org.jfree.chart.plot.PlotRenderingInfo;
044import org.jfree.chart.plot.XYPlot;
045
046/**
047 * The interface that must be supported by annotations that are to be added to
048 * an {@link XYPlot}.  Note that, in JFreeChart 1.0.14, a non-compatible 
049 * change has been made to this interface (it now extends the Annotation
050 * interface to support change notifications).
051 */
052public interface XYAnnotation extends Annotation {
053
054    /**
055     * Draws the annotation.
056     *
057     * @param g2  the graphics device.
058     * @param plot  the plot.
059     * @param dataArea  the data area.
060     * @param domainAxis  the domain axis.
061     * @param rangeAxis  the range axis.
062     * @param rendererIndex  the renderer index.
063     * @param info  an optional info object that will be populated with
064     *              entity information.
065     */
066    void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea,
067              ValueAxis domainAxis, ValueAxis rangeAxis,
068              int rendererIndex, PlotRenderingInfo info);
069
070}