org.jfree.chart.plot

Class CombinedRangeXYPlot

Implemented Interfaces:
Cloneable, EventListener, PublicCloneable, Serializable, AxisChangeListener, DatasetChangeListener, LegendItemSource, MarkerChangeListener, PlotChangeListener, PublicCloneable, RendererChangeListener, Serializable, ValueAxisPlot, Zoomable

public class CombinedRangeXYPlot
extends XYPlot
implements Zoomable, Cloneable, PublicCloneable, Serializable, PlotChangeListener

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

Field Summary

Fields inherited from class org.jfree.chart.plot.XYPlot

DEFAULT_CROSSHAIR_PAINT, DEFAULT_CROSSHAIR_STROKE, DEFAULT_CROSSHAIR_VISIBLE, DEFAULT_GRIDLINE_PAINT, DEFAULT_GRIDLINE_STROKE, localizationResources

Fields inherited from class org.jfree.chart.plot.Plot

DEFAULT_BACKGROUND_ALPHA, DEFAULT_BACKGROUND_PAINT, DEFAULT_FOREGROUND_ALPHA, DEFAULT_INSETS, DEFAULT_LEGEND_ITEM_BOX, DEFAULT_LEGEND_ITEM_CIRCLE, DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, MINIMUM_HEIGHT_TO_DRAW, MINIMUM_WIDTH_TO_DRAW, ZERO

Constructor Summary

CombinedRangeXYPlot()
Default constructor.
CombinedRangeXYPlot(ValueAxis rangeAxis)
Creates a new plot.

Method Summary

void
add(XYPlot subplot)
Adds a subplot, with a default 'weight' of 1.
void
add(XYPlot subplot, int weight)
Adds a subplot with a particular weight (greater than or equal to one).
protected AxisSpace
calculateAxisSpace(Graphics2D g2, Rectangle2D plotArea)
Calculates the space required for the axes.
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 the range for the 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 a list of the 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.
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.
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.

Methods inherited from class org.jfree.chart.plot.XYPlot

addAnnotation, addDomainMarker, addDomainMarker, addDomainMarker, addRangeMarker, addRangeMarker, addRangeMarker, calculateAxisSpace, calculateDomainAxisSpace, calculateRangeAxisSpace, clearAnnotations, clearDomainAxes, clearDomainMarkers, clearDomainMarkers, clearRangeAxes, clearRangeMarkers, clearRangeMarkers, clone, configureDomainAxes, configureRangeAxes, datasetChanged, draw, drawAnnotations, drawAxes, drawBackground, drawDomainCrosshair, drawDomainGridlines, drawDomainMarkers, drawDomainTickBands, drawHorizontalLine, drawQuadrants, drawRangeCrosshair, drawRangeGridlines, drawRangeMarkers, drawRangeTickBands, drawVerticalLine, drawZeroDomainBaseline, drawZeroRangeBaseline, equals, getAnnotations, getAxisOffset, getDataRange, getDataset, getDataset, getDatasetCount, getDatasetRenderingOrder, getDomainAxis, getDomainAxis, getDomainAxisCount, getDomainAxisEdge, getDomainAxisEdge, getDomainAxisForDataset, getDomainAxisIndex, getDomainAxisLocation, getDomainAxisLocation, getDomainCrosshairPaint, getDomainCrosshairStroke, getDomainCrosshairValue, getDomainGridlinePaint, getDomainGridlineStroke, getDomainMarkers, getDomainMarkers, getDomainTickBandPaint, getDomainZeroBaselinePaint, getDomainZeroBaselineStroke, getFixedDomainAxisSpace, getFixedLegendItems, getFixedRangeAxisSpace, getIndexOf, getLegendItems, getOrientation, getPlotType, getQuadrantOrigin, getQuadrantPaint, getRangeAxis, getRangeAxis, getRangeAxisCount, getRangeAxisEdge, getRangeAxisEdge, getRangeAxisForDataset, getRangeAxisIndex, getRangeAxisLocation, getRangeAxisLocation, getRangeCrosshairPaint, getRangeCrosshairStroke, getRangeCrosshairValue, getRangeGridlinePaint, getRangeGridlineStroke, getRangeMarkers, getRangeMarkers, getRangeTickBandPaint, getRangeZeroBaselinePaint, getRangeZeroBaselineStroke, getRenderer, getRenderer, getRendererForDataset, getSeriesCount, getSeriesRenderingOrder, getWeight, handleClick, indexOf, isDomainCrosshairLockedOnData, isDomainCrosshairVisible, isDomainGridlinesVisible, isDomainZeroBaselineVisible, isDomainZoomable, isRangeCrosshairLockedOnData, isRangeCrosshairVisible, isRangeGridlinesVisible, isRangeZeroBaselineVisible, isRangeZoomable, mapDatasetToDomainAxis, mapDatasetToRangeAxis, removeAnnotation, render, rendererChanged, setAxisOffset, setDataset, setDataset, setDatasetRenderingOrder, setDomainAxes, setDomainAxis, setDomainAxis, setDomainAxis, setDomainAxisLocation, setDomainAxisLocation, setDomainAxisLocation, setDomainAxisLocation, setDomainCrosshairLockedOnData, setDomainCrosshairPaint, setDomainCrosshairStroke, setDomainCrosshairValue, setDomainCrosshairValue, setDomainCrosshairVisible, setDomainGridlinePaint, setDomainGridlineStroke, setDomainGridlinesVisible, setDomainTickBandPaint, setDomainZeroBaselinePaint, setDomainZeroBaselineStroke, setDomainZeroBaselineVisible, setFixedDomainAxisSpace, setFixedLegendItems, setFixedRangeAxisSpace, setOrientation, setQuadrantOrigin, setQuadrantPaint, setRangeAxes, setRangeAxis, setRangeAxis, setRangeAxis, setRangeAxisLocation, setRangeAxisLocation, setRangeAxisLocation, setRangeAxisLocation, setRangeCrosshairLockedOnData, setRangeCrosshairPaint, setRangeCrosshairStroke, setRangeCrosshairValue, setRangeCrosshairValue, setRangeCrosshairVisible, setRangeGridlinePaint, setRangeGridlineStroke, setRangeGridlinesVisible, setRangeTickBandPaint, setRangeZeroBaselinePaint, setRangeZeroBaselineStroke, setRangeZeroBaselineVisible, setRenderer, setRenderer, setRenderer, setRenderers, setSeriesRenderingOrder, setWeight, zoomDomainAxes, zoomDomainAxes, zoomRangeAxes, zoomRangeAxes

Methods inherited from class org.jfree.chart.plot.Plot

addChangeListener, axisChanged, clone, datasetChanged, draw, drawBackground, drawBackgroundImage, drawNoDataMessage, drawOutline, equals, fillBackground, getBackgroundAlpha, getBackgroundImage, getBackgroundImageAlignment, getBackgroundImageAlpha, getBackgroundPaint, getDatasetGroup, getDrawingSupplier, getForegroundAlpha, getInsets, getLegendItems, getNoDataMessage, getNoDataMessageFont, getNoDataMessagePaint, getOutlinePaint, getOutlineStroke, getParent, getPlotType, getRectX, getRectY, getRootPlot, handleClick, isSubplot, markerChanged, notifyListeners, removeChangeListener, resolveDomainAxisLocation, resolveRangeAxisLocation, setBackgroundAlpha, setBackgroundImage, setBackgroundImageAlignment, setBackgroundImageAlpha, setBackgroundPaint, setDatasetGroup, setDrawingSupplier, setForegroundAlpha, setInsets, setInsets, setNoDataMessage, setNoDataMessageFont, setNoDataMessagePaint, setOutlinePaint, setOutlineStroke, setParent, zoom

Constructor Details

CombinedRangeXYPlot

public CombinedRangeXYPlot()
Default constructor.

CombinedRangeXYPlot

public CombinedRangeXYPlot(ValueAxis rangeAxis)
Creates a new plot.
Parameters:
rangeAxis - the shared axis.

Method Details

add

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.

add

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).

calculateAxisSpace

protected AxisSpace calculateAxisSpace(Graphics2D g2,
                                       Rectangle2D plotArea)
Calculates the space required for the axes.
Overrides:
calculateAxisSpace in interface XYPlot
Parameters:
g2 - the graphics device.
plotArea - the plot area.
Returns:
The space required for the axes.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of the plot.
Overrides:
clone in interface XYPlot
Returns:
A clone.

draw

public void draw(Graphics2D g2,
                 Rectangle2D area,
                 Point2D anchor,
                 PlotState parentState,
                 PlotRenderingInfo info)
Draws the plot within the specified area on a graphics device.
Overrides:
draw in interface XYPlot
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).

equals

public boolean equals(Object obj)
Tests this plot for equality with another object.
Overrides:
equals in interface XYPlot
Parameters:
obj - the other object.
Returns:
true or false.

findSubplot

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.
source - the source point.
Returns:
A subplot (possibly null).

getDataRange

public Range getDataRange(ValueAxis axis)
Returns the range for the axis. This is the combined range of all the subplots.
Specified by:
getDataRange in interface ValueAxisPlot
Overrides:
getDataRange in interface XYPlot
Parameters:
axis - the axis.
Returns:
The range.

getGap

public double getGap()
Returns the space between subplots.
Returns:
The gap

getLegendItems

public LegendItemCollection getLegendItems()
Returns a collection of legend items for the plot.
Specified by:
getLegendItems in interface LegendItemSource
Overrides:
getLegendItems in interface XYPlot
Returns:
The legend items.

getPlotType

public String getPlotType()
Returns a string describing the type of plot.
Overrides:
getPlotType in interface XYPlot
Returns:
The type of plot.

getSubplots

public List getSubplots()
Returns a list of the subplots.
Returns:
The list (unmodifiable).

handleClick

public void handleClick(int x,
                        int y,
                        PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor values...
Overrides:
handleClick in interface XYPlot
Parameters:
x - x-coordinate, where the click occured.
y - y-coordinate, where the click occured.
info - object containing information about the plot dimensions.

plotChanged

public void plotChanged(PlotChangeEvent event)
Receives a PlotChangeEvent and responds by notifying all listeners.
Specified by:
plotChanged in interface PlotChangeListener
Parameters:
event - the event.

remove

public void remove(XYPlot subplot)
Removes a subplot from the combined chart.
Parameters:
subplot - the subplot (null not permitted).

setFixedDomainAxisSpaceForSubplots

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.

setGap

public void setGap(double gap)
Sets the amount of space between subplots.
Parameters:
gap - the gap between subplots

setOrientation

public void setOrientation(PlotOrientation orientation)
Sets the orientation for the plot (and all its subplots).
Overrides:
setOrientation in interface XYPlot
Parameters:
orientation - the orientation.

setRenderer

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.

Overrides:
setRenderer in interface XYPlot
Parameters:
renderer - the new renderer.

zoomDomainAxes

public void zoomDomainAxes(double lowerPercent,
                           double upperPercent,
                           PlotRenderingInfo info,
                           Point2D source)
Zooms in on the domain axes.
Specified by:
zoomDomainAxes in interface Zoomable
Overrides:
zoomDomainAxes in interface XYPlot
Parameters:
lowerPercent - the lower bound.
upperPercent - the upper bound.
info - the plot rendering info.
source - the source point.

zoomDomainAxes

public void zoomDomainAxes(double factor,
                           PlotRenderingInfo info,
                           Point2D source)
Multiplies the range on the domain axis/axes by the specified factor.
Specified by:
zoomDomainAxes in interface Zoomable
Overrides:
zoomDomainAxes in interface XYPlot
Parameters:
factor - the zoom factor.
info - the plot rendering info.
source - the source point.