Package org.docx4j.toc.switches

Class OSwitch

java.lang.Object

org.docx4j.toc.switches.AbstractSwitch

org.docx4j.toc.switches.SelectorSwitch

org.docx4j.toc.switches.OSwitch

All Implemented Interfaces:

SwitchInterface

public class OSwitch
extends SelectorSwitch

heading Outline switch Per http://webapp.docx4java.org/OnlineDemo/ecma376/WordML/TOC.html 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	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
OSwitch()

Method Summary

Modifier and Type	Method	Description
int	getPriority()
boolean	hasFieldArgument()
boolean	isSelectorSwitch()
String	parseFieldArgument(String fieldArgument)	Default implementation doesn't need to parse at all.
void	process(Style s, SwitchProcessorInterface sp)

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

getEndLevel, getStartLevel, getStyleLevelMap, prepareArgument

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

OSwitch

public OSwitch()

Method Details

process

public void process(Style s,
 SwitchProcessorInterface sp)

parseFieldArgument

public String parseFieldArgument(String fieldArgument)

Description copied from class: AbstractSwitch

Default implementation doesn't need to parse at all.

Specified by:

parseFieldArgument in interface SwitchInterface

Overrides:

parseFieldArgument in class AbstractSwitch

Parameters:

fieldArgument - .

Returns:

error string if any for exception

hasFieldArgument

public boolean hasFieldArgument()

getPriority

public int getPriority()

isSelectorSwitch

public boolean isSelectorSwitch()

Overrides:

isSelectorSwitch in class AbstractSwitch