/* ===========================================================

 * JFreeChart : a free chart library for the Java(tm) platform

 * ===========================================================

 *

 * (C) Copyright 2000-2004, 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., 59 Temple Place, Suite 330,

 * Boston, MA 02111-1307, USA.

 *

 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

 * in the United States and other countries.]

 *

 * -----------------

 * XYAnnotation.java

 * -----------------

 * (C) Copyright 2002-2004, by Object Refinery Limited.

 *

 * Original Author:  David Gilbert (for Object Refinery Limited);

 * Contributor(s):   -;

 *

 * $Id: XYAnnotation.java,v 1.1 2004/08/31 14:28:00 mungady Exp $

 *

 * Changes:

 * --------

 * 28-Aug-2002 : Version 1 (DG);

 * 07-Nov-2002 : Fixed errors reported by Checkstyle (DG);

 * 13-Jan-2003 : Reviewed Javadocs (DG);

 * 09-May-2003 : Added plot to draw(...) method (DG);

 * 02-Jul-2003 : Eliminated the Annotation base interface (DG);

 */



package org.jfree.chart.annotations;



import java.awt.Graphics2D;

import java.awt.geom.Rectangle2D;



import org.jfree.chart.axis.ValueAxis;

import org.jfree.chart.plot.XYPlot;



/**

 * The interface that must be supported by annotations that are to be added to an {@link XYPlot}.

 *

 */

public interface XYAnnotation {



    /**

     * 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.

     */

    public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea,

                     ValueAxis domainAxis, ValueAxis rangeAxis);



}

