org.jfree.chart.block

Class FlowArrangement

Implemented Interfaces:
Arrangement, Serializable

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

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

Constructor Summary

FlowArrangement()
Creates a new instance.
FlowArrangement(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)
Arranges the blocks in the container with the overall height and width specified as fixed constraints.
protected Size2D
arrangeFN(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the blocks in the container with a fixed width and no height constraint.
protected Size2D
arrangeFR(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the blocks in the container with a fixed width and a range constraint on the height.
protected Size2D
arrangeNF(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the blocks with no width constraint and a fixed height 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 with a range constraint on the width and a fixed height.
protected Size2D
arrangeRN(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the block with a range constraint on the width, and no constraint on the height.
protected Size2D
arrangeRR(BlockContainer container, Graphics2D g2, RectangleConstraint constraint)
Arranges the blocks with the overall width and height to fit within specified ranges.
void
clear()
Clears any cached information.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.

Constructor Details

FlowArrangement

public FlowArrangement()
Creates a new instance.

FlowArrangement

public FlowArrangement(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)
Arranges the blocks in the container with the overall height and width specified as fixed constraints.
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)
Arranges the blocks in the container with a fixed width and no height constraint.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size.

arrangeFR

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

arrangeNF

protected Size2D arrangeNF(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Arranges the blocks with no width constraint and a fixed height constraint. This puts all blocks into a single row.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The 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 row.
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 with a range constraint on the width and a fixed height.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size following the arrangement.

arrangeRN

protected Size2D arrangeRN(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Arranges the block with a range constraint on the width, and no constraint on the height.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size following the arrangement.

arrangeRR

protected Size2D arrangeRR(BlockContainer container,
                           Graphics2D g2,
                           RectangleConstraint constraint)
Arranges the blocks with the overall width and height to fit within specified ranges.
Parameters:
container - the container.
g2 - the graphics device.
constraint - the constraint.
Returns:
The size after the arrangement.

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.