Package org.docx4j.toc

Class Toc

java.lang.Object

org.docx4j.toc.Toc

public class Toc
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	DEFAULT_TOC_HEADING

Constructor Summary

Constructors

Constructor	Description
Toc(String tocInstruction)

Method Summary

Modifier and Type	Method	Description
List<SwitchInterface>	getSwitches()
protected static String	getTocHeadingText()
List<R>	getTocInstruction()	Deprecated.
boolean	hasErrors()
static void	setTocHeadingText(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 String DEFAULT_TOC_HEADING

Constructor Details

Toc

public Toc(String tocInstruction)
    throws TocException

Throws:

TocException

Method Details

setTocHeadingText

public static void setTocHeadingText(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 String getTocHeadingText()

hasErrors

public boolean hasErrors()

getSwitches

public List<SwitchInterface> getSwitches()

getTocInstruction

@Deprecated
public List<R> getTocInstruction()

Deprecated.