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

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.dom.element.OdfElement
                          org.odftoolkit.odfdom.dom.element.OdfStylableElement
                              org.odftoolkit.odfdom.dom.element.text.OdfAlphabeticalIndexEntryTemplateElement

All Implemented Interfaces:

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

Direct Known Subclasses:

OdfAlphabeticalIndexEntryTemplate

public abstract class OdfAlphabeticalIndexEntryTemplateElement
extends OdfStylableElement

DOM implementation of OpenDocument element text:alphabetical-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.odftoolkit.odfdom.dom.element.OdfElement

mOdfDocument

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

OdfAlphabeticalIndexEntryTemplateElement(OdfFileDom aOwnerDoc)
Create the instance of OdfAlphabeticalIndexEntryTemplateElement

Method Summary

OdfIndexEntryChapterElement	createIndexEntryChapterElement() Create child element text:index-entry-chapter.
OdfIndexEntryPageNumberElement	createIndexEntryPageNumberElement() Create child element text:index-entry-page-number.
OdfIndexEntrySpanElement	createIndexEntrySpanElement() Create child element text:index-entry-span.
OdfIndexEntryTabStopElement	createIndexEntryTabStopElement(OdfIndexTabStopType type) Create child element text:index-entry-tab-stop.
OdfIndexEntryTabStopElement	createIndexEntryTabStopElement(OdfIndexTabStopType type, OdfLength position) Create child element text:index-entry-tab-stop.
OdfIndexEntryTextElement	createIndexEntryTextElement() Create child element text:index-entry-text.
OdfName	getOdfName() Get the element name
OdfOutlineLevelType	getOutlineLevel() Get value of attribute text:outline-level.
String	getStyleName() Get value of attribute text:style-name.
void	init(OdfOutlineLevelType outlineLevel, OdfStyleNameRef styleName) Initialization of the mandatory attributes of OdfAlphabeticalIndexEntryTemplateElement
void	setOutlineLevel(OdfOutlineLevelType outlineLevel) Set value of attribute text:outline-level.
void	setStyleName(OdfStyleNameRef styleName) Set value of attribute text:style-name.

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

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

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

cloneNode, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getParentAs, hasOdfAttribute, insertBefore, onInsertNode, onRemoveNode, removeChild, replaceChild, setOdfAttribute, 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

OdfAlphabeticalIndexEntryTemplateElement

public OdfAlphabeticalIndexEntryTemplateElement(OdfFileDom aOwnerDoc)

Create the instance of OdfAlphabeticalIndexEntryTemplateElement

Parameters:

aOwnerDoc - The type is OdfFileDom

Method Detail

getOdfName

public OdfName getOdfName()

Get the element name

Specified by:

getOdfName in class OdfElement

Returns:

return the name of element text:alphabetical-index-entry-template.

init

public void init(OdfOutlineLevelType outlineLevel,
                 OdfStyleNameRef styleName)

Initialization of the mandatory attributes of OdfAlphabeticalIndexEntryTemplateElement

Parameters:

outlineLevel - The mandatory attribute text:outline-level"

styleName - The mandatory attribute text:style-name"

getOutlineLevel

public OdfOutlineLevelType getOutlineLevel()

Get value of attribute text:outline-level.

Returns:

return the attribute which type is OdfOutlineLevelType

setOutlineLevel

public void setOutlineLevel(OdfOutlineLevelType outlineLevel)

Set value of attribute text:outline-level.

Parameters:

outlineLevel - the attribute's type is OdfOutlineLevelType

getStyleName

public String getStyleName()

Get value of attribute text:style-name.

Overrides:

getStyleName in class OdfStylableElement

Returns:

return the attribute which type is String

setStyleName

public void setStyleName(OdfStyleNameRef styleName)

Set value of attribute text:style-name.

Parameters:

styleName - the attribute's type is OdfStyleNameRef

createIndexEntryChapterElement

public OdfIndexEntryChapterElement createIndexEntryChapterElement()

Create child element text:index-entry-chapter.

Returns:

return the element text:index-entry-chapter

createIndexEntryPageNumberElement

public OdfIndexEntryPageNumberElement createIndexEntryPageNumberElement()

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

Returns:

return the element text:index-entry-page-number

createIndexEntryTextElement

public OdfIndexEntryTextElement createIndexEntryTextElement()

Create child element text:index-entry-text.

Returns:

return the element text:index-entry-text

createIndexEntrySpanElement

public OdfIndexEntrySpanElement createIndexEntrySpanElement()

Create child element text:index-entry-span.

Returns:

return the element text:index-entry-span

createIndexEntryTabStopElement

public OdfIndexEntryTabStopElement createIndexEntryTabStopElement(OdfIndexTabStopType type)

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

Parameters:

type - the attribute's type is OdfIndexTabStopType, see style:index-tab-stop at specification

Returns:

return the element text:index-entry-tab-stop

createIndexEntryTabStopElement

public OdfIndexEntryTabStopElement createIndexEntryTabStopElement(OdfIndexTabStopType type,
                                                                  OdfLength position)

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

Parameters:

type - the attribute's type is OdfIndexTabStopType, see style:index-tab-stop at specification

position - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfLength

Returns:

return the element text:index-entry-tab-stop