public class

CombinedRangeXYPlot

extends XYPlot
implements PlotChangeListener
java.lang.Object
   ↳ org.jfree.chart.plot.Plot
     ↳ org.jfree.chart.plot.XYPlot
       ↳ org.jfree.chart.plot.CombinedRangeXYPlot

Class Overview

An extension of XYPlot that contains multiple subplots that share a common range axis.

Summary

[Expand]
Inherited Constants
From class org.jfree.chart.plot.XYPlot
From class org.jfree.chart.plot.Plot
[Expand]
Inherited Fields
From class org.jfree.chart.plot.XYPlot
From class org.jfree.chart.plot.Plot
Public Constructors
CombinedRangeXYPlot()
Default constructor.
CombinedRangeXYPlot(ValueAxis rangeAxis)
Creates a new plot.
Public Methods
void add(XYPlot subplot, int weight)
Adds a subplot with a particular weight (greater than or equal to one).
void add(XYPlot subplot)
Adds a subplot, with a default 'weight' of 1.
Object clone()
Returns a clone of the plot.
void draw(Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)
Draws the plot within the specified area on a graphics device.
boolean equals(Object obj)
Tests this plot for equality with another object.
XYPlot findSubplot(PlotRenderingInfo info, Point2D source)
Returns the subplot (if any) that contains the (x, y) point (specified in Java2D space).
Range getDataRange(ValueAxis axis)
Returns a range representing the extent of the data values in this plot (obtained from the subplots) that will be rendered against the specified axis.
double getGap()
Returns the space between subplots.
LegendItemCollection getLegendItems()
Returns a collection of legend items for the plot.
String getPlotType()
Returns a string describing the type of plot.
List getSubplots()
Returns the list of subplots.
void handleClick(int x, int y, PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor values...
void plotChanged(PlotChangeEvent event)
Receives a PlotChangeEvent and responds by notifying all listeners.
void remove(XYPlot subplot)
Removes a subplot from the combined chart.
void setGap(double gap)
Sets the amount of space between subplots.
void setOrientation(PlotOrientation orientation)
Sets the orientation for the plot (and all its subplots).
void setRenderer(XYItemRenderer renderer)
Sets the item renderer FOR ALL SUBPLOTS.
void zoomDomainAxes(double lowerPercent, double upperPercent, PlotRenderingInfo info, Point2D source)
Zooms in on the domain axes.
void zoomDomainAxes(double factor, PlotRenderingInfo info, Point2D source)
Multiplies the range on the domain axis/axes by the specified factor.
void zoomDomainAxes(double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)
Multiplies the range on the domain axis/axes by the specified factor.
Protected Methods
AxisSpace calculateAxisSpace(Graphics2D g2, Rectangle2D plotArea)
Calculates the space required for the axes.
void setFixedDomainAxisSpaceForSubplots(AxisSpace space)
Sets the space (width or height, depending on the orientation of the plot) for the domain axis of each subplot.
[Expand]
Inherited Methods
From class org.jfree.chart.plot.XYPlot
From class org.jfree.chart.plot.Plot
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.event.AxisChangeListener
From interface org.jfree.chart.event.MarkerChangeListener
From interface org.jfree.chart.event.PlotChangeListener
From interface org.jfree.chart.event.RendererChangeListener
From interface org.jfree.chart.plot.Pannable
From interface org.jfree.chart.plot.ValueAxisPlot
From interface org.jfree.chart.plot.Zoomable
From interface org.jfree.data.general.DatasetChangeListener

Public Constructors

public CombinedRangeXYPlot ()

Default constructor.

public CombinedRangeXYPlot (ValueAxis rangeAxis)

Creates a new plot.

Parameters
rangeAxis the shared axis.

Public Methods

public void add (XYPlot subplot, int weight)

Adds a subplot with a particular weight (greater than or equal to one). The weight determines how much space is allocated to the subplot relative to all the other subplots.

You must ensure that the subplot has a non-null domain axis. The range axis for the subplot will be set to null.

Parameters
subplot the subplot.
weight the weight (must be 1 or greater).

public void add (XYPlot subplot)

Adds a subplot, with a default 'weight' of 1.

You must ensure that the subplot has a non-null domain axis. The range axis for the subplot will be set to null.

Parameters
subplot the subplot.

public Object clone ()

Returns a clone of the plot.

Returns
  • A clone.
Throws
CloneNotSupportedException this class will not throw this exception, but subclasses (if any) might.

public void draw (Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)

Draws the plot within the specified area on a graphics device.

Parameters
g2 the graphics device.
area the plot area (in Java2D space).
anchor an anchor point in Java2D space (null permitted).
parentState the state from the parent plot, if there is one (null permitted).
info collects chart drawing information (null permitted).

public boolean equals (Object obj)

Tests this plot for equality with another object.

Parameters
obj the other object.
Returns
  • true or false.

public XYPlot findSubplot (PlotRenderingInfo info, Point2D source)

Returns the subplot (if any) that contains the (x, y) point (specified in Java2D space).

Parameters
info the chart rendering info (null not permitted).
source the source point (null not permitted).
Returns
  • A subplot (possibly null).

public Range getDataRange (ValueAxis axis)

Returns a range representing the extent of the data values in this plot (obtained from the subplots) that will be rendered against the specified axis. NOTE: This method is intended for internal JFreeChart use, and is public only so that code in the axis classes can call it. Since only the range axis is shared between subplots, the JFreeChart code will only call this method for the range values (although this is not checked/enforced).

Parameters
axis the axis.
Returns
  • The range.

public double getGap ()

Returns the space between subplots.

Returns
  • The gap

public LegendItemCollection getLegendItems ()

Returns a collection of legend items for the plot.

Returns
  • The legend items.

public String getPlotType ()

Returns a string describing the type of plot.

Returns
  • The type of plot.

public List getSubplots ()

Returns the list of subplots. The returned list may be empty, but is never null.

Returns
  • An unmodifiable list of subplots.

public void handleClick (int x, int y, PlotRenderingInfo info)

Handles a 'click' on the plot by updating the anchor values...

Parameters
x x-coordinate, where the click occured.
y y-coordinate, where the click occured.
info object containing information about the plot dimensions.

public void plotChanged (PlotChangeEvent event)

Receives a PlotChangeEvent and responds by notifying all listeners.

Parameters
event the event.

public void remove (XYPlot subplot)

Removes a subplot from the combined chart.

Parameters
subplot the subplot (null not permitted).

public void setGap (double gap)

Sets the amount of space between subplots.

Parameters
gap the gap between subplots

public void setOrientation (PlotOrientation orientation)

Sets the orientation for the plot (and all its subplots).

Parameters
orientation the orientation.

public void setRenderer (XYItemRenderer renderer)

Sets the item renderer FOR ALL SUBPLOTS. Registered listeners are notified that the plot has been modified.

Note: usually you will want to set the renderer independently for each subplot, which is NOT what this method does.

Parameters
renderer the new renderer.

public void zoomDomainAxes (double lowerPercent, double upperPercent, PlotRenderingInfo info, Point2D source)

Zooms in on the domain axes.

Parameters
lowerPercent the lower bound.
upperPercent the upper bound.
info the plot rendering info (null not permitted).
source the source point (null not permitted).

public void zoomDomainAxes (double factor, PlotRenderingInfo info, Point2D source)

Multiplies the range on the domain axis/axes by the specified factor.

Parameters
factor the zoom factor.
info the plot rendering info (null not permitted).
source the source point (null not permitted).

public void zoomDomainAxes (double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)

Multiplies the range on the domain axis/axes by the specified factor.

Parameters
factor the zoom factor.
info the plot rendering info (null not permitted).
source the source point (null not permitted).
useAnchor zoom about the anchor point?

Protected Methods

protected AxisSpace calculateAxisSpace (Graphics2D g2, Rectangle2D plotArea)

Calculates the space required for the axes.

Parameters
g2 the graphics device.
plotArea the plot area.
Returns
  • The space required for the axes.

protected void setFixedDomainAxisSpaceForSubplots (AxisSpace space)

Sets the space (width or height, depending on the orientation of the plot) for the domain axis of each subplot.

Parameters
space the space.