001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2022, 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 * Pannable.java
029 * -------------
030 *
031 * (C) Copyright 2009-2022, by David Gilbert and Contributors.
032 *
033 * Original Author:  Ulrich Voigt - patch 2686040;
034 * Contributor(s):   David Gilbert;
035 *
036 */
037
038package org.jfree.chart.plot;
039
040import java.awt.geom.Point2D;
041
042/**
043 * An interface that user interface components can make use of to communicate 
044 * with plots that support panning.
045 */
046public interface Pannable {
047
048    /**
049     * Returns the orientation of the plot.
050     *
051     * @return The orientation (never {@code null}).
052     */
053    PlotOrientation getOrientation();
054
055    /**
056     * Evaluates if the domain axis can be panned.
057     *
058     * @return {@code true} if the domain axis is pannable.
059     */
060    boolean isDomainPannable();
061
062    /**
063     * Evaluates if the range axis can be panned.
064     *
065     * @return {@code true} if the range axis is pannable.
066     */
067    boolean isRangePannable();
068
069    /**
070     * Pans the domain axes by the specified percentage.
071     *
072     * @param percent  the distance to pan (as a percentage of the axis length).
073     * @param info the plot info
074     * @param source the source point where the pan action started.
075     */
076    void panDomainAxes(double percent, PlotRenderingInfo info,
077            Point2D source);
078
079    /**
080     * Pans the range axes by the specified percentage.
081     *
082     * @param percent  the distance to pan (as a percentage of the axis length).
083     * @param info the plot info
084     * @param source the source point where the pan action started.
085     */
086    void panRangeAxes(double percent, PlotRenderingInfo info,
087            Point2D source);
088
089}