Package org.docx4j.toc.switches

Class USwitch

java.lang.Object

org.docx4j.toc.switches.AbstractSwitch

org.docx4j.toc.switches.USwitch

All Implemented Interfaces:

SwitchInterface

public class USwitch
extends AbstractSwitch

This switch indicates to consider the outline level set on the paragraph. That value trumps heading style (eg if outline level is set to body text, a heading won't appear in the outline), EXCEPT where the outline level is set in the heading style definition (which is ignored - the style name is parsed for the level!). If style X is based on heading style, and style X has an outline level setting, that setting is considered.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID

Fields inherited from class org.docx4j.toc.switches.AbstractSwitch

EMPTY, ERROR_NOT_VALID_HEADING_LEVEL

Constructor Summary

Constructors

Constructor	Description
USwitch()

Method Summary

Modifier and Type	Method	Description
int	getOutlineLvl(PPr pPr, SwitchProcessor sp, Style s, int cutOff)
int	getPriority()
boolean	hasFieldArgument()
void	process(Style s, SwitchProcessor sp)
void	process(Style s, SwitchProcessor sp, PPr pPr, OSwitch oSwitch)

Methods inherited from class org.docx4j.toc.switches.AbstractSwitch

getEndLevel, getStartLevel, getStyleLevelMap, isStyleSwitch, parseFieldArgument

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

USwitch

public USwitch()

Method Details

hasFieldArgument

public boolean hasFieldArgument()

process

public void process(Style s,
 SwitchProcessor sp)

process

public void process(Style s,
 SwitchProcessor sp,
 PPr pPr,
 OSwitch oSwitch)

getPriority

public int getPriority()

getOutlineLvl

public int getOutlineLvl(PPr pPr,
 SwitchProcessor sp,
 Style s,
 int cutOff)