org.jfree.chart.block

Class ColumnArrangement

java.lang.Object

org.jfree.chart.block.ColumnArrangement

All Implemented Interfaces:

Serializable, Arrangement

public class ColumnArrangement
extends Object
implements Arrangement, Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ColumnArrangement() Creates a new instance.
ColumnArrangement(org.jfree.ui.HorizontalAlignment hAlign, org.jfree.ui.VerticalAlignment vAlign, double hGap, double vGap) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	add(Block block, Object key) Adds a block to be managed by this instance.
org.jfree.ui.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.
void	clear() Clears any cached information.
boolean	equals(Object obj) Tests this instance for equality with an arbitrary object.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColumnArrangement

public ColumnArrangement()

Creates a new instance.

ColumnArrangement

public ColumnArrangement(org.jfree.ui.HorizontalAlignment hAlign,
                         org.jfree.ui.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 Detail

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 org.jfree.ui.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.

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.

Overrides:

equals in class Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.