Uses of Class
com.itextpdf.kernel.pdf.tagutils.TagTreePointer
Package
Description
-
Uses of TagTreePointer in com.itextpdf.kernel.pdf.tagutils
Modifier and TypeFieldDescriptionprotected TagTreePointer
TagStructureContext.autoTaggingPointer
protected TagTreePointer
TagReference.tagPointer
Modifier and TypeFieldDescriptionprotected List<TagTreePointer>
DefaultAccessibilityProperties.refs
Modifier and TypeMethodDescriptionTagTreePointer.addAnnotationTag
(PdfAnnotation annotation) Adds a new content item for the givenPdfAnnotation
under the current tag.TagTreePointer.addTag
(int index, AccessibilityProperties properties) Adds a new tag to the tag structure.Adds a new tag with given role to the tag structure.TagTreePointer.addTag
(AccessibilityProperties properties) Adds a new tag to the tag structure.Adds a new tag with given role to the tag structure.TagStructureContext.createPointerForStructElem
(PdfStructElem structElem) Creates a newTagTreePointer
which points at givenPdfStructElem
.TagTreePointer.flushParentsIfAllKidsFlushed()
For current tag and all of it's parents consequentially checks if the following constraints apply, and flushes the tag if they do or stops if they don't: tag is not already flushed; tag is not in waiting state (seeWaitingTagsManager
); tag is not the root tag; tag has no kids or all of the kids are either flushed themselves or (if they are a marked content reference) belong to the flushed page.TagTreePointer.flushTag()
Flushes current tag and all it's descendants.TagStructureContext.getAutoTaggingPointer()
All tagging logic performed by iText automatically (along with addition of content, annotations etc) usesTagTreePointer
returned by this method to manipulate the tag structure.TagStructureContext.getTagPointerById
(byte[] id) Retrieve a pointer to a structure element by ID.TagStructureContext.getTagPointerByIdString
(String id) Retrieve a pointer to a structure element by ID.TagTreePointer.moveToKid
(int kidIndex) Moves thisTagTreePointer
instance to the kid of the current tag.Moves thisTagTreePointer
instance to the nth descendant of the current tag which has the given role.Moves thisTagTreePointer
instance to the first descendant of the current tag which has the given role.TagTreePointer.moveToParent()
Moves thisTagTreePointer
instance to the parent of the current tag.TagTreePointer.moveToPointer
(TagTreePointer tagTreePointer) Moves thisTagTreePointer
instance to the tag at which givenTagTreePointer
instance is pointing.TagTreePointer.moveToRoot()
Moves thisTagTreePointer
instance to the document root tag.TagTreePointer.relocate
(TagTreePointer pointerToNewParent) Moves current tag to the tag at which givenTagTreePointer
points.TagTreePointer.relocateKid
(int kidIndex, TagTreePointer pointerToNewParent) Moves kid of the current tag to the tag at which givenTagTreePointer
points.TagStructureContext.removeAnnotationTag
(PdfAnnotation annotation) Removes annotation content item from the tag structure.TagStructureContext.removeAnnotationTag
(PdfAnnotation annotation, boolean setAutoTaggingPointer) Removes annotation content item from the tag structure and sets autoTaggingPointer if true is passed.TagStructureContext.removeContentItem
(PdfPage page, int mcid) Removes content item from the tag structure.TagTreePointer.removeTag()
Removes the current tag.TagTreePointer.setContentStreamForTagging
(PdfStream contentStream) Sometimes, tags are desired to be connected with the content that resides not in the page's content stream, but rather in the some appearance stream or in the form xObject stream.TagTreePointer.setNamespaceForNewTags
(PdfNamespace namespace) Sets aPdfNamespace
which will be set to every new tag created by thisTagTreePointer
instance if this tag doesn't explicitly define namespace by the means ofDefaultAccessibilityProperties.setNamespace(PdfNamespace)
.TagTreePointer.setNextNewKidIndex
(int nextNewKidIndex) Sets index of the next added to the current tag kid, which could be another tag or content item.TagTreePointer.setPageForTagging
(PdfPage page) Sets a page which content will be tagged with this instance ofTagTreePointer
.Sets new role to the current tag.Modifier and TypeMethodDescriptionAccessibilityProperties.getRefsList()
Gets the list of references to other tagged elements.DefaultAccessibilityProperties.getRefsList()
Modifier and TypeMethodDescriptionAccessibilityProperties.addRef
(TagTreePointer treePointer) Adds the reference to other tagged element.DefaultAccessibilityProperties.addRef
(TagTreePointer treePointer) WaitingTagsManager.assignWaitingState
(TagTreePointer pointerToTag, Object associatedObj) Assigns waiting state to the tag at which givenTagTreePointer
points, associating it with the givenObject
.TagStructureContext.getPointerStructElem
(TagTreePointer pointer) GetsPdfStructElem
at whichTagTreePointer
points.boolean
TagTreePointer.isPointingToSameTag
(TagTreePointer otherPointer) Checks if thisTagTreePointer
is pointing at the same tag as the givingTagTreePointer
.TagTreePointer.moveToPointer
(TagTreePointer tagTreePointer) Moves thisTagTreePointer
instance to the tag at which givenTagTreePointer
instance is pointing.TagTreePointer.relocate
(TagTreePointer pointerToNewParent) Moves current tag to the tag at which givenTagTreePointer
points.TagTreePointer.relocateKid
(int kidIndex, TagTreePointer pointerToNewParent) Moves kid of the current tag to the tag at which givenTagTreePointer
points.boolean
WaitingTagsManager.tryMovePointerToWaitingTag
(TagTreePointer tagPointer, Object associatedObject) Moves givenTagTreePointer
to the waiting tag which is associated with the given object.ModifierConstructorDescriptionprotected
TagReference
(PdfStructElem referencedTag, TagTreePointer tagPointer, int insertIndex) Creates aTagReference
instance which represents a reference toPdfStructElem
.TagTreePointer
(TagTreePointer tagPointer) A copy constructor. -
Uses of TagTreePointer in com.itextpdf.layout.renderer
Modifier and TypeMethodDescriptionstatic PdfStructureAttributes
AccessibleAttributesApplier.getLayoutAttributes
(AbstractRenderer renderer, TagTreePointer taggingPointer) static PdfStructureAttributes
AccessibleAttributesApplier.getListAttributes
(AbstractRenderer renderer, TagTreePointer taggingPointer) static PdfStructureAttributes
AccessibleAttributesApplier.getTableAttributes
(AbstractRenderer renderer, TagTreePointer taggingPointer) -
Uses of TagTreePointer in com.itextpdf.layout.tagging
Modifier and TypeMethodDescriptionLayoutTaggingHelper.useAutoTaggingPointerAndRememberItsPosition
(IRenderer renderer) Modifier and TypeMethodDescriptionvoid
LayoutTaggingHelper.addKidsHint
(TagTreePointer parentPointer, Iterable extends IPropertyContainer> newKids) boolean
LayoutTaggingHelper.createTag
(IRenderer renderer, TagTreePointer tagPointer) boolean
LayoutTaggingHelper.createTag
(TaggingHintKey hintKey, TagTreePointer tagPointer)