Package org.docx4j.toc

Class TocFinder

java.lang.Object

org.docx4j.TraversalUtil.CallbackImpl

org.docx4j.toc.TocFinder

All Implemented Interfaces:

TraversalUtil.Callback

public class TocFinder
extends TraversalUtil.CallbackImpl

Don't attempt to reuse this; create a new TocFinder object each time you invoke it.

Constructor Summary

Constructors

Constructor	Description
TocFinder()

Method Summary

Modifier and Type	Method	Description
List<Object>	apply(Object o)	Visits a node in pre order (before its children have been visited).
List<Object>	getChildren(Object o)
SdtBlock	getTocSDT()
boolean	shouldTraverse(Object o)	Decide whether this node's children should be traversed.
void	walkJAXBElements(Object parent)

Methods inherited from class java.lang.Object

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

Constructor Details

TocFinder

public TocFinder()

Method Details

getTocSDT

public SdtBlock getTocSDT()

Returns:

Since:

3.3.1

apply

public List<Object> apply(Object o)

Description copied from class: TraversalUtil.CallbackImpl

Visits a node in pre order (before its children have been visited). A node is visited only if all its parents have been traversed ( TraversalUtil.CallbackImpl.shouldTraverse(Object)).

Implementations can have side effects.

Specified by:

apply in interface TraversalUtil.Callback

Specified by:

apply in class TraversalUtil.CallbackImpl

walkJAXBElements

public void walkJAXBElements(Object parent)

Specified by:

walkJAXBElements in interface TraversalUtil.Callback

Overrides:

walkJAXBElements in class TraversalUtil.CallbackImpl

getChildren

public List<Object> getChildren(Object o)

Specified by:

getChildren in interface TraversalUtil.Callback

Overrides:

getChildren in class TraversalUtil.CallbackImpl

shouldTraverse

public boolean shouldTraverse(Object o)

Decide whether this node's children should be traversed.

Specified by:

shouldTraverse in interface TraversalUtil.Callback

Overrides:

shouldTraverse in class TraversalUtil.CallbackImpl

Returns:

whether the children of this node should be visited