Class PdfBoxAccessibilityHelper

java.lang.Object

com.openhtmltopdf.pdfboxout.PdfBoxAccessibilityHelper

public class PdfBoxAccessibilityHelper
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	PdfBoxAccessibilityHelper.AbbrStuctualElement
private static class	PdfBoxAccessibilityHelper.AbstractStructualElement
private static class	PdfBoxAccessibilityHelper.AbstractTreeItem	Can be either a structure element or a content item.
private static class	PdfBoxAccessibilityHelper.AnchorStuctualElement
private static class	PdfBoxAccessibilityHelper.AnnotationWithStructureParent
private static class	PdfBoxAccessibilityHelper.FigureContentItem
private static class	PdfBoxAccessibilityHelper.FigureStructualElement
private static class	PdfBoxAccessibilityHelper.GenericContentItem
private static class	PdfBoxAccessibilityHelper.GenericStructualElement
private static class	PdfBoxAccessibilityHelper.ListBodyStructualElement
private static class	PdfBoxAccessibilityHelper.ListItemStructualElement
private static class	PdfBoxAccessibilityHelper.ListLabelStructualElement
private static class	PdfBoxAccessibilityHelper.ListStructualElement
private static class	PdfBoxAccessibilityHelper.PageItems
private static class	PdfBoxAccessibilityHelper.TableBodyStructualElement
private static class	PdfBoxAccessibilityHelper.TableCellStructualElement
private static class	PdfBoxAccessibilityHelper.TableFootStructualElement
private static class	PdfBoxAccessibilityHelper.TableHeaderOrCellStructualElement
private static class	PdfBoxAccessibilityHelper.TableHeaderStructualElement
private static class	PdfBoxAccessibilityHelper.TableHeadStructualElement
private static class	PdfBoxAccessibilityHelper.TableRowStructualElement
private static class	PdfBoxAccessibilityHelper.TableStructualElement
private static class	PdfBoxAccessibilityHelper.Token

Field Summary

Fields

Modifier and Type	Field	Description
private PdfContentStreamAdapter	_cs
private RenderingContext	_ctx
private final Document	_doc
private int	_nextMcid
private final PdfBoxFastOutputDevice	_od
private org.apache.pdfbox.pdmodel.PDPage	_page
private float	_pageHeight
private PdfBoxAccessibilityHelper.PageItems	_pageItems
private final Map<org.apache.pdfbox.pdmodel.PDPage, PdfBoxAccessibilityHelper.PageItems>	_pageItemsMap
private final PdfBoxAccessibilityHelper.GenericStructualElement	_root
private final Box	_rootBox
private int	_runningLevel
private static final Map<String, Supplier<PdfBoxAccessibilityHelper.AbstractStructualElement>>	_tagSuppliers
private AffineTransform	_transform
private static final PdfBoxAccessibilityHelper.Token	FALSE_TOKEN
private static final PdfBoxAccessibilityHelper.Token	INSIDE_RUNNING
private static final PdfBoxAccessibilityHelper.Token	NESTED_RUNNING
private static final PdfBoxAccessibilityHelper.Token	STARTING_RUNNING
private static final PdfBoxAccessibilityHelper.Token	TRUE_TOKEN

Constructor Summary

Constructors

Constructor	Description
PdfBoxAccessibilityHelper(PdfBoxFastOutputDevice od, Box root, Document doc)

Method Summary

Modifier and Type	Method	Description
void	addLink(Box anchor, Box target, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation pdAnnotation, org.apache.pdfbox.pdmodel.PDPage page)
private org.apache.pdfbox.cos.COSDictionary	createBackgroundArtifact(StructureType type, Box box)
private PdfBoxAccessibilityHelper.FigureContentItem	createFigureContentStructureItem(StructureType type, Box box)
private PdfBoxAccessibilityHelper.GenericContentItem	createListItemLabelMarkedContent(StructureType type, Box box)
private org.apache.pdfbox.cos.COSDictionary	createMarkedContentDictionary()
private PdfBoxAccessibilityHelper.GenericContentItem	createMarkedContentStructureItem(StructureType type, Box box)
private org.apache.pdfbox.cos.COSDictionary	createPaginationArtifact(StructureType type, Box box)
private PdfBoxAccessibilityHelper.AbstractStructualElement	createStructureItem(StructureType type, Box box)
private static Map<String, Supplier<PdfBoxAccessibilityHelper.AbstractStructualElement>>	createTagSuppliers()
void	endPage()
void	endStructure(Object token)
private void	ensureAncestorTree(PdfBoxAccessibilityHelper.AbstractTreeItem child, Box parent)
private void	ensureParent(Box box, PdfBoxAccessibilityHelper.AbstractTreeItem child)
void	finishNumberTree()
void	finishPdfUa()
private static void	finishTreeItem(PdfBoxAccessibilityHelper.AbstractTreeItem item, PdfBoxAccessibilityHelper.AbstractStructualElement parent)
private static void	finishTreeItems(List<? extends PdfBoxAccessibilityHelper.AbstractTreeItem> children, PdfBoxAccessibilityHelper.AbstractStructualElement parent)
static org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement	getStructualElementForBox(Box targetBox)	Given a box, gets its structual element.
private static String	guessBoxTag(Box box)
private static void	logIncompatibleChild(PdfBoxAccessibilityHelper.AbstractTreeItem parent, PdfBoxAccessibilityHelper.AbstractTreeItem child, Class<?> expected)
private void	setupStructureElement(PdfBoxAccessibilityHelper.AbstractStructualElement child, Box box)
void	startPage(org.apache.pdfbox.pdmodel.PDPage page, PdfContentStreamAdapter cs, RenderingContext ctx, float pageHeight, AffineTransform transform)
PdfBoxAccessibilityHelper.Token	startStructure(StructureType type, Box box)

Methods inherited from class Object

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

Field Details

_pageItemsMap

private final Map<org.apache.pdfbox.pdmodel.PDPage, PdfBoxAccessibilityHelper.PageItems> _pageItemsMap

_od

private final PdfBoxFastOutputDevice _od

_rootBox

private final Box _rootBox

_doc

private final Document _doc

_root

private final PdfBoxAccessibilityHelper.GenericStructualElement _root

_tagSuppliers

private static final Map<String, Supplier<PdfBoxAccessibilityHelper.AbstractStructualElement>> _tagSuppliers

_nextMcid

private int _nextMcid

_pageItems

private PdfBoxAccessibilityHelper.PageItems _pageItems

_cs

private PdfContentStreamAdapter _cs

_ctx

private RenderingContext _ctx

_page

private org.apache.pdfbox.pdmodel.PDPage _page

_pageHeight

private float _pageHeight

_transform

private AffineTransform _transform

_runningLevel

private int _runningLevel

TRUE_TOKEN

private static final PdfBoxAccessibilityHelper.Token TRUE_TOKEN

FALSE_TOKEN

private static final PdfBoxAccessibilityHelper.Token FALSE_TOKEN

INSIDE_RUNNING

private static final PdfBoxAccessibilityHelper.Token INSIDE_RUNNING

STARTING_RUNNING

private static final PdfBoxAccessibilityHelper.Token STARTING_RUNNING

NESTED_RUNNING

private static final PdfBoxAccessibilityHelper.Token NESTED_RUNNING

Constructor Details

PdfBoxAccessibilityHelper

public PdfBoxAccessibilityHelper(PdfBoxFastOutputDevice od,
 Box root,
 Document doc)

Method Details

createTagSuppliers

private static Map<String, Supplier<PdfBoxAccessibilityHelper.AbstractStructualElement>> createTagSuppliers()

logIncompatibleChild

private static void logIncompatibleChild(PdfBoxAccessibilityHelper.AbstractTreeItem parent,
 PdfBoxAccessibilityHelper.AbstractTreeItem child,
 Class<?> expected)

getStructualElementForBox

public static org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement getStructualElementForBox(Box targetBox)

Given a box, gets its structual element.

finishPdfUa

public void finishPdfUa()

finishNumberTree

public void finishNumberTree()

guessBoxTag

private static String guessBoxTag(Box box)

finishTreeItems

private static void finishTreeItems(List<? extends PdfBoxAccessibilityHelper.AbstractTreeItem> children,
 PdfBoxAccessibilityHelper.AbstractStructualElement parent)

finishTreeItem

private static void finishTreeItem(PdfBoxAccessibilityHelper.AbstractTreeItem item,
 PdfBoxAccessibilityHelper.AbstractStructualElement parent)

createMarkedContentDictionary

private org.apache.pdfbox.cos.COSDictionary createMarkedContentDictionary()

ensureAncestorTree

private void ensureAncestorTree(PdfBoxAccessibilityHelper.AbstractTreeItem child,
 Box parent)

createStructureItem

private PdfBoxAccessibilityHelper.AbstractStructualElement createStructureItem(StructureType type,
 Box box)

setupStructureElement

private void setupStructureElement(PdfBoxAccessibilityHelper.AbstractStructualElement child,
 Box box)

ensureParent

private void ensureParent(Box box,
 PdfBoxAccessibilityHelper.AbstractTreeItem child)

createMarkedContentStructureItem

private PdfBoxAccessibilityHelper.GenericContentItem createMarkedContentStructureItem(StructureType type,
 Box box)

createListItemLabelMarkedContent

private PdfBoxAccessibilityHelper.GenericContentItem createListItemLabelMarkedContent(StructureType type,
 Box box)

createFigureContentStructureItem

private PdfBoxAccessibilityHelper.FigureContentItem createFigureContentStructureItem(StructureType type,
 Box box)

createBackgroundArtifact

private org.apache.pdfbox.cos.COSDictionary createBackgroundArtifact(StructureType type,
 Box box)

createPaginationArtifact

private org.apache.pdfbox.cos.COSDictionary createPaginationArtifact(StructureType type,
 Box box)

startStructure

public PdfBoxAccessibilityHelper.Token startStructure(StructureType type,
 Box box)

endStructure

public void endStructure(Object token)

startPage

public void startPage(org.apache.pdfbox.pdmodel.PDPage page,
 PdfContentStreamAdapter cs,
 RenderingContext ctx,
 float pageHeight,
 AffineTransform transform)

endPage

public void endPage()

addLink

public void addLink(Box anchor,
 Box target,
 org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation pdAnnotation,
 org.apache.pdfbox.pdmodel.PDPage page)