org.odftoolkit.odfdom.incubator.doc.office

Class OdfOfficeAutomaticStyles

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.pkg.OdfContainerElementBase

org.odftoolkit.odfdom.dom.element.office.OfficeAutomaticStylesElement

org.odftoolkit.odfdom.incubator.doc.office.OdfOfficeAutomaticStyles

All Implemented Interfaces:

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

public class OdfOfficeAutomaticStyles
extends OfficeAutomaticStylesElement

Convenient functionalty for the parent ODF OpenDocument element

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odftoolkit.odfdom.dom.element.office.OfficeAutomaticStylesElement

ELEMENT_NAME

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

mPackageDocument

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 and Description
OdfOfficeAutomaticStyles(OdfFileDom ownerDoc)

Method Summary

Modifier and Type	Method and Description
Iterable<OdfStyle>	getAllStyles() Returns an iterator for all OdfStyleStyle elements.
NumberBooleanStyleElement	getBooleanStyle(String name) Returns the NumberBooleanStyleElement element with the given name.
Iterable<NumberBooleanStyleElement>	getBooleanStyles() Returns an iterator for all OdfNumberBooleanStyle elements.
OdfNumberCurrencyStyle	getCurrencyStyle(String name) Returns the OdfNumberCurrencyStyle element with the given name.
Iterable<OdfNumberCurrencyStyle>	getCurrencyStyles() Returns an iterator for all OdfNumberCurrencyStyle elements.
OdfNumberDateStyle	getDateStyle(String name) Returns the OdfNumberDateStyle element with the given name.
Iterable<OdfNumberDateStyle>	getDateStyles() Returns an iterator for all OdfNumberDateStyle elements.
OdfTextListStyle	getListStyle(String name) Returns the OdfTextListStyle element with the given name.
Iterable<OdfTextListStyle>	getListStyles() Returns an iterator for all OdfTextListStyle elements.
OdfNumberStyle	getNumberStyle(String name) Returns the OdfNumberNumberStyle element with the given name.
Iterable<OdfNumberStyle>	getNumberStyles() Returns an iterator for all OdfNumberNumberStyle elements.
OdfStylePageLayout	getPageLayout(String name) Returns the OdfStylePageLayout element with the given name.
OdfNumberPercentageStyle	getPercentageStyle(String name) Returns the OdfNumberPercentageStyle element with the given name.
Iterable<OdfNumberPercentageStyle>	getPercentageStyles() Returns an iterator for all OdfNumberPercentageStyle elements.
OdfStyle	getStyle(String name, OdfStyleFamily familyType) Returns the OdfStyleStyle element with the given name and family.
Iterable<OdfStyle>	getStylesForFamily(OdfStyleFamily familyType) Returns an iterator for all OdfStyleStyle elements for the given family.
NumberTextStyleElement	getTextStyle(String name) Returns the NumberTextStyleElement element with the given name.
Iterable<NumberTextStyleElement>	getTextStyles() Returns an iterator for all NumberTextStyleElement elements.
OdfNumberTimeStyle	getTimeStyle(String name) Returns the OdfNumberTimeStyle element with the given name.
Iterable<OdfNumberTimeStyle>	getTimeStyles() Returns an iterator for all OdfNumberTimeStyle elements.
OdfStyle	makeStyleUnique(OdfStyle referenceStyle) This method makes the style unique
OdfTextListStyle	newListStyle() Create an OdfTextListStyle element
OdfStyle	newStyle(OdfStyleFamily styleFamily) Create an OdfStyle element with style family
protected void	onOdfNodeInserted(OdfElement node, Node refNode) override this method to get notified about element insertion
protected void	onOdfNodeRemoved(OdfElement node) override this method to get notified about element insertion
void	optimize() This methods removes all automatic styles that are currently not used by any styleable element.

Methods inherited from class org.odftoolkit.odfdom.dom.element.office.OfficeAutomaticStylesElement

accept, getOdfName, newNumberBooleanStyleElement, newNumberCurrencyStyleElement, newNumberDateStyleElement, newNumberNumberStyleElement, newNumberPercentageStyleElement, newNumberTextStyleElement, newNumberTimeStyleElement, newStylePageLayoutElement, newStyleStyleElement, newTextListStyleElement

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

insertBefore, removeChild, replaceChild

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

cloneNode, cloneOdfElement, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, hasOdfAttribute, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, setOdfAttribute, setOdfAttributeValue, 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, getTextContent, 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, appendChild, 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

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

Constructor Detail

OdfOfficeAutomaticStyles

public OdfOfficeAutomaticStyles(OdfFileDom ownerDoc)

Method Detail

newStyle

public OdfStyle newStyle(OdfStyleFamily styleFamily)

Create an OdfStyle element with style family

Parameters:

styleFamily - The OdfStyleFamily element

Returns:

an OdfStyle element

newListStyle

public OdfTextListStyle newListStyle()

Create an OdfTextListStyle element

Returns:

an OdfTextListStyle element

getPageLayout

public OdfStylePageLayout getPageLayout(String name)

Returns the OdfStylePageLayout element with the given name.

Parameters:

name - is the name of the page layout

Returns:

the page layout or null if there is no such page layout

getStyle

public OdfStyle getStyle(String name,
                         OdfStyleFamily familyType)

Returns the OdfStyleStyle element with the given name and family.

Parameters:

name - is the name of the style

familyType - is the family of the style

Returns:

the style or null if there is no such style

getStylesForFamily

public Iterable<OdfStyle> getStylesForFamily(OdfStyleFamily familyType)

Returns an iterator for all OdfStyleStyle elements for the given family.

Parameters:

familyType -

Returns:

an iterator for all OdfStyleStyle elements for the given family

getAllStyles

public Iterable<OdfStyle> getAllStyles()

Returns an iterator for all OdfStyleStyle elements.

Returns:

an iterator for all OdfStyleStyle elements

getListStyle

public OdfTextListStyle getListStyle(String name)

Returns the OdfTextListStyle element with the given name.

Parameters:

name - is the name of the list style

Returns:

the list style or null if there is no such list style

getListStyles

public Iterable<OdfTextListStyle> getListStyles()

Returns an iterator for all OdfTextListStyle elements.

Returns:

an iterator for all OdfTextListStyle elements

getNumberStyle

public OdfNumberStyle getNumberStyle(String name)

Returns the OdfNumberNumberStyle element with the given name.

Parameters:

name - is the name of the number style

Returns:

the number style or null if there is no such number style

getNumberStyles

public Iterable<OdfNumberStyle> getNumberStyles()

Returns an iterator for all OdfNumberNumberStyle elements.

Returns:

an iterator for all OdfNumberNumberStyle elements

getDateStyle

public OdfNumberDateStyle getDateStyle(String name)

Returns the OdfNumberDateStyle element with the given name.

Parameters:

name - is the name of the date style

Returns:

the date style or null if there is no such date style

getDateStyles

public Iterable<OdfNumberDateStyle> getDateStyles()

Returns an iterator for all OdfNumberDateStyle elements.

Returns:

an iterator for all OdfNumberDateStyle elements

getPercentageStyle

public OdfNumberPercentageStyle getPercentageStyle(String name)

Returns the OdfNumberPercentageStyle element with the given name.

Parameters:

name - is the name of the percentage style

Returns:

the percentage style null if there is no such percentage style

getPercentageStyles

public Iterable<OdfNumberPercentageStyle> getPercentageStyles()

Returns an iterator for all OdfNumberPercentageStyle elements.

Returns:

an iterator for all OdfNumberPercentageStyle elements

getCurrencyStyle

public OdfNumberCurrencyStyle getCurrencyStyle(String name)

Returns the OdfNumberCurrencyStyle element with the given name.

Parameters:

name - is the name of the currency style

Returns:

the currency style null if there is no such currency style

getCurrencyStyles

public Iterable<OdfNumberCurrencyStyle> getCurrencyStyles()

Returns an iterator for all OdfNumberCurrencyStyle elements.

Returns:

an iterator for all OdfNumberCurrencyStyle elements

getTimeStyle

public OdfNumberTimeStyle getTimeStyle(String name)

Returns the OdfNumberTimeStyle element with the given name.

Parameters:

name - is the name of the time style

Returns:

the time style null if there is no such time style

getTimeStyles

public Iterable<OdfNumberTimeStyle> getTimeStyles()

Returns an iterator for all OdfNumberTimeStyle elements.

Returns:

an iterator for all OdfNumberTimeStyle elements

getBooleanStyle

public NumberBooleanStyleElement getBooleanStyle(String name)

Returns the NumberBooleanStyleElement element with the given name.

Parameters:

name - is the name of the boolean style

Returns:

the boolean style null if there is no such boolean style

getBooleanStyles

public Iterable<NumberBooleanStyleElement> getBooleanStyles()

Returns an iterator for all OdfNumberBooleanStyle elements.

Returns:

an iterator for all OdfNumberBooleanStyle elements

getTextStyle

public NumberTextStyleElement getTextStyle(String name)

Returns the NumberTextStyleElement element with the given name.

Parameters:

name - is the name of the text style

Returns:

the text style null if there is no such text style

getTextStyles

public Iterable<NumberTextStyleElement> getTextStyles()

Returns an iterator for all NumberTextStyleElement elements.

Returns:

an iterator for all NumberTextStyleElement elements

onOdfNodeInserted

protected void onOdfNodeInserted(OdfElement node,
                                 Node refNode)

Description copied from class: OdfContainerElementBase

override this method to get notified about element insertion

Overrides:

onOdfNodeInserted in class OdfContainerElementBase

onOdfNodeRemoved

protected void onOdfNodeRemoved(OdfElement node)

Description copied from class: OdfContainerElementBase

override this method to get notified about element insertion

Overrides:

onOdfNodeRemoved in class OdfContainerElementBase

optimize

public void optimize()

This methods removes all automatic styles that are currently not used by any styleable element. Additionally all duplicate automatic styles will be removed.

makeStyleUnique

public OdfStyle makeStyleUnique(OdfStyle referenceStyle)

This method makes the style unique

Parameters:

referenceStyle - The reference OdfStyle element

Returns:

an OdfStyle element