org.apache.fop.area

Class Footnote

Implemented Interfaces:
Serializable

public class Footnote
extends BlockParent

The footnote-reference-area optionally generated by an fo:region-body. This areas holds footnote areas and an optional separator area. See fo:region-body definition in the XSL Rec for more information.

Field Summary

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

children, xOffset, yOffset

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 child)
Add a block area as child to the footnote area
Block
getSeparator()
Get the separator area for this footnote area.
int
getTop()
Get the relative position of the footnote inside the body region.
void
setSeparator(Block sep)
Set the separator area for this footnote.
void
setTop(int top)
Set the relative position of the footnote inside the body region.

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

addBlock, addChildArea, getChildAreas, getXOffset, getYOffset, isEmpty, setXOffset, setYOffset

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

Method Details

addBlock

public void addBlock(Block child)
Add a block area as child to the footnote area
Overrides:
addBlock in interface BlockParent
Parameters:
child - the block area.

getSeparator

public Block getSeparator()
Get the separator area for this footnote area.
Returns:
the separator area

getTop

public int getTop()
Get the relative position of the footnote inside the body region.
Returns:
the relative position.

setSeparator

public void setSeparator(Block sep)
Set the separator area for this footnote.
Parameters:
sep - the separator area

setTop

public void setTop(int top)
Set the relative position of the footnote inside the body region.
Parameters:
top - the relative position.

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