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

Class TextTableIndexSourceElement

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

All Implemented Interfaces:

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

public class TextTableIndexSourceElement
extends OdfElement

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static 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
TextTableIndexSourceElement(OdfFileDom ownerDoc)	Create the instance of TextTableIndexSourceElement

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	getTextCaptionSequenceFormatAttribute()	Receives the value of the ODFDOM attribute representation TextCaptionSequenceFormatAttribute , See @text:caption-sequence-format
String	getTextCaptionSequenceNameAttribute()	Receives the value of the ODFDOM attribute representation TextCaptionSequenceNameAttribute , See @text:caption-sequence-name
String	getTextIndexScopeAttribute()	Receives the value of the ODFDOM attribute representation TextIndexScopeAttribute , See @text:index-scope
Boolean	getTextRelativeTabStopPositionAttribute()	Receives the value of the ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See @text:relative-tab-stop-position
Boolean	getTextUseCaptionAttribute()	Receives the value of the ODFDOM attribute representation TextUseCaptionAttribute , See @text:use-caption
TextIndexTitleTemplateElement	newTextIndexTitleTemplateElement()	Create child element <text:index-title-template>.
TextTableIndexEntryTemplateElement	newTextTableIndexEntryTemplateElement(String textStyleNameValue)	Create child element <text:table-index-entry-template>.
void	setTextCaptionSequenceFormatAttribute(String textCaptionSequenceFormatValue)	Sets the value of ODFDOM attribute representation TextCaptionSequenceFormatAttribute , See @text:caption-sequence-format
void	setTextCaptionSequenceNameAttribute(String textCaptionSequenceNameValue)	Sets the value of ODFDOM attribute representation TextCaptionSequenceNameAttribute , See @text:caption-sequence-name
void	setTextIndexScopeAttribute(String textIndexScopeValue)	Sets the value of ODFDOM attribute representation TextIndexScopeAttribute , See @text:index-scope
void	setTextRelativeTabStopPositionAttribute(Boolean textRelativeTabStopPositionValue)	Sets the value of ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See @text:relative-tab-stop-position
void	setTextUseCaptionAttribute(Boolean textUseCaptionValue)	Sets the value of ODFDOM attribute representation TextUseCaptionAttribute , See @text:use-caption

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 Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Detail

TextTableIndexSourceElement

public TextTableIndexSourceElement(OdfFileDom ownerDoc)

Create the instance of TextTableIndexSourceElement

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

getTextCaptionSequenceFormatAttribute

public String getTextCaptionSequenceFormatAttribute()

Receives the value of the ODFDOM attribute representation TextCaptionSequenceFormatAttribute , See @text:caption-sequence-format

Returns:

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

setTextCaptionSequenceFormatAttribute

public void setTextCaptionSequenceFormatAttribute(String textCaptionSequenceFormatValue)

Sets the value of ODFDOM attribute representation TextCaptionSequenceFormatAttribute , See @text:caption-sequence-format

Parameters:

textCaptionSequenceFormatValue - The type is String

getTextCaptionSequenceNameAttribute

public String getTextCaptionSequenceNameAttribute()

Receives the value of the ODFDOM attribute representation TextCaptionSequenceNameAttribute , See @text:caption-sequence-name

Returns:

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

setTextCaptionSequenceNameAttribute

public void setTextCaptionSequenceNameAttribute(String textCaptionSequenceNameValue)

Sets the value of ODFDOM attribute representation TextCaptionSequenceNameAttribute , See @text:caption-sequence-name

Parameters:

textCaptionSequenceNameValue - The type is String

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

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

getTextUseCaptionAttribute

public Boolean getTextUseCaptionAttribute()

Receives the value of the ODFDOM attribute representation TextUseCaptionAttribute , See @text:use-caption

Returns:

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

setTextUseCaptionAttribute

public void setTextUseCaptionAttribute(Boolean textUseCaptionValue)

Sets the value of ODFDOM attribute representation TextUseCaptionAttribute , See @text:use-caption

Parameters:

textUseCaptionValue - The type is Boolean

newTextIndexTitleTemplateElement

public TextIndexTitleTemplateElement newTextIndexTitleTemplateElement()

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

Returns:

the element <text:index-title-template>

newTextTableIndexEntryTemplateElement

public TextTableIndexEntryTemplateElement newTextTableIndexEntryTemplateElement(String textStyleNameValue)

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

Parameters:

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

Returns:

the element <text:table-index-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