org.docx4j.toc.switches

Class SwitchProcessor

java.lang.Object

org.docx4j.toc.switches.SwitchProcessor

public class SwitchProcessor
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyResolver	propertyResolver
protected StyleBasedOnHelper	styleBasedOnHelper

Constructor Summary

Constructors

Constructor and Description
SwitchProcessor(PageDimensions pageDimensions, STTabTlc leader)

Method Summary

Modifier and Type	Method and Description
void	bookmarkP(P p, String name, int id) Surround the specified r in the specified p with a bookmark (with specified name and id)
protected AtomicInteger	getBookmarkId(WordprocessingMLPackage wordMLPackage)
TocEntry	getEntry()
boolean	isStyleFound()
boolean	pageNumbers()
void	proceed(boolean proceed)
List<TocEntry>	processSwitches(WordprocessingMLPackage wordMLPackage, List<P> pList, List<SwitchInterface> switchesList, Map<P,Emulator.ResultTriple> pNumbersMap)
void	setPageNumbers(boolean pageNumbers)
void	setStartingIdForNewBookmarks(AtomicInteger bookmarkId) Provide a way to set the starting bookmark ID number.
void	setStyleFound(boolean headingFound)

Methods inherited from class java.lang.Object

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

Field Detail

propertyResolver

protected PropertyResolver propertyResolver

styleBasedOnHelper

protected StyleBasedOnHelper styleBasedOnHelper

Constructor Detail

SwitchProcessor

public SwitchProcessor(PageDimensions pageDimensions,
                       STTabTlc leader)

Method Detail

processSwitches

public List<TocEntry> processSwitches(WordprocessingMLPackage wordMLPackage,
                                      List<P> pList,
                                      List<SwitchInterface> switchesList,
                                      Map<P,Emulator.ResultTriple> pNumbersMap)

bookmarkP

public void bookmarkP(P p,
                      String name,
                      int id)

Surround the specified r in the specified p with a bookmark (with specified name and id)

Parameters:

p -

r -

name -

id -

setPageNumbers

public void setPageNumbers(boolean pageNumbers)

pageNumbers

public boolean pageNumbers()

getEntry

public TocEntry getEntry()

proceed

public void proceed(boolean proceed)

isStyleFound

public boolean isStyleFound()

setStyleFound

public void setStyleFound(boolean headingFound)

setStartingIdForNewBookmarks

public void setStartingIdForNewBookmarks(AtomicInteger bookmarkId)

Provide a way to set the starting bookmark ID number. For efficiency, user code needs to pass this value through. If it isn't, the value will be calculated (less efficient).

Parameters:

bookmarkId -

Since:

3.3.0

getBookmarkId

protected AtomicInteger getBookmarkId(WordprocessingMLPackage wordMLPackage)