com.hfg.xml.msofficexml.docx.drawingml.fill

Class DmlGradientFill

java.lang.Object

com.hfg.xml.XMLContainerImpl

com.hfg.xml.XMLTag

com.hfg.xml.msofficexml.docx.drawingml.fill.DmlFill

com.hfg.xml.msofficexml.docx.drawingml.fill.DmlGradientFill

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

public class DmlGradientFill
extends DmlFill

Represents a gradient fill (<a:gradFill>) tag in drawing markup language (DML) from Office Open XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DmlGradientFill.TileRectFlip

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

Method Summary

Modifier and Type	Method and Description
DmlGradientFill	addGradientStop(Percent inPosition, DmlColor inColorModel)
DmlGradientFill	setAngle(Angle inValue) Specifies the direction (clockwise) for the gradient.
DmlGradientFill	setFlip(DmlGradientFill.TileRectFlip inValue) Specifies the direction in which to flip the gradient while tiling.
DmlGradientFill	setRotateWithShape(boolean inValue) Specifies if the gradient fill rotates with the shape when the shape is rotated.
DmlGradientFill	setScaled(boolean inValue) Specifies whether the angle scales with the fill region.

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

DmlGradientFill

public DmlGradientFill()

Method Detail

setAngle

public DmlGradientFill setAngle(Angle inValue)

Specifies the direction (clockwise) for the gradient.

Parameters:

inValue - gradient angle in arbitrary units. (The value in the xml will be converted to 60000ths of a degree)

Returns:

this DmlGradientFill object to enable method chaining

setScaled

public DmlGradientFill setScaled(boolean inValue)

Specifies whether the angle scales with the fill region.

Parameters:

inValue - whether the angle scales with the fill region

Returns:

this DmlGradientFill object to enable method chaining

addGradientStop

public DmlGradientFill addGradientStop(Percent inPosition,
                                       DmlColor inColorModel)

setFlip

public DmlGradientFill setFlip(DmlGradientFill.TileRectFlip inValue)

Specifies the direction in which to flip the gradient while tiling. This is only relevant when a tileRect is specified so that the gradient must be tiles to fill the shape. Possible values are none, x (horizontal), xy (horizontal and vertical), and y (vertical).

Parameters:

inValue - the direction to flip the gradient fill

Returns:

this DmlGradientFill object to enable method chaining

setRotateWithShape

public DmlGradientFill setRotateWithShape(boolean inValue)

Specifies if the gradient fill rotates with the shape when the shape is rotated.

Parameters:

inValue - whether to rotate the gradient fill when the shape is rotated

Returns:

this DmlGradientFill object to enable method chaining