org.docx4j.toc.switches

Class OSwitch

java.lang.Object

org.docx4j.toc.switches.AbstractSwitch

org.docx4j.toc.switches.OSwitch

All Implemented Interfaces:

SwitchInterface

public class OSwitch
extends AbstractSwitch

Uses paragraphs formatted with (or based on) all or the specified range of built-in heading styles. Headings in a style range are specified by text in this switch's field-argument using the notation specified as for \l, where each integer corresponds to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1). If no heading range is specified, all heading levels used in the document are listed. Actually Word 2010 does this based on style's w:name (TODO confirm its that or id, not instead of id)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

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

EMPTY, ERROR_NOT_VALID_HEADING_LEVEL

Constructor Summary

Constructors

Constructor and Description
OSwitch()

Method Summary

Modifier and Type	Method and Description
int	getPriority()
boolean	hasFieldArgument()
boolean	isStyleSwitch()
String	parseFieldArgument(String fieldArgument)
void	process(Style s, SwitchProcessor sp)

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

getEndLevel, getStartLevel, getStyleLevelMap

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

OSwitch

public OSwitch()

Method Detail

process

public void process(Style s,
                    SwitchProcessor sp)

parseFieldArgument

public String parseFieldArgument(String fieldArgument)

Specified by:

parseFieldArgument in interface SwitchInterface

Overrides:

parseFieldArgument in class AbstractSwitch

hasFieldArgument

public boolean hasFieldArgument()

getPriority

public int getPriority()

isStyleSwitch

public boolean isStyleSwitch()

Specified by:

isStyleSwitch in interface SwitchInterface

Overrides:

isStyleSwitch in class AbstractSwitch