org.jfree.chart.plot.Zoomable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D API, it supports a wide range of chart types including
bar charts, pie charts, line charts, XY-plots, time series plots, Sankey charts
and more.
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2011, 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* -------------
* Zoomable.java
* -------------
*
* (C) Copyright 2004-2008, by Object Refinery Limited and Contributors.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): Rune Fauske;
*
* Changes
* -------
* 12-Nov-2004 : Version 1 (DG);
* 26-Jan-2004 : Added getOrientation() method (DG);
* 04-Sep-2006 : Added credit for Rune Fauske, see patch 1050659 (DG);
* 21-Sep-2007 : Added new zooming methods with 'useAnchor' flag. This breaks
* the API, but is the cleanest way I can think of to fix a
* long-standing bug (DG);
*
*/
package org.jfree.chart.plot;
import java.awt.geom.Point2D;
import org.jfree.chart.ChartPanel;
/**
* A plot that is zoomable must implement this interface to provide a
* mechanism for the {@link ChartPanel} to control the zooming.
*/
public interface Zoomable {
/**
* Returns true if the plot's domain is zoomable, and
* false otherwise.
*
* @return A boolean.
*
* @see #isRangeZoomable()
*/
public boolean isDomainZoomable();
/**
* Returns true if the plot's range is zoomable, and
* false otherwise.
*
* @return A boolean.
*
* @see #isDomainZoomable()
*/
public boolean isRangeZoomable();
/**
* Returns the orientation of the plot.
*
* @return The orientation.
*/
public PlotOrientation getOrientation();
/**
* Multiplies the range on the domain axis/axes by the specified factor.
* The source point can be used in some cases to identify a
* subplot, or to determine the center of zooming (refer to the
* documentation of the implementing class for details).
*
* @param factor the zoom factor.
* @param state the plot state.
* @param source the source point (in Java2D coordinates).
*
* @see #zoomRangeAxes(double, PlotRenderingInfo, Point2D)
*/
public void zoomDomainAxes(double factor, PlotRenderingInfo state,
Point2D source);
/**
* Multiplies the range on the domain axis/axes by the specified factor.
* The source point can be used in some cases to identify a
* subplot, or to determine the center of zooming (refer to the
* documentation of the implementing class for details).
*
* @param factor the zoom factor.
* @param state the plot state.
* @param source the source point (in Java2D coordinates).
* @param useAnchor use source point as zoom anchor?
*
* @see #zoomRangeAxes(double, PlotRenderingInfo, Point2D, boolean)
*
* @since 1.0.7
*/
public void zoomDomainAxes(double factor, PlotRenderingInfo state,
Point2D source, boolean useAnchor);
/**
* Zooms in on the domain axes. The source point can be used
* in some cases to identify a subplot for zooming.
*
* @param lowerPercent the new lower bound.
* @param upperPercent the new upper bound.
* @param state the plot state.
* @param source the source point (in Java2D coordinates).
*
* @see #zoomRangeAxes(double, double, PlotRenderingInfo, Point2D)
*/
public void zoomDomainAxes(double lowerPercent, double upperPercent,
PlotRenderingInfo state, Point2D source);
/**
* Multiplies the range on the range axis/axes by the specified factor.
* The source point can be used in some cases to identify a
* subplot, or to determine the center of zooming (refer to the
* documentation of the implementing class for details).
*
* @param factor the zoom factor.
* @param state the plot state.
* @param source the source point (in Java2D coordinates).
*
* @see #zoomDomainAxes(double, PlotRenderingInfo, Point2D)
*/
public void zoomRangeAxes(double factor, PlotRenderingInfo state,
Point2D source);
/**
* Multiplies the range on the range axis/axes by the specified factor.
* The source point can be used in some cases to identify a
* subplot, or to determine the center of zooming (refer to the
* documentation of the implementing class for details).
*
* @param factor the zoom factor.
* @param state the plot state.
* @param source the source point (in Java2D coordinates).
* @param useAnchor use source point as zoom anchor?
*
* @see #zoomDomainAxes(double, PlotRenderingInfo, Point2D)
*
* @since 1.0.7
*/
public void zoomRangeAxes(double factor, PlotRenderingInfo state,
Point2D source, boolean useAnchor);
/**
* Zooms in on the range axes. The source point can be used
* in some cases to identify a subplot for zooming.
*
* @param lowerPercent the new lower bound.
* @param upperPercent the new upper bound.
* @param state the plot state.
* @param source the source point (in Java2D coordinates).
*
* @see #zoomDomainAxes(double, double, PlotRenderingInfo, Point2D)
*/
public void zoomRangeAxes(double lowerPercent, double upperPercent,
PlotRenderingInfo state, Point2D source);
}