Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

LegendItemBlockContainer

extends BlockContainer

java.lang.Object
↳	org.jfree.chart.block.AbstractBlock
	↳	org.jfree.chart.block.BlockContainer
		↳	org.jfree.chart.title.LegendItemBlockContainer

Class Overview

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

Summary

Public Constructors
	LegendItemBlockContainer(Arrangement arrangement, int datasetIndex, int series) This constructor is deprecated. As of 1.0.6, use the other constructor.
	LegendItemBlockContainer(Arrangement arrangement, Dataset dataset, Comparable seriesKey) Creates a new legend item block.

Public Methods
Object	draw(Graphics2D g2, Rectangle2D area, Object params) Draws the block within the specified area.
Dataset	getDataset() Returns a reference to the dataset for the associated legend item.
int	getDatasetIndex() This method is deprecated. As of 1.0.6, use the `getDataset()` method.
int	getSeriesIndex() Returns the series index.
Comparable	getSeriesKey() Returns the series key.
String	getToolTipText() Returns the tool tip text.
String	getURLText() Returns the URL text.
void	setToolTipText(String text) Sets the tool tip text.
void	setURLText(String text) Sets the URL text.

[Expand]

Inherited Methods

From class org.jfree.chart.block.BlockContainer

void	add(Block block, Object key) Adds a block to the container.
void	add(Block block) Adds a block to the container.
Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
void	clear() Clears all the blocks from the container.
Object	clone() Returns a clone of the container.
Object	draw(Graphics2D g2, Rectangle2D area, Object params) Draws the block within the specified area.
void	draw(Graphics2D g2, Rectangle2D area) Draws the container and all the blocks within it.
boolean	equals(Object obj) Tests this container for equality with an arbitrary object.
Arrangement	getArrangement() Returns the arrangement (layout) manager for the container.
List	getBlocks() Returns an unmodifiable list of the `Block` objects managed by this arrangement.
boolean	isEmpty() Returns `true` if there are no blocks in the container, and `false` otherwise.
void	setArrangement(Arrangement arrangement) Sets the arrangement (layout) manager.

From class org.jfree.chart.block.AbstractBlock

Size2D	arrange(Graphics2D g2) Arranges the contents of the block, with no constraints, and returns the block size.
Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
double	calculateTotalHeight(double contentHeight) Adds the margin, border and padding to the specified content height.
double	calculateTotalWidth(double contentWidth) Adds the margin, border and padding to the specified content width.
Object	clone() Returns a clone of this block.
void	drawBorder(Graphics2D g2, Rectangle2D area) Draws the border around the perimeter of the specified area.
boolean	equals(Object obj) Tests this block for equality with an arbitrary object.
BlockBorder	getBorder() This method is deprecated. Use `getFrame()` instead.
Rectangle2D	getBounds() Returns the current bounds of the block.
double	getContentXOffset() Returns the x-offset for the content within the block.
double	getContentYOffset() Returns the y-offset for the content within the block.
BlockFrame	getFrame() Returns the current frame (border).
double	getHeight() Returns the natural height of the block, if this is known in advance.
String	getID() Returns the id.
RectangleInsets	getMargin() Returns the margin.
RectangleInsets	getPadding() Returns the padding.
double	getWidth() Returns the natural width of the block, if this is known in advance.
void	setBorder(BlockBorder border) This method is deprecated. Use `setFrame(BlockFrame)` instead.
void	setBorder(double top, double left, double bottom, double right) Sets a black border with the specified line widths.
void	setBounds(Rectangle2D bounds) Sets the bounds of the block.
void	setFrame(BlockFrame frame) Sets the frame (or border).
void	setHeight(double height) Sets the natural width of the block, if this is known in advance.
void	setID(String id) Sets the id for the block.
void	setMargin(RectangleInsets margin) Sets the margin (use RectangleInsets#ZERO_INSETS for no padding).
void	setMargin(double top, double left, double bottom, double right) Sets the margin.
void	setPadding(double top, double left, double bottom, double right) Sets the padding.
void	setPadding(RectangleInsets padding) Sets the padding (use RectangleInsets#ZERO_INSETS for no padding).
void	setWidth(double width) Sets the natural width of the block, if this is known in advance.
RectangleConstraint	toContentConstraint(RectangleConstraint c) Returns a constraint for the content of this block that will result in the bounds of the block matching the specified constraint.
Rectangle2D	trimBorder(Rectangle2D area) Reduces the specified area by the amount of space consumed by the border.
Rectangle2D	trimMargin(Rectangle2D area) Reduces the specified area by the amount of space consumed by the margin.
Rectangle2D	trimPadding(Rectangle2D area) Reduces the specified area by the amount of space consumed by the padding.
double	trimToContentHeight(double fixedHeight) Calculate the height available for content after subtracting the margin, border and padding space from the specified fixed height.
double	trimToContentWidth(double fixedWidth) Calculate the width available for content after subtracting the margin, border and padding space from the specified fixed width.

From class java.lang.Object

From interface org.jfree.chart.block.Block

Public Constructors

public LegendItemBlockContainer (Arrangement arrangement, int datasetIndex, int series)

This constructor is deprecated.
As of 1.0.6, use the other constructor.

Creates a new legend item block.

Parameters

arrangement	the arrangement.
datasetIndex	the dataset index.
series	the series index.

public LegendItemBlockContainer (Arrangement arrangement, Dataset dataset, Comparable seriesKey)

Creates a new legend item block.

Parameters

arrangement	the arrangement.
dataset	the dataset.
seriesKey	the series key.

Public Methods

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.

public Dataset getDataset ()

Returns a reference to the dataset for the associated legend item.

Returns

A dataset reference.

public int getDatasetIndex ()

This method is deprecated.
As of 1.0.6, use the getDataset() method.

Returns the dataset index.

Returns

The dataset index.

public int getSeriesIndex ()

Returns the series index.

Returns

The series index.

public Comparable getSeriesKey ()

Returns the series key.

Returns

The series key.

public String getToolTipText ()

Returns the tool tip text.

Returns

The tool tip text (possibly null).

public String getURLText ()

Returns the URL text.

Returns

The URL text (possibly null).

public void setToolTipText (String text)

Sets the tool tip text.

Parameters

text	the text (`null` permitted).

public void setURLText (String text)

Sets the URL text.

Parameters

text	the text (`null` permitted).

Classes

LegendItemBlockContainer

Class Overview

Summary

Public Constructors

public LegendItemBlockContainer (Arrangement arrangement, int datasetIndex, int series)

Parameters

public LegendItemBlockContainer (Arrangement arrangement, Dataset dataset, Comparable seriesKey)

Parameters

Public Methods

public Object draw (Graphics2D g2, Rectangle2D area, Object params)

Parameters

Returns

public Dataset getDataset ()

Returns

public int getDatasetIndex ()

Returns

public int getSeriesIndex ()

Returns

public Comparable getSeriesKey ()

Returns

public String getToolTipText ()

Returns

public String getURLText ()

Returns

public void setToolTipText (String text)

Parameters

public void setURLText (String text)

Parameters