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

Class TextObjectIndexSourceElement

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

All Implemented Interfaces:

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

public class TextObjectIndexSourceElement
extends OdfElement

DOM implementation of OpenDocument element <text:object-index-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
TextObjectIndexSourceElement(OdfFileDom ownerDoc)	Create the instance of TextObjectIndexSourceElement

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
Boolean	getTextRelativeTabStopPositionAttribute()	Receives the value of the ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See @text:relative-tab-stop-position
Boolean	getTextUseChartObjectsAttribute()	Receives the value of the ODFDOM attribute representation TextUseChartObjectsAttribute , See @text:use-chart-objects
Boolean	getTextUseDrawObjectsAttribute()	Receives the value of the ODFDOM attribute representation TextUseDrawObjectsAttribute , See @text:use-draw-objects
Boolean	getTextUseMathObjectsAttribute()	Receives the value of the ODFDOM attribute representation TextUseMathObjectsAttribute , See @text:use-math-objects
Boolean	getTextUseOtherObjectsAttribute()	Receives the value of the ODFDOM attribute representation TextUseOtherObjectsAttribute , See @text:use-other-objects
Boolean	getTextUseSpreadsheetObjectsAttribute()	Receives the value of the ODFDOM attribute representation TextUseSpreadsheetObjectsAttribute , See @text:use-spreadsheet-objects
TextIndexTitleTemplateElement	newTextIndexTitleTemplateElement()	Create child element <text:index-title-template>.
TextObjectIndexEntryTemplateElement	newTextObjectIndexEntryTemplateElement(String textStyleNameValue)	Create child element <text:object-index-entry-template>.
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	setTextUseChartObjectsAttribute(Boolean textUseChartObjectsValue)	Sets the value of ODFDOM attribute representation TextUseChartObjectsAttribute , See @text:use-chart-objects
void	setTextUseDrawObjectsAttribute(Boolean textUseDrawObjectsValue)	Sets the value of ODFDOM attribute representation TextUseDrawObjectsAttribute , See @text:use-draw-objects
void	setTextUseMathObjectsAttribute(Boolean textUseMathObjectsValue)	Sets the value of ODFDOM attribute representation TextUseMathObjectsAttribute , See @text:use-math-objects
void	setTextUseOtherObjectsAttribute(Boolean textUseOtherObjectsValue)	Sets the value of ODFDOM attribute representation TextUseOtherObjectsAttribute , See @text:use-other-objects
void	setTextUseSpreadsheetObjectsAttribute(Boolean textUseSpreadsheetObjectsValue)	Sets the value of ODFDOM attribute representation TextUseSpreadsheetObjectsAttribute , See @text:use-spreadsheet-objects

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

TextObjectIndexSourceElement

public TextObjectIndexSourceElement(OdfFileDom ownerDoc)

Create the instance of TextObjectIndexSourceElement

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:object-index-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

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

getTextUseChartObjectsAttribute

public Boolean getTextUseChartObjectsAttribute()

Receives the value of the ODFDOM attribute representation TextUseChartObjectsAttribute , See @text:use-chart-objects

Returns:

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

setTextUseChartObjectsAttribute

public void setTextUseChartObjectsAttribute(Boolean textUseChartObjectsValue)

Sets the value of ODFDOM attribute representation TextUseChartObjectsAttribute , See @text:use-chart-objects

Parameters:

textUseChartObjectsValue - The type is Boolean

getTextUseDrawObjectsAttribute

public Boolean getTextUseDrawObjectsAttribute()

Receives the value of the ODFDOM attribute representation TextUseDrawObjectsAttribute , See @text:use-draw-objects

Returns:

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

setTextUseDrawObjectsAttribute

public void setTextUseDrawObjectsAttribute(Boolean textUseDrawObjectsValue)

Sets the value of ODFDOM attribute representation TextUseDrawObjectsAttribute , See @text:use-draw-objects

Parameters:

textUseDrawObjectsValue - The type is Boolean

getTextUseMathObjectsAttribute

public Boolean getTextUseMathObjectsAttribute()

Receives the value of the ODFDOM attribute representation TextUseMathObjectsAttribute , See @text:use-math-objects

Returns:

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

setTextUseMathObjectsAttribute

public void setTextUseMathObjectsAttribute(Boolean textUseMathObjectsValue)

Sets the value of ODFDOM attribute representation TextUseMathObjectsAttribute , See @text:use-math-objects

Parameters:

textUseMathObjectsValue - The type is Boolean

getTextUseOtherObjectsAttribute

public Boolean getTextUseOtherObjectsAttribute()

Receives the value of the ODFDOM attribute representation TextUseOtherObjectsAttribute , See @text:use-other-objects

Returns:

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

setTextUseOtherObjectsAttribute

public void setTextUseOtherObjectsAttribute(Boolean textUseOtherObjectsValue)

Sets the value of ODFDOM attribute representation TextUseOtherObjectsAttribute , See @text:use-other-objects

Parameters:

textUseOtherObjectsValue - The type is Boolean

getTextUseSpreadsheetObjectsAttribute

public Boolean getTextUseSpreadsheetObjectsAttribute()

Receives the value of the ODFDOM attribute representation TextUseSpreadsheetObjectsAttribute , See @text:use-spreadsheet-objects

Returns:

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

setTextUseSpreadsheetObjectsAttribute

public void setTextUseSpreadsheetObjectsAttribute(Boolean textUseSpreadsheetObjectsValue)

Sets the value of ODFDOM attribute representation TextUseSpreadsheetObjectsAttribute , See @text:use-spreadsheet-objects

Parameters:

textUseSpreadsheetObjectsValue - The type is Boolean

newTextIndexTitleTemplateElement

public TextIndexTitleTemplateElement newTextIndexTitleTemplateElement()

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

Returns:

the element <text:index-title-template>

newTextObjectIndexEntryTemplateElement

public TextObjectIndexEntryTemplateElement newTextObjectIndexEntryTemplateElement(String textStyleNameValue)

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

Parameters:

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

Returns:

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