org.jfree.chart.plot

Class CombinedRangeXYPlot

public class CombinedRangeXYPlot extends XYPlot implements PlotChangeListener

An extension of XYPlot that contains multiple subplots that share a common range axis.
Constructor Summary
CombinedRangeXYPlot()
Default constructor.
CombinedRangeXYPlot(ValueAxis rangeAxis)
Creates a new plot.
Method Summary
voidadd(XYPlot subplot)
Adds a subplot, with a default 'weight' of 1.
voidadd(XYPlot subplot, int weight)
Adds a subplot with a particular weight (greater than or equal to one).
protected AxisSpacecalculateAxisSpace(Graphics2D g2, Rectangle2D plotArea)
Calculates the space required for the axes.
Objectclone()
Returns a clone of the plot.
voiddraw(Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)
Draws the plot within the specified area on a graphics device.
booleanequals(Object obj)
Tests this plot for equality with another object.
XYPlotfindSubplot(PlotRenderingInfo info, Point2D source)
Returns the subplot (if any) that contains the (x, y) point (specified in Java2D space).
RangegetDataRange(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.
doublegetGap()
Returns the space between subplots.
LegendItemCollectiongetLegendItems()
Returns a collection of legend items for the plot.
StringgetPlotType()
Returns a string describing the type of plot.
ListgetSubplots()
Returns the list of subplots.
voidhandleClick(int x, int y, PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor values...
voidplotChanged(PlotChangeEvent event)
Receives a PlotChangeEvent and responds by notifying all listeners.
voidremove(XYPlot subplot)
Removes a subplot from the combined chart.
protected voidsetFixedDomainAxisSpaceForSubplots(AxisSpace space)
Sets the space (width or height, depending on the orientation of the plot) for the domain axis of each subplot.
voidsetGap(double gap)
Sets the amount of space between subplots.
voidsetOrientation(PlotOrientation orientation)
Sets the orientation for the plot (and all its subplots).
voidsetRenderer(XYItemRenderer renderer)
Sets the item renderer FOR ALL SUBPLOTS.
voidzoomDomainAxes(double factor, PlotRenderingInfo info, Point2D source)
Multiplies the range on the domain axis/axes by the specified factor.
voidzoomDomainAxes(double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)
Multiplies the range on the domain axis/axes by the specified factor.
voidzoomDomainAxes(double lowerPercent, double upperPercent, PlotRenderingInfo info, Point2D source)
Zooms in on the domain axes.

Constructor Detail

CombinedRangeXYPlot

public CombinedRangeXYPlot()
Default constructor.

CombinedRangeXYPlot

public CombinedRangeXYPlot(ValueAxis rangeAxis)
Creates a new plot.

Parameters: rangeAxis the shared axis.

Method Detail

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.

Parameters: g2 the graphics device. plotArea the plot area.

Returns: The space required for the axes.

clone

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.

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.

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.

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 (null not permitted). source the source point (null not permitted).

Returns: A subplot (possibly null).

getDataRange

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.

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.

Returns: The legend items.

getPlotType

public String getPlotType()
Returns a string describing the type of plot.

Returns: The type of plot.

getSubplots

public List getSubplots()
Returns the list of subplots. The returned list may be empty, but is never null.

Returns: An unmodifiable list of subplots.

handleClick

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.

plotChanged

public void plotChanged(PlotChangeEvent event)
Receives a PlotChangeEvent and responds by notifying all listeners.

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

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.

Parameters: renderer the new renderer.

zoomDomainAxes

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

zoomDomainAxes

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?

zoomDomainAxes

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