Package 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.incubator.doc.office.OdfStylesBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

OfficeAutomaticStylesElement

public abstract class OdfOfficeAutomaticStyles
extends OdfStylesBase

Convenient functionality for the parent ODF OpenDocument element

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static OdfName	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

Modifier	Constructor	Description
	OdfOfficeAutomaticStyles(OdfFileDom ownerDoc)
protected	OdfOfficeAutomaticStyles(OdfFileDom ownerDoc, OdfName elementName)	Used by generated subclass OfficeAutomaticStylesElement

Method Summary

Modifier and Type	Method	Description
void	accept(ElementVisitor visitor)	Accept an visitor instance to allow the visitor to do some operations.
DataStyleElement	createDataStyle(OfficeValueTypeAttribute.Value type, String numberFormatCode, String newDataStyleName)
OdfName	getOdfName()
OdfStylePageLayout	getOrCreatePageLayout(String name)	Returns the OdfStylePageLayout element with the given name.
OdfStylePageLayout	getPageLayout(String name)	Returns the OdfStylePageLayout element with the given name.
protected <T extends OdfElement> T	getStylesElement(OdfFileDom dom, Class<T> clazz)
OdfStyle	makeStyleUnique(OdfStyle referenceStyle)	This method makes the style unique
OdfTextListStyle	newListStyle()	Create an OdfTextListStyle element
OdfTextListStyle	newListStyle(String listStyleName)	Create an OdfTextListStyle element
NumberBooleanStyleElement	newNumberBooleanStyleElement(String styleNameValue)	Create child element <number:boolean-style>.
NumberCurrencyStyleElement	newNumberCurrencyStyleElement(String styleNameValue)	Create child element <number:currency-style>.
NumberDateStyleElement	newNumberDateStyleElement(String styleNameValue)	Create child element <number:date-style>.
NumberNumberStyleElement	newNumberNumberStyleElement(String styleNameValue)	Create child element <number:number-style>.
NumberPercentageStyleElement	newNumberPercentageStyleElement(String styleNameValue)	Create child element <number:percentage-style>.
NumberTextStyleElement	newNumberTextStyleElement(String styleNameValue)	Create child element <number:text-style>.
NumberTimeStyleElement	newNumberTimeStyleElement(String styleNameValue)	Create child element <number:time-style>.
OdfStylePageLayout	newPageLayout()	Create an OdfStylePageLayout element
OdfStylePageLayout	newPageLayout(String pageLayoutName)	Create an OdfStylePageLayout element
OdfStyle	newStyle(OdfStyleFamily styleFamily)	Create an OdfStyle element with style family
StylePageLayoutElement	newStylePageLayoutElement(String styleNameValue)	Create child element <style:page-layout>.
StyleStyleElement	newStyleStyleElement(String styleFamilyValue, String styleNameValue)	Create child element <style:style>.
TextListStyleElement	newTextListStyleElement(String styleNameValue)	Create child element <text:list-style>.
void	onOdfNodeInserted(OdfElement node, Node refNode)	override this method to get notified about element insertion
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.incubator.doc.office.OdfStylesBase

getAllDataStyles, getAllStyles, getBooleanStyle, getBooleanStyles, getCurrencyStyle, getCurrencyStyles, getDateStyle, getDateStyles, getListStyle, getListStyles, getNumberStyle, getNumberStyles, getPercentageStyle, getPercentageStyles, getStyle, getStylesForFamily, getTextStyle, getTextStyles, getTimeStyle, getTimeStyles, newStyle

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

insertBefore, removeChild, replaceChild

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, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, receiveNode, removeContent, removeSingleElement, 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 Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Detail

OdfOfficeAutomaticStyles

public OdfOfficeAutomaticStyles(OdfFileDom ownerDoc)

OdfOfficeAutomaticStyles

protected OdfOfficeAutomaticStyles(OdfFileDom ownerDoc,
                                   OdfName elementName)

Used by generated subclass OfficeAutomaticStylesElement

Method Detail

getOdfName

public OdfName getOdfName()

Specified by:

getOdfName in class OdfElement

newStyle

public OdfStyle newStyle(OdfStyleFamily styleFamily)

Create an OdfStyle element with style family

Parameters:

styleFamily - The OdfStyleFamily element

Returns:

an OdfStyle element

getStylesElement

protected <T extends OdfElement> T getStylesElement(OdfFileDom dom,
                                                    Class<T> clazz)
                                             throws Exception

Specified by:

getStylesElement in class OdfStylesBase

Throws:

Exception

newListStyle

public OdfTextListStyle newListStyle()

Create an OdfTextListStyle element

Returns:

an OdfTextListStyle element

newPageLayout

public OdfStylePageLayout newPageLayout()

Create an OdfStylePageLayout element

Returns:

an OdfStylePageLayout element

newPageLayout

public OdfStylePageLayout newPageLayout(String pageLayoutName)

Create an OdfStylePageLayout element

Returns:

an OdfStylePageLayout element

newListStyle

public OdfTextListStyle newListStyle(String listStyleName)

Create an OdfTextListStyle element

Parameters:

listStyleName - the name of the new list style

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

getOrCreatePageLayout

public OdfStylePageLayout getOrCreatePageLayout(String name)

Returns the OdfStylePageLayout element with the given name.

Parameters:

name - is the name of the page layout

Returns:

the page layout

onOdfNodeInserted

public void onOdfNodeInserted(OdfElement node,
                              Node refNode)

Description copied from class: OdfContainerElementBase

override this method to get notified about element insertion

Overrides:

onOdfNodeInserted in class OdfStylesBase

onOdfNodeRemoved

public void onOdfNodeRemoved(OdfElement node)

Description copied from class: OdfContainerElementBase

override this method to get notified about element insertion

Overrides:

onOdfNodeRemoved in class OdfStylesBase

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 to create a new automatic style

Returns:

an OdfStyle element

createDataStyle

public DataStyleElement createDataStyle(OfficeValueTypeAttribute.Value type,
                                        String numberFormatCode,
                                        String newDataStyleName)

newNumberBooleanStyleElement

public NumberBooleanStyleElement newNumberBooleanStyleElement(String styleNameValue)

Create child element <number:boolean-style>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <number:boolean-style>

newNumberCurrencyStyleElement

public NumberCurrencyStyleElement newNumberCurrencyStyleElement(String styleNameValue)

Create child element <number:currency-style>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <number:currency-style>

newNumberDateStyleElement

public NumberDateStyleElement newNumberDateStyleElement(String styleNameValue)

Create child element <number:date-style>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <number:date-style>

newNumberNumberStyleElement

public NumberNumberStyleElement newNumberNumberStyleElement(String styleNameValue)

Create child element <number:number-style>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <number:number-style>

newNumberPercentageStyleElement

public NumberPercentageStyleElement newNumberPercentageStyleElement(String styleNameValue)

Create child element <number:percentage-style>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <number:percentage-style>

newNumberTextStyleElement

public NumberTextStyleElement newNumberTextStyleElement(String styleNameValue)

Create child element <number:text-style>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <number:text-style>

newNumberTimeStyleElement

public NumberTimeStyleElement newNumberTimeStyleElement(String styleNameValue)

Create child element <number:time-style>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <number:time-style>

newStylePageLayoutElement

public StylePageLayoutElement newStylePageLayoutElement(String styleNameValue)

Create child element <style:page-layout>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <style:page-layout>

newStyleStyleElement

public StyleStyleElement newStyleStyleElement(String styleFamilyValue,
                                              String styleNameValue)

Create child element <style:style>.

Parameters:

styleFamilyValue - the String value of StyleFamilyAttribute, see @style:family at specification

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <style:style>

newTextListStyleElement

public TextListStyleElement newTextListStyleElement(String styleNameValue)

Create child element <text:list-style>.

Parameters:

styleNameValue - the String value of StyleNameAttribute, see @style:name at specification

Returns:

the element <text:list-style>

accept

public void accept(ElementVisitor visitor)

Description copied from class: OdfElement

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