Package org.docx4j.toc.switches

Class SwitchProcessor

java.lang.Object

org.docx4j.toc.switches.SwitchProcessor

All Implemented Interfaces:

SwitchProcessorInterface

public class SwitchProcessor
extends Object
implements SwitchProcessorInterface

Field Summary

Fields

Modifier and Type	Field	Description
private AtomicInteger	bookmarkId
private TocEntry	entry
private STTabTlc	leader
private static org.slf4j.Logger	log
private static final int	MILLION
private PageDimensions	pageDimensions
private boolean	pageNumbers
protected PropertyResolver	propertyResolver
private boolean	selected
protected StyleBasedOnHelper	styleBasedOnHelper
private static final String	TOC_PREFIX

Constructor Summary

Constructors

Constructor	Description
SwitchProcessor(PageDimensions pageDimensions, STTabTlc leader)

Method Summary

Modifier and Type	Method	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)
private void	bookmarkStyleText(P p, String anchorValue, AtomicInteger id, TocEntry te)
protected AtomicInteger	getBookmarkId(WordprocessingMLPackage wordMLPackage)
TocEntry	getEntry()
PropertyResolver	getPropertyResolver()
StyleBasedOnHelper	getStyleBasedOnHelper()
private int	initBookmarkIdStart(WordprocessingMLPackage wordMLPackage)
boolean	isSelected()
boolean	pageNumbers()
List<TocEntry>	processSwitches(WordprocessingMLPackage wordMLPackage, List<P> pList, List<SwitchInterface> switchesList, Map<P,Emulator.ResultTriple> pNumbersMap)	Return a list consisting of those p in pList which are determined to form part of the ToC.
void	setPageNumbers(boolean pageNumbers)
void	setSelected(boolean selected)
void	setStartingIdForNewBookmarks(AtomicInteger bookmarkId)	Provide a way to set the starting bookmark ID number.

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

propertyResolver

protected PropertyResolver propertyResolver

styleBasedOnHelper

protected StyleBasedOnHelper styleBasedOnHelper

pageDimensions

private PageDimensions pageDimensions

TOC_PREFIX

private static final String TOC_PREFIX

See Also:

• Constant Field Values

MILLION

private static final int MILLION

See Also:

• Constant Field Values

entry

private TocEntry entry

leader

private STTabTlc leader

selected

private boolean selected

pageNumbers

private boolean pageNumbers

bookmarkId

private AtomicInteger bookmarkId

Constructor Details

SwitchProcessor

public SwitchProcessor(PageDimensions pageDimensions,
 STTabTlc leader)

Method Details

getPropertyResolver

public PropertyResolver getPropertyResolver()

Specified by:

getPropertyResolver in interface SwitchProcessorInterface

getStyleBasedOnHelper

public StyleBasedOnHelper getStyleBasedOnHelper()

Specified by:

getStyleBasedOnHelper in interface SwitchProcessorInterface

isSelected

public boolean isSelected()

Specified by:

isSelected in interface SwitchProcessorInterface

setSelected

public void setSelected(boolean selected)

Specified by:

setSelected in interface SwitchProcessorInterface

processSwitches

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

Return a list consisting of those p in pList which are determined to form part of the ToC.

Parameters:

wordMLPackage -

pList -

switchesList -

pNumbersMap -

Returns:

bookmarkStyleText

private void bookmarkStyleText(P p,
 String anchorValue,
 AtomicInteger id,
 TocEntry te)

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)

Specified by:

setPageNumbers in interface SwitchProcessorInterface

pageNumbers

public boolean pageNumbers()

getEntry

public TocEntry getEntry()

Specified by:

getEntry in interface SwitchProcessorInterface

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)

initBookmarkIdStart

private int initBookmarkIdStart(WordprocessingMLPackage wordMLPackage)