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()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FootnoteManager.FootnoteArea

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<BlockBox, FootnoteManager.FootnoteArea>	_containerMap
private final Map<PageBox, FootnoteManager.FootnoteArea>	_footnoteAreas

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.
private void	clearFootnoteAreaPages(FootnoteManager.FootnoteArea area)
private FootnoteManager.FootnoteArea	createFootnoteArea(LayoutContext c, PageBox page)
private BlockBox	createFootnoteAreaBlock(LayoutContext c, PageBox footnoteCallPage)	Sets up the footnote area.
private void	positionFootnoteArea(LayoutContext c, FootnoteManager.FootnoteArea area, PageBox firstPage, int lineHeight, boolean allowRepeat)
void	removeFootnoteBodies(LayoutContext c, List<BlockBox> footnoteBodies, LineBox line)	Removes footnotes.
private void	reserveSubsequentPagesForFootnoteArea(LayoutContext c, FootnoteManager.FootnoteArea area, int desiredHeight, int footnoteTop, int startAt)

Methods inherited from class Object

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

Field Details

_footnoteAreas

private final Map<PageBox, FootnoteManager.FootnoteArea> _footnoteAreas

_containerMap

private final Map<BlockBox, FootnoteManager.FootnoteArea> _containerMap

Constructor Details

FootnoteManager

public FootnoteManager()

Method Details

createFootnoteArea

private FootnoteManager.FootnoteArea createFootnoteArea(LayoutContext c,
 PageBox page)

createFootnoteAreaBlock

private BlockBox createFootnoteAreaBlock(LayoutContext c,
 PageBox footnoteCallPage)

Sets up the footnote area.

positionFootnoteArea

private void positionFootnoteArea(LayoutContext c,
 FootnoteManager.FootnoteArea area,
 PageBox firstPage,
 int lineHeight,
 boolean allowRepeat)

reserveSubsequentPagesForFootnoteArea

private void reserveSubsequentPagesForFootnoteArea(LayoutContext c,
 FootnoteManager.FootnoteArea area,
 int desiredHeight,
 int footnoteTop,
 int startAt)

clearFootnoteAreaPages

private void clearFootnoteAreaPages(FootnoteManager.FootnoteArea area)

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.