Package org.odftoolkit.odfdom.dom.element.office

Class OfficeSpreadsheetElement

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.ElementImpl

org.apache.xerces.dom.ElementNSImpl

org.odftoolkit.odfdom.pkg.OdfElement

org.odftoolkit.odfdom.dom.element.office.OfficeSpreadsheetElement

All Implemented Interfaces:

Serializable, Cloneable, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo

public class OfficeSpreadsheetElement
extends OdfElement

DOM implementation of OpenDocument element <office:spreadsheet>.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final OdfName	ELEMENT_NAME

Fields inherited from class org.apache.xerces.dom.ElementNSImpl

localName, namespaceURI

Fields inherited from class org.apache.xerces.dom.ElementImpl

attributes, name

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

Constructor	Description
OfficeSpreadsheetElement(OdfFileDom ownerDoc)	Create the instance of OfficeSpreadsheetElement

Method Summary

Modifier and Type	Method	Description
void	accept(ElementVisitor visitor)	Accept an visitor instance to allow the visitor to do some operations.
OdfName	getOdfName()	Get the element name
String	getTableProtectionKeyAttribute()	Receives the value of the ODFDOM attribute representation TableProtectionKeyAttribute , See @table:protection-key
String	getTableProtectionKeyDigestAlgorithmAttribute()	Receives the value of the ODFDOM attribute representation TableProtectionKeyDigestAlgorithmAttribute , See @table:protection-key-digest-algorithm
Boolean	getTableStructureProtectedAttribute()	Receives the value of the ODFDOM attribute representation TableStructureProtectedAttribute , See @table:structure-protected
TableCalculationSettingsElement	newTableCalculationSettingsElement()	Create child element <table:calculation-settings>.
TableConsolidationElement	newTableConsolidationElement(String tableFunctionValue, String tableSourceCellRangeAddressesValue, String tableTargetCellAddressValue)	Create child element <table:consolidation>.
TableContentValidationsElement	newTableContentValidationsElement()	Create child element <table:content-validations>.
TableDatabaseRangesElement	newTableDatabaseRangesElement()	Create child element <table:database-ranges>.
TableDataPilotTablesElement	newTableDataPilotTablesElement()	Create child element <table:data-pilot-tables>.
TableDdeLinksElement	newTableDdeLinksElement()	Create child element <table:dde-links>.
TableLabelRangesElement	newTableLabelRangesElement()	Create child element <table:label-ranges>.
TableNamedExpressionsElement	newTableNamedExpressionsElement()	Create child element <table:named-expressions>.
TableTableElement	newTableTableElement()	Create child element <table:table>.
TableTrackedChangesElement	newTableTrackedChangesElement()	Create child element <table:tracked-changes>.
TextAlphabeticalIndexAutoMarkFileElement	newTextAlphabeticalIndexAutoMarkFileElement(String xlinkHrefValue, String xlinkTypeValue)	Create child element <text:alphabetical-index-auto-mark-file>.
TextDdeConnectionDeclsElement	newTextDdeConnectionDeclsElement()	Create child element <text:dde-connection-decls>.
TextSequenceDeclsElement	newTextSequenceDeclsElement()	Create child element <text:sequence-decls>.
TextUserFieldDeclsElement	newTextUserFieldDeclsElement()	Create child element <text:user-field-decls>.
TextVariableDeclsElement	newTextVariableDeclsElement()	Create child element <text:variable-decls>.
void	setTableProtectionKeyAttribute(String tableProtectionKeyValue)	Sets the value of ODFDOM attribute representation TableProtectionKeyAttribute , See @table:protection-key
void	setTableProtectionKeyDigestAlgorithmAttribute(String tableProtectionKeyDigestAlgorithmValue)	Sets the value of ODFDOM attribute representation TableProtectionKeyDigestAlgorithmAttribute , See @table:protection-key-digest-algorithm
void	setTableStructureProtectedAttribute(Boolean tableStructureProtectedValue)	Sets the value of ODFDOM attribute representation TableStructureProtectedAttribute , See @table:structure-protected

Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement

appendChild, appendUsingWhitespaceHandling, cloneElement, cloneNode, cloneNode, cloneNode, cloneOdfElement, componentSize, copyAttributes, countChildComponents, countDescendantComponents, countPrecedingSiblingElements, delete, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getChildElement, getChildElement, getComponent, getComponentRoot, getFirstChildElement, getLastChildElement, getNextSiblingElement, getOdfAttribute, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, setOdfAttribute, setOdfAttribute, setOdfAttributeValue, setRepetition, split, toString

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setPrefix, setType

Methods inherited from class org.apache.xerces.dom.ElementImpl

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttribute, hasAttributeNS, hasAttributes, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, item, setTextContent, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setUserData, setUserData

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData

Field Details

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Details

OfficeSpreadsheetElement

public OfficeSpreadsheetElement(OdfFileDom ownerDoc)

Create the instance of OfficeSpreadsheetElement

Parameters:

ownerDoc - The type is OdfFileDom

Method Details

getOdfName

public OdfName getOdfName()

Get the element name

Specified by:

getOdfName in class OdfElement

Returns:

return OdfName the name of element <office:spreadsheet>.

getTableProtectionKeyAttribute

public String getTableProtectionKeyAttribute()

Receives the value of the ODFDOM attribute representation TableProtectionKeyAttribute , See @table:protection-key

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setTableProtectionKeyAttribute

public void setTableProtectionKeyAttribute(String tableProtectionKeyValue)

Sets the value of ODFDOM attribute representation TableProtectionKeyAttribute , See @table:protection-key

Parameters:

tableProtectionKeyValue - The type is String

getTableProtectionKeyDigestAlgorithmAttribute

public String getTableProtectionKeyDigestAlgorithmAttribute()

Receives the value of the ODFDOM attribute representation TableProtectionKeyDigestAlgorithmAttribute , See @table:protection-key-digest-algorithm

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setTableProtectionKeyDigestAlgorithmAttribute

public void setTableProtectionKeyDigestAlgorithmAttribute(String tableProtectionKeyDigestAlgorithmValue)

Sets the value of ODFDOM attribute representation TableProtectionKeyDigestAlgorithmAttribute , See @table:protection-key-digest-algorithm

Parameters:

tableProtectionKeyDigestAlgorithmValue - The type is String

getTableStructureProtectedAttribute

public Boolean getTableStructureProtectedAttribute()

Receives the value of the ODFDOM attribute representation TableStructureProtectedAttribute , See @table:structure-protected

Returns:

- the Boolean , the value or null, if the attribute is not set and no default value defined.

setTableStructureProtectedAttribute

public void setTableStructureProtectedAttribute(Boolean tableStructureProtectedValue)

Sets the value of ODFDOM attribute representation TableStructureProtectedAttribute , See @table:structure-protected

Parameters:

tableStructureProtectedValue - The type is Boolean

newTableCalculationSettingsElement

public TableCalculationSettingsElement newTableCalculationSettingsElement()

Create child element <table:calculation-settings>.

Returns:

the element <table:calculation-settings>

newTableConsolidationElement

public TableConsolidationElement newTableConsolidationElement(String tableFunctionValue,
 String tableSourceCellRangeAddressesValue,
 String tableTargetCellAddressValue)

Create child element <table:consolidation>.

Parameters:

tableFunctionValue - the String value of TableFunctionAttribute, see @table:function at specification

tableSourceCellRangeAddressesValue - the String value of TableSourceCellRangeAddressesAttribute, see @table:source-cell-range-addresses at specification

tableTargetCellAddressValue - the String value of TableTargetCellAddressAttribute, see @table:target-cell-address at specification

Returns:

the element <table:consolidation>

newTableContentValidationsElement

public TableContentValidationsElement newTableContentValidationsElement()

Create child element <table:content-validations>.

Returns:

the element <table:content-validations>

newTableDataPilotTablesElement

public TableDataPilotTablesElement newTableDataPilotTablesElement()

Create child element <table:data-pilot-tables>.

Returns:

the element <table:data-pilot-tables>

newTableDatabaseRangesElement

public TableDatabaseRangesElement newTableDatabaseRangesElement()

Create child element <table:database-ranges>.

Returns:

the element <table:database-ranges>

newTableDdeLinksElement

public TableDdeLinksElement newTableDdeLinksElement()

Create child element <table:dde-links>.

Returns:

the element <table:dde-links>

newTableLabelRangesElement

public TableLabelRangesElement newTableLabelRangesElement()

Create child element <table:label-ranges>.

Returns:

the element <table:label-ranges>

newTableNamedExpressionsElement

public TableNamedExpressionsElement newTableNamedExpressionsElement()

Create child element <table:named-expressions>.

Returns:

the element <table:named-expressions>

newTableTableElement

public TableTableElement newTableTableElement()

Create child element <table:table>.

Returns:

the element <table:table>

newTableTrackedChangesElement

public TableTrackedChangesElement newTableTrackedChangesElement()

Create child element <table:tracked-changes>.

Returns:

the element <table:tracked-changes>

newTextAlphabeticalIndexAutoMarkFileElement

public TextAlphabeticalIndexAutoMarkFileElement newTextAlphabeticalIndexAutoMarkFileElement(String xlinkHrefValue,
 String xlinkTypeValue)

Create child element <text:alphabetical-index-auto-mark-file>.

Parameters:

xlinkHrefValue - the String value of XlinkHrefAttribute, see @xlink:href at specification

xlinkTypeValue - the String value of XlinkTypeAttribute, see @xlink:type at specification

Returns:

the element <text:alphabetical-index-auto-mark-file>

newTextDdeConnectionDeclsElement

public TextDdeConnectionDeclsElement newTextDdeConnectionDeclsElement()

Create child element <text:dde-connection-decls>.

Returns:

the element <text:dde-connection-decls>

newTextSequenceDeclsElement

public TextSequenceDeclsElement newTextSequenceDeclsElement()

Create child element <text:sequence-decls>.

Returns:

the element <text:sequence-decls>

newTextUserFieldDeclsElement

public TextUserFieldDeclsElement newTextUserFieldDeclsElement()

Create child element <text:user-field-decls>.

Returns:

the element <text:user-field-decls>

newTextVariableDeclsElement

public TextVariableDeclsElement newTextVariableDeclsElement()

Create child element <text:variable-decls>.

Returns:

the element <text:variable-decls>

accept

public void accept(ElementVisitor visitor)

Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design pattern to get a better understanding.

Overrides:

accept in class OdfElement

Parameters:

visitor - an instance of DefaultElementVisitor