Package org.odftoolkit.odfdom.dom.element.text

Class TextListStyleElement

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.OdfStyleBase

org.odftoolkit.odfdom.dom.element.text.TextListStyleElement

All Implemented Interfaces:

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

Direct Known Subclasses:

OdfTextListStyle

public class TextListStyleElement
extends OdfStyleBase

DOM implementation of OpenDocument element <text:list-style>.

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

Constructor	Description
TextListStyleElement(OdfFileDom ownerDoc)	Create the instance of TextListStyleElement

Method Summary

Modifier and Type	Method	Description
void	accept(ElementVisitor visitor)	Accept an visitor instance to allow the visitor to do some operations.
OdfName	getOdfName()	Get the element name
String	getStyleDisplayNameAttribute()	Receives the value of the ODFDOM attribute representation StyleDisplayNameAttribute , See @style:display-name
String	getStyleNameAttribute()	Receives the value of the ODFDOM attribute representation StyleNameAttribute , See @style:name
Boolean	getTextConsecutiveNumberingAttribute()	Receives the value of the ODFDOM attribute representation TextConsecutiveNumberingAttribute , See @text:consecutive-numbering
TextListLevelStyleBulletElement	newTextListLevelStyleBulletElement(String textBulletCharValue, int textLevelValue)	Create child element <text:list-level-style-bullet>.
TextListLevelStyleImageElement	newTextListLevelStyleImageElement(int textLevelValue)	Create child element <text:list-level-style-image>.
TextListLevelStyleNumberElement	newTextListLevelStyleNumberElement(String styleNumFormatValue, int textLevelValue)	Create child element <text:list-level-style-number>.
void	setStyleDisplayNameAttribute(String styleDisplayNameValue)	Sets the value of ODFDOM attribute representation StyleDisplayNameAttribute , See @style:display-name
void	setStyleNameAttribute(String styleNameValue)	Sets the value of ODFDOM attribute representation StyleNameAttribute , See @style:name
void	setTextConsecutiveNumberingAttribute(Boolean textConsecutiveNumberingValue)	Sets the value of ODFDOM attribute representation TextConsecutiveNumberingAttribute , See @text:consecutive-numbering

Methods inherited from class org.odftoolkit.odfdom.dom.element.OdfStyleBase

addStyleUser, compareTo, equals, getFamily, getFamilyName, getOrCreatePropertiesElement, getParentStyle, getProperties, getPropertiesElement, getProperty, getStrictProperties, getStyleProperties, getStylePropertiesDeep, getStyleUserCount, getStyleUsers, hashCode, hasProperty, onOdfNodeInserted, onOdfNodeRemoved, removeProperty, removeStyleUser, setProperties, setProperty

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, 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, 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

TextListStyleElement

public TextListStyleElement(OdfFileDom ownerDoc)

Create the instance of TextListStyleElement

Parameters:

ownerDoc - The type is OdfFileDom

Method Detail

getOdfName

public OdfName getOdfName()

Get the element name

Specified by:

getOdfName in class OdfElement

Returns:

return OdfName the name of element <text:list-style>.

getStyleDisplayNameAttribute

public String getStyleDisplayNameAttribute()

Receives the value of the ODFDOM attribute representation StyleDisplayNameAttribute , See @style:display-name

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setStyleDisplayNameAttribute

public void setStyleDisplayNameAttribute(String styleDisplayNameValue)

Sets the value of ODFDOM attribute representation StyleDisplayNameAttribute , See @style:display-name

Parameters:

styleDisplayNameValue - The type is String

getStyleNameAttribute

public String getStyleNameAttribute()

Receives the value of the ODFDOM attribute representation StyleNameAttribute , See @style:name

Attribute is mandatory.

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setStyleNameAttribute

public void setStyleNameAttribute(String styleNameValue)

Sets the value of ODFDOM attribute representation StyleNameAttribute , See @style:name

Parameters:

styleNameValue - The type is String

getTextConsecutiveNumberingAttribute

public Boolean getTextConsecutiveNumberingAttribute()

Receives the value of the ODFDOM attribute representation TextConsecutiveNumberingAttribute , See @text:consecutive-numbering

Returns:

- the Boolean , the value or null, if the attribute is not set and no default value defined.

setTextConsecutiveNumberingAttribute

public void setTextConsecutiveNumberingAttribute(Boolean textConsecutiveNumberingValue)

Sets the value of ODFDOM attribute representation TextConsecutiveNumberingAttribute , See @text:consecutive-numbering

Parameters:

textConsecutiveNumberingValue - The type is Boolean

newTextListLevelStyleBulletElement

public TextListLevelStyleBulletElement newTextListLevelStyleBulletElement(String textBulletCharValue,
                                                                          int textLevelValue)

Create child element <text:list-level-style-bullet>.

Parameters:

textBulletCharValue - the String value of TextBulletCharAttribute , see @text:bullet-char at specification

textLevelValue - the Integer value of TextLevelAttribute, see @text:level at specification

Returns:

the element <text:list-level-style-bullet>

newTextListLevelStyleImageElement

public TextListLevelStyleImageElement newTextListLevelStyleImageElement(int textLevelValue)

Create child element <text:list-level-style-image>.

Parameters:

textLevelValue - the Integer value of TextLevelAttribute, see @text:level at specification

Returns:

the element <text:list-level-style-image>

newTextListLevelStyleNumberElement

public TextListLevelStyleNumberElement newTextListLevelStyleNumberElement(String styleNumFormatValue,
                                                                          int textLevelValue)

Create child element <text:list-level-style-number>.

Parameters:

styleNumFormatValue - the String value of StyleNumFormatAttribute , see @style:num-format at specification

textLevelValue - the Integer value of TextLevelAttribute, see @text:level at specification

Returns:

the element <text:list-level-style-number>

accept

public void accept(ElementVisitor visitor)

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