org.jfree.chart.renderer.xy

Class XYAreaRenderer

public class XYAreaRenderer extends AbstractXYItemRenderer implements XYItemRenderer, Cloneable, PublicCloneable, Serializable

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.
Field Summary
static intAREA
Useful constant for specifying the type of rendering (area only).
static intAREA_AND_SHAPES
Useful constant for specifying the type of rendering (area and shapes).
static intLINES
Useful constant for specifying the type of rendering (lines only).
static intSHAPES
Useful constant for specifying the type of rendering (shapes only).
static intSHAPES_AND_LINES
Useful constant for specifying the type of rendering (shapes and lines).
Constructor Summary
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
Objectclone()
Returns a clone of the renderer.
voiddrawItem(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.
booleanequals(Object obj)
Tests this renderer for equality with an arbitrary object.
ShapegetLegendArea()
Returns the shape used to represent an area in the legend.
LegendItemgetLegendItem(int datasetIndex, int series)
Returns a default legend item for the specified series.
booleangetPlotArea()
Returns true if Area is being plotted by the renderer.
booleangetPlotLines()
Returns true if lines are being plotted by the renderer.
booleangetPlotShapes()
Returns true if shapes are being plotted by the renderer.
XYItemRendererStateinitialise(Graphics2D g2, 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.
booleanisOutline()
Returns a flag that controls whether or not outlines of the areas are drawn.
voidsetLegendArea(Shape area)
Sets the shape used as an area in each legend item and sends a RendererChangeEvent to all registered listeners.
voidsetOutline(boolean show)
Sets a flag that controls whether or not outlines of the areas are drawn and sends a RendererChangeEvent to all registered listeners.

Field Detail

AREA

public static final int AREA
Useful constant for specifying the type of rendering (area only).

AREA_AND_SHAPES

public static final int AREA_AND_SHAPES
Useful constant for specifying the type of rendering (area and shapes).

LINES

public static final int LINES
Useful constant for specifying the type of rendering (lines only).

SHAPES

public static final int SHAPES
Useful constant for specifying the type of rendering (shapes only).

SHAPES_AND_LINES

public static final int SHAPES_AND_LINES
Useful constant for specifying the type of rendering (shapes and lines).

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

clone

public Object clone()
Returns a clone of the renderer.

Returns: A clone.

Throws: CloneNotSupportedException if the renderer cannot be cloned.

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.

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.

Parameters: obj the object (null permitted).

Returns: A boolean.

getLegendArea

public Shape getLegendArea()
Returns the shape used to represent an area in the legend.

Returns: The legend area (never null).

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.

Parameters: datasetIndex the dataset index (zero-based). series the series index (zero-based).

Returns: A legend item for the series.

getPlotArea

public boolean getPlotArea()
Returns true if Area is being plotted by the renderer.

Returns: true if Area is 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.

getPlotShapes

public boolean getPlotShapes()
Returns true if shapes are being plotted by the renderer.

Returns: true if shapes are being plotted by the renderer.

initialise

public XYItemRendererState initialise(Graphics2D g2, 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.

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.

isOutline

public boolean isOutline()
Returns a flag that controls whether or not outlines of the areas are drawn.

Returns: The flag.

See Also: XYAreaRenderer

setLegendArea

public void setLegendArea(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).

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