com.hfg.xml.msofficexml.xlsx.spreadsheetml

Class SsmlWorksheet

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

All Implemented Interfaces:

XMLContainer, XMLizable, XMLNode, Cloneable, Comparable

public class SsmlWorksheet
extends SsmlXMLTag

Represents an Office Open XML sheet (<ssml:worksheet>) 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
SsmlWorksheet(WorksheetPart inParentWorksheetPart)
SsmlWorksheet(WorksheetPart inParentWorksheetPart, String inName, XMLTag inSheetTag)

Method Summary

Modifier and Type	Method and Description
SsmlCol	addColumn()
SsmlConditionalFormatting	addConditionalFormatting(CellRange inCellRange)
SsmlDataValidation	addDataValidation(CellRange inCellRange)
WorksheetDrawing	addDrawing()
SsmlSheetView	addSheetView()
SsmlTable	addTable()
SsmlCommentsPart	getCommentsPart()
String	getFooter()
String	getHeader()
String	getName()
SsmlExtension	getOrAddExtension(XMLNamespace inNamespace, SsmlExtension.URI_Type inURI_Type)
SsmlPageMargins	getPageMargins()
WorksheetPart	getParentWorksheetPart()
SsmlSheetData	getSheetData()
SsmlSheetFormatProperties	getSheetFormatProperties()
List<SsmlSheetView>	getSheetViews()
SsmlTable	getTable(String inTableName) Returns a table by name.
Collection<SsmlTable>	getTables() Returns all table definitions.
void	mergeCells(CellRange inCellRange)
void	removeMergeCell(CellRange inCellRange)
protected void	renameTable(String inOldName, String inNewName) Called by the table when the user calls setName().
SsmlWorksheet	setDimension(CellRange inCellRange)
SsmlWorksheet	setFooter(String inValue)
SsmlWorksheet	setHeader(String inValue)
SsmlWorksheet	setName(String inValue)
void	setPrintArea(CellRange inPrintArea)
SsmlWorksheet	setSortState(SsmlSortState inValue)
void	toIndentedXML(Writer inWriter, int inInitialIndentLevel, int inIndentSize)
String	toString()
List<String>	toTSV()
void	toXML(Writer inWriter)

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

SsmlWorksheet

public SsmlWorksheet(WorksheetPart inParentWorksheetPart)

SsmlWorksheet

public SsmlWorksheet(WorksheetPart inParentWorksheetPart,
                     String inName,
                     XMLTag inSheetTag)

Method Detail

toTSV

public List<String> toTSV()

toString

public String toString()

Overrides:

toString in class XMLTag

getParentWorksheetPart

public WorksheetPart getParentWorksheetPart()

getCommentsPart

public SsmlCommentsPart getCommentsPart()

setName

public SsmlWorksheet setName(String inValue)

getName

public String getName()

getSheetData

public SsmlSheetData getSheetData()

mergeCells

public void mergeCells(CellRange inCellRange)

removeMergeCell

public void removeMergeCell(CellRange inCellRange)

addColumn

public SsmlCol addColumn()

addTable

public SsmlTable addTable()

addDataValidation

public SsmlDataValidation addDataValidation(CellRange inCellRange)

getTables

public Collection<SsmlTable> getTables()

Returns all table definitions.

getTable

public SsmlTable getTable(String inTableName)

Returns a table by name.

Parameters:

inTableName - the name of the table

Returns:

SsmlTable

setDimension

public SsmlWorksheet setDimension(CellRange inCellRange)

getSheetFormatProperties

public SsmlSheetFormatProperties getSheetFormatProperties()

getPageMargins

public SsmlPageMargins getPageMargins()

addSheetView

public SsmlSheetView addSheetView()

getSheetViews

public List<SsmlSheetView> getSheetViews()

setHeader

public SsmlWorksheet setHeader(String inValue)

getHeader

public String getHeader()

setFooter

public SsmlWorksheet setFooter(String inValue)

getFooter

public String getFooter()

addDrawing

public WorksheetDrawing addDrawing()

addConditionalFormatting

public SsmlConditionalFormatting addConditionalFormatting(CellRange inCellRange)

getOrAddExtension

public SsmlExtension getOrAddExtension(XMLNamespace inNamespace,
                                       SsmlExtension.URI_Type inURI_Type)

setPrintArea

public void setPrintArea(CellRange inPrintArea)

toXML

public void toXML(Writer inWriter)

Specified by:

toXML in interface XMLizable

Overrides:

toXML in class XMLTag

toIndentedXML

public void toIndentedXML(Writer inWriter,
                          int inInitialIndentLevel,
                          int inIndentSize)

Specified by:

toIndentedXML in interface XMLizable

Overrides:

toIndentedXML in class XMLTag

setSortState

public SsmlWorksheet setSortState(SsmlSortState inValue)

renameTable

protected void renameTable(String inOldName,
                           String inNewName)

Called by the table when the user calls setName().