com.hfg.xml.msofficexml.xlsx.spreadsheetDrawing

Class SsDrawShape

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.spreadsheetDrawing.SsDrawShape

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

public class SsDrawShape
extends SsmlXMLTag

Represents an Office Open XML worksheet shape (<xdr:sp>) 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
SsDrawShape(Xlsx inXlsx)
SsDrawShape(Xlsx inXlsx, DmlShapeType inShapeType)

Method Summary

Modifier and Type	Method and Description
SsDrawNonVisualShapeDrawingProperties	getNonVisualShapeDrawingProperties() Returns the non-visual shape drawing properties (<xdr:nvSpPr>) tag if one exists or else instantiates a new one.
SsDrawShapeStyle	getOrCreateStyle() Returns the style (<xdr:style>) tag if one exists or else instantiates a new one.
SsDrawTextBody	getOrCreateTextBody() Returns the text body (<xdr:txBody>) tag if one exists or else instantiates a new one.
DmlTransform	getOrCreateTransform() Returns the transform (<a:xfrm>) tag if one exists or else instantiates a new one.
SsDrawShapeProperties	getShapeProperties() Returns the shape properties (<xdr:spPr>) tag if one exists or else instantiates a new one.
SsDrawShape	setName(String inValue) A shortcut for setting the name of a shape.
void	setText(String inText)

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

SsDrawShape

public SsDrawShape(Xlsx inXlsx)

SsDrawShape

public SsDrawShape(Xlsx inXlsx,
                   DmlShapeType inShapeType)

Method Detail

setName

public SsDrawShape setName(String inValue)

A shortcut for setting the name of a shape.

Parameters:

inValue - the name to be applied to the shape

Returns:

this shape object to facilitate method chaining

getNonVisualShapeDrawingProperties

public SsDrawNonVisualShapeDrawingProperties getNonVisualShapeDrawingProperties()

Returns the non-visual shape drawing properties (<xdr:nvSpPr>) tag if one exists or else instantiates a new one.

Returns:

the non-visual shape drawing properties (<xdr:nvSpPr>) for this shape tag

getShapeProperties

public SsDrawShapeProperties getShapeProperties()

Returns the shape properties (<xdr:spPr>) tag if one exists or else instantiates a new one.

Returns:

the shape properties (<xdr:spPr>) for this shape tag

getOrCreateStyle

public SsDrawShapeStyle getOrCreateStyle()

Returns the style (<xdr:style>) tag if one exists or else instantiates a new one.

Returns:

the style properties (<xdr:style>) for this shape tag

getOrCreateTransform

public DmlTransform getOrCreateTransform()

Returns the transform (<a:xfrm>) tag if one exists or else instantiates a new one.

Returns:

the transform (<a:xfrm>) for this shape tag

getOrCreateTextBody

public SsDrawTextBody getOrCreateTextBody()

Returns the text body (<xdr:txBody>) tag if one exists or else instantiates a new one.

Returns:

the text body (<xdr:txBody>) for this shape tag

setText

public void setText(String inText)