Class LayoutTaggingHelper

java.lang.Object

com.itextpdf.layout.tagging.LayoutTaggingHelper

public class LayoutTaggingHelper
extends Object

The class is a helper which is used to correctly create structure tree for layout element (with keeping right order for tags).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	LayoutTaggingHelper.ScanContext

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<IRenderer, TagTreePointer>	autoTaggingPointerSavedPosition
private final TagStructureContext	context
private final PdfDocument	document
private final Map<PdfObject, TaggingDummyElement>	dummiesForPreExistingTags
private final boolean	immediateFlush
private final Map<TaggingHintKey, List<TaggingHintKey>>	kidsHints
private final Map<TaggingHintKey, TaggingHintKey>	parentHints
private final int	RETVAL_NO_PARENT
private final int	RETVAL_PARENT_AND_KID_FINISHED
private final Map<String, List<ITaggingRule>>	taggingRules

Constructor Summary

Constructors

Constructor	Description
LayoutTaggingHelper(PdfDocument document, boolean immediateFlush)

Method Summary

Modifier and Type	Method	Description
void	addKidsHint(TagTreePointer parentPointer, Iterable<? extends IPropertyContainer> newKids)
void	addKidsHint(IPropertyContainer parent, Iterable<? extends IPropertyContainer> newKids)
void	addKidsHint(IPropertyContainer parent, Iterable<? extends IPropertyContainer> newKids, int insertIndex)
void	addKidsHint(TaggingHintKey parentKey, Collection<TaggingHintKey> newKidsKeys)
void	addKidsHint(TaggingHintKey parentKey, Collection<TaggingHintKey> newKidsKeys, int insertIndex)
private void	addKidsHint(TaggingHintKey parentKey, Collection<TaggingHintKey> newKidsKeys, int insertIndex, boolean skipFinishedChecks)
static void	addTreeHints(LayoutTaggingHelper taggingHelper, IRenderer rootRenderer)
private boolean	createSingleTag(TaggingHintKey hintKey, TagTreePointer tagPointer)
boolean	createTag(IRenderer renderer, TagTreePointer tagPointer)
boolean	createTag(TaggingHintKey hintKey, TagTreePointer tagPointer)
private void	finishDummyKids(List<TaggingHintKey> taggingHintKeys)
void	finishTaggingHint(IPropertyContainer hintOwner)
List<TaggingHintKey>	getAccessibleKidsHint(TaggingHintKey parent)
TaggingHintKey	getAccessibleParentHint(TaggingHintKey hintKey)
static TaggingHintKey	getHintKey(IPropertyContainer container)
List<TaggingHintKey>	getKidsHint(TaggingHintKey parent)
private int	getNearestNextSiblingIndex(WaitingTagsManager waitingTagsManager, TagTreePointer parentPointer, TaggingHintKey parentKey, TaggingHintKey kidKey)
static TaggingHintKey	getOrCreateHintKey(IPropertyContainer container)
private static TaggingHintKey	getOrCreateHintKey(IPropertyContainer hintOwner, boolean setProperty)
TaggingHintKey	getParentHint(IPropertyContainer hintOwner)
TaggingHintKey	getParentHint(TaggingHintKey hintKey)
PdfDocument	getPdfDocument()
boolean	isArtifact(IPropertyContainer hintOwner)
private static boolean	isNonAccessibleHint(TaggingHintKey hintKey)
private boolean	isSomeKidNotFinished(TaggingHintKey hint)
private boolean	isSomeParentNotFinished(TaggingHintKey parentHint)
private boolean	isTagAlreadyExistsForHint(TaggingHintKey tagHint)
void	markArtifactHint(IPropertyContainer hintOwner)
void	markArtifactHint(TaggingHintKey hintKey)
int	moveKidHint(TaggingHintKey hintKeyOfKidToMove, TaggingHintKey newParent)
int	moveKidHint(TaggingHintKey hintKeyOfKidToMove, TaggingHintKey newParent, int insertIndex)
private void	moveKidTagIfCreated(TaggingHintKey parentKey, TaggingHintKey kidKey)
private void	registerRules(PdfVersion pdfVersion)
private void	registerSingleRule(String role, ITaggingRule rule)
void	releaseAllHints()
void	releaseFinishedHints()
private void	releaseHint(TaggingHintKey hint, Set<TaggingHintKey> hintsToBeHeld, boolean checkContextIsFinished)
private int	removeParentHint(TaggingHintKey hintKey)
private int	removeParentHint(TaggingHintKey hintKey, TaggingHintKey parentHint)
int	replaceKidHint(TaggingHintKey kidHintKey, Collection<TaggingHintKey> newKidsHintKeys)
void	restoreAutoTaggingPointerPosition(IRenderer renderer)
private int	scanForNearestNextSiblingIndex(LayoutTaggingHelper.ScanContext scanContext, TaggingHintKey toCheck, TaggingHintKey parent)
void	setRoleHint(IPropertyContainer hintOwner, String role)
TagTreePointer	useAutoTaggingPointerAndRememberItsPosition(IRenderer renderer)

Methods inherited from class Object

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

Field Details

context

private final TagStructureContext context

document

private final PdfDocument document

immediateFlush

private final boolean immediateFlush

kidsHints

private final Map<TaggingHintKey, List<TaggingHintKey>> kidsHints

parentHints

private final Map<TaggingHintKey, TaggingHintKey> parentHints

autoTaggingPointerSavedPosition

private final Map<IRenderer, TagTreePointer> autoTaggingPointerSavedPosition

taggingRules

private final Map<String, List<ITaggingRule>> taggingRules

dummiesForPreExistingTags

private final Map<PdfObject, TaggingDummyElement> dummiesForPreExistingTags

RETVAL_NO_PARENT

private final int RETVAL_NO_PARENT

See Also:

• Constant Field Values

RETVAL_PARENT_AND_KID_FINISHED

private final int RETVAL_PARENT_AND_KID_FINISHED

See Also:

• Constant Field Values

Constructor Details

LayoutTaggingHelper

public LayoutTaggingHelper(PdfDocument document,
 boolean immediateFlush)

Method Details

addTreeHints

public static void addTreeHints(LayoutTaggingHelper taggingHelper,
 IRenderer rootRenderer)

getHintKey

public static TaggingHintKey getHintKey(IPropertyContainer container)

getOrCreateHintKey

public static TaggingHintKey getOrCreateHintKey(IPropertyContainer container)

addKidsHint

public void addKidsHint(TagTreePointer parentPointer,
 Iterable<? extends IPropertyContainer> newKids)

addKidsHint

public void addKidsHint(IPropertyContainer parent,
 Iterable<? extends IPropertyContainer> newKids)

addKidsHint

public void addKidsHint(IPropertyContainer parent,
 Iterable<? extends IPropertyContainer> newKids,
 int insertIndex)

addKidsHint

public void addKidsHint(TaggingHintKey parentKey,
 Collection<TaggingHintKey> newKidsKeys)

addKidsHint

public void addKidsHint(TaggingHintKey parentKey,
 Collection<TaggingHintKey> newKidsKeys,
 int insertIndex)

setRoleHint

public void setRoleHint(IPropertyContainer hintOwner,
 String role)

isArtifact

public boolean isArtifact(IPropertyContainer hintOwner)

markArtifactHint

public void markArtifactHint(IPropertyContainer hintOwner)

markArtifactHint

public void markArtifactHint(TaggingHintKey hintKey)

useAutoTaggingPointerAndRememberItsPosition

public TagTreePointer useAutoTaggingPointerAndRememberItsPosition(IRenderer renderer)

restoreAutoTaggingPointerPosition

public void restoreAutoTaggingPointerPosition(IRenderer renderer)

getKidsHint

public List<TaggingHintKey> getKidsHint(TaggingHintKey parent)

getAccessibleKidsHint

public List<TaggingHintKey> getAccessibleKidsHint(TaggingHintKey parent)

getParentHint

public TaggingHintKey getParentHint(IPropertyContainer hintOwner)

getParentHint

public TaggingHintKey getParentHint(TaggingHintKey hintKey)

getAccessibleParentHint

public TaggingHintKey getAccessibleParentHint(TaggingHintKey hintKey)

releaseFinishedHints

public void releaseFinishedHints()

releaseAllHints

public void releaseAllHints()

createTag

public boolean createTag(IRenderer renderer,
 TagTreePointer tagPointer)

createTag

public boolean createTag(TaggingHintKey hintKey,
 TagTreePointer tagPointer)

finishTaggingHint

public void finishTaggingHint(IPropertyContainer hintOwner)

replaceKidHint

public int replaceKidHint(TaggingHintKey kidHintKey,
 Collection<TaggingHintKey> newKidsHintKeys)

moveKidHint

public int moveKidHint(TaggingHintKey hintKeyOfKidToMove,
 TaggingHintKey newParent)

moveKidHint

public int moveKidHint(TaggingHintKey hintKeyOfKidToMove,
 TaggingHintKey newParent,
 int insertIndex)

getPdfDocument

public PdfDocument getPdfDocument()

getOrCreateHintKey

private static TaggingHintKey getOrCreateHintKey(IPropertyContainer hintOwner,
 boolean setProperty)

addKidsHint

private void addKidsHint(TaggingHintKey parentKey,
 Collection<TaggingHintKey> newKidsKeys,
 int insertIndex,
 boolean skipFinishedChecks)

createSingleTag

private boolean createSingleTag(TaggingHintKey hintKey,
 TagTreePointer tagPointer)

removeParentHint

private int removeParentHint(TaggingHintKey hintKey)

removeParentHint

private int removeParentHint(TaggingHintKey hintKey,
 TaggingHintKey parentHint)

finishDummyKids

private void finishDummyKids(List<TaggingHintKey> taggingHintKeys)

moveKidTagIfCreated

private void moveKidTagIfCreated(TaggingHintKey parentKey,
 TaggingHintKey kidKey)

isNonAccessibleHint

private static boolean isNonAccessibleHint(TaggingHintKey hintKey)

isTagAlreadyExistsForHint

private boolean isTagAlreadyExistsForHint(TaggingHintKey tagHint)

releaseHint

private void releaseHint(TaggingHintKey hint,
 Set<TaggingHintKey> hintsToBeHeld,
 boolean checkContextIsFinished)

isSomeParentNotFinished

private boolean isSomeParentNotFinished(TaggingHintKey parentHint)

isSomeKidNotFinished

private boolean isSomeKidNotFinished(TaggingHintKey hint)

registerRules

private void registerRules(PdfVersion pdfVersion)

registerSingleRule

private void registerSingleRule(String role,
 ITaggingRule rule)

getNearestNextSiblingIndex

private int getNearestNextSiblingIndex(WaitingTagsManager waitingTagsManager,
 TagTreePointer parentPointer,
 TaggingHintKey parentKey,
 TaggingHintKey kidKey)

scanForNearestNextSiblingIndex

private int scanForNearestNextSiblingIndex(LayoutTaggingHelper.ScanContext scanContext,
 TaggingHintKey toCheck,
 TaggingHintKey parent)