Package org.docx4j.toc

Class Toc

java.lang.Object
org.docx4j.toc.Toc
public class Toc
extends java.lang.Object

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected static java.lang.String DEFAULT_TOC_HEADING  

  • Constructor Summary

    Constructors
    Constructor Description
    Toc​(java.lang.String tocInstruction)  

  • Method Summary

    Modifier and Type Method Description
    java.util.List<SwitchInterface> getSwitches()  
    protected static java.lang.String getTocHeadingText()  
    java.util.List<R> getTocInstruction()
    Deprecated.
    boolean hasErrors()  
    static void setTocHeadingText​(java.lang.String tocHeadingText)
    Use the provided text for the ToC heading.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULT_TOC_HEADING

      protected static java.lang.String DEFAULT_TOC_HEADING

  • Constructor Details

  • Method Details

    • setTocHeadingText

      public static void setTocHeadingText​(java.lang.String tocHeadingText)
      Use the provided text for the ToC heading. (Except in ToC update case where the existing heading P is to be re-used)
      Parameters:
      tocHeadingText -

    • getTocHeadingText

      protected static java.lang.String getTocHeadingText()

    • hasErrors

      public boolean hasErrors()

    • getSwitches

      public java.util.List<SwitchInterface> getSwitches()

    • getTocInstruction

      @Deprecated public java.util.List<R> getTocInstruction()
      Deprecated.