Top Inners Fields Constructors Methods

com.openhtmltopdf.pdfboxout

public Class PdfBoxBookmarkManager

Class Inheritance

extends Object

java.lang.Object
com.openhtmltopdf.pdfboxout.PdfBoxBookmarkManager

Imports

java.awt.Rectangle, java.util.ArrayList, .Collections, .List, java.util.logging.Level, com.openhtmltopdf.util.LogMessageId, .XRLog, org.apache.pdfbox.pdmodel.PDDocument, org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement, org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination, .PDPageFitHeightDestination, .PDPageXYZDestination, org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline, .PDOutlineItem, .PDOutlineNode, org.w3c.dom.Document, .Element, com.openhtmltopdf.css.style.CalculatedStyle, com.openhtmltopdf.layout.SharedContext, com.openhtmltopdf.render.Box, .PageBox, .RenderingContext, com.openhtmltopdf.render.displaylist.PagedBoxCollector

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	PdfBoxBookmarkManager.Bookmark

Field Summary

Modifier and Type	Field and Description
private final List<PdfBoxBookmarkManager.Bookmark>	_bookmarks
private PDDestination	_defaultDestination
private final float	_dotsPerPoint
private final PdfBoxFastOutputDevice	_od
private final SharedContext	_sharedContext
private final PDDocument	_writer
private final Document	_xml

Constructor Summary

Access	Constructor and Description
public	PdfBoxBookmarkManager(Document xml, PDDocument doc, SharedContext sharedContext, float dotsPerPoint, PdfBoxFastOutputDevice od)

Method Summary

Modifier and Type	Method and Description
public static PDPageXYZDestination	createBoxDestination(RenderingContext c, PDDocument writer, PdfBoxFastOutputDevice od, float dotsPerPoint, Box root, Box box) Creates a `PDPageXYZDestination` with the Y set to the min Y of the border box and the X and Z set to null.
private void	handleBookmarksInParent(Element element)
private void	loadBookmark(PdfBoxBookmarkManager.Bookmark parent, Element bookmark)
public void	loadBookmarks()
private void	writeBookmark(RenderingContext c, Box root, PDOutlineNode parent, PdfBoxBookmarkManager.Bookmark bookmark)
private void	writeBookmarks(RenderingContext c, Box root, PDOutlineNode parent, List<PdfBoxBookmarkManager.Bookmark> bookmarks)
public void	writeOutline(RenderingContext c, Box root)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_bookmarks	back to summary
private final List<PdfBoxBookmarkManager.Bookmark> _bookmarks

_defaultDestination	back to summary
private PDDestination _defaultDestination

_dotsPerPoint	back to summary
private final float _dotsPerPoint

_od	back to summary
private final PdfBoxFastOutputDevice _od

_sharedContext	back to summary
private final SharedContext _sharedContext

_writer	back to summary
private final PDDocument _writer

_xml	back to summary
private final Document _xml

Constructor Detail

PdfBoxBookmarkManager	back to summary
public PdfBoxBookmarkManager(Document xml, PDDocument doc, SharedContext sharedContext, float dotsPerPoint, PdfBoxFastOutputDevice od)

Method Detail

createBoxDestination	back to summary
public static PDPageXYZDestination createBoxDestination(RenderingContext c, PDDocument writer, PdfBoxFastOutputDevice od, float dotsPerPoint, Box root, Box box) Creates a `PDPageXYZDestination` with the Y set to the min Y of the border box and the X and Z set to null. Takes into account any transforms set for the box as well as inserted overflow pages.

handleBookmarksInParent	back to summary
private void handleBookmarksInParent(Element element)

loadBookmark	back to summary
private void loadBookmark(PdfBoxBookmarkManager.Bookmark parent, Element bookmark)

loadBookmarks	back to summary
public void loadBookmarks()

writeBookmark	back to summary
private void writeBookmark(RenderingContext c, Box root, PDOutlineNode parent, PdfBoxBookmarkManager.Bookmark bookmark)

writeBookmarks	back to summary
private void writeBookmarks(RenderingContext c, Box root, PDOutlineNode parent, List<PdfBoxBookmarkManager.Bookmark> bookmarks)

writeOutline	back to summary
public void writeOutline(RenderingContext c, Box root)

com.openhtmltopdf.pdfboxout back to summary

private Class PdfBoxBookmarkManager.Bookmark

Class Inheritance

extends Object

java.lang.Object
com.openhtmltopdf.pdfboxout.PdfBoxBookmarkManager.Bookmark

Field Summary

Modifier and Type	Field and Description
private List<PdfBoxBookmarkManager.Bookmark>	_children
private final String	_HRef
private final String	_name

Constructor Summary

Access	Constructor and Description
public	Bookmark(String name, String href)

Method Summary

Modifier and Type	Method and Description
public void	addChild(PdfBoxBookmarkManager.Bookmark child)
public List<PdfBoxBookmarkManager.Bookmark>	getChildren()
public String	getHRef()
public String	getName()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_children	back to summary
private List<PdfBoxBookmarkManager.Bookmark> _children

_HRef	back to summary
private final String _HRef

_name	back to summary
private final String _name

Constructor Detail

Bookmark	back to summary
public Bookmark(String name, String href)

Method Detail

addChild	back to summary
public void addChild(PdfBoxBookmarkManager.Bookmark child)

getChildren	back to summary
public List<PdfBoxBookmarkManager.Bookmark> getChildren()

getHRef	back to summary
public String getHRef()

getName	back to summary
public String getName()