Package com.itextpdf.layout.tagging

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

Constructor Summary

Constructors

Constructor	Description
LayoutTaggingHelper(PdfDocument document, boolean immediateFlush)

Method Summary

Modifier and Type	Method	Description
void	addKidsHint(TagTreePointer parentPointer, IterableIPropertyContainer> newKids)
void	addKidsHint(IPropertyContainer parent, IterableIPropertyContainer> newKids)
void	addKidsHint(IPropertyContainer parent, IterableIPropertyContainer> newKids, int insertIndex)
void	addKidsHint(TaggingHintKey parentKey, Collection<TaggingHintKey> newKidsKeys)
void	addKidsHint(TaggingHintKey parentKey, Collection<TaggingHintKey> newKidsKeys, int insertIndex)
static void	addTreeHints(LayoutTaggingHelper taggingHelper, IRenderer rootRenderer)
boolean	createTag(IRenderer renderer, TagTreePointer tagPointer)
boolean	createTag(TaggingHintKey hintKey, TagTreePointer tagPointer)
void	finishTaggingHint(IPropertyContainer hintOwner)
List<TaggingHintKey>	getAccessibleKidsHint(TaggingHintKey parent)
TaggingHintKey	getAccessibleParentHint(TaggingHintKey hintKey)
static TaggingHintKey	getHintKey(IPropertyContainer container)
List<TaggingHintKey>	getKidsHint(TaggingHintKey parent)
static TaggingHintKey	getOrCreateHintKey(IPropertyContainer container)
TaggingHintKey	getParentHint(IPropertyContainer hintOwner)
TaggingHintKey	getParentHint(TaggingHintKey hintKey)
PdfDocument	getPdfDocument()
boolean	isArtifact(IPropertyContainer hintOwner)
void	markArtifactHint(IPropertyContainer hintOwner)
void	markArtifactHint(TaggingHintKey hintKey)
int	moveKidHint(TaggingHintKey hintKeyOfKidToMove, TaggingHintKey newParent)
int	moveKidHint(TaggingHintKey hintKeyOfKidToMove, TaggingHintKey newParent, int insertIndex)
void	releaseAllHints()
void	releaseFinishedHints()
int	replaceKidHint(TaggingHintKey kidHintKey, Collection<TaggingHintKey> newKidsHintKeys)
void	restoreAutoTaggingPointerPosition(IRenderer renderer)
void	setRoleHint(IPropertyContainer hintOwner, String role)
TagTreePointer	useAutoTaggingPointerAndRememberItsPosition(IRenderer renderer)

Methods inherited from class java.lang.Object

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

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, IterableIPropertyContainer> newKids)
            

addKidsHint

             public void addKidsHint
             (IPropertyContainer parent, IterableIPropertyContainer> newKids)
            

addKidsHint

             public void addKidsHint
             (IPropertyContainer parent, IterableIPropertyContainer> 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()