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

Class TextTableOfContentSourceElement

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

All Implemented Interfaces:

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

public class TextTableOfContentSourceElement
extends OdfElement

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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final OdfName	ELEMENT_NAME

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
TextTableOfContentSourceElement(OdfFileDom ownerDoc)	Create the instance of TextTableOfContentSourceElement

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	getTextIndexScopeAttribute()	Receives the value of the ODFDOM attribute representation TextIndexScopeAttribute , See @text:index-scope
Integer	getTextOutlineLevelAttribute()	Receives the value of the ODFDOM attribute representation TextOutlineLevelAttribute , See @text:outline-level
Boolean	getTextRelativeTabStopPositionAttribute()	Receives the value of the ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See @text:relative-tab-stop-position
Boolean	getTextUseIndexMarksAttribute()	Receives the value of the ODFDOM attribute representation TextUseIndexMarksAttribute , See @text:use-index-marks
Boolean	getTextUseIndexSourceStylesAttribute()	Receives the value of the ODFDOM attribute representation TextUseIndexSourceStylesAttribute , See @text:use-index-source-styles
Boolean	getTextUseOutlineLevelAttribute()	Receives the value of the ODFDOM attribute representation TextUseOutlineLevelAttribute , See @text:use-outline-level
TextIndexSourceStylesElement	newTextIndexSourceStylesElement(int textOutlineLevelValue)	Create child element <text:index-source-styles>.
TextIndexTitleTemplateElement	newTextIndexTitleTemplateElement()	Create child element <text:index-title-template>.
TextTableOfContentEntryTemplateElement	newTextTableOfContentEntryTemplateElement(int textOutlineLevelValue, String textStyleNameValue)	Create child element <text:table-of-content-entry-template>.
void	setTextIndexScopeAttribute(String textIndexScopeValue)	Sets the value of ODFDOM attribute representation TextIndexScopeAttribute , See @text:index-scope
void	setTextOutlineLevelAttribute(Integer textOutlineLevelValue)	Sets the value of ODFDOM attribute representation TextOutlineLevelAttribute , See @text:outline-level
void	setTextRelativeTabStopPositionAttribute(Boolean textRelativeTabStopPositionValue)	Sets the value of ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See @text:relative-tab-stop-position
void	setTextUseIndexMarksAttribute(Boolean textUseIndexMarksValue)	Sets the value of ODFDOM attribute representation TextUseIndexMarksAttribute , See @text:use-index-marks
void	setTextUseIndexSourceStylesAttribute(Boolean textUseIndexSourceStylesValue)	Sets the value of ODFDOM attribute representation TextUseIndexSourceStylesAttribute , See @text:use-index-source-styles
void	setTextUseOutlineLevelAttribute(Boolean textUseOutlineLevelValue)	Sets the value of ODFDOM attribute representation TextUseOutlineLevelAttribute , See @text:use-outline-level

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, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, 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

public static final OdfName ELEMENT_NAME

Constructor Details

TextTableOfContentSourceElement

public TextTableOfContentSourceElement(OdfFileDom ownerDoc)

Create the instance of TextTableOfContentSourceElement

Parameters:

ownerDoc - The type is OdfFileDom

Method Details

getOdfName

public OdfName getOdfName()

Get the element name

Specified by:

getOdfName in class OdfElement

Returns:

return OdfName the name of element <text:table-of-content-source>.

getTextIndexScopeAttribute

public String getTextIndexScopeAttribute()

Receives the value of the ODFDOM attribute representation TextIndexScopeAttribute , See @text:index-scope

Returns:

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

setTextIndexScopeAttribute

public void setTextIndexScopeAttribute(String textIndexScopeValue)

Sets the value of ODFDOM attribute representation TextIndexScopeAttribute , See @text:index-scope

Parameters:

textIndexScopeValue - The type is String

getTextOutlineLevelAttribute

public Integer getTextOutlineLevelAttribute()

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

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

getTextRelativeTabStopPositionAttribute

public Boolean getTextRelativeTabStopPositionAttribute()

Receives the value of the ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See @text:relative-tab-stop-position

Returns:

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

setTextRelativeTabStopPositionAttribute

public void setTextRelativeTabStopPositionAttribute(Boolean textRelativeTabStopPositionValue)

Sets the value of ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See @text:relative-tab-stop-position

Parameters:

textRelativeTabStopPositionValue - The type is Boolean

getTextUseIndexMarksAttribute

public Boolean getTextUseIndexMarksAttribute()

Receives the value of the ODFDOM attribute representation TextUseIndexMarksAttribute , See @text:use-index-marks

Returns:

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

setTextUseIndexMarksAttribute

public void setTextUseIndexMarksAttribute(Boolean textUseIndexMarksValue)

Sets the value of ODFDOM attribute representation TextUseIndexMarksAttribute , See @text:use-index-marks

Parameters:

textUseIndexMarksValue - The type is Boolean

getTextUseIndexSourceStylesAttribute

public Boolean getTextUseIndexSourceStylesAttribute()

Receives the value of the ODFDOM attribute representation TextUseIndexSourceStylesAttribute , See @text:use-index-source-styles

Returns:

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

setTextUseIndexSourceStylesAttribute

public void setTextUseIndexSourceStylesAttribute(Boolean textUseIndexSourceStylesValue)

Sets the value of ODFDOM attribute representation TextUseIndexSourceStylesAttribute , See @text:use-index-source-styles

Parameters:

textUseIndexSourceStylesValue - The type is Boolean

getTextUseOutlineLevelAttribute

public Boolean getTextUseOutlineLevelAttribute()

Receives the value of the ODFDOM attribute representation TextUseOutlineLevelAttribute , See @text:use-outline-level

Returns:

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

setTextUseOutlineLevelAttribute

public void setTextUseOutlineLevelAttribute(Boolean textUseOutlineLevelValue)

Sets the value of ODFDOM attribute representation TextUseOutlineLevelAttribute , See @text:use-outline-level

Parameters:

textUseOutlineLevelValue - The type is Boolean

newTextIndexSourceStylesElement

public TextIndexSourceStylesElement newTextIndexSourceStylesElement(int textOutlineLevelValue)

Create child element <text:index-source-styles>.

Parameters:

textOutlineLevelValue - the Integer value of TextOutlineLevelAttribute , see @text:outline-level at specification

Returns:

the element <text:index-source-styles>

newTextIndexTitleTemplateElement

public TextIndexTitleTemplateElement newTextIndexTitleTemplateElement()

Create child element <text:index-title-template>.

Returns:

the element <text:index-title-template>

newTextTableOfContentEntryTemplateElement

public TextTableOfContentEntryTemplateElement newTextTableOfContentEntryTemplateElement(int textOutlineLevelValue,
 String textStyleNameValue)

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

Parameters:

textOutlineLevelValue - the Integer value of TextOutlineLevelAttribute , see @text:outline-level at specification

textStyleNameValue - the String value of TextStyleNameAttribute, see @text:style-name at specification

Returns:

the element <text:table-of-content-entry-template>

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