Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.block

Class BlockContainer

Implemented Interfaces:
Block, Cloneable, Drawable, PublicCloneable, Serializable
Known Direct Subclasses:
LegendItemBlockContainer
public class BlockContainer
extends AbstractBlock
implements Block, Cloneable, PublicCloneable, Serializable
A container for a collection of Block objects. The container uses an Arrangement object to handle the position of each block.

Constructor Summary

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

Method Summary

void
add(Block block)
Adds a block to the container.
void
add(Block block, Object key)
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.
void
draw(Graphics2D g2, Rectangle2D area)
Draws the container and all the blocks within it.
Object
draw(Graphics2D g2, Rectangle2D area, Object params)
Draws the block within the specified area.
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.

Methods inherited from class org.jfree.chart.block.AbstractBlock

arrange, arrange, calculateTotalHeight, calculateTotalWidth, clone, drawBorder, equals, getBorder, getBounds, getContentXOffset, getContentYOffset, getFrame, getHeight, getID, getMargin, getPadding, getWidth, setBorder, setBorder, setBounds, setFrame, setHeight, setID, setMargin, setMargin, setPadding, setPadding, setWidth, toContentConstraint, trimBorder, trimMargin, trimPadding, trimToContentHeight, trimToContentWidth

Constructor Details

BlockContainer

public BlockContainer()
Creates a new instance with default settings.

BlockContainer

public BlockContainer(Arrangement arrangement)
Creates a new instance with the specified arrangement.
Parameters:
arrangement - the arrangement manager (null not permitted).

Method Details

add

public void add(Block block)
Adds a block to the container.
Parameters:
block - the block (null permitted).

add

public void add(Block block,
                Object key)
Adds a block to the container.
Parameters:
block - the block (null permitted).
key - the key (null permitted).

arrange

public Size2D arrange(Graphics2D g2,
                      RectangleConstraint constraint)
Arranges the contents of the block, within the given constraints, and returns the block size.
Specified by:
arrange in interface Block
Overrides:
arrange in interface AbstractBlock
Parameters:
g2 - the graphics device.
constraint - the constraint (null not permitted).
Returns:
The block size (in Java2D units, never null).

clear

public void clear()
Clears all the blocks from the container.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of the container.
Overrides:
clone in interface AbstractBlock
Returns:
A clone.

draw

public void draw(Graphics2D g2,
                 Rectangle2D area)
Draws the container and all the blocks within it.
Parameters:
g2 - the graphics device.
area - the area.

draw

public Object draw(Graphics2D g2,
                   Rectangle2D area,
                   Object params)
Draws the block within the specified area.
Specified by:
draw in interface Block
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.

equals

public boolean equals(Object obj)
Tests this container for equality with an arbitrary object.
Overrides:
equals in interface AbstractBlock
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getArrangement

public Arrangement getArrangement()
Returns the arrangement (layout) manager for the container.
Returns:
The arrangement manager (never null).

getBlocks

public List getBlocks()
Returns an unmodifiable list of the Block objects managed by this arrangement.
Returns:
A list of blocks.

isEmpty

public boolean isEmpty()
Returns true if there are no blocks in the container, and false otherwise.
Returns:
A boolean.

setArrangement

public void setArrangement(Arrangement arrangement)
Sets the arrangement (layout) manager.
Parameters:
arrangement - the arrangement (null not permitted).

Overview Package Class Use Source Tree Index Deprecated About