org.jfree.chart.block

Class BorderArrangement

Implemented Interfaces:
Arrangement, Serializable

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

An arrangement manager that lays out blocks in a similar way to Swing's BorderLayout class.

Constructor Summary

BorderArrangement()
Creates a new instance.

Method Summary

void
add(Block block, Object key)
Adds a block to the arrangement manager at the specified edge.
Size2D
arrange(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the items in the specified container, subject to the given constraint.
protected Size2D
arrangeFF(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the items within a container.
protected Size2D
arrangeFN(BlockContainer container, Graphics2D g2, double width)
Arranges the container width a fixed width and no constraint on the height.
protected Size2D
arrangeFR(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Performs an arrangement with a fixed width and a range for the height.
protected Size2D
arrangeNN(BlockContainer container, Graphics2D g2)
Performs an arrangement without constraints.
protected Size2D
arrangeRR(BlockContainer container, Range widthRange, Range heightRange, Graphics2D g2)
Performs an arrangement with range constraints on both the vertical and horizontal sides.
void
clear()
Clears the layout.
boolean
equals(Object obj)
Tests this arrangement for equality with an arbitrary object.

Constructor Details

BorderArrangement

public BorderArrangement()
Creates a new instance.

Method Details

add

public void add(Block block,
                Object key)
Adds a block to the arrangement manager at the specified edge.
Specified by:
add in interface Arrangement
Parameters:
block - the block (null permitted).
key - the edge (an instance of RectangleEdge) or null for the center block.

arrange

public Size2D arrange(BlockContainer container,
                      Graphics2D g2,
                      RectangleConstraint constraint)
Arranges the items in 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 block size.

arrangeFF

protected Size2D arrangeFF(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Arranges the items within a container.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The container size after the arrangement.

arrangeFN

protected Size2D arrangeFN(BlockContainer container,
                           Graphics2D g2,
                           double width)
Arranges the container width a fixed width and no constraint on the height.
Parameters:
container - the container.
g2 - the graphics device.
width - the fixed width.
Returns:
The container size after arranging the contents.

arrangeFR

protected Size2D arrangeFR(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Performs an arrangement with a fixed width and a range for the height.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The container size after the arrangement.

arrangeNN

protected Size2D arrangeNN(BlockContainer container,
                           Graphics2D g2)
Performs an arrangement without constraints.
Parameters:
container - the container.
g2 - the graphics device.
Returns:
The container size after the arrangement.

arrangeRR

protected Size2D arrangeRR(BlockContainer container,
                           Range widthRange,
                           Range heightRange,
                           Graphics2D g2)
Performs an arrangement with range constraints on both the vertical and horizontal sides.
Parameters:
container - the container.
widthRange - the allowable range for the container width.
heightRange - the allowable range for the container height.
g2 - the graphics device.
Returns:
The container size.

clear

public void clear()
Clears the layout.
Specified by:
clear in interface Arrangement

equals

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