org.jfree.chart.renderer.xy

Class XYAreaRenderer2

public class XYAreaRenderer2 extends AbstractXYItemRenderer implements XYItemRenderer, PublicCloneable

Area item renderer for an XYPlot. The example shown here is generated by the XYAreaRenderer2Demo1.java program included in the JFreeChart demo collection:

XYAreaRenderer2Sample.png
Constructor Summary
XYAreaRenderer2()
Constructs a new renderer.
XYAreaRenderer2(XYToolTipGenerator labelGenerator, 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.
booleangetPlotLines()
This method should not be used.
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.

Constructor Detail

XYAreaRenderer2

public XYAreaRenderer2()
Constructs a new renderer.

XYAreaRenderer2

public XYAreaRenderer2(XYToolTipGenerator labelGenerator, XYURLGenerator urlGenerator)
Constructs a new renderer.

Parameters: labelGenerator the tool tip generator to use. null is none. 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 not 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).

See Also: setLegendArea

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.

getPlotLines

public boolean getPlotLines()

Deprecated: This method was included in the API by mistake and serves no useful purpose. It has always returned false.

This method should not be used.

Returns: false always.

isOutline

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

Returns: The flag.

See Also: XYAreaRenderer2

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

See Also: getLegendArea

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

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