Package org.docx4j.finders

Class SectPrFinder

java.lang.Object

org.docx4j.TraversalUtil.CallbackImpl

org.docx4j.finders.SectPrFinder

All Implemented Interfaces:

TraversalUtil.Callback

public class SectPrFinder
extends TraversalUtil.CallbackImpl

Constructor Summary

Constructors

Constructor	Description
SectPrFinder(MainDocumentPart mdp)

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<SectPr>	getOrderedSectPrList()	The body level sectPr (if there is one) is at the end of the list.
List<SectPr>	getSectPrList()	Deprecated.
boolean	shouldTraverse(Object o)	Decide whether this node's children should be traversed.

Methods inherited from class org.docx4j.TraversalUtil.CallbackImpl

getChildren, walkJAXBElements

Methods inherited from class java.lang.Object

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

Constructor Details

SectPrFinder

public SectPrFinder(MainDocumentPart mdp)

Method Details

getSectPrList

@Deprecated
public List<SectPr> getSectPrList()

Deprecated.

Note that the body level sectPr (if there is one) is at the start of the list.

Returns:

the sectPrList

getOrderedSectPrList

public List<SectPr> getOrderedSectPrList()

The body level sectPr (if there is one) is at the end of the list.

Returns:

the sectPrList

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

shouldTraverse

public boolean shouldTraverse(Object o)

Description copied from class: TraversalUtil.CallbackImpl

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