Package com.itextpdf.kernel.pdf.tagutils
Class TagTreeIterator
- java.lang.Object
-
- com.itextpdf.kernel.pdf.tagutils.TagTreeIterator
-
public class TagTreeIterator extends java.lang.Object
This class is used to traverse the tag tree.There is a possibility to add a handler that will be called for the elements during the traversal.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TagTreeIterator.TreeTraversalOrder
Tree traversal order enum.
-
Field Summary
Fields Modifier and Type Field Description private TagTreeIteratorElementApprover
approver
private java.util.Set<ITagTreeIteratorHandler>
handlerList
private IStructureNode
pointer
private TagTreeIterator.TreeTraversalOrder
traversalOrder
-
Constructor Summary
Constructors Constructor Description TagTreeIterator(IStructureNode tagTreePointer)
Creates a new instance ofTagTreeIterator
.TagTreeIterator(IStructureNode tagTreePointer, TagTreeIteratorElementApprover approver, TagTreeIterator.TreeTraversalOrder traversalOrder)
Creates a new instance ofTagTreeIterator
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TagTreeIterator
addHandler(ITagTreeIteratorHandler handler)
Adds a handler that will be called for the elements during the traversal.void
traverse()
Traverses the tag tree in the order of the document structure.private void
traverse(IStructureNode elem)
-
-
-
Field Detail
-
pointer
private final IStructureNode pointer
-
handlerList
private final java.util.Set<ITagTreeIteratorHandler> handlerList
-
approver
private final TagTreeIteratorElementApprover approver
-
traversalOrder
private final TagTreeIterator.TreeTraversalOrder traversalOrder
-
-
Constructor Detail
-
TagTreeIterator
public TagTreeIterator(IStructureNode tagTreePointer)
Creates a new instance ofTagTreeIterator
. It will useTagTreeIteratorElementApprover
to filter elements and TreeTraversalOrder.PRE_ORDER for tree traversal.- Parameters:
tagTreePointer
- the tag tree pointer.
-
TagTreeIterator
public TagTreeIterator(IStructureNode tagTreePointer, TagTreeIteratorElementApprover approver, TagTreeIterator.TreeTraversalOrder traversalOrder)
Creates a new instance ofTagTreeIterator
.- Parameters:
tagTreePointer
- the tag tree pointer.approver
- a filter that will be called to let iterator know whether some particular element should be traversed or not.traversalOrder
- an order in which the tree will be traversed.
-
-
Method Detail
-
addHandler
public TagTreeIterator addHandler(ITagTreeIteratorHandler handler)
Adds a handler that will be called for the elements during the traversal.- Parameters:
handler
- the handler.- Returns:
- this
TagTreeIterator
instance.
-
traverse
public void traverse()
Traverses the tag tree in the order of the document structure.Make sure the correct handlers are added before calling this method.
-
traverse
private void traverse(IStructureNode elem)
-
-