public class

StandardXYItemRenderer

extends AbstractXYItemRenderer
implements Serializable Cloneable XYItemRenderer
java.lang.Object
   ↳ org.jfree.chart.renderer.AbstractRenderer
     ↳ org.jfree.chart.renderer.xy.AbstractXYItemRenderer
       ↳ org.jfree.chart.renderer.xy.StandardXYItemRenderer
Known Direct Subclasses

Class Overview

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.

Summary

Nested Classes
class StandardXYItemRenderer.State Records the state for the renderer. 
Constants
int DISCONTINUOUS Constant for the type of rendering (discontinuous lines).
int DISCONTINUOUS_LINES Constant for the type of rendering (discontinuous lines).
int IMAGES Constant for the type of rendering (images only).
int LINES Constant for the type of rendering (lines only).
int SHAPES Constant for the type of rendering (shapes only).
int SHAPES_AND_LINES Constant for the type of rendering (shapes and lines).
[Expand]
Inherited Fields
From class org.jfree.chart.renderer.AbstractRenderer
Public Constructors
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.
Public Methods
Object clone()
Returns a clone of the renderer.
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 another object.
boolean getBaseShapesFilled()
Returns the base 'shape filled' attribute.
boolean getBaseShapesVisible()
Returns true if shapes are being plotted by the renderer.
boolean getDrawSeriesLineAsPath()
Returns a flag that controls whether or not each series is drawn as a single path.
double getGapThreshold()
Returns the gap threshold for discontinuous lines.
UnitType getGapThresholdType()
Returns the gap threshold type (relative or absolute).
boolean getItemShapeFilled(int series, int item)
Returns the flag used to control whether or not the shape for an item is filled.
LegendItem getLegendItem(int datasetIndex, int series)
Returns a legend item for a series.
Shape getLegendLine()
Returns the shape used to represent a line in the legend.
boolean getPlotDiscontinuous()
Returns a flag that controls whether or not the renderer shows discontinuous lines.
boolean getPlotImages()
Returns true if images are being plotted by the renderer.
boolean getPlotLines()
Returns true if lines are being plotted by the renderer.
Boolean getSeriesShapesFilled(int series)
Returns the flag used to control whether or not the shapes for a series are filled.
Boolean getShapesFilled()
This method is deprecated. As of 1.0.8, you should avoid using this method and rely on just the per-series (getSeriesShapesFilled(int)) and base-level (getBaseShapesFilled()) settings.
XYItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
Initialises the renderer.
void setBaseShapesFilled(boolean flag)
Sets the base 'shapes filled' flag and sends a RendererChangeEvent to all registered listeners.
void setBaseShapesVisible(boolean flag)
Sets the flag that controls whether or not a shape is plotted at each data point.
void setDrawSeriesLineAsPath(boolean flag)
Sets the flag that controls whether or not each series is drawn as a single path.
void setGapThreshold(double t)
Sets the gap threshold for discontinuous lines and sends a RendererChangeEvent to all registered listeners.
void setGapThresholdType(UnitType thresholdType)
Sets the gap threshold type and sends a RendererChangeEvent to all registered listeners.
void setLegendLine(Shape line)
Sets the shape used as a line in each legend item and sends a RendererChangeEvent to all registered listeners.
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.
void setPlotImages(boolean flag)
Sets the flag that controls whether or not an image is drawn at each data point and sends a RendererChangeEvent to all registered listeners.
void setPlotLines(boolean flag)
Sets the flag that controls whether or not a line is plotted between each data point and sends a RendererChangeEvent to all registered listeners.
void setSeriesShapesFilled(int series, Boolean flag)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setShapesFilled(boolean filled)
This method is deprecated. As of 1.0.8, you should avoid using this method and rely on just the per-series (setSeriesShapesFilled(int, Boolean)) and base-level (setBaseShapesVisible(boolean)) settings.
void setShapesFilled(Boolean filled)
This method is deprecated. As of 1.0.8, you should avoid using this method and rely on just the per-series (setSeriesShapesFilled(int, Boolean)) and base-level (setBaseShapesVisible(boolean)) settings.
Protected Methods
Image getImage(Plot plot, int series, int item, double x, double y)
Returns the image used to draw a single data item.
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.
[Expand]
Inherited Methods
From class org.jfree.chart.renderer.xy.AbstractXYItemRenderer
From class org.jfree.chart.renderer.AbstractRenderer
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.renderer.xy.XYItemRenderer

Constants

public static final int DISCONTINUOUS

Constant for the type of rendering (discontinuous lines).

Constant Value: 8 (0x00000008)

public static final int DISCONTINUOUS_LINES

Constant for the type of rendering (discontinuous lines).

Constant Value: 10 (0x0000000a)

public static final int IMAGES

Constant for the type of rendering (images only).

Constant Value: 4 (0x00000004)

public static final int LINES

Constant for the type of rendering (lines only).

Constant Value: 2 (0x00000002)

public static final int SHAPES

Constant for the type of rendering (shapes only).

Constant Value: 1 (0x00000001)

public static final int SHAPES_AND_LINES

Constant for the type of rendering (shapes and lines).

Constant Value: 3 (0x00000003)

Public Constructors

public StandardXYItemRenderer ()

Constructs a new renderer.

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.

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

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.

Public Methods

public Object clone ()

Returns a clone of the renderer.

Returns
  • A clone.
Throws
CloneNotSupportedException if the renderer cannot be cloned.

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.

public boolean equals (Object obj)

Tests this renderer for equality with another object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public boolean getBaseShapesFilled ()

Returns the base 'shape filled' attribute.

Returns
  • The base flag.
See Also

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

public boolean getDrawSeriesLineAsPath ()

Returns a flag that controls whether or not each series is drawn as a single path.

Returns
  • A boolean.
See Also

public double getGapThreshold ()

Returns the gap threshold for discontinuous lines.

Returns
  • The gap threshold.
See Also

public UnitType getGapThresholdType ()

Returns the gap threshold type (relative or absolute).

Returns
  • The type.
See Also

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

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.

public Shape getLegendLine ()

Returns the shape used to represent a line in the legend.

Returns
  • The legend line (never null).
See Also

public boolean getPlotDiscontinuous ()

Returns a flag that controls whether or not the renderer shows discontinuous lines.

Returns
  • true if lines should be discontinuous.

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

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

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.

public Boolean getShapesFilled ()

This method is deprecated.
As of 1.0.8, you should avoid using this method and rely on just the per-series (getSeriesShapesFilled(int)) and base-level (getBaseShapesFilled()) settings.

Returns the override flag that controls whether or not shapes are filled for ALL series.

Returns
  • The flag (possibly null).

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.

public void setBaseShapesFilled (boolean flag)

Sets the base 'shapes filled' flag and sends a RendererChangeEvent to all registered listeners.

Parameters
flag the flag.
See Also

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

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

public void setGapThreshold (double t)

Sets the gap threshold for discontinuous lines and sends a RendererChangeEvent to all registered listeners.

Parameters
t the threshold.
See Also

public void setGapThresholdType (UnitType thresholdType)

Sets the gap threshold type and sends a RendererChangeEvent to all registered listeners.

Parameters
thresholdType the type (null not permitted).
See Also

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

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.

public void setPlotImages (boolean flag)

Sets the flag that controls whether or not an image is drawn at each data point and sends a RendererChangeEvent to all registered listeners.

Parameters
flag the flag.
See Also

public void setPlotLines (boolean flag)

Sets the flag that controls whether or not a line is plotted between each data point and sends a RendererChangeEvent to all registered listeners.

Parameters
flag the flag.
See Also

public void setSeriesShapesFilled (int series, Boolean flag)

Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.

Parameters
series the series index (zero-based).
flag the flag.
See Also

public void setShapesFilled (boolean filled)

This method is deprecated.
As of 1.0.8, you should avoid using this method and rely on just the per-series (setSeriesShapesFilled(int, Boolean)) and base-level (setBaseShapesVisible(boolean)) settings.

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.
See Also

public void setShapesFilled (Boolean filled)

This method is deprecated.
As of 1.0.8, you should avoid using this method and rely on just the per-series (setSeriesShapesFilled(int, Boolean)) and base-level (setBaseShapesVisible(boolean)) settings.

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

Protected Methods

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

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).
series the series index
item the item index
x the x value of the item
y the y value of the item
image the image (can be used to get size information about the image)
Returns
  • The hotspot used to draw the data item.