Module platform

Package org.jfree.chart.renderer.xy

Class DeviationRenderer

java.lang.Object

org.jfree.chart.renderer.AbstractRenderer

org.jfree.chart.renderer.xy.AbstractXYItemRenderer

org.jfree.chart.renderer.xy.XYLineAndShapeRenderer

org.jfree.chart.renderer.xy.DeviationRenderer

All Implemented Interfaces:

Serializable, Cloneable, EventListener, AnnotationChangeListener, LegendItemSource, XYItemRenderer, PublicCloneable

Direct Known Subclasses:

DeviationStepRenderer

public class DeviationRenderer
extends XYLineAndShapeRenderer

A specialised subclass of the XYLineAndShapeRenderer that requires an IntervalXYDataset and represents the y-interval by shading an area behind the y-values on the chart. The example shown here is generated by the DeviationRendererDemo1.java program included in the JFreeChart demo collection:

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeviationRenderer.State	A state object that is passed to each call to drawItem().

Field Summary

Fields

Modifier and Type	Field	Description
protected float	alpha	The alpha transparency for the interval shading.

Fields inherited from class org.jfree.chart.renderer.AbstractRenderer

DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, DEFAULT_PAINT, DEFAULT_SHAPE, DEFAULT_STROKE, DEFAULT_VALUE_LABEL_FONT, DEFAULT_VALUE_LABEL_PAINT, ZERO

Constructor Summary

Constructors

Constructor	Description
DeviationRenderer()	Creates a new renderer that displays lines and shapes for the data items, as well as the shaded area for the y-interval.
DeviationRenderer(boolean lines, boolean shapes)	Creates a new renderer.

Method Summary

Modifier and Type	Method	Description
void	drawItem(Graphics2D g2, XYItemRendererState state, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)	Draws the visual representation of a single data item.
boolean	equals(Object obj)	Tests this renderer for equality with an arbitrary object.
Range	findRangeBounds(XYDataset dataset)	Returns the range of values the renderer requires to display all the items from the specified dataset.
float	getAlpha()	Returns the alpha transparency for the background shading.
int	getPassCount()	Returns the number of passes (through the dataset) used by this renderer.
XYItemRendererState	initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset dataset, PlotRenderingInfo info)	Initialises and returns a state object that can be passed to each invocation of the drawItem(java.awt.Graphics2D, org.jfree.chart.renderer.xy.XYItemRendererState, java.awt.geom.Rectangle2D, org.jfree.chart.plot.PlotRenderingInfo, org.jfree.chart.plot.XYPlot, org.jfree.chart.axis.ValueAxis, org.jfree.chart.axis.ValueAxis, org.jfree.data.xy.XYDataset, int, int, org.jfree.chart.plot.CrosshairState, int) method.
protected boolean	isItemPass(int pass)	Returns true if this is the pass where the shapes are drawn.
protected boolean	isLinePass(int pass)	Returns true if this is the pass where the lines are drawn.
void	setAlpha(float alpha)	Sets the alpha transparency for the background shading, and sends a RendererChangeEvent to all registered listeners.
void	setDrawSeriesLineAsPath(boolean flag)	This method is overridden so that this flag cannot be changed---it is set to true for this renderer.

Methods inherited from class org.jfree.chart.renderer.xy.XYLineAndShapeRenderer

clone, drawFirstPassShape, drawPrimaryLine, drawPrimaryLineAsPath, drawSecondaryPass, getDefaultLinesVisible, getDefaultShapesFilled, getDefaultShapesVisible, getDrawOutlines, getDrawSeriesLineAsPath, getItemLineVisible, getItemShapeFilled, getItemShapeVisible, getLegendItem, getLegendLine, getSeriesLinesVisible, getSeriesShapesFilled, getSeriesShapesVisible, getUseFillPaint, getUseOutlinePaint, setDefaultLinesVisible, setDefaultShapesFilled, setDefaultShapesVisible, setDrawOutlines, setLegendLine, setSeriesLinesVisible, setSeriesLinesVisible, setSeriesShapesFilled, setSeriesShapesFilled, setSeriesShapesVisible, setSeriesShapesVisible, setUseFillPaint, setUseOutlinePaint

Methods inherited from class org.jfree.chart.renderer.xy.AbstractXYItemRenderer

addAnnotation, addAnnotation, addEntity, annotationChanged, beginElementGroup, calculateDomainMarkerTextAnchorPoint, drawAnnotations, drawDomainLine, drawDomainMarker, drawItemLabel, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, findDomainBounds, findRangeBounds, getAnnotations, getDefaultItemLabelGenerator, getDefaultToolTipGenerator, getDrawingSupplier, getItemLabelGenerator, getLegendItemLabelGenerator, getLegendItems, getLegendItemToolTipGenerator, getLegendItemURLGenerator, getPlot, getSeriesItemLabelGenerator, getSeriesToolTipGenerator, getToolTipGenerator, getURLGenerator, lineTo, moveTo, removeAnnotation, removeAnnotations, setDefaultItemLabelGenerator, setDefaultToolTipGenerator, setLegendItemLabelGenerator, setLegendItemToolTipGenerator, setLegendItemURLGenerator, setPlot, setSeriesItemLabelGenerator, setSeriesToolTipGenerator, setURLGenerator, updateCrosshairValues

Methods inherited from class org.jfree.chart.renderer.AbstractRenderer

addChangeListener, beginElementGroup, calculateLabelAnchorPoint, clearSeriesPaints, clearSeriesStrokes, endElementGroup, fireChangeEvent, getAutoPopulateSeriesFillPaint, getAutoPopulateSeriesOutlinePaint, getAutoPopulateSeriesOutlineStroke, getAutoPopulateSeriesPaint, getAutoPopulateSeriesShape, getAutoPopulateSeriesStroke, getDataBoundsIncludesVisibleSeriesOnly, getDefaultCreateEntities, getDefaultEntityRadius, getDefaultFillPaint, getDefaultItemLabelFont, getDefaultItemLabelPaint, getDefaultItemLabelsVisible, getDefaultLegendShape, getDefaultLegendTextFont, getDefaultLegendTextPaint, getDefaultNegativeItemLabelPosition, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultPositiveItemLabelPosition, getDefaultSeriesVisible, getDefaultSeriesVisibleInLegend, getDefaultShape, getDefaultStroke, getItemCreateEntity, getItemFillPaint, getItemLabelAnchorOffset, getItemLabelFont, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendShape, getLegendTextFont, getLegendTextPaint, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesVisible, getSeriesVisibleInLegend, getTreatLegendShapeAsLine, hashCode, hasListener, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, lookupLegendShape, lookupLegendTextFont, lookupLegendTextPaint, lookupSeriesFillPaint, lookupSeriesOutlinePaint, lookupSeriesOutlineStroke, lookupSeriesPaint, lookupSeriesShape, lookupSeriesStroke, notifyListeners, removeChangeListener, setAutoPopulateSeriesFillPaint, setAutoPopulateSeriesOutlinePaint, setAutoPopulateSeriesOutlineStroke, setAutoPopulateSeriesPaint, setAutoPopulateSeriesShape, setAutoPopulateSeriesStroke, setDataBoundsIncludesVisibleSeriesOnly, setDefaultCreateEntities, setDefaultCreateEntities, setDefaultEntityRadius, setDefaultFillPaint, setDefaultFillPaint, setDefaultItemLabelFont, setDefaultItemLabelFont, setDefaultItemLabelPaint, setDefaultItemLabelPaint, setDefaultItemLabelsVisible, setDefaultItemLabelsVisible, setDefaultLegendShape, setDefaultLegendTextFont, setDefaultLegendTextPaint, setDefaultNegativeItemLabelPosition, setDefaultNegativeItemLabelPosition, setDefaultOutlinePaint, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultOutlineStroke, setDefaultPaint, setDefaultPaint, setDefaultPositiveItemLabelPosition, setDefaultPositiveItemLabelPosition, setDefaultSeriesVisible, setDefaultSeriesVisible, setDefaultSeriesVisibleInLegend, setDefaultSeriesVisibleInLegend, setDefaultShape, setDefaultShape, setDefaultStroke, setDefaultStroke, setItemLabelAnchorOffset, setLegendShape, setLegendTextFont, setLegendTextPaint, setSeriesCreateEntities, setSeriesCreateEntities, setSeriesFillPaint, setSeriesFillPaint, setSeriesItemLabelFont, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setTreatLegendShapeAsLine

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.LegendItemSource

getLegendItems

Methods inherited from interface org.jfree.chart.renderer.xy.XYItemRenderer

addAnnotation, addAnnotation, addChangeListener, drawAnnotations, drawDomainLine, drawDomainMarker, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, getDefaultCreateEntities, getDefaultFillPaint, getDefaultItemLabelFont, getDefaultItemLabelGenerator, getDefaultItemLabelPaint, getDefaultItemLabelsVisible, getDefaultNegativeItemLabelPosition, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultPositiveItemLabelPosition, getDefaultSeriesVisible, getDefaultSeriesVisibleInLegend, getDefaultShape, getDefaultStroke, getDefaultToolTipGenerator, getItemCreateEntity, getItemFillPaint, getItemLabelFont, getItemLabelGenerator, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendItemLabelGenerator, getNegativeItemLabelPosition, getPlot, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelGenerator, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesToolTipGenerator, getSeriesVisible, getSeriesVisibleInLegend, getToolTipGenerator, getURLGenerator, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, removeAnnotation, removeAnnotations, removeChangeListener, setDefaultCreateEntities, setDefaultCreateEntities, setDefaultFillPaint, setDefaultFillPaint, setDefaultItemLabelFont, setDefaultItemLabelGenerator, setDefaultItemLabelPaint, setDefaultItemLabelsVisible, setDefaultItemLabelsVisible, setDefaultNegativeItemLabelPosition, setDefaultNegativeItemLabelPosition, setDefaultOutlinePaint, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultOutlineStroke, setDefaultPaint, setDefaultPaint, setDefaultPositiveItemLabelPosition, setDefaultPositiveItemLabelPosition, setDefaultSeriesVisible, setDefaultSeriesVisible, setDefaultSeriesVisibleInLegend, setDefaultSeriesVisibleInLegend, setDefaultShape, setDefaultShape, setDefaultStroke, setDefaultStroke, setDefaultToolTipGenerator, setLegendItemLabelGenerator, setPlot, setSeriesCreateEntities, setSeriesCreateEntities, setSeriesFillPaint, setSeriesFillPaint, setSeriesItemLabelFont, setSeriesItemLabelGenerator, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesToolTipGenerator, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setURLGenerator

Field Details

alpha

protected float alpha

The alpha transparency for the interval shading.

Constructor Details

DeviationRenderer

public DeviationRenderer()

Creates a new renderer that displays lines and shapes for the data items, as well as the shaded area for the y-interval.

DeviationRenderer

public DeviationRenderer(boolean lines,
 boolean shapes)

Creates a new renderer.

Parameters:

lines - show lines between data items?

shapes - show a shape for each data item?

Method Details

getAlpha

public float getAlpha()

Returns the alpha transparency for the background shading.

Returns:

The alpha transparency.

See Also:

• setAlpha(float)

setAlpha

public void setAlpha(float alpha)

Sets the alpha transparency for the background shading, and sends a RendererChangeEvent to all registered listeners.

Parameters:

alpha - the alpha (in the range 0.0f to 1.0f).

See Also:

• getAlpha()

setDrawSeriesLineAsPath

public void setDrawSeriesLineAsPath(boolean flag)

This method is overridden so that this flag cannot be changed---it is set to true for this renderer.

Overrides:

setDrawSeriesLineAsPath in class XYLineAndShapeRenderer

Parameters:

flag - ignored.

See Also:

• XYLineAndShapeRenderer.getDrawSeriesLineAsPath()

findRangeBounds

public Range findRangeBounds(XYDataset dataset)

Returns the range of values the renderer requires to display all the items from the specified dataset.

Specified by:

findRangeBounds in interface XYItemRenderer

Overrides:

findRangeBounds in class AbstractXYItemRenderer

Parameters:

dataset - the dataset (null permitted).

Returns:

The range (null if the dataset is null or empty).

See Also:

• AbstractXYItemRenderer.findDomainBounds(XYDataset)

initialise

public XYItemRendererState initialise(Graphics2D g2,
 Rectangle2D dataArea,
 XYPlot plot,
 XYDataset dataset,
 PlotRenderingInfo info)

Initialises and returns a state object that can be passed to each invocation of the drawItem(java.awt.Graphics2D, org.jfree.chart.renderer.xy.XYItemRendererState, java.awt.geom.Rectangle2D, org.jfree.chart.plot.PlotRenderingInfo, org.jfree.chart.plot.XYPlot, org.jfree.chart.axis.ValueAxis, org.jfree.chart.axis.ValueAxis, org.jfree.data.xy.XYDataset, int, int, org.jfree.chart.plot.CrosshairState, int) method.

Specified by:

initialise in interface XYItemRenderer

Overrides:

initialise in class XYLineAndShapeRenderer

Parameters:

g2 - the graphics target.

dataArea - the data area.

plot - the plot.

dataset - the dataset.

info - the plot rendering info.

Returns:

A newly initialised state object.

getPassCount

public int getPassCount()

Returns the number of passes (through the dataset) used by this renderer.

Specified by:

getPassCount in interface XYItemRenderer

Overrides:

getPassCount in class XYLineAndShapeRenderer

Returns:

3.

isItemPass

protected boolean isItemPass(int pass)

Returns true if this is the pass where the shapes are drawn.

Overrides:

isItemPass in class XYLineAndShapeRenderer

Parameters:

pass - the pass index.

Returns:

A boolean.

See Also:

• isLinePass(int)

isLinePass

protected boolean isLinePass(int pass)

Returns true if this is the pass where the lines are drawn.

Overrides:

isLinePass in class XYLineAndShapeRenderer

Parameters:

pass - the pass index.

Returns:

A boolean.

See Also:

• isItemPass(int)

drawItem

public void drawItem(Graphics2D g2,
 XYItemRendererState state,
 Rectangle2D dataArea,
 PlotRenderingInfo info,
 XYPlot plot,
 ValueAxis domainAxis,
 ValueAxis rangeAxis,
 XYDataset dataset,
 int series,
 int item,
 CrosshairState crosshairState,
 int pass)

Draws the visual representation of a single data item.

Specified by:

drawItem in interface XYItemRenderer

Overrides:

drawItem in class XYLineAndShapeRenderer

Parameters:

g2 - the graphics device.

state - the renderer state.

dataArea - the area within which the data is being drawn.

info - collects information about the drawing.

plot - the plot (can be used to obtain standard color information etc).

domainAxis - the domain axis.

rangeAxis - the range axis.

dataset - the dataset.

series - the series index (zero-based).

item - the item index (zero-based).

crosshairState - crosshair information for the plot (null permitted).

pass - the pass index.

equals

public boolean equals(Object obj)

Tests this renderer for equality with an arbitrary object.

Overrides:

equals in class XYLineAndShapeRenderer

Parameters:

obj - the object (null permitted).

Returns:

A boolean.