org.odftoolkit.odfdom.dom

Class OdfStylesDom

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.CoreDocumentImpl

org.apache.xerces.dom.DocumentImpl

org.odftoolkit.odfdom.pkg.OdfFileDom

org.odftoolkit.odfdom.dom.OdfStylesDom

All Implemented Interfaces:

Serializable, Cloneable, NamespaceContext, Document, DocumentEvent, EventTarget, Node, NodeList, DocumentRange, DocumentTraversal

public class OdfStylesDom
extends OdfFileDom

The DOM repesentation of the ODF styles.xml file of an ODF document.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odftoolkit.odfdom.pkg.OdfFileDom

inCententMetadataCache, mDuplicatePrefixesByUri, mPackage, mPackageDocument, mPackagePath, mPrefixByUri, mUriByPrefix, mXPath, sink

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

eventListeners, iteratorReferenceQueue, iterators, mutationEvents, rangeReferenceQueue, ranges

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

actualEncoding, allowGrammarAccess, changes, docElement, docType, encoding, errorChecking, fDocumentURI, identifiers, standalone, userData, version, xmlVersionChanged

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

Constructor Summary

Constructors

Constructor and Description
OdfStylesDom(OdfSchemaDocument odfDocument, String packagePath) Creates the DOM representation of an XML file of an Odf document.

Method Summary

Modifier and Type	Method and Description
OdfOfficeAutomaticStyles	getAutomaticStyles() Retrieve the ODF AutomaticStyles
OdfSchemaDocument	getDocument() Retrieves the Odf Document
OdfOfficeStyles	getOfficeStyles()
OdfOfficeAutomaticStyles	getOrCreateAutomaticStyles()
OfficeDocumentStylesElement	getRootElement() * @return The root element of the styles.xml file as OfficeDocumentStylesElement.
XPath	getXPath() Creates an JDK XPath instance.
protected void	initialize() Might be used to initialize specific XML Namespace prefixes/URIs for this XML file

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

createAttribute, createAttributeNS, createAttributeNS, createElement, createElementNS, createElementNS, getBookmarkRDFMetadata, getInContentMetadataCache, getNamespaceURI, getPackagePath, getPrefix, getPrefixes, getSink, newFileDom, newFileDom, newOdfElement, setNamespace, setNamespace, toString, updateInContentMetadataCache

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

addEventListener, cloneNode, copyEventListeners, createEvent, createNodeIterator, createNodeIterator, createRange, createTreeWalker, createTreeWalker, dispatchAggregateEvents, dispatchAggregateEvents, dispatchEvent, dispatchEventToSubtree, dispatchingEventToSubtree, getEventListeners, getImplementation, removeEventListener, saveEnclosingAttr, setEventListeners

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

abort, adoptNode, callUserDataHandlers, canRenameElements, changed, changes, checkDOMNSErr, checkNamespaceWF, checkQName, clearIdentifiers, clone, cloneNode, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createDocumentType, createElementDefinition, createElementNS, createEntity, createEntityReference, createNotation, createProcessingInstruction, createTextNode, getAsync, getBaseURI, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getEncoding, getErrorChecking, getFeature, getIdentifier, getIdentifiers, getInputEncoding, getNodeName, getNodeNumber, getNodeNumber, getNodeType, getOwnerDocument, getStandalone, getStrictErrorChecking, getTextContent, getUserData, getUserData, getUserDataRecord, getVersion, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, insertBefore, isKidOK, isValidQName, isXMLName, load, loadXML, normalizeDocument, putIdentifier, removeChild, removeIdentifier, renameNode, replaceChild, saveXML, setAsync, setDocumentURI, setEncoding, setErrorChecking, setInputEncoding, setStandalone, setStrictErrorChecking, setTextContent, setUserData, setUserData, setVersion, setXmlEncoding, setXmlStandalone, setXmlVersion, undeferChildren

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

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, normalize, setOwnerDocument, setReadOnly, synchronizeChildren

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

getNextSibling, getParentNode, getPreviousSibling

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

addEventListener, appendChild, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getContainer, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, getUserDataRecord, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, synchronizeData

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, compareDocumentPosition, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getUserData, hasAttributes, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, setNodeValue, setPrefix, setUserData

Constructor Detail

OdfStylesDom

public OdfStylesDom(OdfSchemaDocument odfDocument,
                    String packagePath)

Creates the DOM representation of an XML file of an Odf document.

Parameters:

odfDocument - the document the XML files belongs to

packagePath - the internal package path to the XML file

Method Detail

initialize

protected void initialize()

Might be used to initialize specific XML Namespace prefixes/URIs for this XML file

Overrides:

initialize in class OdfFileDom

getDocument

public OdfSchemaDocument getDocument()

Retrieves the Odf Document

Overrides:

getDocument in class OdfFileDom

Returns:

The OdfDocument

getRootElement

public OfficeDocumentStylesElement getRootElement()

* @return The root element of the styles.xml file as OfficeDocumentStylesElement.

Overrides:

getRootElement in class OdfFileDom

Returns:

The OdfElement being the root of the document.

getXPath

public XPath getXPath()

Creates an JDK XPath instance. Initialized with ODF namespaces from OdfDocumentNamespace. Updated with all namespace of the XML file.

Overrides:

getXPath in class OdfFileDom

Returns:

an XPath instance with namespace context set to include the standard ODFDOM prefixes.

getOfficeStyles

public OdfOfficeStyles getOfficeStyles()

Returns:

the style:office-styles element of this dom. May return null if there is not yet such element in this dom.

See Also:

getOrCreateAutomaticStyles()

getAutomaticStyles

public OdfOfficeAutomaticStyles getAutomaticStyles()

Retrieve the ODF AutomaticStyles

Returns:

the style:automatic-styles element of this dom. May return null if there is not yet such element in this dom.

See Also:

getOrCreateAutomaticStyles()

getOrCreateAutomaticStyles

public OdfOfficeAutomaticStyles getOrCreateAutomaticStyles()

Returns:

the style:automatic-styles element of this dom. If it does not yet exists, a new one is inserted into the dom and returned.