Class OdfOfficeStyles
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.OdfOfficeStyles
- All Implemented Interfaces:
Serializable
,Cloneable
,Element
,ElementTraversal
,EventTarget
,Node
,NodeList
,TypeInfo
- Direct Known Subclasses:
OfficeStylesElement
Convenient functionality for the parent ODF OpenDocument element
- See Also:
-
Field Summary
FieldsFields 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
ConstructorsModifierConstructorDescriptionOdfOfficeStyles
(OdfFileDom ownerDoc) protected
OdfOfficeStyles
(OdfFileDom ownerDoc, OdfName elementName) Used by generated subclass OdfOfficeStylesElement -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(ElementVisitor visitor) Accept an visitor instance to allow the visitor to do some operations.getDefaultStyle
(OdfStyleFamily familyType) Returns theOdfStyleDefaultStyle
element.Returns an iterator for allOdfStyleDefaultStyle
elements.getFillImage
(String name) Returns theDrawFillImageElement
element with the given name.Returns an iterator for allDrawFillImageElement
elements.getGradient
(String name) Returns theDrawGradientElement
element with the given name.Returns an iterator for allDrawGradientElement
elements.Returns theDrawHatchElement
element with the given name.Returns an iterator for allDrawHatchElement
elements.Returns an iterator for allDrawMarkerElement
elements.Returns theDrawMarkerElement
element with the given name.Retrieve or create ODF default styleRetrieve or create ODF OutlineStyleReturns theOdfTextOutlineStyle
element.protected <T extends OdfElement>
TgetStylesElement
(OdfFileDom dom, Class<T> clazz) newDrawFillImageElement
(String drawNameValue, String xlinkHrefValue, String xlinkTypeValue) Create child element <draw:fill-image>.newDrawGradientElement
(String drawStyleValue) Create child element <draw:gradient>.newDrawHatchElement
(String drawNameValue, String drawStyleValue) Create child element <draw:hatch>.newDrawMarkerElement
(String drawNameValue, String svgDValue, int svgViewBoxValue) Create child element <draw:marker>.newDrawOpacityElement
(String drawStyleValue) Create child element <draw:opacity>.newDrawStrokeDashElement
(String drawNameValue) Create child element <draw:stroke-dash>.newListStyle
(String name) Create ODF TextListStylenewNumberBooleanStyleElement
(String styleNameValue) Create child element <number:boolean-style>.newNumberCurrencyStyleElement
(String styleNameValue) Create child element <number:currency-style>.newNumberDateStyleElement
(String styleNameValue) Create child element <number:date-style>.newNumberNumberStyleElement
(String styleNameValue) Create child element <number:number-style>.newNumberPercentageStyleElement
(String styleNameValue) Create child element <number:percentage-style>.newNumberTextStyleElement
(String styleNameValue) Create child element <number:text-style>.newNumberTimeStyleElement
(String styleNameValue) Create child element <number:time-style>.Create child element <style:default-page-layout>.newStyleDefaultStyleElement
(String styleFamilyValue) Create child element <style:default-style>.newStylePresentationPageLayoutElement
(String styleNameValue) Create child element <style:presentation-page-layout>.newStyleStyleElement
(String styleFamilyValue, String styleNameValue) Create child element <style:style>.newSvgLinearGradientElement
(String drawNameValue) Create child element <svg:linearGradient>.newSvgRadialGradientElement
(String drawNameValue) Create child element <svg:radialGradient>.newTableTableTemplateElement
(String tableFirstRowEndColumnValue, String tableFirstRowStartColumnValue, String tableLastRowEndColumnValue, String tableLastRowStartColumnValue, String tableNameValue) Create child element <table:table-template>.Create child element <text:bibliography-configuration>.newTextLinenumberingConfigurationElement
(String styleNumFormatValue) Create child element <text:linenumbering-configuration>.newTextListStyleElement
(String styleNameValue) Create child element <text:list-style>.newTextNotesConfigurationElement
(String styleNumFormatValue, String textNoteClassValue) Create child element <text:notes-configuration>.newTextOutlineStyleElement
(String styleNameValue) Create child element <text:outline-style>.void
onOdfNodeInserted
(OdfElement node, Node refNode) override this method to get notified about element insertionvoid
onOdfNodeRemoved
(OdfElement node) override this method to get notified about element insertionMethods 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 Details
-
ELEMENT_NAME
-
-
Constructor Details
-
OdfOfficeStyles
-
OdfOfficeStyles
Used by generated subclass OdfOfficeStylesElement
-
-
Method Details
-
getOdfName
- Specified by:
getOdfName
in classOdfElement
-
getOrCreateDefaultStyle
Retrieve or create ODF default style- Parameters:
family
- The style family- Returns:
- The code>OdfDefaultStyle element
-
newListStyle
Create ODF TextListStyle- Parameters:
name
- The style name- Returns:
- The code>OdfTextListStyle element
-
getOrCreateOutlineStyle
Retrieve or create ODF OutlineStyle- Returns:
- The code>OdfTextOutlineStyle element
-
getOutlineStyle
Returns theOdfTextOutlineStyle
element.- Returns:
- a pointer to the outline stye or null if there is no such element
-
getDefaultStyle
Returns theOdfStyleDefaultStyle
element.- Parameters:
familyType
- is the family for the default style- Returns:
- the default style with the given family or null if there is no such default style
-
getDefaultStyles
Returns an iterator for allOdfStyleDefaultStyle
elements.- Returns:
- iterator for all
OdfStyleDefaultStyle
elements
-
getMarker
Returns theDrawMarkerElement
element with the given name.- Parameters:
name
- is the name of the marker- Returns:
- the marker or null if there is no such marker
-
getMarker
Returns an iterator for allDrawMarkerElement
elements.- Returns:
- an iterator for all
DrawMarkerElement
elements
-
getGradient
Returns theDrawGradientElement
element with the given name.- Parameters:
name
- is the name of the gradient- Returns:
- the gradient or null if there is no such gradient
-
getGradients
Returns an iterator for allDrawGradientElement
elements.- Returns:
- an iterator for all
DrawGradientElement
elements
-
getHatch
Returns theDrawHatchElement
element with the given name.- Parameters:
name
- is the name of the hatch- Returns:
- the hatch or null if there is no such hatch
-
getHatches
Returns an iterator for allDrawHatchElement
elements.- Returns:
- an iterator for all
DrawHatchElement
elements
-
getFillImage
Returns theDrawFillImageElement
element with the given name.- Parameters:
name
- is the name of the fill image- Returns:
- the fill image or null if there is no such fill image
-
getFillImages
Returns an iterator for allDrawFillImageElement
elements.- Returns:
- an iterator for all
DrawFillImageElement
elements
-
onOdfNodeInserted
Description copied from class:OdfContainerElementBase
override this method to get notified about element insertion- Overrides:
onOdfNodeInserted
in classOdfStylesBase
-
onOdfNodeRemoved
Description copied from class:OdfContainerElementBase
override this method to get notified about element insertion- Overrides:
onOdfNodeRemoved
in classOdfStylesBase
-
getStylesElement
protected <T extends OdfElement> T getStylesElement(OdfFileDom dom, Class<T> clazz) throws Exception - Specified by:
getStylesElement
in classOdfStylesBase
- Throws:
Exception
-
newDrawFillImageElement
public DrawFillImageElement newDrawFillImageElement(String drawNameValue, String xlinkHrefValue, String xlinkTypeValue) Create child element <draw:fill-image>.- Parameters:
drawNameValue
- theString
value ofDrawNameAttribute
, see @draw:name at specificationxlinkHrefValue
- theString
value ofXlinkHrefAttribute
, see @xlink:href at specificationxlinkTypeValue
- theString
value ofXlinkTypeAttribute
, see @xlink:type at specification- Returns:
- the element <draw:fill-image>
-
newDrawGradientElement
Create child element <draw:gradient>.- Parameters:
drawStyleValue
- theString
value ofDrawStyleAttribute
, see @draw:style at specification- Returns:
- the element <draw:gradient>
-
newDrawHatchElement
Create child element <draw:hatch>.- Parameters:
drawNameValue
- theString
value ofDrawNameAttribute
, see @draw:name at specificationdrawStyleValue
- theString
value ofDrawStyleAttribute
, see @draw:style at specification- Returns:
- the element <draw:hatch>
-
newDrawMarkerElement
public DrawMarkerElement newDrawMarkerElement(String drawNameValue, String svgDValue, int svgViewBoxValue) Create child element <draw:marker>.- Parameters:
drawNameValue
- theString
value ofDrawNameAttribute
, see @draw:name at specificationsvgDValue
- theString
value ofSvgDAttribute
, see @svg:d at specificationsvgViewBoxValue
- theInteger
value ofSvgViewBoxAttribute
, see @svg:viewBox at specification- Returns:
- the element <draw:marker>
-
newDrawOpacityElement
Create child element <draw:opacity>.- Parameters:
drawStyleValue
- theString
value ofDrawStyleAttribute
, see @draw:style at specification- Returns:
- the element <draw:opacity>
-
newDrawStrokeDashElement
Create child element <draw:stroke-dash>.- Parameters:
drawNameValue
- theString
value ofDrawNameAttribute
, see @draw:name at specification- Returns:
- the element <draw:stroke-dash>
-
newNumberBooleanStyleElement
Create child element <number:boolean-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <number:boolean-style>
-
newNumberCurrencyStyleElement
Create child element <number:currency-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <number:currency-style>
-
newNumberDateStyleElement
Create child element <number:date-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <number:date-style>
-
newNumberNumberStyleElement
Create child element <number:number-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <number:number-style>
-
newNumberPercentageStyleElement
Create child element <number:percentage-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <number:percentage-style>
-
newNumberTextStyleElement
Create child element <number:text-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <number:text-style>
-
newNumberTimeStyleElement
Create child element <number:time-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <number:time-style>
-
newStyleDefaultPageLayoutElement
Create child element <style:default-page-layout>.Child element is new in Odf 1.2
- Returns:
- the element <style:default-page-layout>
-
newStyleDefaultStyleElement
Create child element <style:default-style>.- Parameters:
styleFamilyValue
- theString
value ofStyleFamilyAttribute
, see @style:family at specification- Returns:
- the element <style:default-style>
-
newStylePresentationPageLayoutElement
public StylePresentationPageLayoutElement newStylePresentationPageLayoutElement(String styleNameValue) Create child element <style:presentation-page-layout>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <style:presentation-page-layout>
-
newStyleStyleElement
Create child element <style:style>.- Parameters:
styleFamilyValue
- theString
value ofStyleFamilyAttribute
, see @style:family at specificationstyleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <style:style>
-
newSvgLinearGradientElement
Create child element <svg:linearGradient>.- Parameters:
drawNameValue
- theString
value ofDrawNameAttribute
, see @draw:name at specification- Returns:
- the element <svg:linearGradient>
-
newSvgRadialGradientElement
Create child element <svg:radialGradient>.- Parameters:
drawNameValue
- theString
value ofDrawNameAttribute
, see @draw:name at specification- Returns:
- the element <svg:radialGradient>
-
newTableTableTemplateElement
public TableTableTemplateElement newTableTableTemplateElement(String tableFirstRowEndColumnValue, String tableFirstRowStartColumnValue, String tableLastRowEndColumnValue, String tableLastRowStartColumnValue, String tableNameValue) Create child element <table:table-template>.- Parameters:
tableFirstRowEndColumnValue
- theString
value ofTableFirstRowEndColumnAttribute
, see @table:first-row-end-column at specificationtableFirstRowStartColumnValue
- theString
value ofTableFirstRowStartColumnAttribute
, see @table:first-row-start-column at specificationtableLastRowEndColumnValue
- theString
value ofTableLastRowEndColumnAttribute
, see @table:last-row-end-column at specificationtableLastRowStartColumnValue
- theString
value ofTableLastRowStartColumnAttribute
, see @table:last-row-start-column at specificationtableNameValue
- theString
value ofTableNameAttribute
, see @table:name at specification Child element is new in Odf 1.2- Returns:
- the element <table:table-template>
-
newTextBibliographyConfigurationElement
Create child element <text:bibliography-configuration>.- Returns:
- the element <text:bibliography-configuration>
-
newTextLinenumberingConfigurationElement
public TextLinenumberingConfigurationElement newTextLinenumberingConfigurationElement(String styleNumFormatValue) Create child element <text:linenumbering-configuration>.- Parameters:
styleNumFormatValue
- theString
value ofStyleNumFormatAttribute
, see @style:num-format at specification- Returns:
- the element <text:linenumbering-configuration>
-
newTextListStyleElement
Create child element <text:list-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <text:list-style>
-
newTextNotesConfigurationElement
public TextNotesConfigurationElement newTextNotesConfigurationElement(String styleNumFormatValue, String textNoteClassValue) Create child element <text:notes-configuration>.- Parameters:
styleNumFormatValue
- theString
value ofStyleNumFormatAttribute
, see @style:num-format at specificationtextNoteClassValue
- theString
value ofTextNoteClassAttribute
, see @text:note-class at specification- Returns:
- the element <text:notes-configuration>
-
newTextOutlineStyleElement
Create child element <text:outline-style>.- Parameters:
styleNameValue
- theString
value ofStyleNameAttribute
, see @style:name at specification- Returns:
- the element <text:outline-style>
-
accept
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 classOdfElement
- Parameters:
visitor
- an instance of DefaultElementVisitor
-