org.jfree.chart.renderer.xy
Class StandardXYItemRenderer

java.lang.Object
  extended byorg.jfree.chart.renderer.AbstractRenderer
      extended byorg.jfree.chart.renderer.xy.AbstractXYItemRenderer
          extended byorg.jfree.chart.renderer.xy.StandardXYItemRenderer
All Implemented Interfaces:
java.lang.Cloneable, LegendItemSource, java.io.Serializable, XYItemRenderer
Direct Known Subclasses:
CyclicXYItemRenderer

public class StandardXYItemRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, java.lang.Cloneable, java.io.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.

See Also:
Serialized Form

Nested Class Summary
static class StandardXYItemRenderer.State
          Records the state for the renderer.
 
Field Summary
static int DISCONTINUOUS
          Constant for the type of rendering (discontinuous lines).
static int DISCONTINUOUS_LINES
          Constant for the type of rendering (discontinuous lines).
static int IMAGES
          Constant for the type of rendering (images only).
static int LINES
          Constant for the type of rendering (lines only).
static int SHAPES
          Constant for the type of rendering (shapes only).
static int SHAPES_AND_LINES
          Constant for 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
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
 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 another object.
 java.lang.Boolean getDefaultShapesFilled()
          Returns the default 'shape filled' attribute.
 boolean getDefaultShapesVisible()
          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).
protected  java.awt.Image getImage(Plot plot, int series, int item, double x, double y)
          Returns the image used to draw a single data item.
protected  java.awt.Point getImageHotspot(Plot plot, int series, int item, double x, double y, java.awt.Image image)
          Returns the hotspot of the image used to draw a single data item.
 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.
 boolean getPlotDiscontinuous()
          Returns true if lines should be discontinuous.
 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 getPlotShapes()
          Returns true if shapes 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.
 XYItemRendererState initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
          Initialises the renderer.
 void setDefaultShapesFilled(java.lang.Boolean flag)
          Sets the default 'shapes filled' flag.
 void setDefaultShapesVisible(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.
 void setGapThresholdType(UnitType thresholdType)
          Sets the gap threshold type.
 void setPlotImages(boolean flag)
          Sets the flag that controls whether or not an image is drawn at each data point.
 void setPlotLines(boolean flag)
          Sets the flag that controls whether or not a line is plotted between each data point.
 void setPlotShapes(boolean flag)
          Sets the flag that controls whether or not a shape is plotted at each data point.
 void setSeriesShapesFilled(int series, java.lang.Boolean flag)
          Sets the 'shapes filled' flag for a series.
 void setShapesFilled(boolean filled)
          Sets the 'shapes filled' for ALL series.
 void setShapesFilled(java.lang.Boolean filled)
          Sets the 'shapes filled' for ALL series.
 
Methods inherited from class org.jfree.chart.renderer.xy.AbstractXYItemRenderer
addAnnotation, addAnnotation, addEntity, calculateDomainMarkerTextAnchorPoint, drawAnnotations, drawDomainGridLine, drawDomainMarker, drawItemLabel, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, findRangeBounds, getBaseLabelGenerator, getBaseToolTipGenerator, getDefaultEntityRadius, getDrawingSupplier, getLabelGenerator, getLegendItemLabelGenerator, getLegendItems, getPassCount, getPlot, getSeriesLabelGenerator, getSeriesToolTipGenerator, getToolTipGenerator, getURLGenerator, removeAnnotation, removeAnnotations, setBaseLabelGenerator, setBaseToolTipGenerator, setDefaultEntityRadius, setLabelGenerator, setLegendItemLabelGenerator, setPlot, setSeriesLabelGenerator, setSeriesToolTipGenerator, setToolTipGenerator, setURLGenerator, updateCrosshairValues
 
Methods inherited from class org.jfree.chart.renderer.AbstractRenderer
addChangeListener, calculateLabelAnchorPoint, getBaseCreateEntities, getBaseFillPaint, getBaseItemLabelFont, getBaseItemLabelPaint, getBaseItemLabelsVisible, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseSeriesVisible, getBaseSeriesVisibleInLegend, getBaseShape, getBaseStroke, getCreateEntities, getItemCreateEntity, getItemFillPaint, getItemLabelAnchorOffset, getItemLabelFont, getItemLabelFont, getItemLabelPaint, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesVisible, getSeriesVisible, getSeriesVisibleInLegend, getSeriesVisibleInLegend, hashCode, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisibleInLegend, notifyListeners, removeChangeListener, setBaseCreateEntities, setBaseCreateEntities, setBaseFillPaint, setBaseFillPaint, setBaseItemLabelFont, setBaseItemLabelFont, setBaseItemLabelPaint, setBaseItemLabelPaint, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlinePaint, setBaseOutlineStroke, setBaseOutlineStroke, setBasePaint, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseSeriesVisible, setBaseSeriesVisible, setBaseSeriesVisibleInLegend, setBaseSeriesVisibleInLegend, setBaseShape, setBaseShape, setBaseStroke, setBaseStroke, setCreateEntities, setCreateEntities, setFillPaint, setFillPaint, setItemLabelAnchorOffset, setItemLabelFont, setItemLabelFont, setItemLabelPaint, setItemLabelPaint, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, 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
finalize, 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, getBaseItemLabelPaint, getBaseItemLabelsVisible, getBaseLabelGenerator, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseSeriesVisible, getBaseSeriesVisibleInLegend, getBaseShape, getBaseStroke, getBaseToolTipGenerator, getItemLabelFont, getItemLabelFont, getItemLabelPaint, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLabelGenerator, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPassCount, getPlot, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesLabelGenerator, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesToolTipGenerator, getSeriesVisible, getSeriesVisible, getSeriesVisibleInLegend, getSeriesVisibleInLegend, getToolTipGenerator, getURLGenerator, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisibleInLegend, removeAnnotation, removeAnnotations, removeChangeListener, setBaseItemLabelFont, setBaseItemLabelPaint, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseLabelGenerator, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlineStroke, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseSeriesVisible, setBaseSeriesVisible, setBaseSeriesVisibleInLegend, setBaseSeriesVisibleInLegend, setBaseShape, setBaseStroke, setBaseToolTipGenerator, setItemLabelFont, setItemLabelPaint, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setLabelGenerator, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlineStroke, setPaint, setPlot, setPositiveItemLabelPosition, setPositiveItemLabelPosition, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesLabelGenerator, 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
Constant for the type of rendering (shapes only).

See Also:
Constant Field Values

LINES

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

See Also:
Constant Field Values

SHAPES_AND_LINES

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

See Also:
Constant Field Values

IMAGES

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

See Also:
Constant Field Values

DISCONTINUOUS

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

See Also:
Constant Field Values

DISCONTINUOUS_LINES

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

See Also:
Constant Field Values
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

getDefaultShapesVisible

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

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

setDefaultShapesVisible

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

Parameters:
flag - the flag.

getPlotShapes

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

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

setPlotShapes

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

Parameters:
flag - the flag.

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.

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.

setShapesFilled

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

Parameters:
filled - the flag.

setShapesFilled

public void setShapesFilled(java.lang.Boolean filled)
Sets the 'shapes filled' for ALL series.

Parameters:
filled - the flag (null permitted).

setSeriesShapesFilled

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

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

getDefaultShapesFilled

public java.lang.Boolean getDefaultShapesFilled()
Returns the default 'shape filled' attribute.

Returns:
The default flag.

setDefaultShapesFilled

public void setDefaultShapesFilled(java.lang.Boolean flag)
Sets the default 'shapes filled' flag.

Parameters:
flag - the flag.

getPlotLines

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

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

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.

getGapThresholdType

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

Returns:
The type.

setGapThresholdType

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

Parameters:
thresholdType - the type (null not permitted).

getGapThreshold

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

Returns:
The gap threshold.

setGapThreshold

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

Parameters:
t - the threshold.

getPlotImages

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

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

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.

getPlotDiscontinuous

public boolean getPlotDiscontinuous()
Returns true if lines should be discontinuous.

Returns:
true if lines should be discontinuous.

getDrawSeriesLineAsPath

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

Returns:
A boolean.

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.

getLegendItem

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

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.

initialise

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

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

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.

equals

public boolean equals(java.lang.Object obj)
Tests this renderer for equality with another object.

Overrides:
equals in class AbstractXYItemRenderer
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a clone of the renderer.

Overrides:
clone in class AbstractXYItemRenderer
Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - if the renderer cannot be cloned.

getImage

protected java.awt.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.

getImageHotspot

protected java.awt.Point getImageHotspot(Plot plot,
                                         int series,
                                         int item,
                                         double x,
                                         double y,
                                         java.awt.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.