org.jfree.chart.block

Class GridArrangement

Implemented Interfaces:
Arrangement, Serializable

public class GridArrangement
extends java.lang.Object
implements Arrangement, Serializable

Arranges blocks in a grid within their container.

Constructor Summary

GridArrangement(int rows, int columns)
Creates a new grid arrangement.

Method Summary

void
add(Block block, Object key)
Adds a block and a key which can be used to determine the position of the block in the arrangement.
Size2D
arrange(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the blocks within the specified container, subject to the given constraint.
protected Size2D
arrangeFF(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the container with a fixed overall width and height.
protected Size2D
arrangeFN(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arrange with a fixed width and a height within a given range.
protected Size2D
arrangeFR(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arrange with a fixed width and a height within a given range.
protected Size2D
arrangeNN(BlockContainer container, Graphics2D g2)
Arranges the container with no constraint on the width or height.
void
clear()
Clears any cached layout information retained by the arrangement.
boolean
equals(Object obj)
Compares this layout manager for equality with an arbitrary object.

Constructor Details

GridArrangement

public GridArrangement(int rows,
                       int columns)
Creates a new grid arrangement.
Parameters:
rows - the row count.
columns - the column count.

Method Details

add

public void add(Block block,
                Object key)
Adds a block and a key which can be used to determine the position of the block in the arrangement. This method is called by the container (you don't need to call this method directly) and gives the arrangement an opportunity to record the details if they are required.
Specified by:
add in interface Arrangement
Parameters:
block - the block.
key - the key (null permitted).

arrange

public Size2D arrange(BlockContainer container,
                      Graphics2D g2,
                      RectangleConstraint constraint)
Arranges the blocks within the specified container, subject to the given constraint.
Specified by:
arrange in interface Arrangement
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size following the arrangement.

arrangeFF

protected Size2D arrangeFF(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Arranges the container with a fixed overall width and height.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size following the arrangement.

arrangeFN

protected Size2D arrangeFN(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Arrange with a fixed width and a height within a given range.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size of the arrangement.

arrangeFR

protected Size2D arrangeFR(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Arrange with a fixed width and a height within a given range.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size of the arrangement.

arrangeNN

protected Size2D arrangeNN(BlockContainer container,
                           Graphics2D g2)
Arranges the container with no constraint on the width or height.
Parameters:
container - the container.
g2 - the graphics device.
Returns:
The size.

clear

public void clear()
Clears any cached layout information retained by the arrangement.
Specified by:
clear in interface Arrangement

equals

public boolean equals(Object obj)
Compares this layout manager for equality with an arbitrary object.
Parameters:
obj - the object.
Returns:
A boolean.