Class OdfStylableElement
- 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.OdfStylableElement
-
- All Implemented Interfaces:
Serializable
,Cloneable
,OdfStylePropertySet
,Element
,ElementTraversal
,EventTarget
,Node
,NodeList
,TypeInfo
- Direct Known Subclasses:
ChartAxisElement
,ChartChartElement
,ChartDataPointElement
,ChartErrorIndicatorElement
,ChartFloorElement
,ChartFooterElement
,ChartGridElement
,ChartLegendElement
,ChartMeanValueElement
,ChartPlotAreaElement
,ChartRegressionCurveElement
,ChartSeriesElement
,ChartStockGainMarkerElement
,ChartStockLossMarkerElement
,ChartStockRangeLineElement
,ChartSubtitleElement
,ChartTitleElement
,ChartWallElement
,DrawPageElement
,OdfStyleableShapeElement
,PresentationNotesElement
,StyleDropCapElement
,StyleHandoutMasterElement
,StyleMasterPageElement
,TableBodyElement
,TableEvenColumnsElement
,TableEvenRowsElement
,TableFirstColumnElement
,TableFirstRowElement
,TableLastColumnElement
,TableLastRowElement
,TableOddColumnsElement
,TableOddRowsElement
,TableTableCellElementBase
,TableTableColumnElement
,TableTableElement
,TableTableRowElement
,TextAElement
,TextAlphabeticalIndexElement
,TextAlphabeticalIndexEntryTemplateElement
,TextBibliographyElement
,TextBibliographyEntryTemplateElement
,TextContainingElement
,TextIllustrationIndexElement
,TextIllustrationIndexEntryTemplateElement
,TextIndexEntryBibliographyElement
,TextIndexEntryChapterElement
,TextIndexEntryLinkEndElement
,TextIndexEntryLinkStartElement
,TextIndexEntryPageNumberElement
,TextIndexEntrySpanElement
,TextIndexEntryTabStopElement
,TextIndexEntryTextElement
,TextIndexSourceStyleElement
,TextIndexTitleElement
,TextIndexTitleTemplateElement
,TextLinenumberingConfigurationElement
,TextNumberedParagraphElement
,TextObjectIndexElement
,TextObjectIndexEntryTemplateElement
,TextRubyElement
,TextRubyTextElement
,TextSectionElement
,TextSpanElement
,TextTableIndexElement
,TextTableIndexEntryTemplateElement
,TextTableOfContentElement
,TextTableOfContentEntryTemplateElement
,TextUserIndexElement
,TextUserIndexEntryTemplateElement
public abstract class OdfStylableElement extends OdfElement implements OdfStylePropertySet
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected OdfStyleFamily
mFamily
protected OdfName
mStyleNameAttrib
-
Fields inherited from class org.apache.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
-
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 OdfStylableElement(OdfFileDom ownerDocument, OdfName name, OdfStyleFamily family, OdfName styleNameAttrib)
Creates a new instance of OdfElementImpl
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OdfStyle
getAutomaticStyle()
Retrieve ODF AutomaticStyleOdfOfficeAutomaticStyles
getAutomaticStyles()
Retrieve ODF OfficeAutomaticStylesOdfStyle
getDocumentStyle()
Retrieve ODF DocumentStyleString
getDocumentStyleName()
OdfOfficeAutomaticStyles
getOrCreateAutomaticStyles()
Retrieve ODF OfficeAutomaticStylesStyleStyleElement
getOrCreateUnqiueAutomaticStyle()
Retrieve or create unique ODF AutomaticStyleStyleStyleElement
getOrCreateUnqiueAutomaticStyle(Boolean createStyleName, OdfStyleFamily styleFamily)
Retrieve or create unique ODF AutomaticStyleMap<OdfStyleProperty,String>
getProperties(Set<OdfStyleProperty> properties)
Retrieve the set of ODF style proertiesString
getProperty(OdfStyleProperty property)
Retrieve ODF style propertySet<OdfStyleProperty>
getStrictProperties()
Retrieve the set of strict ODF propertiesOdfStyleFamily
getStyleFamily()
Retrieve ODF style familyString
getStyleName()
Retrieve style nameboolean
hasAutomaticStyle()
Judge if there is an automatic style, not necessary including propertiesboolean
hasDocumentStyle()
boolean
hasProperty(OdfStyleProperty property)
Judge if there is an automatic style with this propertyprotected void
onInsertNode()
protected void
onRemoveNode()
void
removeProperty(OdfStyleProperty property)
Remove the ODF propertyOdfStyle
reuseDocumentStyle(String styleName)
Returns a DocumentStyle if there is no local stylevoid
setAttributeNS(String uri, String qname, String value)
Set style attribute value with uri and namevoid
setDocumentStyle(OdfStyle style)
Set ODF DocumentStylevoid
setProperties(Map<OdfStyleProperty,String> properties)
Set ODF propertiesvoid
setProperty(OdfStyleProperty property, String value)
Set ODF style property with valuevoid
setStyleName(String name)
Set style name-
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement
accept, 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, getOdfAttributeValue, getOdfName, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onRemoveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, 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, 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
-
mFamily
protected OdfStyleFamily mFamily
-
mStyleNameAttrib
protected OdfName mStyleNameAttrib
-
-
Constructor Detail
-
OdfStylableElement
public OdfStylableElement(OdfFileDom ownerDocument, OdfName name, OdfStyleFamily family, OdfName styleNameAttrib) throws DOMException
Creates a new instance of OdfElementImpl- Parameters:
ownerDocument
-name
-family
-styleNameAttrib
-- Throws:
DOMException
-
-
Method Detail
-
getOrCreateUnqiueAutomaticStyle
public StyleStyleElement getOrCreateUnqiueAutomaticStyle()
Retrieve or create unique ODF AutomaticStyle- Returns:
- The
StyleStyleElement
element
-
getOrCreateUnqiueAutomaticStyle
public StyleStyleElement getOrCreateUnqiueAutomaticStyle(Boolean createStyleName, OdfStyleFamily styleFamily)
Retrieve or create unique ODF AutomaticStyle- Returns:
- The
StyleStyleElement
element
-
getOrCreateAutomaticStyles
public OdfOfficeAutomaticStyles getOrCreateAutomaticStyles()
Retrieve ODF OfficeAutomaticStyles- Returns:
- the
OdfOfficeAutomaticStyles
element that contains the automatic style for this element. A new node will be created if not existent.
-
getAutomaticStyles
public OdfOfficeAutomaticStyles getAutomaticStyles()
Retrieve ODF OfficeAutomaticStyles- Returns:
- the
OdfOfficeAutomaticStyles
element that contains the automatic style for this element, or null if not available.
-
setAttributeNS
public void setAttributeNS(String uri, String qname, String value)
Set style attribute value with uri and name- Specified by:
setAttributeNS
in interfaceElement
- Overrides:
setAttributeNS
in classorg.apache.xerces.dom.ElementImpl
- Parameters:
uri
- The namespace uriqname
- The qualified name of the attributevalue
- The attribute value
-
getStyleName
public String getStyleName()
Retrieve style name- Returns:
- the style name
-
setStyleName
public void setStyleName(String name)
Set style name- Parameters:
name
- The style name
-
getAutomaticStyle
public OdfStyle getAutomaticStyle()
Retrieve ODF AutomaticStyle- Returns:
- the
OdfStyle
element
-
hasAutomaticStyle
public boolean hasAutomaticStyle()
Judge if there is an automatic style, not necessary including properties- Returns:
- true if there is an automatic style
-
reuseDocumentStyle
public OdfStyle reuseDocumentStyle(String styleName)
Returns a DocumentStyle if there is no local style- Returns:
- The
OdfStyle
element
-
setDocumentStyle
public void setDocumentStyle(OdfStyle style)
Set ODF DocumentStyle- Parameters:
style
- The document style
-
getDocumentStyle
public OdfStyle getDocumentStyle()
Retrieve ODF DocumentStyle- Returns:
- the document style
-
getDocumentStyleName
public String getDocumentStyleName()
-
hasDocumentStyle
public boolean hasDocumentStyle()
- Returns:
- true if there is a document style.
-
getStyleFamily
public OdfStyleFamily getStyleFamily()
Retrieve ODF style family- Returns:
- the style family.
-
getProperty
public String getProperty(OdfStyleProperty property)
Retrieve ODF style property- Specified by:
getProperty
in interfaceOdfStylePropertySet
- Parameters:
property
- The style property- Returns:
- string for a property.
-
getProperties
public Map<OdfStyleProperty,String> getProperties(Set<OdfStyleProperty> properties)
Retrieve the set of ODF style proerties- Specified by:
getProperties
in interfaceOdfStylePropertySet
- Parameters:
properties
-- Returns:
- a map of all the properties.
-
getStrictProperties
public Set<OdfStyleProperty> getStrictProperties()
Retrieve the set of strict ODF properties- Specified by:
getStrictProperties
in interfaceOdfStylePropertySet
- Returns:
- a set of all the properties from the style family.
-
hasProperty
public boolean hasProperty(OdfStyleProperty property)
Judge if there is an automatic style with this property- Specified by:
hasProperty
in interfaceOdfStylePropertySet
- Parameters:
property
-- Returns:
- true if there is an automatic style with this property.
-
removeProperty
public void removeProperty(OdfStyleProperty property)
Remove the ODF property- Specified by:
removeProperty
in interfaceOdfStylePropertySet
- Parameters:
property
-
-
setProperties
public void setProperties(Map<OdfStyleProperty,String> properties)
Set ODF properties- Specified by:
setProperties
in interfaceOdfStylePropertySet
- Parameters:
properties
-
-
setProperty
public void setProperty(OdfStyleProperty property, String value)
Set ODF style property with value- Specified by:
setProperty
in interfaceOdfStylePropertySet
- Parameters:
property
-value
-
-
onInsertNode
protected void onInsertNode()
- Overrides:
onInsertNode
in classOdfElement
-
onRemoveNode
protected void onRemoveNode()
- Overrides:
onRemoveNode
in classOdfElement
-
-