org.apache.fop.area

Class BlockParent

Implemented Interfaces:
Serializable
Known Direct Subclasses:
BeforeFloat, Block, Footnote, NormalFlow

public class BlockParent
extends Area

A BlockParent holds block-level areas.

Field Summary

protected List
children
The children of this block parent area.
protected int
xOffset
The x offset position of this block parent.
protected int
yOffset
The y offset position of this block parent.

Fields inherited from class org.apache.fop.area.Area

BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, RL, TB, bpd, ipd, log, props

Fields inherited from class org.apache.fop.area.AreaTreeObject

foreignAttributes

Method Summary

void
addBlock(Block block)
Add the block area to this block parent.
void
addChildArea(Area childArea)
List
getChildAreas()
Get the list of child areas for this block area.
int
getXOffset()
Get the X offset of this block parent area.
int
getYOffset()
Get the Y offset of this block parent area.
boolean
isEmpty()
Check whether there are child areas.
void
setXOffset(int off)
Set the X offset of this block parent area.
void
setYOffset(int off)
Set the Y offset of this block parent area.

Methods inherited from class org.apache.fop.area.Area

addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBPD, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString

Methods inherited from class org.apache.fop.area.AreaTreeObject

getForeignAttributeValue, getForeignAttributes, setForeignAttribute, setForeignAttributes

Field Details

children

protected List children
The children of this block parent area.

xOffset

protected int xOffset
The x offset position of this block parent. Used for relative (serves as left-offset trait) and absolute positioning (serves as left-position trait).

yOffset

protected int yOffset
The y offset position of this block parent. Used for relative (serves as top-offset trait) and absolute positioning (serves as top-position trait).

Method Details

addBlock

public void addBlock(Block block)
Add the block area to this block parent.
Parameters:
block - the child block area to add

addChildArea

public void addChildArea(Area childArea)
Overrides:
addChildArea in interface Area

getChildAreas

public List getChildAreas()
Get the list of child areas for this block area.
Returns:
the list of child areas

getXOffset

public int getXOffset()
Get the X offset of this block parent area.
Returns:
the x offset of the block parent area

getYOffset

public int getYOffset()
Get the Y offset of this block parent area.
Returns:
the y offset of the block parent area

isEmpty

public boolean isEmpty()
Check whether there are child areas.
Returns:
the result.

setXOffset

public void setXOffset(int off)
Set the X offset of this block parent area.
Parameters:
off - the x offset of the block parent area

setYOffset

public void setYOffset(int off)
Set the Y offset of this block parent area.
Parameters:
off - the y offset of the block parent area

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.