Package org.docx4j.model.datastorage

Interface BindingTraverserInterface

All Known Implementing Classes:
BindingTraverserCommonImpl, BindingTraverserNonXSLT, BindingTraverserXSLT
public interface BindingTraverserInterface

  • Method Summary

    Modifier and Type Method Description
    java.util.concurrent.atomic.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​(java.util.concurrent.atomic.AtomicInteger bookmarkId)
    Provide a way to set the starting bookmark ID number for the purposes of Binding Traverse.
    java.lang.Object traverseToBind​(JaxbXmlPart part, OpcPackage pkg, java.util.Map<java.lang.String,​Xpaths.Xpath> xpathsMap)  

  • Method Details

    • traverseToBind

      java.lang.Object traverseToBind​(JaxbXmlPart part, OpcPackage pkg, java.util.Map<java.lang.String,​Xpaths.Xpath> xpathsMap) throws Docx4JException
      Throws:
      Docx4JException

    • setStartingIdForNewBookmarks

      void setStartingIdForNewBookmarks​(java.util.concurrent.atomic.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

      java.util.concurrent.atomic.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