org.jfree.chart.renderer.xy

Class XYAreaRenderer

java.lang.Object

org.jfree.chart.renderer.AbstractRenderer

org.jfree.chart.renderer.xy.AbstractXYItemRenderer

org.jfree.chart.renderer.xy.XYAreaRenderer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.EventListener, AnnotationChangeListener, LegendItemSource, XYItemRenderer, org.jfree.util.PublicCloneable

Direct Known Subclasses:

StackedXYAreaRenderer

public class XYAreaRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, org.jfree.util.PublicCloneable

Area item renderer for an XYPlot. This class can draw (a) shapes at each point, or (b) lines between points, or (c) both shapes and lines, or (d) filled areas, or (e) filled areas and shapes. The example shown here is generated by the XYAreaRendererDemo1.java program included in the JFreeChart demo collection:

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AREA Useful constant for specifying the type of rendering (area only).
static int	AREA_AND_SHAPES Useful constant for specifying the type of rendering (area and shapes).
static int	LINES Useful constant for specifying the type of rendering (lines only).
static int	SHAPES Useful constant for specifying the type of rendering (shapes only).
static int	SHAPES_AND_LINES Useful constant for specifying the type of rendering (shapes and lines).

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 and Description
XYAreaRenderer() Constructs a new renderer.
XYAreaRenderer(int type) Constructs a new renderer.
XYAreaRenderer(int type, XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator) Constructs a new renderer.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a clone of the renderer.
void	drawItem(java.awt.Graphics2D g2, XYItemRendererState state, java.awt.geom.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(java.lang.Object obj) Tests this renderer for equality with an arbitrary object.
org.jfree.ui.GradientPaintTransformer	getGradientTransformer() Returns the gradient paint transformer.
java.awt.Shape	getLegendArea() Returns the shape used to represent an area in the legend.
LegendItem	getLegendItem(int datasetIndex, int series) Returns a default legend item for the specified series.
boolean	getPlotArea() Returns true if Area is being plotted by the renderer.
boolean	getPlotLines() Returns true if lines are being plotted by the renderer.
boolean	getPlotShapes() Returns true if shapes are being plotted by the renderer.
boolean	getUseFillPaint() Returns the flag that controls whether the series fill paint is used to fill the area under the line.
int	hashCode() Returns a hash code for this instance.
XYItemRendererState	initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info) Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem() method.
boolean	isOutline() Returns a flag that controls whether or not outlines of the areas are drawn.
void	setGradientTransformer(org.jfree.ui.GradientPaintTransformer transformer) Sets the gradient paint transformer and sends a RendererChangeEvent to all registered listeners.
void	setLegendArea(java.awt.Shape area) Sets the shape used as an area in each legend item and sends a RendererChangeEvent to all registered listeners.
void	setOutline(boolean show) Sets a flag that controls whether or not outlines of the areas are drawn and sends a RendererChangeEvent to all registered listeners.
void	setUseFillPaint(boolean use) Sets the flag that controls whether or not the series fill paint is used to fill the area under the line and sends a RendererChangeEvent to all listeners.

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

addAnnotation, addAnnotation, annotationChanged, drawAnnotations, drawDomainGridLine, drawDomainLine, drawDomainMarker, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, findRangeBounds, getAnnotations, getBaseItemLabelGenerator, getBaseToolTipGenerator, getDrawingSupplier, getItemLabelGenerator, getItemLabelGenerator, getLegendItemLabelGenerator, getLegendItems, getLegendItemToolTipGenerator, getLegendItemURLGenerator, getPassCount, getPlot, getSeriesItemLabelGenerator, getSeriesToolTipGenerator, getToolTipGenerator, getToolTipGenerator, getURLGenerator, isPointInRect, removeAnnotation, removeAnnotations, setBaseItemLabelGenerator, setBaseToolTipGenerator, setItemLabelGenerator, setLegendItemLabelGenerator, setLegendItemToolTipGenerator, setLegendItemURLGenerator, setPlot, setSeriesItemLabelGenerator, setSeriesToolTipGenerator, setToolTipGenerator, setURLGenerator

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

addChangeListener, clearSeriesPaints, clearSeriesStrokes, getAutoPopulateSeriesFillPaint, getAutoPopulateSeriesOutlinePaint, getAutoPopulateSeriesOutlineStroke, getAutoPopulateSeriesPaint, getAutoPopulateSeriesShape, getAutoPopulateSeriesStroke, getBaseCreateEntities, getBaseFillPaint, getBaseItemLabelFont, getBaseItemLabelPaint, getBaseItemLabelsVisible, getBaseLegendShape, getBaseLegendTextFont, getBaseLegendTextPaint, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseSeriesVisible, getBaseSeriesVisibleInLegend, getBaseShape, getBaseStroke, getCreateEntities, getDataBoundsIncludesVisibleSeriesOnly, getDefaultEntityRadius, getItemCreateEntity, getItemFillPaint, getItemLabelAnchorOffset, getItemLabelFont, getItemLabelFont, getItemLabelPaint, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendShape, getLegendTextFont, getLegendTextPaint, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesVisible, getSeriesVisible, getSeriesVisibleInLegend, getSeriesVisibleInLegend, hasListener, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, lookupLegendShape, lookupLegendTextFont, lookupLegendTextPaint, lookupSeriesFillPaint, lookupSeriesOutlinePaint, lookupSeriesOutlineStroke, lookupSeriesPaint, lookupSeriesShape, lookupSeriesStroke, notifyListeners, removeChangeListener, setAutoPopulateSeriesFillPaint, setAutoPopulateSeriesOutlinePaint, setAutoPopulateSeriesOutlineStroke, setAutoPopulateSeriesPaint, setAutoPopulateSeriesShape, setAutoPopulateSeriesStroke, setBaseCreateEntities, setBaseCreateEntities, setBaseFillPaint, setBaseFillPaint, setBaseItemLabelFont, setBaseItemLabelFont, setBaseItemLabelPaint, setBaseItemLabelPaint, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseLegendShape, setBaseLegendTextFont, setBaseLegendTextPaint, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlinePaint, setBaseOutlineStroke, setBaseOutlineStroke, setBasePaint, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseSeriesVisible, setBaseSeriesVisible, setBaseSeriesVisibleInLegend, setBaseSeriesVisibleInLegend, setBaseShape, setBaseShape, setBaseStroke, setBaseStroke, setCreateEntities, setCreateEntities, setDataBoundsIncludesVisibleSeriesOnly, setDefaultEntityRadius, setFillPaint, setFillPaint, setItemLabelAnchorOffset, setItemLabelFont, setItemLabelFont, setItemLabelPaint, setItemLabelPaint, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setLegendShape, setLegendTextFont, setLegendTextPaint, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlinePaint, setOutlineStroke, setOutlineStroke, setPaint, setPaint, setPositiveItemLabelPosition, setPositiveItemLabelPosition, 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, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setShape, setShape, setStroke, setStroke

Methods inherited from class java.lang.Object

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

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

addAnnotation, addAnnotation, addChangeListener, drawAnnotations, drawDomainGridLine, drawDomainMarker, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, findRangeBounds, getBaseItemLabelFont, getBaseItemLabelGenerator, getBaseItemLabelPaint, getBaseItemLabelsVisible, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseSeriesVisible, getBaseSeriesVisibleInLegend, getBaseShape, getBaseStroke, getBaseToolTipGenerator, getItemLabelFont, getItemLabelFont, getItemLabelGenerator, getItemLabelPaint, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendItemLabelGenerator, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPassCount, getPlot, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesItemLabelFont, getSeriesItemLabelGenerator, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesToolTipGenerator, getSeriesVisible, getSeriesVisible, getSeriesVisibleInLegend, getSeriesVisibleInLegend, getToolTipGenerator, getURLGenerator, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, removeAnnotation, removeAnnotations, removeChangeListener, setBaseItemLabelFont, setBaseItemLabelGenerator, setBaseItemLabelPaint, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlineStroke, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseSeriesVisible, setBaseSeriesVisible, setBaseSeriesVisibleInLegend, setBaseSeriesVisibleInLegend, setBaseShape, setBaseStroke, setBaseToolTipGenerator, setItemLabelFont, setItemLabelGenerator, setItemLabelPaint, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setLegendItemLabelGenerator, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlineStroke, setPaint, setPlot, setPositiveItemLabelPosition, setPositiveItemLabelPosition, setSeriesItemLabelFont, setSeriesItemLabelGenerator, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesStroke, setSeriesToolTipGenerator, setSeriesVisible, setSeriesVisible, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setShape, setStroke, setToolTipGenerator, setURLGenerator

Methods inherited from interface org.jfree.chart.LegendItemSource

getLegendItems

Field Detail

SHAPES

public static final int SHAPES

Useful constant for specifying the type of rendering (shapes only).

See Also:

Constant Field Values

LINES

public static final int LINES

Useful constant for specifying the type of rendering (lines only).

See Also:

Constant Field Values

SHAPES_AND_LINES

public static final int SHAPES_AND_LINES

Useful constant for specifying the type of rendering (shapes and lines).

See Also:

Constant Field Values

AREA

public static final int AREA

Useful constant for specifying the type of rendering (area only).

See Also:

Constant Field Values

AREA_AND_SHAPES

public static final int AREA_AND_SHAPES

Useful constant for specifying the type of rendering (area and shapes).

See Also:

Constant Field Values

Constructor Detail

XYAreaRenderer

public XYAreaRenderer()

Constructs a new renderer.

XYAreaRenderer

public XYAreaRenderer(int type)

Constructs a new renderer.

Parameters:

type - the type of the renderer.

XYAreaRenderer

public XYAreaRenderer(int type,
                      XYToolTipGenerator toolTipGenerator,
                      XYURLGenerator urlGenerator)

Constructs a new renderer. To specify the type of renderer, use one of the constants: SHAPES, LINES, SHAPES_AND_LINES, AREA or AREA_AND_SHAPES.

Parameters:

type - the type of renderer.

toolTipGenerator - the tool tip generator to use (null permitted).

urlGenerator - the URL generator (null permitted).

Method Detail

getPlotShapes

public boolean getPlotShapes()

Returns true if shapes are being plotted by the renderer.

Returns:

true if shapes are being plotted by the renderer.

getPlotLines

public boolean getPlotLines()

Returns true if lines are being plotted by the renderer.

Returns:

true if lines are being plotted by the renderer.

getPlotArea

public boolean getPlotArea()

Returns true if Area is being plotted by the renderer.

Returns:

true if Area is being plotted by the renderer.

isOutline

public boolean isOutline()

Returns a flag that controls whether or not outlines of the areas are drawn.

Returns:

The flag.

See Also:

setOutline(boolean)

setOutline

public void setOutline(boolean show)

Sets a flag that controls whether or not outlines of the areas are drawn and sends a RendererChangeEvent to all registered listeners.

Parameters:

show - the flag.

See Also:

isOutline()

getLegendArea

public java.awt.Shape getLegendArea()

Returns the shape used to represent an area in the legend.

Returns:

The legend area (never null).

setLegendArea

public void setLegendArea(java.awt.Shape area)

Sets the shape used as an area in each legend item and sends a RendererChangeEvent to all registered listeners.

Parameters:

area - the area (null not permitted).

getUseFillPaint

public boolean getUseFillPaint()

Returns the flag that controls whether the series fill paint is used to fill the area under the line.

Returns:

A boolean.

Since:

1.0.14

setUseFillPaint

public void setUseFillPaint(boolean use)

Sets the flag that controls whether or not the series fill paint is used to fill the area under the line and sends a RendererChangeEvent to all listeners.

Parameters:

use - the new flag value.

Since:

1.0.14

getGradientTransformer

public org.jfree.ui.GradientPaintTransformer getGradientTransformer()

Returns the gradient paint transformer.

Returns:

The gradient paint transformer (never null).

Since:

1.0.14

setGradientTransformer

public void setGradientTransformer(org.jfree.ui.GradientPaintTransformer transformer)

Sets the gradient paint transformer and sends a RendererChangeEvent to all registered listeners.

Parameters:

transformer - the transformer (null not permitted).

Since:

1.0.14

initialise

public XYItemRendererState initialise(java.awt.Graphics2D g2,
                                      java.awt.geom.Rectangle2D dataArea,
                                      XYPlot plot,
                                      XYDataset data,
                                      PlotRenderingInfo info)

Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem() method.

Specified by:

initialise in interface XYItemRenderer

Overrides:

initialise in class AbstractXYItemRenderer

Parameters:

g2 - the graphics device.

dataArea - the area inside the axes.

plot - the plot.

data - the data.

info - an optional info collection object to return data back to the caller.

Returns:

A state object for use by the renderer.

getLegendItem

public LegendItem getLegendItem(int datasetIndex,
                                int series)

Returns a default legend item for the specified series. Subclasses should override this method to generate customised items.

Specified by:

getLegendItem in interface XYItemRenderer

Overrides:

getLegendItem in class AbstractXYItemRenderer

Parameters:

datasetIndex - the dataset index (zero-based).

series - the series index (zero-based).

Returns:

A legend item for the series.

drawItem

public void drawItem(java.awt.Graphics2D g2,
                     XYItemRendererState state,
                     java.awt.geom.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

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.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone of the renderer.

Specified by:

clone in interface org.jfree.util.PublicCloneable

Returns:

A clone.

Throws:

java.lang.CloneNotSupportedException - if the renderer cannot be cloned.

equals

public boolean equals(java.lang.Object obj)

Tests this renderer for equality with an arbitrary object.

Overrides:

equals in class AbstractXYItemRenderer

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class AbstractRenderer

Returns:

A hash code.