com.hfg.xml.msofficexml.docx.wordprocessingml

Class WmlTextRunProperties

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

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

public class WmlTextRunProperties
extends WmlXMLTag

Text run properties 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 inherited from class com.hfg.xml.msofficexml.OfficeOpenXMLTag

sSQLLoggingLevel

Fields inherited from class com.hfg.xml.XMLContainerImpl

mContentAndSubtagList

Constructor Summary

Constructors

Constructor and Description
WmlTextRunProperties(Docx inDocx)

Method Summary

Modifier and Type	Method and Description
WmlTextRunProperties	combine(WmlTextRunProperties inPropertiesToOverlay)
WmlTextRunProperties	disableSpellingAndGrammarChecks()
WmlTextBorder	getBorder()
WmlTextBorder	getBorder(CSSDeclaration inCSSDeclaration)
WmlShading	getShading()
WmlSpacing	getSpacing()
WmlTextRunProperties	setAnsiThemeFont(String inValue)
WmlTextRunProperties	setAsciiThemeFont(String inValue)
WmlTextRunProperties	setAutoColor()
WmlTextRunProperties	setBold()
WmlTextRunProperties	setColor(Color inColor)
WmlTextRunProperties	setComplexScriptBold()
WmlTextRunProperties	setComplexScriptItalics()
WmlTextRunProperties	setComplexScriptSize(GfxSize inValue) Specifies a positive measurement of complex script font size.
WmlTextRunProperties	setComplexScriptThemeFont(String inValue)
WmlTextRunProperties	setEastAsiaThemeFont(String inValue)
WmlTextRunProperties	setFont(Font inFont)
WmlTextRunProperties	setFont(String inFont)
WmlTextRunProperties	setHighlight(WmlHighlightColor inColor) Specifies a highlighting color to be applied as background behind the contents: <w:highlight w:val="red"/> This element will supersede any background shading specified in shd.
WmlTextRunProperties	setItalics()
WmlTextRunProperties	setShadow()
WmlTextRunProperties	setSize(GfxSize inValue) Specifies a positive measurement of font size.
WmlTextRunProperties	setSmallCaps()
WmlTextRunProperties	setStrikeThrough()
WmlTextRunProperties	setStyle(String inStyleId)
WmlTextRunProperties	setSubscript()
WmlTextRunProperties	setSuperscript()
WmlTextRunProperties	setThemeColor(String inValue)
WmlTextRunProperties	setThemeShade(String inValue)
WmlTextRunProperties	setUnderline()
WmlTextRunProperties	vanish()

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

WmlTextRunProperties

public WmlTextRunProperties(Docx inDocx)

Method Detail

combine

public WmlTextRunProperties combine(WmlTextRunProperties inPropertiesToOverlay)

setStyle

public WmlTextRunProperties setStyle(String inStyleId)

setBold

public WmlTextRunProperties setBold()

setComplexScriptBold

public WmlTextRunProperties setComplexScriptBold()

setItalics

public WmlTextRunProperties setItalics()

setComplexScriptItalics

public WmlTextRunProperties setComplexScriptItalics()

setUnderline

public WmlTextRunProperties setUnderline()

setSuperscript

public WmlTextRunProperties setSuperscript()

setSubscript

public WmlTextRunProperties setSubscript()

setShadow

public WmlTextRunProperties setShadow()

setSmallCaps

public WmlTextRunProperties setSmallCaps()

setColor

public WmlTextRunProperties setColor(Color inColor)

setAutoColor

public WmlTextRunProperties setAutoColor()

setThemeColor

public WmlTextRunProperties setThemeColor(String inValue)

setThemeShade

public WmlTextRunProperties setThemeShade(String inValue)

setFont

public WmlTextRunProperties setFont(Font inFont)

setFont

public WmlTextRunProperties setFont(String inFont)

setAnsiThemeFont

public WmlTextRunProperties setAnsiThemeFont(String inValue)

setAsciiThemeFont

public WmlTextRunProperties setAsciiThemeFont(String inValue)

setComplexScriptThemeFont

public WmlTextRunProperties setComplexScriptThemeFont(String inValue)

setEastAsiaThemeFont

public WmlTextRunProperties setEastAsiaThemeFont(String inValue)

setSize

public WmlTextRunProperties setSize(GfxSize inValue)

Specifies a positive measurement of font size.

Parameters:

inValue - the font size expressed in any units that extend GfxSize

Returns:

this text run properties object to enable method chaining

setComplexScriptSize

public WmlTextRunProperties setComplexScriptSize(GfxSize inValue)

Specifies a positive measurement of complex script font size.

Parameters:

inValue - the complex script font size expressed in any units that extend GfxSize

Returns:

this text run properties object to enable method chaining

setStrikeThrough

public WmlTextRunProperties setStrikeThrough()

setHighlight

public WmlTextRunProperties setHighlight(WmlHighlightColor inColor)

Specifies a highlighting color to be applied as background behind the contents: <w:highlight w:val="red"/> This element will supersede any background shading specified in shd.

Parameters:

inColor - Only the colors specified by this enum are allowed

Returns:

this text run properties object (facilitates chaining)

disableSpellingAndGrammarChecks

public WmlTextRunProperties disableSpellingAndGrammarChecks()

vanish

public WmlTextRunProperties vanish()

getBorder

public WmlTextBorder getBorder()

getBorder

public WmlTextBorder getBorder(CSSDeclaration inCSSDeclaration)

getShading

public WmlShading getShading()

getSpacing

public WmlSpacing getSpacing()