com.hfg.xml.msofficexml.docx.wordprocessingml

Class WmlSectionProperties

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

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, java.lang.Cloneable

public class WmlSectionProperties
extends WmlXMLTag

Represents an Office Open XML section properties (<w:sectPr>) tag.

Nested Class Summary

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

XMLContainerImpl.sMode

Field Summary

Fields inherited from class com.hfg.xml.XMLContainerImpl

mContentAndSubtagList

Constructor Summary

Constructors

Constructor and Description
WmlSectionProperties(Docx inDocx)

Method Summary

Modifier and Type	Method and Description
void	addFooter(WmlFooter inValue, WmlHeaderFooterType inType)
void	addHeader(WmlHeader inValue, WmlHeaderFooterType inType)
GfxSize2D	getContentDimensions()
WmlPageMargins	getPageMargins() Returns the page margins if one exists or else instantiates a new one.
WmlPageSize	getPageSize() Returns the page size tag if one exists or else instantiates a new one.
WmlSectionProperties	setPageSize(PaperSize inValue) Sets the page dimensions based on the specified paper size.
WmlSectionProperties	setPageSize(PaperSize inSize, Orientation inOrientation) Sets the page dimensions based on the specified paper size and orientation.

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

getParentDoc

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

orderSubtags, setParentDoc, toIndentedXML, toXML

Methods inherited from class com.hfg.xml.XMLTag

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

Methods inherited from class com.hfg.xml.XMLContainerImpl

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

Methods inherited from class java.lang.Object

equals, 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

WmlSectionProperties

public WmlSectionProperties(Docx inDocx)

Method Detail

setPageSize

public WmlSectionProperties setPageSize(PaperSize inSize,
                                        Orientation inOrientation)

Sets the page dimensions based on the specified paper size and orientation.

setPageSize

public WmlSectionProperties setPageSize(PaperSize inValue)

Sets the page dimensions based on the specified paper size.

getPageSize

public WmlPageSize getPageSize()

Returns the page size tag if one exists or else instantiates a new one.

Returns:

the page size tag for this section

getPageMargins

public WmlPageMargins getPageMargins()

Returns the page margins if one exists or else instantiates a new one.

Returns:

the page margins for this section

getContentDimensions

public GfxSize2D getContentDimensions()

addHeader

public void addHeader(WmlHeader inValue,
                      WmlHeaderFooterType inType)

addFooter

public void addFooter(WmlFooter inValue,
                      WmlHeaderFooterType inType)