com.hfg.xml.msofficexml.docx.wordprocessingml

Class WmlPageMargins

java.lang.Object

com.hfg.xml.XMLContainerImpl

com.hfg.xml.XMLTag

com.hfg.xml.msofficexml.docx.wordprocessingml.WmlPageMargins

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

public class WmlPageMargins
extends XMLTag

Page margins tag (<pgMar>) of a OfficeOpenXML Docx document.

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
WmlPageMargins()

Method Summary

Modifier and Type	Method and Description
GfxSize	getBottom()
GfxSize	getFooter()
GfxSize	getGutter()
GfxSize	getHeader()
GfxSize	getLeft()
GfxSize	getRight()
GfxSize	getTop()
WmlPageMargins	setBottom(GfxSize inValue) Specifies the distance (in twentieths of a point) between the bottom of the text margins for the main document and the bottom of the page for all pages in this section.
WmlPageMargins	setFooter(GfxSize inValue) Specifies the distance (in twips or twentieths of a point) from the bottom edge of the page to the bottom edge of the footer.
WmlPageMargins	setGutter(GfxSize inValue) Specifies the page gutter (the extra space added to the margin, typically to account for binding).
WmlPageMargins	setHeader(GfxSize inValue) Specifies the distance (in twips or twentieths of a point) from the top edge of the page to the top edge of the header.
WmlPageMargins	setLeft(GfxSize inValue) Specifies the distance (in twips or twentieths of a point) from the left edge of the page to the left edge of the text.
WmlPageMargins	setRight(GfxSize inValue) Specifies the distance (in twips or twentieths of a point) from the right edge of the page to the right edge of the text.
WmlPageMargins	setTop(GfxSize inValue) Specifies the distance (in twips or twentieths of a point) from the top edge of the page to the top edge of the text.

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, toIndentedXML, toString, toXML, 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

WmlPageMargins

public WmlPageMargins()

Method Detail

setBottom

public WmlPageMargins setBottom(GfxSize inValue)

Specifies the distance (in twentieths of a point) between the bottom of the text margins for the main document and the bottom of the page for all pages in this section.

Parameters:

inValue - distance specified in generic GfxSize which will be converted to twisps (twentieths of a point)

Returns:

this WmlPageMargins object to enable method chaining

getBottom

public GfxSize getBottom()

setFooter

public WmlPageMargins setFooter(GfxSize inValue)

Specifies the distance (in twips or twentieths of a point) from the bottom edge of the page to the bottom edge of the footer.

Parameters:

inValue - distance specified in generic GfxSize which will be converted to twisps (twentieths of a point)

Returns:

this WmlPageMargins object to enable method chaining

getFooter

public GfxSize getFooter()

setGutter

public WmlPageMargins setGutter(GfxSize inValue)

Specifies the page gutter (the extra space added to the margin, typically to account for binding).

Parameters:

inValue - distance specified in generic GfxSize which will be converted to twisps (twentieths of a point)

Returns:

this WmlPageMargins object to enable method chaining

getGutter

public GfxSize getGutter()

setHeader

public WmlPageMargins setHeader(GfxSize inValue)

Specifies the distance (in twips or twentieths of a point) from the top edge of the page to the top edge of the header.

Parameters:

inValue - distance specified in generic GfxSize which will be converted to twisps (twentieths of a point)

Returns:

this WmlPageMargins object to enable method chaining

getHeader

public GfxSize getHeader()

setLeft

public WmlPageMargins setLeft(GfxSize inValue)

Specifies the distance (in twips or twentieths of a point) from the left edge of the page to the left edge of the text.

Parameters:

inValue - distance specified in generic GfxSize which will be converted to twisps (twentieths of a point)

Returns:

this WmlPageMargins object to enable method chaining

getLeft

public GfxSize getLeft()

setRight

public WmlPageMargins setRight(GfxSize inValue)

Specifies the distance (in twips or twentieths of a point) from the right edge of the page to the right edge of the text.

Parameters:

inValue - distance specified in generic GfxSize which will be converted to twisps (twentieths of a point)

Returns:

this WmlPageMargins object to enable method chaining

getRight

public GfxSize getRight()

setTop

public WmlPageMargins setTop(GfxSize inValue)

Specifies the distance (in twips or twentieths of a point) from the top edge of the page to the top edge of the text.

Parameters:

inValue - distance specified in generic GfxSize which will be converted to twisps (twentieths of a point)

Returns:

this WmlPageMargins object to enable method chaining

getTop

public GfxSize getTop()