org.apache.fop.area
Class Footnote
java.lang.Object
|
+--org.apache.fop.area.Area
|
+--org.apache.fop.area.BlockParent
|
+--org.apache.fop.area.Footnote
- All Implemented Interfaces:
- java.io.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.
- See Also:
- Serialized Form
Fields inherited from class org.apache.fop.area.Area |
bpd, BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, ipd, log, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, props, RL, TB |
Method Summary |
void |
addBlock(Block child)
Add a block area as child to the footnote area |
java.util.List |
getChildAreas()
Get all child areas. |
Block |
getSeparator()
Get the separator area for this footnote area. |
int |
getTop()
Get the relative position of the footnote inside the body region. |
boolean |
isEmpty()
Check whether there are child areas. |
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.Area |
addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Footnote
public Footnote()
setSeparator
public void setSeparator(Block sep)
- Set the separator area for this footnote.
- Parameters:
sep
- the separator area
getSeparator
public Block getSeparator()
- Get the separator area for this footnote area.
- Returns:
- 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.
getTop
public int getTop()
- Get the relative position of the footnote inside the body region.
- Returns:
- the relative position.
addBlock
public void addBlock(Block child)
- Add a block area as child to the footnote area
- Overrides:
addBlock
in class BlockParent
- Parameters:
child
- the block area.
getChildAreas
public java.util.List getChildAreas()
- Get all child areas.
- Overrides:
getChildAreas
in class BlockParent
- Returns:
- the list of child areas. Maybe null.
isEmpty
public boolean isEmpty()
- Check whether there are child areas.
- Returns:
- the result.
Copyright 1999-2005 The Apache Software Foundation. All Rights Reserved.