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

public class

BlockContainer

extends AbstractBlock
implements Serializable Cloneable Block

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

Known Direct Subclasses

LegendItemBlockContainer

Class Overview

A container for a collection of Block objects. The container uses an Arrangement object to handle the position of each block.

Summary

Public Constructors
	BlockContainer() Creates a new instance with default settings.
	BlockContainer(Arrangement arrangement) Creates a new instance with the specified arrangement.

Public Methods
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.

[Expand]

Inherited Methods

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 BlockContainer ()

Creates a new instance with default settings.

public BlockContainer (Arrangement arrangement)

Creates a new instance with the specified arrangement.

Parameters

arrangement	the arrangement manager (`null` not permitted).

Public Methods

public void add (Block block, Object key)

Adds a block to the container.

Parameters

block	the block (`null` permitted).
key	the key (`null` permitted).

public void add (Block block)

Adds a block to the container.

Parameters

block	the block (`null` permitted).

public Size2D arrange (Graphics2D g2, RectangleConstraint constraint)

Arranges the contents of the block, within the given constraints, and returns the block size.

Parameters

g2	the graphics device.
constraint	the constraint (`null` not permitted).

Returns

The block size (in Java2D units, never null).

public void clear ()

Clears all the blocks from the container.

public Object clone ()

Returns a clone of the container.

Returns

A clone.

Throws

CloneNotSupportedException	if there is a problem cloning.

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 void draw (Graphics2D g2, Rectangle2D area)

Draws the container and all the blocks within it.

Parameters

g2	the graphics device.
area	the area.

public boolean equals (Object obj)

Tests this container for equality with an arbitrary object.

Parameters

obj	the object (`null` permitted).

Returns

A boolean.

public Arrangement getArrangement ()

Returns the arrangement (layout) manager for the container.

Returns

The arrangement manager (never null).

public List getBlocks ()

Returns an unmodifiable list of the Block objects managed by this arrangement.

Returns

A list of blocks.

public boolean isEmpty ()

Returns true if there are no blocks in the container, and false otherwise.

Returns

A boolean.

public void setArrangement (Arrangement arrangement)

Sets the arrangement (layout) manager.

Parameters

arrangement	the arrangement (`null` not permitted).

Interfaces

Classes

BlockContainer

Class Overview

Summary

Public Constructors

public BlockContainer ()

public BlockContainer (Arrangement arrangement)

Parameters

Public Methods

public void add (Block block, Object key)

Parameters

public void add (Block block)

Parameters

public Size2D arrange (Graphics2D g2, RectangleConstraint constraint)

Parameters

Returns

public void clear ()

public Object clone ()

Returns

Throws

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

Parameters

Returns

public void draw (Graphics2D g2, Rectangle2D area)

Parameters

public boolean equals (Object obj)

Parameters

Returns

public Arrangement getArrangement ()

Returns

public List getBlocks ()

Returns

public boolean isEmpty ()

Returns

public void setArrangement (Arrangement arrangement)

Parameters