org.odftoolkit.odfdom.dom.element.text
Class TextUserIndexEntryTemplateElement

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
                              org.odftoolkit.odfdom.dom.element.text.TextUserIndexEntryTemplateElement

All Implemented Interfaces:

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

public class TextUserIndexEntryTemplateElement
extends OdfStylableElement

DOM implementation of OpenDocument element text:user-index-entry-template.

See Also:

Serialized Form

Field Summary

static OdfName

ELEMENT_NAME

Fields inherited from class org.odftoolkit.odfdom.dom.element.OdfStylableElement

mFamily, mStyleNameAttrib

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

TextUserIndexEntryTemplateElement(OdfFileDom ownerDoc)
Create the instance of TextUserIndexEntryTemplateElement

Method Summary

void	accept(ElementVisitor visitor) Accept an visitor instance to allow the visitor to do some operations.
OdfName	getOdfName() Get the element name
Integer	getTextOutlineLevelAttribute() Receives the value of the ODFDOM attribute representation TextOutlineLevelAttribute , See text:outline-level Attribute is mandatory.
String	getTextStyleNameAttribute() Receives the value of the ODFDOM attribute representation TextStyleNameAttribute , See text:style-name Attribute is mandatory.
TextIndexEntryChapterElement	newTextIndexEntryChapterElement() Create child element text:index-entry-chapter.
TextIndexEntryPageNumberElement	newTextIndexEntryPageNumberElement() Create child element text:index-entry-page-number.
TextIndexEntrySpanElement	newTextIndexEntrySpanElement() Create child element text:index-entry-span.
TextIndexEntryTabStopElement	newTextIndexEntryTabStopElement(String styleTypeValue) Create child element text:index-entry-tab-stop.
TextIndexEntryTextElement	newTextIndexEntryTextElement() Create child element text:index-entry-text.
void	setTextOutlineLevelAttribute(Integer textOutlineLevelValue) Sets the value of ODFDOM attribute representation TextOutlineLevelAttribute , See text:outline-level
void	setTextStyleNameAttribute(String textStyleNameValue) Sets the value of ODFDOM attribute representation TextStyleNameAttribute , See text:style-name

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

getAutomaticStyle, getAutomaticStyles, getDocumentStyle, getOrCreateUnqiueAutomaticStyle, getProperties, getProperty, getStrictProperties, getStyleFamily, getStyleName, hasAutomaticStyle, hasDocumentStyle, hasProperty, onInsertNode, onRemoveNode, removeProperty, reuseDocumentStyle, setAttributeNS, setDocumentStyle, setProperties, setProperty, setStyleName

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

cloneNode, cloneOdfElement, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, hasOdfAttribute, insertBefore, onInsertNode, onRemoveNode, removeChild, replaceChild, setOdfAttribute, setOdfAttributeValue, toString

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getBaseURI, getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setPrefix, setType, setValues

Methods inherited from class org.apache.xerces.dom.ElementImpl

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, 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, 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

Field Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Detail

TextUserIndexEntryTemplateElement

public TextUserIndexEntryTemplateElement(OdfFileDom ownerDoc)

Create the instance of TextUserIndexEntryTemplateElement

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:user-index-entry-template.

getTextOutlineLevelAttribute

public Integer getTextOutlineLevelAttribute()

Receives the value of the ODFDOM attribute representation TextOutlineLevelAttribute , See text:outline-level Attribute is mandatory.

Returns:

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

setTextOutlineLevelAttribute

public void setTextOutlineLevelAttribute(Integer textOutlineLevelValue)

Sets the value of ODFDOM attribute representation TextOutlineLevelAttribute , See text:outline-level

Parameters:

textOutlineLevelValue - The type is Integer

getTextStyleNameAttribute

public String getTextStyleNameAttribute()

Receives the value of the ODFDOM attribute representation TextStyleNameAttribute , See text:style-name Attribute is mandatory.

Returns:

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

setTextStyleNameAttribute

public void setTextStyleNameAttribute(String textStyleNameValue)

Sets the value of ODFDOM attribute representation TextStyleNameAttribute , See text:style-name

Parameters:

textStyleNameValue - The type is String

newTextIndexEntryChapterElement

public TextIndexEntryChapterElement newTextIndexEntryChapterElement()

Create child element text:index-entry-chapter.

Returns:

the element text:index-entry-chapter

newTextIndexEntryPageNumberElement

public TextIndexEntryPageNumberElement newTextIndexEntryPageNumberElement()

Create child element text:index-entry-page-number.

Returns:

the element text:index-entry-page-number

newTextIndexEntrySpanElement

public TextIndexEntrySpanElement newTextIndexEntrySpanElement()

Create child element text:index-entry-span.

Returns:

the element text:index-entry-span

newTextIndexEntryTabStopElement

public TextIndexEntryTabStopElement newTextIndexEntryTabStopElement(String styleTypeValue)

Create child element text:index-entry-tab-stop.

Parameters:

styleTypeValue - the String value of StyleTypeAttribute, see style:type at specification

Returns:

the element text:index-entry-tab-stop

newTextIndexEntryTextElement

public TextIndexEntryTextElement newTextIndexEntryTextElement()

Create child element text:index-entry-text.

Returns:

the element text:index-entry-text

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