org.jfree.chart.plot

Class CombinedRangeCategoryPlot

public class CombinedRangeCategoryPlot extends CategoryPlot implements PlotChangeListener

A combined category plot where the range axis is shared.
Constructor Summary
CombinedRangeCategoryPlot()
Default constructor.
CombinedRangeCategoryPlot(ValueAxis rangeAxis)
Creates a new plot.
Method Summary
voidadd(CategoryPlot subplot)
Adds a subplot (with a default 'weight' of 1) and sends a PlotChangeEvent to all registered listeners.
voidadd(CategoryPlot subplot, int weight)
Adds a subplot and sends a PlotChangeEvent to all registered listeners.
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 on a Java 2D graphics device (such as the screen or a printer).
booleanequals(Object obj)
Tests the plot for equality with an arbitrary object.
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.
ListgetSubplots()
Returns the list of subplots.
voidhandleClick(int x, int y, PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor value.
voidplotChanged(PlotChangeEvent event)
Receives a PlotChangeEvent and responds by notifying all listeners.
voidremove(CategoryPlot subplot)
Removes a subplot from the combined chart.
protected voidsetFixedDomainAxisSpaceForSubplots(AxisSpace space)
Sets the size (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 and sends a PlotChangeEvent to all registered listeners.
voidsetOrientation(PlotOrientation orientation)
Sets the orientation for the plot (and all the subplots).

Constructor Detail

CombinedRangeCategoryPlot

public CombinedRangeCategoryPlot()
Default constructor.

CombinedRangeCategoryPlot

public CombinedRangeCategoryPlot(ValueAxis rangeAxis)
Creates a new plot.

Parameters: rangeAxis the shared range axis.

Method Detail

add

public void add(CategoryPlot subplot)
Adds a subplot (with a default 'weight' of 1) and sends a PlotChangeEvent to all registered listeners.

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

add

public void add(CategoryPlot subplot, int weight)
Adds a subplot and sends a PlotChangeEvent to all registered listeners.

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 (null not permitted). weight the weight (must be >= 1).

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 on a Java 2D graphics device (such as the screen or a printer). Will perform all the placement calculations for each sub-plots and then tell these to draw themselves.

Parameters: g2 the graphics device. area the area within which the plot (including axis labels) should be drawn. anchor the anchor point (null permitted). parentState the parent state. info collects information about the drawing (null permitted).

equals

public boolean equals(Object obj)
Tests the plot for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: true or false.

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 (in Java2D units).

getLegendItems

public LegendItemCollection getLegendItems()
Returns a collection of legend items for the plot.

Returns: The legend items.

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

Parameters: x x-coordinate of the click. y y-coordinate of the click. info information about the plot's dimensions.

plotChanged

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

Parameters: event the event.

remove

public void remove(CategoryPlot subplot)
Removes a subplot from the combined chart.

Parameters: subplot the subplot (null not permitted).

setFixedDomainAxisSpaceForSubplots

protected void setFixedDomainAxisSpaceForSubplots(AxisSpace space)
Sets the size (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 and sends a PlotChangeEvent to all registered listeners.

Parameters: gap the gap between subplots (in Java2D units).

setOrientation

public void setOrientation(PlotOrientation orientation)
Sets the orientation for the plot (and all the subplots).

Parameters: orientation the orientation.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.