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 * XYAnnotationBoundsInfo.java
029 * ---------------------------
030 * (C) Copyright 2009-present, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.annotations;
038
039import org.jfree.data.Range;
040
041/**
042 * An interface that supplies information about the bounds of the annotation.
043 */
044public interface XYAnnotationBoundsInfo {
045
046    /**
047     * Returns a flag that determines whether or not the annotation's
048     * bounds should be taken into account for auto-range calculations on
049     * the axes that the annotation is plotted against.
050     *
051     * @return A boolean.
052     */
053    boolean getIncludeInDataBounds();
054
055    /**
056     * Returns the range of x-values (in data space) that the annotation
057     * uses.
058     *
059     * @return The x-range.
060     */
061    Range getXRange();
062
063    /**
064     * Returns the range of y-values (in data space) that the annotation
065     * uses.
066     *
067     * @return The y-range.
068     */
069    Range getYRange();
070
071}