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

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.text.OdfTableOfContentSourceElement

All Implemented Interfaces:

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

Direct Known Subclasses:

OdfTableOfContentSource

public abstract class OdfTableOfContentSourceElement
extends OdfElement

DOM implementation of OpenDocument element text:table-of-content-source.

See Also:

Serialized Form

Field Summary

static OdfName

ELEMENT_NAME

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

OdfTableOfContentSourceElement(OdfFileDom aOwnerDoc)
Create the instance of OdfTableOfContentSourceElement

Method Summary

OdfIndexSourceStylesElement	createIndexSourceStylesElement(OdfPositiveInteger outlineLevel) Create child element text:index-source-styles.
OdfIndexTitleTemplateElement	createIndexTitleTemplateElement() Create child element text:index-title-template.
OdfTableOfContentEntryTemplateElement	createTableOfContentEntryTemplateElement(OdfPositiveInteger outlineLevel, OdfStyleNameRef styleName) Create child element text:table-of-content-entry-template.
OdfIndexScopeType	getIndexScope() Get value of attribute text:index-scope.
OdfName	getOdfName() Get the element name
OdfPositiveInteger	getOutlineLevel() Get value of attribute text:outline-level.
OdfBoolean	getRelativeTabStopPosition() Get value of attribute text:relative-tab-stop-position.
OdfBoolean	getUseIndexMarks() Get value of attribute text:use-index-marks.
OdfBoolean	getUseIndexSourceStyles() Get value of attribute text:use-index-source-styles.
OdfBoolean	getUseOutlineLevel() Get value of attribute text:use-outline-level.
void	setIndexScope(OdfIndexScopeType indexScope) Set value of attribute text:index-scope.
void	setOutlineLevel(OdfPositiveInteger outlineLevel) Set value of attribute text:outline-level.
void	setRelativeTabStopPosition(OdfBoolean isRelativeTabStopPosition) Set value of attribute text:relative-tab-stop-position.
void	setUseIndexMarks(OdfBoolean isUseIndexMarks) Set value of attribute text:use-index-marks.
void	setUseIndexSourceStyles(OdfBoolean isUseIndexSourceStyles) Set value of attribute text:use-index-source-styles.
void	setUseOutlineLevel(OdfBoolean isUseOutlineLevel) Set value of attribute text:use-outline-level.

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

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

OdfTableOfContentSourceElement

public OdfTableOfContentSourceElement(OdfFileDom aOwnerDoc)

Create the instance of OdfTableOfContentSourceElement

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:table-of-content-source.

getOutlineLevel

public OdfPositiveInteger getOutlineLevel()

Get value of attribute text:outline-level.

Returns:

return the attribute which type is OdfPositiveInteger

setOutlineLevel

public void setOutlineLevel(OdfPositiveInteger outlineLevel)

Set value of attribute text:outline-level.

Parameters:

outlineLevel - the attribute's type is OdfPositiveInteger

getUseOutlineLevel

public OdfBoolean getUseOutlineLevel()

Get value of attribute text:use-outline-level.

Returns:

return the attribute which type is OdfBoolean

setUseOutlineLevel

public void setUseOutlineLevel(OdfBoolean isUseOutlineLevel)

Set value of attribute text:use-outline-level.

Parameters:

isUseOutlineLevel - the attribute's type is OdfBoolean

getUseIndexMarks

public OdfBoolean getUseIndexMarks()

Get value of attribute text:use-index-marks.

Returns:

return the attribute which type is OdfBoolean

setUseIndexMarks

public void setUseIndexMarks(OdfBoolean isUseIndexMarks)

Set value of attribute text:use-index-marks.

Parameters:

isUseIndexMarks - the attribute's type is OdfBoolean

getUseIndexSourceStyles

public OdfBoolean getUseIndexSourceStyles()

Get value of attribute text:use-index-source-styles.

Returns:

return the attribute which type is OdfBoolean

setUseIndexSourceStyles

public void setUseIndexSourceStyles(OdfBoolean isUseIndexSourceStyles)

Set value of attribute text:use-index-source-styles.

Parameters:

isUseIndexSourceStyles - the attribute's type is OdfBoolean

getIndexScope

public OdfIndexScopeType getIndexScope()

Get value of attribute text:index-scope.

Returns:

return the attribute which type is OdfIndexScopeType

setIndexScope

public void setIndexScope(OdfIndexScopeType indexScope)

Set value of attribute text:index-scope.

Parameters:

indexScope - the attribute's type is OdfIndexScopeType

getRelativeTabStopPosition

public OdfBoolean getRelativeTabStopPosition()

Get value of attribute text:relative-tab-stop-position.

Returns:

return the attribute which type is OdfBoolean

setRelativeTabStopPosition

public void setRelativeTabStopPosition(OdfBoolean isRelativeTabStopPosition)

Set value of attribute text:relative-tab-stop-position.

Parameters:

isRelativeTabStopPosition - the attribute's type is OdfBoolean

createIndexTitleTemplateElement

public OdfIndexTitleTemplateElement createIndexTitleTemplateElement()

Create child element text:index-title-template.

Returns:

return the element text:index-title-template

createTableOfContentEntryTemplateElement

public OdfTableOfContentEntryTemplateElement createTableOfContentEntryTemplateElement(OdfPositiveInteger outlineLevel,
                                                                                      OdfStyleNameRef styleName)

Create child element text:table-of-content-entry-template.

Parameters:

outlineLevel - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfPositiveInteger

styleName - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfStyleNameRef

Returns:

return the element text:table-of-content-entry-template

createIndexSourceStylesElement

public OdfIndexSourceStylesElement createIndexSourceStylesElement(OdfPositiveInteger outlineLevel)

Create child element text:index-source-styles.

Parameters:

outlineLevel - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfPositiveInteger

Returns:

return the element text:index-source-styles