com.hfg.xml.msofficexml.docx.wordprocessingml

Class WmlParagraphProperties

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.WmlParagraphProperties

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

public class WmlParagraphProperties
extends WmlXMLTag

Represents an Office Open XML paragraph properties (<w:pPr>) tag.

From Ecma Office Open XML Part 1 - 17.3.1.26 pPr (Paragraph Properties):
"This element specifies a set of paragraph properties which shall be applied to the contents of the parent paragraph after all style/numbering/table properties have been applied to the text. These properties are defined as direct formatting, since they are directly applied to the paragraph and supersede any formatting from styles."

Nested Class Summary

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

XMLContainerImpl.sMode

Field Summary

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
WmlParagraphProperties(Docx inDocx)

Method Summary

Modifier and Type	Method and Description
WmlParagraphProperties	addTab(WmlTab inValue) Adds a tab stop definition.
WmlParagraphBorder	getBorders()
WmlIndentation	getIndentation()
WmlNumberingProperties	getNumberingProperties() Returns the numbering properties tag if one exists or else instantiates a new one.
WmlTextRunProperties	getRunProperties() Returns the run properties tag if one exists or else instantiates a new one.
WmlSectionProperties	getSectionProperties() Returns the section properties tag if one exists or else instantiates a new one.
WmlShading	getShading()
WmlSpacing	getSpacing()
List<WmlTab>	getTabs() Adds a tab stop definition.
WmlParagraphProperties	setContextualSpacing(boolean inValue) Specifies that this paragraph should use contextual spacing.
WmlParagraphProperties	setJustification(WmlJustification inValue)
WmlParagraphProperties	setKeepLines() Specifies that this paragraph's lines should be kept on one page.
WmlParagraphProperties	setKeepNext() Specifies that this paragraph should not be separated by a page break from the one that follows it.
WmlParagraphProperties	setOutlineLevel(Integer inValue)
WmlParagraphProperties	setPageBreakBefore(boolean inValue) Specifies whether or not this paragraph should be preceded by a page break.
WmlParagraphProperties	setStyle(String inStyleId)

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

Constructor Detail

WmlParagraphProperties

public WmlParagraphProperties(Docx inDocx)

Method Detail

setStyle

public WmlParagraphProperties setStyle(String inStyleId)

setOutlineLevel

public WmlParagraphProperties setOutlineLevel(Integer inValue)

getBorders

public WmlParagraphBorder getBorders()

getShading

public WmlShading getShading()

getSpacing

public WmlSpacing getSpacing()

getIndentation

public WmlIndentation getIndentation()

setJustification

public WmlParagraphProperties setJustification(WmlJustification inValue)

setKeepNext

public WmlParagraphProperties setKeepNext()

Specifies that this paragraph should not be separated by a page break from the one that follows it.

setKeepLines

public WmlParagraphProperties setKeepLines()

Specifies that this paragraph's lines should be kept on one page.

setContextualSpacing

public WmlParagraphProperties setContextualSpacing(boolean inValue)

Specifies that this paragraph should use contextual spacing.

setPageBreakBefore

public WmlParagraphProperties setPageBreakBefore(boolean inValue)

Specifies whether or not this paragraph should be preceded by a page break.

getSectionProperties

public WmlSectionProperties getSectionProperties()

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

Returns:

the section properties for this table

getNumberingProperties

public WmlNumberingProperties getNumberingProperties()

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

Returns:

the numbering properties for this table

getRunProperties

public WmlTextRunProperties getRunProperties()

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

Returns:

the run properties for this table

addTab

public WmlParagraphProperties addTab(WmlTab inValue)

Adds a tab stop definition.

getTabs

public List<WmlTab> getTabs()

Adds a tab stop definition.