org.jfree.chart.block

Class ColumnArrangement

Implemented Interfaces:
Arrangement, Serializable

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

Arranges blocks in a column layout. This class is immutable.

Constructor Summary

ColumnArrangement()
Creates a new instance.
ColumnArrangement(HorizontalAlignment hAlign, VerticalAlignment vAlign, double hGap, double vGap)
Creates a new instance.

Method Summary

void
add(Block block, Object key)
Adds a block to be managed by this instance.
Size2D
arrange(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Calculates and sets the bounds of all the items in the specified container, subject to the given constraint.
protected Size2D
arrangeFF(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Calculates and sets the bounds of all the items in the specified container, subject to the given constraint.
protected Size2D
arrangeNF(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Calculates and sets the bounds of all the items in the specified container, subject to the given constraint.
protected Size2D
arrangeNN(BlockContainer container, Graphics2D g2)
Arranges the blocks without any constraints.
protected Size2D
arrangeRF(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the blocks in the container using a fixed height and a range for the width.
protected Size2D
arrangeRR(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
void
clear()
Clears any cached information.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.

Constructor Details

ColumnArrangement

public ColumnArrangement()
Creates a new instance.

ColumnArrangement

public ColumnArrangement(HorizontalAlignment hAlign,
                         VerticalAlignment vAlign,
                         double hGap,
                         double vGap)
Creates a new instance.
Parameters:
hAlign - the horizontal alignment (currently ignored).
vAlign - the vertical alignment (currently ignored).
hGap - the horizontal gap.
vGap - the vertical gap.

Method Details

add

public void add(Block block,
                Object key)
Adds a block to be managed by this instance. This method is usually called by the BlockContainer, you shouldn't need to call it directly.
Specified by:
add in interface Arrangement
Parameters:
block - the block.
key - a key that controls the position of the block.

arrange

public Size2D arrange(BlockContainer container,
                      Graphics2D g2,
                      RectangleConstraint constraint)
Calculates and sets the bounds of all the items in the specified container, subject to the given constraint. The Graphics2D can be used by some items (particularly items containing text) to calculate sizing parameters.
Specified by:
arrange in interface Arrangement
Parameters:
container - the container whose items are being arranged.
g2 - the graphics device.
constraint - the size constraint.
Returns:
The size of the container after arrangement of the contents.

arrangeFF

protected Size2D arrangeFF(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Calculates and sets the bounds of all the items in the specified container, subject to the given constraint. The Graphics2D can be used by some items (particularly items containing text) to calculate sizing parameters.
Parameters:
container - the container whose items are being arranged.
g2 - the graphics device.
constraint - the size constraint.
Returns:
The container size after the arrangement.

arrangeNF

protected Size2D arrangeNF(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Calculates and sets the bounds of all the items in the specified container, subject to the given constraint. The Graphics2D can be used by some items (particularly items containing text) to calculate sizing parameters.
Parameters:
container - the container whose items are being arranged.
g2 - the graphics device.
constraint - the size constraint.
Returns:
The container size after the arrangement.

arrangeNN

protected Size2D arrangeNN(BlockContainer container,
                           Graphics2D g2)
Arranges the blocks without any constraints. This puts all blocks into a single column.
Parameters:
container - the container.
g2 - the graphics device.
Returns:
The size after the arrangement.

arrangeRF

protected Size2D arrangeRF(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Arranges the blocks in the container using a fixed height and a range for the width.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size of the container after arrangement.

arrangeRR

protected Size2D arrangeRR(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)

clear

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

equals

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