org.jfree.chart.plot
Class CombinedRangeCategoryPlot

java.lang.Object
  extended byorg.jfree.chart.plot.Plot
      extended byorg.jfree.chart.plot.CategoryPlot
          extended byorg.jfree.chart.plot.CombinedRangeCategoryPlot
All Implemented Interfaces:
AxisChangeListener, java.lang.Cloneable, DatasetChangeListener, java.util.EventListener, LegendItemSource, PlotChangeListener, RendererChangeListener, java.io.Serializable, ValueAxisPlot, Zoomable

public class CombinedRangeCategoryPlot
extends CategoryPlot
implements Zoomable, java.lang.Cloneable, java.io.Serializable, PlotChangeListener

A combined category plot where the range axis is shared.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.jfree.chart.plot.CategoryPlot
DEFAULT_DOMAIN_GRIDLINES_VISIBLE, DEFAULT_GRIDLINE_PAINT, DEFAULT_GRIDLINE_STROKE, DEFAULT_RANGE_GRIDLINES_VISIBLE, DEFAULT_VALUE_LABEL_FONT, 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
CombinedRangeCategoryPlot()
          Default constructor.
CombinedRangeCategoryPlot(ValueAxis rangeAxis)
          Creates a new plot.
 
Method Summary
 void add(CategoryPlot subplot)
          Adds a subplot (with a default 'weight' of 1) and sends a PlotChangeEvent to all registered listeners.
 void add(CategoryPlot subplot, int weight)
          Adds a subplot and sends a PlotChangeEvent to all registered listeners.
protected  AxisSpace calculateAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea)
          Calculates the space required for the axes.
 java.lang.Object clone()
          Returns a clone of the plot.
 void draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, PlotState parentState, PlotRenderingInfo info)
          Draws the plot on a Java 2D graphics device (such as the screen or a printer).
 boolean equals(java.lang.Object obj)
          Tests the plot for equality with an arbitrary object.
 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.
 java.util.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 value.
 void plotChanged(PlotChangeEvent event)
          Receives a PlotChangeEvent and responds by notifying all listeners.
 void remove(CategoryPlot subplot)
          Removes a subplot from the combined chart.
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.
 void setGap(double gap)
          Sets the amount of space between subplots and sends a PlotChangeEvent to all registered listeners.
 void setOrientation(PlotOrientation orientation)
          Sets the orientation for the plot (and all the subplots).
 
Methods inherited from class org.jfree.chart.plot.CategoryPlot
addAnnotation, addRangeMarker, addRangeMarker, addRangeMarker, calculateDomainAxisSpace, calculateRangeAxisSpace, clearDomainAxes, clearRangeAxes, clearRangeMarkers, clearRangeMarkers, configureDomainAxes, configureRangeAxes, datasetChanged, drawAnnotations, drawAxes, drawDomainGridlines, drawRangeGridlines, drawRangeLine, drawRangeMarkers, drawRangeMarkers, getAnchorValue, getAnnotations, getAxisOffset, getCategories, getColumnRenderingOrder, getDataset, getDataset, getDatasetRenderingOrder, getDomainAxis, getDomainAxis, getDomainAxisEdge, getDomainAxisEdge, getDomainAxisForDataset, getDomainAxisLocation, getDomainAxisLocation, getDomainGridlinePaint, getDomainGridlinePosition, getDomainGridlineStroke, getDrawSharedDomainAxis, getFixedDomainAxisSpace, getFixedLegendItems, getFixedRangeAxisSpace, getIndexOf, getOrientation, getPlotType, getRangeAxis, getRangeAxis, getRangeAxisEdge, getRangeAxisEdge, getRangeAxisForDataset, getRangeAxisLocation, getRangeAxisLocation, getRangeCrosshairPaint, getRangeCrosshairStroke, getRangeCrosshairValue, getRangeGridlinePaint, getRangeGridlineStroke, getRangeMarkers, getRangeMarkers, getRenderer, getRenderer, getRendererForDataset, getRowRenderingOrder, getWeight, isDomainGridlinesVisible, isDomainZoomable, isRangeCrosshairLockedOnData, isRangeCrosshairVisible, isRangeGridlinesVisible, isRangeZoomable, mapDatasetToDomainAxis, mapDatasetToRangeAxis, render, rendererChanged, setAnchorValue, setAnchorValue, setAxisOffset, setColumnRenderingOrder, setDataset, setDataset, setDatasetRenderingOrder, setDomainAxis, setDomainAxis, setDomainAxisLocation, setDomainAxisLocation, setDomainAxisLocation, setDomainGridlinePaint, setDomainGridlinePosition, setDomainGridlineStroke, setDomainGridlinesVisible, setDrawSharedDomainAxis, setFixedDomainAxisSpace, setFixedLegendItems, setFixedRangeAxisSpace, setRangeAxis, setRangeAxis, setRangeAxisLocation, setRangeAxisLocation, setRangeAxisLocation, setRangeAxisLocation, setRangeCrosshairLockedOnData, setRangeCrosshairPaint, setRangeCrosshairStroke, setRangeCrosshairValue, setRangeCrosshairValue, setRangeCrosshairVisible, setRangeGridlinePaint, setRangeGridlineStroke, setRangeGridlinesVisible, setRenderer, setRenderer, setRenderer, setRenderer, setRowRenderingOrder, setWeight, zoom, zoomDomainAxes, zoomDomainAxes, zoomRangeAxes, zoomRangeAxes
 
Methods inherited from class org.jfree.chart.plot.Plot
addChangeListener, axisChanged, draw, drawBackground, drawBackgroundImage, drawNoDataMessage, drawOutline, fillBackground, getBackgroundAlpha, getBackgroundImage, getBackgroundImageAlignment, getBackgroundPaint, getDataAreaRatio, getDatasetGroup, getDrawingSupplier, getForegroundAlpha, getInsets, getNoDataMessage, getNoDataMessageFont, getNoDataMessagePaint, getOutlinePaint, getOutlineStroke, getParent, getRectX, getRectY, getRootPlot, isSubplot, notifyListeners, removeChangeListener, resolveDomainAxisLocation, resolveRangeAxisLocation, setBackgroundAlpha, setBackgroundImage, setBackgroundImageAlignment, setBackgroundPaint, setDataAreaRatio, setDatasetGroup, setDrawingSupplier, setForegroundAlpha, setInsets, setInsets, setNoDataMessage, setNoDataMessageFont, setNoDataMessagePaint, setOutlinePaint, setOutlineStroke, setParent
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jfree.chart.plot.Zoomable
getOrientation, isDomainZoomable, isRangeZoomable, zoomDomainAxes, zoomDomainAxes, zoomRangeAxes, zoomRangeAxes
 

Constructor Detail

CombinedRangeCategoryPlot

public CombinedRangeCategoryPlot()
Default constructor.


CombinedRangeCategoryPlot

public CombinedRangeCategoryPlot(ValueAxis rangeAxis)
Creates a new plot.

Parameters:
rangeAxis - the shared range axis.
Method Detail

getGap

public double getGap()
Returns the space between subplots.

Returns:
The gap (in Java2D units).

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

add

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

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.

Parameters:
subplot - the subplot (null not permitted).
weight - the weight (must be >= 1).

remove

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

Parameters:
subplot - the subplot (null not permitted).

getSubplots

public java.util.List getSubplots()
Returns the list of subplots.

Returns:
The list (unmodifiable).

calculateAxisSpace

protected AxisSpace calculateAxisSpace(java.awt.Graphics2D g2,
                                       java.awt.geom.Rectangle2D plotArea)
Calculates the space required for the axes.

Overrides:
calculateAxisSpace in class CategoryPlot
Parameters:
g2 - the graphics device.
plotArea - the plot area.
Returns:
The space required for the axes.

draw

public void draw(java.awt.Graphics2D g2,
                 java.awt.geom.Rectangle2D plotArea,
                 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.

Overrides:
draw in class CategoryPlot
Parameters:
g2 - the graphics device.
plotArea - the area within which the plot (including axis labels) should be drawn.
parentState - the parent state.
info - collects information about the drawing (null permitted).

setOrientation

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

Overrides:
setOrientation in class CategoryPlot
Parameters:
orientation - the orientation.

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 class CategoryPlot
Parameters:
axis - the axis.
Returns:
The range.

getLegendItems

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

Specified by:
getLegendItems in interface LegendItemSource
Overrides:
getLegendItems in class CategoryPlot
Returns:
The legend items.

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.

handleClick

public void handleClick(int x,
                        int y,
                        PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor value.

Overrides:
handleClick in class CategoryPlot
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.

Specified by:
plotChanged in interface PlotChangeListener
Parameters:
event - the event.

equals

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

Overrides:
equals in class CategoryPlot
Parameters:
obj - the object (null permitted).
Returns:
true or false.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a clone of the plot.

Overrides:
clone in class CategoryPlot
Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - this class will not throw this exception, but subclasses (if any) might.