com.hfg.xml.msofficexml.docx.wordprocessingml.style

Class WmlParagraphStyle

java.lang.Object

com.hfg.xml.XMLContainerImpl

com.hfg.xml.XMLTag

com.hfg.xml.msofficexml.OfficeOpenXMLTag

com.hfg.xml.msofficexml.docx.wordprocessingml.WmlXMLTag

com.hfg.xml.msofficexml.docx.wordprocessingml.style.WmlStyle

com.hfg.xml.msofficexml.docx.wordprocessingml.style.WmlParagraphStyle

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

public class WmlParagraphStyle
extends WmlStyle

Paragraph style for Docx's Office Open XML documents.

Nested Class Summary

Nested classes/interfaces inherited from class com.hfg.xml.XMLContainerImpl

XMLContainerImpl.sMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADING1_STYLE_ID
static String	HEADING2_STYLE_ID
static String	LIST_PARAGRAPH_STYLE_ID
static String	NORMAL_STYLE_ID
static String	TOC_HEADING_STYLE_ID
static String	TOC1_STYLE_ID
static String	TOC2_STYLE_ID
static String	TOC3_STYLE_ID

Fields inherited from class com.hfg.xml.msofficexml.OfficeOpenXMLTag

sSQLLoggingLevel

Fields inherited from class com.hfg.xml.XMLContainerImpl

mContentAndSubtagList

Constructor Summary

Constructors

Constructor and Description
WmlParagraphStyle(Docx inDocx)
WmlParagraphStyle(String inId, Docx inDocx)

Method Summary

Modifier and Type	Method and Description
static List<WmlStyle>	generateDefaultStyles(Docx inParentDoc)
WmlTextRunProperties	getTextRunProperties() Returns the run properties tag if one exists or else instantiates a new one.
WmlParagraphStyle	setAutoRedefine()
WmlParagraphStyle	setBasedOn(String inStyleId)
WmlParagraphStyle	setLink(String inStyleId)
WmlParagraphStyle	setName(String inValue)
WmlParagraphStyle	setNext(String inStyleId) Sets the style that should be used for the paragraph that follows this one.
WmlParagraphStyle	setPrimaryStyle(boolean inValue) Specifies whether this is a "Primary Style" which should be included in the Quick Gallery.
WmlParagraphStyle	setSemiHidden()
WmlParagraphStyle	setUI_Priority(Integer inValue)
WmlParagraphStyle	setUnhideWhenUsed()

Methods inherited from class com.hfg.xml.msofficexml.docx.wordprocessingml.style.WmlStyle

getId, getName, getParagraphProperties, getType, setId, setIsDefault

Methods inherited from class com.hfg.xml.msofficexml.docx.wordprocessingml.WmlXMLTag

addSubtag, addSubtag, getParentDoc, getParentOfficeXMLPart

Methods inherited from class com.hfg.xml.msofficexml.OfficeOpenXMLTag

colorToCT_Color, generateUID, getLogger, orderSubtags, setParentDoc, toIndentedXML, toXML

Methods inherited from class com.hfg.xml.XMLTag

addSubtag, addSubtag, addXMLNamespaceDeclaration, clone, compareTo, equals, findNodesByAttributeValue, findNodesByAttributeValue, getAttribute, getAttribute, getAttributes, getAttributeValue, getAttributeValue, getEndTag, getNamespace, getQualifiedTagName, getStartTag, getTagName, hasAttribute, hasAttribute, hasAttributes, isEmptyTag, removeAttribute, removeAttribute, replaceCharacterEntities, setAttribute, setAttribute, setAttribute, setAttributes, setContent, setDefaultXMLNamespaceDeclaration, setNamespace, setSortAttributesBeforeWriting, setTagName, setTagName, sortAttributes, toIndentedXML, toIndentedXML, toIndentedXML, toString, toXML, toXML, toXML, useDoubleQuotes, verifyTagName, verifyTagName, verifyTagName, verifyTagName

Methods inherited from class com.hfg.xml.XMLContainerImpl

addContent, addContentWithoutEscaping, addSubtag, addSubtag, addSubtags, clearContent, clearSubtags, getContent, getContentPlusSubtagList, getNextSibling, getOptionalSubtagByName, getOptionalSubtagByName, getOptionalSubtagByName, getOptionalSubtagByName, getParentNode, getPreviousSibling, getRequiredSubtagById, getRequiredSubtagById, getRequiredSubtagByName, getRequiredSubtagByName, getSubtagByAttribute, getSubtagByAttribute, getSubtags, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByAttribute, getSubtagsByClass, getSubtagsByClass, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getTotalTagCount, getUnescapedContent, getXMLNodeSubtags, hasContent, hasContentOrSubtags, indexOf, innerHTML, removeSubtag, removeSubtagsByAttribute, removeSubtagsByAttribute, removeSubtagsByAttribute, removeSubtagsByClass, removeSubtagsByClass, removeSubtagsByName, removeSubtagsByName, removeSubtagsByName, setContent, setParentNode, setSubtags

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hfg.xml.XMLContainer

addContent, addContentWithoutEscaping, addSubtag, addSubtags, clearContent, clearSubtags, getContent, getNextSibling, getOptionalSubtagByName, getOptionalSubtagByName, getParentNode, getPreviousSibling, getRequiredSubtagByName, getRequiredSubtagByName, getSubtags, getSubtagsByName, getSubtagsByName, getSubtagsByName, getSubtagsByName, getTotalTagCount, getUnescapedContent, getXMLNodeSubtags, hasContent, indexOf, removeSubtag, removeSubtagsByName, removeSubtagsByName, setParentNode, setSubtags

Field Detail

NORMAL_STYLE_ID

public static final String NORMAL_STYLE_ID

See Also:

Constant Field Values

HEADING1_STYLE_ID

public static final String HEADING1_STYLE_ID

See Also:

Constant Field Values

HEADING2_STYLE_ID

public static final String HEADING2_STYLE_ID

See Also:

Constant Field Values

TOC_HEADING_STYLE_ID

public static final String TOC_HEADING_STYLE_ID

See Also:

Constant Field Values

TOC1_STYLE_ID

public static final String TOC1_STYLE_ID

See Also:

Constant Field Values

TOC2_STYLE_ID

public static final String TOC2_STYLE_ID

See Also:

Constant Field Values

TOC3_STYLE_ID

public static final String TOC3_STYLE_ID

See Also:

Constant Field Values

LIST_PARAGRAPH_STYLE_ID

public static final String LIST_PARAGRAPH_STYLE_ID

See Also:

Constant Field Values

Constructor Detail

WmlParagraphStyle

public WmlParagraphStyle(Docx inDocx)

WmlParagraphStyle

public WmlParagraphStyle(String inId,
                         Docx inDocx)

Method Detail

setName

public WmlParagraphStyle setName(String inValue)

Overrides:

setName in class WmlStyle

setBasedOn

public WmlParagraphStyle setBasedOn(String inStyleId)

Overrides:

setBasedOn in class WmlStyle

setSemiHidden

public WmlParagraphStyle setSemiHidden()

Overrides:

setSemiHidden in class WmlStyle

setUnhideWhenUsed

public WmlParagraphStyle setUnhideWhenUsed()

Overrides:

setUnhideWhenUsed in class WmlStyle

setLink

public WmlParagraphStyle setLink(String inStyleId)

Overrides:

setLink in class WmlStyle

setUI_Priority

public WmlParagraphStyle setUI_Priority(Integer inValue)

Overrides:

setUI_Priority in class WmlStyle

setPrimaryStyle

public WmlParagraphStyle setPrimaryStyle(boolean inValue)

Specifies whether this is a "Primary Style" which should be included in the Quick Gallery.

Parameters:

inValue - whether this is a "Primary Style" which should be included in the Quick Gallery

Returns:

this style object to enable method chaining

getTextRunProperties

public WmlTextRunProperties getTextRunProperties()

Returns the run properties tag if one exists or else instantiates a new one.

Overrides:

getTextRunProperties in class WmlStyle

Returns:

the run properties

setNext

public WmlParagraphStyle setNext(String inStyleId)

Sets the style that should be used for the paragraph that follows this one.

setAutoRedefine

public WmlParagraphStyle setAutoRedefine()

generateDefaultStyles

public static List<WmlStyle> generateDefaultStyles(Docx inParentDoc)