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 * Pannable.java
029 * -------------
030 *
031 * (C) Copyright 2009-present, 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
042import org.jfree.chart.ChartPanel;
043
044/**
045 * An interface that the {@link ChartPanel} class uses to communicate with
046 * plots that support panning.
047 */
048public interface Pannable {
049
050    /**
051     * Returns the orientation of the plot.
052     *
053     * @return The orientation (never {@code null}).
054     */
055    PlotOrientation getOrientation();
056
057    /**
058     * Evaluates if the domain axis can be panned.
059     *
060     * @return {@code true} if the domain axis is pannable.
061     */
062    boolean isDomainPannable();
063
064    /**
065     * Evaluates if the range axis can be panned.
066     *
067     * @return {@code true} if the range axis is pannable.
068     */
069    boolean isRangePannable();
070
071    /**
072     * Pans the domain axes by the specified percentage.
073     *
074     * @param percent  the distance to pan (as a percentage of the axis length).
075     * @param info the plot info
076     * @param source the source point where the pan action started.
077     */
078    void panDomainAxes(double percent, PlotRenderingInfo info,
079                       Point2D source);
080
081    /**
082     * Pans the range axes by the specified percentage.
083     *
084     * @param percent  the distance to pan (as a percentage of the axis length).
085     * @param info the plot info
086     * @param source the source point where the pan action started.
087     */
088    void panRangeAxes(double percent, PlotRenderingInfo info,
089                      Point2D source);
090
091}