Package | Description |
---|---|
com.itextpdf.kernel.pdf.tagutils |
Modifier and Type | Field and Description |
---|---|
protected TagTreePointer |
TagStructureContext.autoTaggingPointer |
protected TagTreePointer |
TagReference.tagPointer |
Modifier and Type | Field and Description |
---|---|
protected List<TagTreePointer> |
DefaultAccessibilityProperties.refs |
Modifier and Type | Method and Description |
---|---|
TagTreePointer |
TagTreePointer.addAnnotationTag(PdfAnnotation annotation)
Adds a new content item for the given
PdfAnnotation under the current tag. |
TagTreePointer |
TagTreePointer.addTag(AccessibilityProperties properties)
Adds a new tag to the tag structure.
|
TagTreePointer |
TagTreePointer.addTag(int index,
AccessibilityProperties properties)
Adds a new tag to the tag structure.
|
TagTreePointer |
TagTreePointer.addTag(int index,
String role)
Adds a new tag with given role to the tag structure.
|
TagTreePointer |
TagTreePointer.addTag(String role)
Adds a new tag with given role to the tag structure.
|
TagTreePointer |
TagStructureContext.createPointerForStructElem(PdfStructElem structElem)
Creates a new
TagTreePointer which points at given PdfStructElem . |
TagTreePointer |
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 (see
WaitingTagsManager );
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 |
TagTreePointer.flushTag()
Flushes current tag and all it's descendants.
|
TagTreePointer |
TagStructureContext.getAutoTaggingPointer()
All tagging logic performed by iText automatically (along with addition of content, annotations etc)
uses
TagTreePointer returned by this method to manipulate the tag structure. |
TagTreePointer |
TagStructureContext.getTagPointerById(byte[] id)
Retrieve a pointer to a structure element by ID.
|
TagTreePointer |
TagStructureContext.getTagPointerByIdString(String id)
Retrieve a pointer to a structure element by ID.
|
TagTreePointer |
TagTreePointer.moveToKid(int kidIndex)
Moves this
TagTreePointer instance to the kid of the current tag. |
TagTreePointer |
TagTreePointer.moveToKid(int n,
String role)
Moves this
TagTreePointer instance to the nth descendant of the current tag which has the given role. |
TagTreePointer |
TagTreePointer.moveToKid(String role)
Moves this
TagTreePointer instance to the first descendant of the current tag which has the given role. |
TagTreePointer |
TagTreePointer.moveToParent()
Moves this
TagTreePointer instance to the parent of the current tag. |
TagTreePointer |
TagTreePointer.moveToPointer(TagTreePointer tagTreePointer)
Moves this
TagTreePointer instance to the tag at which given TagTreePointer instance is pointing. |
TagTreePointer |
TagTreePointer.moveToRoot()
Moves this
TagTreePointer instance to the document root tag. |
TagTreePointer |
TagTreePointer.relocate(TagTreePointer pointerToNewParent)
Moves current tag to the tag at which given
TagTreePointer points. |
TagTreePointer |
TagTreePointer.relocateKid(int kidIndex,
TagTreePointer pointerToNewParent)
Moves kid of the current tag to the tag at which given
TagTreePointer points. |
TagTreePointer |
TagStructureContext.removeAnnotationTag(PdfAnnotation annotation)
Removes annotation content item from the tag structure.
|
TagTreePointer |
TagStructureContext.removeAnnotationTag(PdfAnnotation annotation,
boolean setAutoTaggingPointer)
Removes annotation content item from the tag structure and sets autoTaggingPointer if true is passed.
|
TagTreePointer |
TagStructureContext.removeContentItem(PdfPage page,
int mcid)
Removes content item from the tag structure.
|
TagTreePointer |
TagTreePointer.removeTag()
Removes the current tag.
|
TagTreePointer |
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 |
TagTreePointer.setNamespaceForNewTags(PdfNamespace namespace)
Sets a
PdfNamespace which will be set to every new tag created by this TagTreePointer instance
if this tag doesn't explicitly define namespace by the means of DefaultAccessibilityProperties.setNamespace(PdfNamespace) . |
TagTreePointer |
TagTreePointer.setNextNewKidIndex(int nextNewKidIndex)
Sets index of the next added to the current tag kid, which could be another tag or content item.
|
TagTreePointer |
TagTreePointer.setPageForTagging(PdfPage page)
Sets a page which content will be tagged with this instance of
TagTreePointer . |
TagTreePointer |
TagTreePointer.setRole(String role)
Sets new role to the current tag.
|
Modifier and Type | Method and Description |
---|---|
List<TagTreePointer> |
DefaultAccessibilityProperties.getRefsList() |
List<TagTreePointer> |
AccessibilityProperties.getRefsList()
Gets the list of references to other tagged elements.
|
Modifier and Type | Method and Description |
---|---|
AccessibilityProperties |
DefaultAccessibilityProperties.addRef(TagTreePointer treePointer) |
AccessibilityProperties |
AccessibilityProperties.addRef(TagTreePointer treePointer)
Adds the reference to other tagged element.
|
Object |
WaitingTagsManager.assignWaitingState(TagTreePointer pointerToTag,
Object associatedObj)
Assigns waiting state to the tag at which given
TagTreePointer points, associating it with the given
Object . |
PdfStructElem |
TagStructureContext.getPointerStructElem(TagTreePointer pointer)
Gets
PdfStructElem at which TagTreePointer points. |
boolean |
TagTreePointer.isPointingToSameTag(TagTreePointer otherPointer)
Checks if this
TagTreePointer is pointing at the same tag as the giving TagTreePointer . |
TagTreePointer |
TagTreePointer.moveToPointer(TagTreePointer tagTreePointer)
Moves this
TagTreePointer instance to the tag at which given TagTreePointer instance is pointing. |
TagTreePointer |
TagTreePointer.relocate(TagTreePointer pointerToNewParent)
Moves current tag to the tag at which given
TagTreePointer points. |
TagTreePointer |
TagTreePointer.relocateKid(int kidIndex,
TagTreePointer pointerToNewParent)
Moves kid of the current tag to the tag at which given
TagTreePointer points. |
boolean |
WaitingTagsManager.tryMovePointerToWaitingTag(TagTreePointer tagPointer,
Object associatedObject)
Moves given
TagTreePointer to the waiting tag which is associated with the given object. |
Constructor and Description |
---|
TagReference(PdfStructElem referencedTag,
TagTreePointer tagPointer,
int insertIndex)
Creates a
TagReference instance which represents a reference to PdfStructElem . |
TagTreePointer(TagTreePointer tagPointer)
A copy constructor.
|
Copyright © 1998–2023 Apryse Group NV. All rights reserved.