Package org.docx4j.model.datastorage

Interface BindingTraverserInterface

All Known Implementing Classes:

BindingTraverserCommonImpl, BindingTraverserNonXSLT, BindingTraverserStAX, BindingTraverserXSLT

public interface BindingTraverserInterface

Method Summary

Modifier and Type	Method	Description
AtomicInteger	getNextBookmarkId()	Since we are potentially processing multiple parts (ie main document part, headers, footers), we need to be able to pass the number from part to part.
void	setStartingIdForNewBookmarks(AtomicInteger bookmarkId)	Provide a way to set the starting bookmark ID number for the purposes of Binding Traverse.
Object	traverseToBind(JaxbXmlPart part, OpcPackage pkg, Map<String,Xpaths.Xpath> xpathsMap)	Traverse (typically a clone of) the part, binding content controls.

Method Details

traverseToBind

Object traverseToBind(JaxbXmlPart part,
 OpcPackage pkg,
 Map<String,Xpaths.Xpath> xpathsMap)
               throws Docx4JException

Traverse (typically a clone of) the part, binding content controls. Returns JAXB content tree.

Throws:

Docx4JException

setStartingIdForNewBookmarks

void setStartingIdForNewBookmarks(AtomicInteger bookmarkId)

Provide a way to set the starting bookmark ID number for the purposes of Binding Traverse. For efficiency, user code needs to pass this value through from the previous stage (repeats/condition handing). If it isn't, the value will be calculated (less efficient). New bookmarks could be created from XHTML, or renumbered in Flat OPC XML (TODO).

Parameters:

bookmarkId -

Since:

3.2.1

getNextBookmarkId

AtomicInteger getNextBookmarkId()

Since we are potentially processing multiple parts (ie main document part, headers, footers), we need to be able to pass the number from part to part.

Since:

3.2.1