Package com.itextpdf.kernel.pdf.tagutils

Class TagTreeIterator

java.lang.Object

com.itextpdf.kernel.pdf.tagutils.TagTreeIterator

       public class TagTreeIterator extends 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 enum	TagTreeIterator.TreeTraversalOrder	Tree traversal order enum.

Constructor Summary

Constructors

Constructor	Description
TagTreeIterator(IStructureNode tagTreePointer)	Creates a new instance of TagTreeIterator.
TagTreeIterator(IStructureNode tagTreePointer, TagTreeIterator.TreeTraversalOrder traversalOrder)	Creates a new instance of TagTreeIterator.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Details

TagTreeIterator

             public TagTreeIterator
             (IStructureNode tagTreePointer)
            

Creates a new instance of TagTreeIterator. It will use TreeTraversalOrder.PRE_ORDER for tree traversal.

Parameters:

tagTreePointer - the tag tree pointer.

TagTreeIterator

             public TagTreeIterator
             (IStructureNode tagTreePointer, TagTreeIterator.TreeTraversalOrder traversalOrder)
            

Creates a new instance of TagTreeIterator.

Parameters:

tagTreePointer - the tag tree pointer

traversalOrder - an order in which the tree will be traversed.

Method Details

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.