com.hfg.xml.msofficexml.xlsx.spreadsheetml

Class SsmlDataBar

java.lang.Object

com.hfg.xml.XMLContainerImpl

com.hfg.xml.XMLTag

com.hfg.xml.msofficexml.OfficeOpenXMLTag

com.hfg.xml.msofficexml.xlsx.spreadsheetml.SsmlXMLTag

com.hfg.xml.msofficexml.xlsx.spreadsheetml.SsmlDataBar

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

public class SsmlDataBar
extends SsmlXMLTag

Represents an Office Open XML conditional formatting data bar (<ssml:dataBar>) 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.msofficexml.OfficeOpenXMLTag

sSQLLoggingLevel

Fields inherited from class com.hfg.xml.XMLContainerImpl

mContentAndSubtagList

Constructor Summary

Constructors

Constructor and Description
SsmlDataBar(SsmlWorksheet inParentWorksheet)
SsmlDataBar(SsmlWorksheet inParentWorksheet, XMLNamespace inNamespace)

Method Summary

Modifier and Type	Method and Description
SsmlDataBar	setBorder(Boolean inValue)
SsmlDataBar	setBorderColor(Color inValue)
SsmlDataBar	setColor(Color inValue)
void	setExtension(SsmlDataBar inValue)
SsmlDataBar	setGradient(Boolean inValue)
SsmlDataBar	setMaxLength(Integer inValue) Specifies the maximum length of the data bar, as a percentage of the cell's width.
SsmlDataBar	setMinLength(Integer inValue) Specifies the minimum length of the data bar, as a percentage of the cell's width.
SsmlDataBar	setShowValue(Boolean inValue) Specifies whether or not to display the numeric value to the right of the data bar.

Methods inherited from class com.hfg.xml.msofficexml.xlsx.spreadsheetml.SsmlXMLTag

getParentDoc, setAttribute

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

SsmlDataBar

public SsmlDataBar(SsmlWorksheet inParentWorksheet)

SsmlDataBar

public SsmlDataBar(SsmlWorksheet inParentWorksheet,
                   XMLNamespace inNamespace)

Method Detail

setExtension

public void setExtension(SsmlDataBar inValue)

setMinLength

public SsmlDataBar setMinLength(Integer inValue)

Specifies the minimum length of the data bar, as a percentage of the cell's width. Default is 0.

Parameters:

inValue - the minimum percent of the cell width for data bar values

Returns:

this SsmlDataBar object to enable method chaining.

setMaxLength

public SsmlDataBar setMaxLength(Integer inValue)

Specifies the maximum length of the data bar, as a percentage of the cell's width. Default is 90.

Parameters:

inValue - the maximum percent of the cell width for data bar values

Returns:

this SsmlDataBar object to enable method chaining.

setShowValue

public SsmlDataBar setShowValue(Boolean inValue)

Specifies whether or not to display the numeric value to the right of the data bar. Default is "true".

Parameters:

inValue - whether or not to display the numeric value

Returns:

this SsmlDataBar object to enable method chaining.

setColor

public SsmlDataBar setColor(Color inValue)

setBorderColor

public SsmlDataBar setBorderColor(Color inValue)

setGradient

public SsmlDataBar setGradient(Boolean inValue)

setBorder

public SsmlDataBar setBorder(Boolean inValue)