public class

LineAndShapeRenderer

extends AbstractCategoryItemRenderer
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.renderer.AbstractRenderer
     ↳ org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
       ↳ org.jfree.chart.renderer.category.LineAndShapeRenderer
Known Direct Subclasses

Class Overview

A renderer that draws shapes for each data item, and lines between data items (for use with the CategoryPlot class). The example shown here is generated by the LineChartDemo1.java program included in the JFreeChart Demo Collection:

LineAndShapeRendererSample.png

Summary

[Expand]
Inherited Fields
From class org.jfree.chart.renderer.AbstractRenderer
Public Constructors
LineAndShapeRenderer()
Creates a renderer with both lines and shapes visible by default.
LineAndShapeRenderer(boolean lines, boolean shapes)
Creates a new renderer with lines and/or shapes visible.
Public Methods
Object clone()
Returns an independent copy of the renderer.
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.
boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.
boolean getBaseLinesVisible()
Returns the base 'lines visible' attribute.
boolean getBaseShapesFilled()
Returns the base 'shape filled' attribute.
boolean getBaseShapesVisible()
Returns the base 'shape visible' attribute.
boolean getDrawOutlines()
Returns true if outlines should be drawn for shapes, and false otherwise.
boolean getItemLineVisible(int series, int item)
Returns the flag used to control whether or not the line for an item is visible.
double getItemMargin()
Returns the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width).
boolean getItemShapeFilled(int series, int item)
Returns the flag used to control whether or not the shape for an item is filled.
boolean getItemShapeVisible(int series, int item)
Returns the flag used to control whether or not the shape for an item is visible.
LegendItem getLegendItem(int datasetIndex, int series)
Returns a legend item for a series.
Boolean getLinesVisible()
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
int getPassCount()
This renderer uses two passes to draw the data.
Boolean getSeriesLinesVisible(int series)
Returns the flag used to control whether or not the lines for a series are visible.
boolean getSeriesShapesFilled(int series)
Returns the flag used to control whether or not the shapes for a series are filled.
Boolean getSeriesShapesVisible(int series)
Returns the flag used to control whether or not the shapes for a series are visible.
Boolean getShapesFilled()
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
Boolean getShapesVisible()
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
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.
boolean getUseOutlinePaint()
Returns the flag that controls whether the outline paint is used for shape outlines.
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.
void setBaseLinesVisible(boolean flag)
Sets the base 'lines visible' flag and sends a RendererChangeEvent to all registered listeners.
void setBaseShapesFilled(boolean flag)
Sets the base 'shapes filled' flag and sends a RendererChangeEvent to all registered listeners.
void setBaseShapesVisible(boolean flag)
Sets the base 'shapes visible' flag and sends a RendererChangeEvent to all registered listeners.
void setDrawOutlines(boolean flag)
Sets the flag that controls whether outlines are drawn for shapes, and sends a RendererChangeEvent to all registered listeners.
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.
void setLinesVisible(boolean visible)
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
void setLinesVisible(Boolean visible)
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
void setSeriesLinesVisible(int series, boolean visible)
Sets the 'lines visible' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setSeriesLinesVisible(int series, Boolean flag)
Sets the 'lines visible' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setSeriesShapesFilled(int series, boolean filled)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setSeriesShapesFilled(int series, Boolean filled)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setSeriesShapesVisible(int series, Boolean flag)
Sets the 'shapes visible' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setSeriesShapesVisible(int series, boolean visible)
Sets the 'shapes visible' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setShapesFilled(boolean filled)
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
void setShapesFilled(Boolean filled)
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
void setShapesVisible(boolean visible)
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
void setShapesVisible(Boolean visible)
This method is deprecated. As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).
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.
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.
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.
[Expand]
Inherited Methods
From class org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
From class org.jfree.chart.renderer.AbstractRenderer
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.renderer.category.CategoryItemRenderer

Public Constructors

public LineAndShapeRenderer ()

Creates a renderer with both lines and shapes visible by default.

public LineAndShapeRenderer (boolean lines, boolean shapes)

Creates a new renderer with lines and/or shapes visible.

Parameters
lines draw lines?
shapes draw shapes?

Public Methods

public Object clone ()

Returns an independent copy of the renderer.

Returns
  • A clone.
Throws
CloneNotSupportedException should not happen.

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.

public boolean equals (Object obj)

Tests this renderer for equality with an arbitrary object.

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

public boolean getBaseLinesVisible ()

Returns the base 'lines visible' attribute.

Returns
  • The base flag.
See Also

public boolean getBaseShapesFilled ()

Returns the base 'shape filled' attribute.

Returns
  • The base flag.
See Also

public boolean getBaseShapesVisible ()

Returns the base 'shape visible' attribute.

Returns
  • The base flag.
See Also

public boolean getDrawOutlines ()

Returns true if outlines should be drawn for shapes, and false otherwise.

Returns
  • A boolean.
See Also

public boolean getItemLineVisible (int series, int item)

Returns the flag used to control whether or not the line for an item is visible.

Parameters
series the series index (zero-based).
item the item index (zero-based).
Returns
  • A boolean.

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

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.

public boolean getItemShapeVisible (int series, int item)

Returns the flag used to control whether or not the shape for an item is visible.

Parameters
series the series index (zero-based).
item the item index (zero-based).
Returns
  • A boolean.

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.

public Boolean getLinesVisible ()

This method is deprecated.
As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

Returns a flag that controls whether or not lines are drawn for ALL series. If this flag is null, then the "per series" settings will apply.

Returns
  • A flag (possibly null).
See Also

public int getPassCount ()

This renderer uses two passes to draw the data.

Returns
  • The pass count (2 for this renderer).

public Boolean getSeriesLinesVisible (int series)

Returns the flag used to control whether or not the lines for a series are visible.

Parameters
series the series index (zero-based).
Returns
  • The flag (possibly null).
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 getSeriesShapesVisible (int series)

Returns the flag used to control whether or not the shapes for a series are visible.

Parameters
series the series index (zero-based).
Returns
  • A boolean.
See Also

public Boolean getShapesFilled ()

This method is deprecated.
As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

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

Returns
  • A Boolean.
See Also

public Boolean getShapesVisible ()

This method is deprecated.
As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

Returns the flag that controls whether the shapes are visible for the items in ALL series.

Returns
  • The flag (possibly null).
See Also

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

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

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

public void setBaseLinesVisible (boolean flag)

Sets the base 'lines visible' flag and sends a RendererChangeEvent to all registered listeners.

Parameters
flag the flag.
See Also

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 base 'shapes visible' flag and sends a RendererChangeEvent to all registered listeners.

Parameters
flag the flag.
See Also

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

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

public void setLinesVisible (boolean visible)

This method is deprecated.
As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

Sets a flag that controls whether or not lines are drawn between the items in ALL series, and sends a RendererChangeEvent to all registered listeners.

Parameters
visible the flag.
See Also

public void setLinesVisible (Boolean visible)

This method is deprecated.
As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

Sets a flag that controls whether or not lines are drawn between the items in ALL series, and sends a RendererChangeEvent to all registered listeners. You need to set this to null if you want the "per series" settings to apply.

Parameters
visible the flag (null permitted).
See Also

public void setSeriesLinesVisible (int series, boolean visible)

Sets the 'lines visible' flag for a series and sends a RendererChangeEvent to all registered listeners.

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

public void setSeriesLinesVisible (int series, Boolean flag)

Sets the 'lines visible' flag for a series and sends a RendererChangeEvent to all registered listeners.

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

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

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

public void setSeriesShapesVisible (int series, Boolean flag)

Sets the 'shapes visible' 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 setSeriesShapesVisible (int series, boolean visible)

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

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

public void setShapesFilled (boolean filled)

This method is deprecated.
As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

Sets the 'shapes 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.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

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

Parameters
filled the flag (null permitted).
See Also

public void setShapesVisible (boolean visible)

This method is deprecated.
As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

Sets the 'shapes visible' for ALL series and sends a RendererChangeEvent to all registered listeners.

Parameters
visible the flag.
See Also

public void setShapesVisible (Boolean visible)

This method is deprecated.
As of 1.0.7 (the override facility is unnecessary, just use the per-series and base (default) settings).

Sets the 'shapes visible' for ALL series and sends a RendererChangeEvent to all registered listeners.

Parameters
visible the flag (null permitted).
See Also

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

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

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