Class FootnoteManager

java.lang.Object

com.openhtmltopdf.layout.FootnoteManager

public class FootnoteManager
extends Object

The footnote manager which is only created if footnotes are detected in the document. See LayoutContext.getFootnoteManager()

Constructor Summary

Constructors

Constructor	Description
FootnoteManager()

Method Summary

Modifier and Type	Method	Description
void	addFootnoteBody(LayoutContext c, BlockBox footnoteBody, LineBox line)	Adds a footnote body to the line box page, creating the footnote area as required.
void	removeFootnoteBodies(LayoutContext c, List<BlockBox> footnoteBodies, LineBox line)	Removes footnotes.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FootnoteManager

public FootnoteManager()

Method Details

addFootnoteBody

public void addFootnoteBody(LayoutContext c,
 BlockBox footnoteBody,
 LineBox line)

Adds a footnote body to the line box page, creating the footnote area as required.

Important: This changes the page break point by expanding the footnote area. It also reserves subsequent pages if required for the footnote area.

If the line box is moved to a different page, one must call removeFootnoteBodies(LayoutContext, List, LineBox) before the page change and this method again after.

removeFootnoteBodies

public void removeFootnoteBodies(LayoutContext c,
 List<BlockBox> footnoteBodies,
 LineBox line)

Removes footnotes. This is used when a line is moved to a new page. We remove from first page and add to the next.