org.jfree.chart.renderer.xy

Class StandardXYItemRenderer

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

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

This renderer has been retained for historical reasons and, in general, you should use the XYLineAndShapeRenderer class instead.

Nested Class Summary
static classStandardXYItemRenderer.State
Records the state for the renderer.
Field Summary
static intDISCONTINUOUS
Constant for the type of rendering (discontinuous lines).
static intDISCONTINUOUS_LINES
Constant for the type of rendering (discontinuous lines).
static intIMAGES
Constant for the type of rendering (images only).
static intLINES
Constant for the type of rendering (lines only).
static intSHAPES
Constant for the type of rendering (shapes only).
static intSHAPES_AND_LINES
Constant for the type of rendering (shapes and lines).
Constructor Summary
StandardXYItemRenderer()
Constructs a new renderer.
StandardXYItemRenderer(int type)
Constructs a new renderer.
StandardXYItemRenderer(int type, XYToolTipGenerator toolTipGenerator)
Constructs a new renderer.
StandardXYItemRenderer(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 another object.
booleangetBaseShapesFilled()
Returns the base 'shape filled' attribute.
booleangetBaseShapesVisible()
Returns true if shapes are being plotted by the renderer.
booleangetDrawSeriesLineAsPath()
Returns a flag that controls whether or not each series is drawn as a single path.
doublegetGapThreshold()
Returns the gap threshold for discontinuous lines.
UnitTypegetGapThresholdType()
Returns the gap threshold type (relative or absolute).
protected ImagegetImage(Plot plot, int series, int item, double x, double y)
Returns the image used to draw a single data item.
protected PointgetImageHotspot(Plot plot, int series, int item, double x, double y, Image image)
Returns the hotspot of the image used to draw a single data item.
booleangetItemShapeFilled(int series, int item)
Returns the flag used to control whether or not the shape for an item is filled.
LegendItemgetLegendItem(int datasetIndex, int series)
Returns a legend item for a series.
ShapegetLegendLine()
Returns the shape used to represent a line in the legend.
booleangetPlotDiscontinuous()
Returns a flag that controls whether or not the renderer shows discontinuous lines.
booleangetPlotImages()
Returns true if images are being plotted by the renderer.
booleangetPlotLines()
Returns true if lines are being plotted by the renderer.
BooleangetSeriesShapesFilled(int series)
Returns the flag used to control whether or not the shapes for a series are filled.
BooleangetShapesFilled()
Returns the override flag that controls whether or not shapes are filled for ALL series.
XYItemRendererStateinitialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
Initialises the renderer.
voidsetBaseShapesFilled(boolean flag)
Sets the base 'shapes filled' flag.
voidsetBaseShapesVisible(boolean flag)
Sets the flag that controls whether or not a shape is plotted at each data point.
voidsetDrawSeriesLineAsPath(boolean flag)
Sets the flag that controls whether or not each series is drawn as a single path.
voidsetGapThreshold(double t)
Sets the gap threshold for discontinuous lines.
voidsetGapThresholdType(UnitType thresholdType)
Sets the gap threshold type.
voidsetLegendLine(Shape line)
Sets the shape used as a line in each legend item and sends a RendererChangeEvent to all registered listeners.
voidsetPlotDiscontinuous(boolean flag)
Sets the flag that controls whether or not the renderer shows discontinuous lines, and sends a RendererChangeEvent to all registered listeners.
voidsetPlotImages(boolean flag)
Sets the flag that controls whether or not an image is drawn at each data point.
voidsetPlotLines(boolean flag)
Sets the flag that controls whether or not a line is plotted between each data point.
voidsetSeriesShapesFilled(int series, Boolean flag)
Sets the 'shapes filled' flag for a series.
voidsetShapesFilled(boolean filled)
Sets the 'shapes filled' for ALL series.
voidsetShapesFilled(Boolean filled)
Sets the override flag that controls whether or not shapes are filled for ALL series and sends a RendererChangeEvent to all registered listeners.

Field Detail

DISCONTINUOUS

public static final int DISCONTINUOUS
Constant for the type of rendering (discontinuous lines).

DISCONTINUOUS_LINES

public static final int DISCONTINUOUS_LINES
Constant for the type of rendering (discontinuous lines).

IMAGES

public static final int IMAGES
Constant for the type of rendering (images only).

LINES

public static final int LINES
Constant for the type of rendering (lines only).

SHAPES

public static final int SHAPES
Constant for the type of rendering (shapes only).

SHAPES_AND_LINES

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

Constructor Detail

StandardXYItemRenderer

public StandardXYItemRenderer()
Constructs a new renderer.

StandardXYItemRenderer

public StandardXYItemRenderer(int type)
Constructs a new renderer. To specify the type of renderer, use one of the constants: SHAPES, LINES or SHAPES_AND_LINES.

Parameters: type the type.

StandardXYItemRenderer

public StandardXYItemRenderer(int type, XYToolTipGenerator toolTipGenerator)
Constructs a new renderer. To specify the type of renderer, use one of the constants: SHAPES, LINES or SHAPES_AND_LINES.

Parameters: type the type of renderer. toolTipGenerator the item label generator (null permitted).

StandardXYItemRenderer

public StandardXYItemRenderer(int type, XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)
Constructs a new renderer. To specify the type of renderer, use one of the constants: SHAPES, LINES or SHAPES_AND_LINES.

Parameters: type the type of renderer. toolTipGenerator the item label generator (null permitted). urlGenerator the URL generator.

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 another object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getBaseShapesFilled

public boolean getBaseShapesFilled()
Returns the base 'shape filled' attribute.

Returns: The base flag.

See Also: StandardXYItemRenderer

getBaseShapesVisible

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

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

See Also: StandardXYItemRenderer

getDrawSeriesLineAsPath

public boolean getDrawSeriesLineAsPath()
Returns a flag that controls whether or not each series is drawn as a single path.

Returns: A boolean.

See Also: StandardXYItemRenderer

getGapThreshold

public double getGapThreshold()
Returns the gap threshold for discontinuous lines.

Returns: The gap threshold.

See Also: StandardXYItemRenderer

getGapThresholdType

public UnitType getGapThresholdType()
Returns the gap threshold type (relative or absolute).

Returns: The type.

See Also: setGapThresholdType

getImage

protected Image getImage(Plot plot, int series, int item, double x, double y)
Returns the image used to draw a single data item.

Parameters: plot the plot (can be used to obtain standard color information etc). series the series index. item the item index. x the x value of the item. y the y value of the item.

Returns: The image.

See Also: getPlotImages

getImageHotspot

protected Point getImageHotspot(Plot plot, int series, int item, double x, double y, Image image)
Returns the hotspot of the image used to draw a single data item. The hotspot is the point relative to the top left of the image that should indicate the data item. The default is the center of the image.

Parameters: plot the plot (can be used to obtain standard color information etc). image the image (can be used to get size information about the image) series the series index item the item index x the x value of the item y the y value of the item

Returns: The hotspot used to draw the data item.

getItemShapeFilled

public boolean getItemShapeFilled(int series, int item)
Returns the flag used to control whether or not the shape for an item is filled.

The default implementation passes control to the getSeriesShapesFilled method. You can override this method if you require different behaviour.

Parameters: series the series index (zero-based). item the item index (zero-based).

Returns: A boolean.

See Also: StandardXYItemRenderer

getLegendItem

public LegendItem getLegendItem(int datasetIndex, int series)
Returns a legend item for a series.

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

Returns: A legend item for the series.

getLegendLine

public Shape getLegendLine()
Returns the shape used to represent a line in the legend.

Returns: The legend line (never null).

See Also: setLegendLine

getPlotDiscontinuous

public boolean getPlotDiscontinuous()
Returns a flag that controls whether or not the renderer shows discontinuous lines.

Returns: true if lines should be discontinuous.

getPlotImages

public boolean getPlotImages()
Returns true if images are being plotted by the renderer.

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

See Also: StandardXYItemRenderer

getPlotLines

public boolean getPlotLines()
Returns true if lines are being plotted by the renderer.

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

See Also: StandardXYItemRenderer

getSeriesShapesFilled

public Boolean getSeriesShapesFilled(int series)
Returns the flag used to control whether or not the shapes for a series are filled.

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

Returns: A boolean.

getShapesFilled

public Boolean getShapesFilled()
Returns the override flag that controls whether or not shapes are filled for ALL series.

Returns: The flag (possibly null).

Since: 1.0.5

initialise

public XYItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
Initialises the renderer.

This method will be called before the first item is rendered, giving the renderer an opportunity to initialise any state information it wants to maintain. The renderer can do nothing if it chooses.

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: The renderer state.

setBaseShapesFilled

public void setBaseShapesFilled(boolean flag)
Sets the base 'shapes filled' flag.

Parameters: flag the flag.

See Also: getBaseShapesFilled

setBaseShapesVisible

public void setBaseShapesVisible(boolean flag)
Sets the flag that controls whether or not a shape is plotted at each data point.

Parameters: flag the flag.

See Also: StandardXYItemRenderer

setDrawSeriesLineAsPath

public void setDrawSeriesLineAsPath(boolean flag)
Sets the flag that controls whether or not each series is drawn as a single path.

Parameters: flag the flag.

See Also: getDrawSeriesLineAsPath

setGapThreshold

public void setGapThreshold(double t)
Sets the gap threshold for discontinuous lines.

Parameters: t the threshold.

See Also: getGapThreshold

setGapThresholdType

public void setGapThresholdType(UnitType thresholdType)
Sets the gap threshold type.

Parameters: thresholdType the type (null not permitted).

See Also: getGapThresholdType

setLegendLine

public void setLegendLine(Shape line)
Sets the shape used as a line in each legend item and sends a RendererChangeEvent to all registered listeners.

Parameters: line the line (null not permitted).

See Also: getLegendLine

setPlotDiscontinuous

public void setPlotDiscontinuous(boolean flag)
Sets the flag that controls whether or not the renderer shows discontinuous lines, and sends a RendererChangeEvent to all registered listeners.

Parameters: flag the new flag value.

Since: 1.0.5

setPlotImages

public void setPlotImages(boolean flag)
Sets the flag that controls whether or not an image is drawn at each data point.

Parameters: flag the flag.

See Also: getPlotImages

setPlotLines

public void setPlotLines(boolean flag)
Sets the flag that controls whether or not a line is plotted between each data point.

Parameters: flag the flag.

See Also: getPlotLines

setSeriesShapesFilled

public void setSeriesShapesFilled(int series, Boolean flag)
Sets the 'shapes filled' flag for a series.

Parameters: series the series index (zero-based). flag the flag.

See Also: StandardXYItemRenderer

setShapesFilled

public void setShapesFilled(boolean filled)
Sets the 'shapes filled' for ALL series.

Parameters: filled the flag.

See Also: setShapesFilled

setShapesFilled

public void setShapesFilled(Boolean filled)
Sets the override flag that controls whether or not shapes are filled for ALL series and sends a RendererChangeEvent to all registered listeners.

Parameters: filled the flag (null permitted).

See Also: StandardXYItemRenderer