org.jfree.chart.renderer.category

Class ScatterRenderer

public class ScatterRenderer extends AbstractCategoryItemRenderer implements Cloneable, PublicCloneable, Serializable

A renderer that handles the multiple values from a MultiValueCategoryDataset by plotting a shape for each value for each given item in the dataset. The example shown here is generated by the ScatterRendererDemo1.java program included in the JFreeChart Demo Collection:

ScatterRendererSample.png

Since: 1.0.7

Constructor Summary
ScatterRenderer()
Constructs a new renderer.
Method Summary
Objectclone()
Returns an independent copy of the renderer.
voiddrawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draw a single data item.
booleanequals(Object obj)
Tests this renderer for equality with an arbitrary object.
booleangetBaseShapesFilled()
Returns the base 'shape filled' attribute.
booleangetDrawOutlines()
Returns true if outlines should be drawn for shapes, and false otherwise.
doublegetItemMargin()
Returns the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width).
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.
booleangetSeriesShapesFilled(int series)
Returns the flag used to control whether or not the shapes for a series are filled.
booleangetUseFillPaint()
Returns true if the renderer should use the fill paint setting to fill shapes, and false if it should just use the regular paint.
booleangetUseOutlinePaint()
Returns the flag that controls whether the outline paint is used for shape outlines.
booleangetUseSeriesOffset()
Returns the flag that controls whether or not the x-position for each data item is offset within the category according to the series.
voidsetBaseShapesFilled(boolean flag)
Sets the base 'shapes filled' flag and sends a RendererChangeEvent to all registered listeners.
voidsetDrawOutlines(boolean flag)
Sets the flag that controls whether outlines are drawn for shapes, and sends a RendererChangeEvent to all registered listeners.
voidsetItemMargin(double margin)
Sets the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width), and sends a RendererChangeEvent to all registered listeners.
voidsetSeriesShapesFilled(int series, Boolean filled)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.
voidsetSeriesShapesFilled(int series, boolean filled)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.
voidsetUseFillPaint(boolean flag)
Sets the flag that controls whether the fill paint is used to fill shapes, and sends a RendererChangeEvent to all registered listeners.
voidsetUseOutlinePaint(boolean use)
Sets the flag that controls whether the outline paint is used for shape outlines, and sends a RendererChangeEvent to all registered listeners.
voidsetUseSeriesOffset(boolean offset)
Sets the flag that controls whether or not the x-position for each data item is offset within its category according to the series, and sends a RendererChangeEvent to all registered listeners.

Constructor Detail

ScatterRenderer

public ScatterRenderer()
Constructs a new renderer.

Method Detail

clone

public Object clone()
Returns an independent copy of the renderer.

Returns: A clone.

Throws: CloneNotSupportedException should not happen.

drawItem

public void drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draw a single data item.

Parameters: g2 the graphics device. state the renderer state. dataArea the area in which the data is drawn. plot the plot. domainAxis the domain axis. rangeAxis the range axis. dataset the dataset. row the row index (zero-based). column the column index (zero-based). 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.

getBaseShapesFilled

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

Returns: The base flag.

getDrawOutlines

public boolean getDrawOutlines()
Returns true if outlines should be drawn for shapes, and false otherwise.

Returns: A boolean.

See Also: ScatterRenderer

getItemMargin

public double getItemMargin()
Returns the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width). This can be used to match the offset alignment with the bars drawn by a BarRenderer).

Returns: The item margin.

See Also: ScatterRenderer getUseSeriesOffset

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.

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: The legend item.

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.

getUseFillPaint

public boolean getUseFillPaint()
Returns true if the renderer should use the fill paint setting to fill shapes, and false if it should just use the regular paint.

Returns: A boolean.

getUseOutlinePaint

public boolean getUseOutlinePaint()
Returns the flag that controls whether the outline paint is used for shape outlines. If not, the regular series paint is used.

Returns: A boolean.

See Also: ScatterRenderer

getUseSeriesOffset

public boolean getUseSeriesOffset()
Returns the flag that controls whether or not the x-position for each data item is offset within the category according to the series.

Returns: A boolean.

See Also: ScatterRenderer

setBaseShapesFilled

public void setBaseShapesFilled(boolean flag)
Sets the base 'shapes filled' flag and sends a RendererChangeEvent to all registered listeners.

Parameters: flag the flag.

setDrawOutlines

public void setDrawOutlines(boolean flag)
Sets the flag that controls whether outlines are drawn for shapes, and sends a RendererChangeEvent to all registered listeners.

In some cases, shapes look better if they do NOT have an outline, but this flag allows you to set your own preference.

Parameters: flag the flag.

See Also: getDrawOutlines

setItemMargin

public void setItemMargin(double margin)
Sets the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width), and sends a RendererChangeEvent to all registered listeners.

Parameters: margin the margin (0.0 <= margin < 1.0).

See Also: getItemMargin getUseSeriesOffset

setSeriesShapesFilled

public void setSeriesShapesFilled(int series, Boolean filled)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.

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

setSeriesShapesFilled

public void setSeriesShapesFilled(int series, boolean filled)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.

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

setUseFillPaint

public void setUseFillPaint(boolean flag)
Sets the flag that controls whether the fill paint is used to fill shapes, and sends a RendererChangeEvent to all registered listeners.

Parameters: flag the flag.

setUseOutlinePaint

public void setUseOutlinePaint(boolean use)
Sets the flag that controls whether the outline paint is used for shape outlines, and sends a RendererChangeEvent to all registered listeners.

Parameters: use the flag.

See Also: getUseOutlinePaint

setUseSeriesOffset

public void setUseSeriesOffset(boolean offset)
Sets the flag that controls whether or not the x-position for each data item is offset within its category according to the series, and sends a RendererChangeEvent to all registered listeners.

Parameters: offset the offset.

See Also: getUseSeriesOffset

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