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
private static final String	BACKSLASH
protected static String	DEFAULT_TOC_HEADING
private static final String	DEFAULT_TOC_INSTRUCTION
private static final String	ERROR_BOOKMARK_NOT_DEFINED
private String	errorString
private static org.slf4j.Logger	log
private static final String	SPACE
private List<SwitchInterface>	switchesList
private static final String	TOC_INSTRUCTION_MASK
private String	tocInstruction
private static ObjectFactory	wmlObjectFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Toc()
	Toc(String tocInstruction)

Method Summary

Modifier and Type	Method	Description
List<SwitchInterface>	getSwitches()
protected static String	getTocHeadingText()
List<R>	getTocInstruction()	Deprecated.
boolean	hasErrors()
private void	parseInstruction()
static void	setTocHeadingText(String tocHeadingText)	Use the provided text for the ToC heading.
private void	sortSwitchesListByPriority()	The switches are processed in a specific order.

Methods inherited from class java.lang.Object

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

Field Details

log

private static org.slf4j.Logger log

ERROR_BOOKMARK_NOT_DEFINED

private static final String ERROR_BOOKMARK_NOT_DEFINED

See Also:

• Constant Field Values

SPACE

private static final String SPACE

See Also:

• Constant Field Values

BACKSLASH

private static final String BACKSLASH

See Also:

• Constant Field Values

TOC_INSTRUCTION_MASK

private static final String TOC_INSTRUCTION_MASK

See Also:

• Constant Field Values

DEFAULT_TOC_INSTRUCTION

private static final String DEFAULT_TOC_INSTRUCTION

See Also:

• Constant Field Values

DEFAULT_TOC_HEADING

protected static String DEFAULT_TOC_HEADING

tocInstruction

private String tocInstruction

errorString

private String errorString

wmlObjectFactory

private static ObjectFactory wmlObjectFactory

switchesList

private List<SwitchInterface> switchesList

Constructor Details

Toc

private Toc()

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()

parseInstruction

private void parseInstruction()
                       throws TocException

Throws:

TocException

sortSwitchesListByPriority

private void sortSwitchesListByPriority()

The switches are processed in a specific order. p10 O (heading Outline) p 9 T (sTyle) p 8 U (oUtline) p 7 C (SEQ entries) p 6 N (page number) p 5 H (Hyperlink)

hasErrors

public boolean hasErrors()

getSwitches

public List<SwitchInterface> getSwitches()

getTocInstruction

@Deprecated
public List<R> getTocInstruction()

Deprecated.