org.jfree.chart.block
Class ColumnArrangement

java.lang.Object
  extended byorg.jfree.chart.block.ColumnArrangement
All Implemented Interfaces:
Arrangement, java.io.Serializable

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

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

See Also:
Serialized Form

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, java.lang.Object key)
          Adds a block to be managed by this instance.
 Size2D arrange(BlockContainer container, RectangleConstraint constraint, java.awt.Graphics2D g2)
          Calculates and sets the bounds of all the items in the specified container, subject to the given constraint.
protected  Size2D arrangeFF(BlockContainer container, RectangleConstraint constraint, java.awt.Graphics2D g2)
          Calculates and sets the bounds of all the items in the specified container, subject to the given constraint.
protected  Size2D arrangeNF(BlockContainer container, RectangleConstraint constraint, java.awt.Graphics2D g2)
          Calculates and sets the bounds of all the items in the specified container, subject to the given constraint.
protected  Size2D arrangeNN(BlockContainer container, java.awt.Graphics2D g2)
          Arranges the blocks without any constraints.
protected  Size2D arrangeRF(BlockContainer container, RectangleConstraint constraint, java.awt.Graphics2D g2)
           
protected  Size2D arrangeRR(BlockContainer container, RectangleConstraint constraint, java.awt.Graphics2D g2)
           
 void clear()
          Clears any cached information.
 boolean equals(java.lang.Object obj)
          Tests this instance for equality with an arbitrary object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 Detail

add

public void add(Block block,
                java.lang.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,
                      RectangleConstraint constraint,
                      java.awt.Graphics2D g2)
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.
constraint - the size constraint.
g2 - the graphics device.
Returns:
The size of the container after arrangement of the contents.

arrangeFF

protected Size2D arrangeFF(BlockContainer container,
                           RectangleConstraint constraint,
                           java.awt.Graphics2D g2)
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.
constraint - the size constraint.
g2 - the graphics device.

arrangeNF

protected Size2D arrangeNF(BlockContainer container,
                           RectangleConstraint constraint,
                           java.awt.Graphics2D g2)
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.
constraint - the size constraint.
g2 - the graphics device.

arrangeRR

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

arrangeRF

protected Size2D arrangeRF(BlockContainer container,
                           RectangleConstraint constraint,
                           java.awt.Graphics2D g2)

arrangeNN

protected Size2D arrangeNN(BlockContainer container,
                           java.awt.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.

clear

public void clear()
Clears any cached information.

Specified by:
clear in interface Arrangement

equals

public boolean equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.

Parameters:
obj - the object (null permitted).
Returns:
A boolean.