org.jfree.chart.title

Class LegendItemBlockContainer

public class LegendItemBlockContainer extends BlockContainer

A container that holds all the pieces of a single legend item.

Since: 1.0.2

Constructor Summary
LegendItemBlockContainer(Arrangement arrangement, int dataset, int series)
Creates a new legend item block.
Method Summary
Objectdraw(Graphics2D g2, Rectangle2D area, Object params)
Draws the block within the specified area.
intgetDatasetIndex()
Returns the dataset index.
intgetSeriesIndex()
Returns the series index.
StringgetToolTipText()
Returns the tool tip text.
StringgetURLText()
Returns the URL text.
voidsetToolTipText(String text)
Sets the tool tip text.
voidsetURLText(String text)
Sets the URL text.

Constructor Detail

LegendItemBlockContainer

public LegendItemBlockContainer(Arrangement arrangement, int dataset, int series)
Creates a new legend item block.

Parameters: arrangement dataset series

Method Detail

draw

public Object draw(Graphics2D g2, Rectangle2D area, Object params)
Draws the block within the specified area.

Parameters: g2 the graphics device. area the area. params passed on to blocks within the container (null permitted).

Returns: An instance of EntityBlockResult, or null.

getDatasetIndex

public int getDatasetIndex()
Returns the dataset index.

Returns: The dataset index.

getSeriesIndex

public int getSeriesIndex()
Returns the series index.

Returns: The series index.

getToolTipText

public String getToolTipText()
Returns the tool tip text.

Returns: The tool tip text (possibly null).

Since: 1.0.3

getURLText

public String getURLText()
Returns the URL text.

Returns: The URL text (possibly null).

Since: 1.0.3

setToolTipText

public void setToolTipText(String text)
Sets the tool tip text.

Parameters: text the text (null permitted).

Since: 1.0.3

setURLText

public void setURLText(String text)
Sets the URL text.

Parameters: text the text (null permitted).

Since: 1.0.3