org.odftoolkit.odfdom.dom.element.text

Class TextUserIndexSourceElement

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

All Implemented Interfaces:

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

public class TextUserIndexSourceElement
extends OdfElement

DOM implementation of OpenDocument element text:user-index-source.

See Also:

Serialized Form

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	accept(ElementVisitor visitor) Accept an visitor instance to allow the visitor to do some operations.
OdfName	getOdfName() Get the element name
Boolean	getTextCopyOutlineLevelsAttribute() Receives the value of the ODFDOM attribute representation TextCopyOutlineLevelsAttribute , See text:copy-outline-levels
String	getTextIndexNameAttribute() Receives the value of the ODFDOM attribute representation TextIndexNameAttribute , See text:index-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	getTextUseFloatingFramesAttribute() Receives the value of the ODFDOM attribute representation TextUseFloatingFramesAttribute , See text:use-floating-frames
Boolean	getTextUseGraphicsAttribute() Receives the value of the ODFDOM attribute representation TextUseGraphicsAttribute , See text:use-graphics
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	getTextUseObjectsAttribute() Receives the value of the ODFDOM attribute representation TextUseObjectsAttribute , See text:use-objects
Boolean	getTextUseTablesAttribute() Receives the value of the ODFDOM attribute representation TextUseTablesAttribute , See text:use-tables
TextIndexSourceStylesElement	newTextIndexSourceStylesElement(int textOutlineLevelValue) Create child element text:index-source-styles.
TextIndexTitleTemplateElement	newTextIndexTitleTemplateElement() Create child element text:index-title-template.
TextUserIndexEntryTemplateElement	newTextUserIndexEntryTemplateElement(int textOutlineLevelValue, String textStyleNameValue) Create child element text:user-index-entry-template.
void	setTextCopyOutlineLevelsAttribute(Boolean textCopyOutlineLevelsValue) Sets the value of ODFDOM attribute representation TextCopyOutlineLevelsAttribute , See text:copy-outline-levels
void	setTextIndexNameAttribute(String textIndexNameValue) Sets the value of ODFDOM attribute representation TextIndexNameAttribute , See text:index-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	setTextUseFloatingFramesAttribute(Boolean textUseFloatingFramesValue) Sets the value of ODFDOM attribute representation TextUseFloatingFramesAttribute , See text:use-floating-frames
void	setTextUseGraphicsAttribute(Boolean textUseGraphicsValue) Sets the value of ODFDOM attribute representation TextUseGraphicsAttribute , See text:use-graphics
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	setTextUseObjectsAttribute(Boolean textUseObjectsValue) Sets the value of ODFDOM attribute representation TextUseObjectsAttribute , See text:use-objects
void	setTextUseTablesAttribute(Boolean textUseTablesValue) Sets the value of ODFDOM attribute representation TextUseTablesAttribute , See text:use-tables

Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement

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

TextUserIndexSourceElement

public TextUserIndexSourceElement(OdfFileDom ownerDoc)

Create the instance of TextUserIndexSourceElement

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

getTextCopyOutlineLevelsAttribute

public Boolean getTextCopyOutlineLevelsAttribute()

Receives the value of the ODFDOM attribute representation TextCopyOutlineLevelsAttribute , See text:copy-outline-levels

Returns:

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

setTextCopyOutlineLevelsAttribute

public void setTextCopyOutlineLevelsAttribute(Boolean textCopyOutlineLevelsValue)

Sets the value of ODFDOM attribute representation TextCopyOutlineLevelsAttribute , See text:copy-outline-levels

Parameters:

textCopyOutlineLevelsValue - The type is Boolean

getTextIndexNameAttribute

public String getTextIndexNameAttribute()

Receives the value of the ODFDOM attribute representation TextIndexNameAttribute , See text:index-name

Attribute is mandatory.

Returns:

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

setTextIndexNameAttribute

public void setTextIndexNameAttribute(String textIndexNameValue)

Sets the value of ODFDOM attribute representation TextIndexNameAttribute , See text:index-name

Parameters:

textIndexNameValue - 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

getTextUseFloatingFramesAttribute

public Boolean getTextUseFloatingFramesAttribute()

Receives the value of the ODFDOM attribute representation TextUseFloatingFramesAttribute , See text:use-floating-frames

Returns:

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

setTextUseFloatingFramesAttribute

public void setTextUseFloatingFramesAttribute(Boolean textUseFloatingFramesValue)

Sets the value of ODFDOM attribute representation TextUseFloatingFramesAttribute , See text:use-floating-frames

Parameters:

textUseFloatingFramesValue - The type is Boolean

getTextUseGraphicsAttribute

public Boolean getTextUseGraphicsAttribute()

Receives the value of the ODFDOM attribute representation TextUseGraphicsAttribute , See text:use-graphics

Returns:

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

setTextUseGraphicsAttribute

public void setTextUseGraphicsAttribute(Boolean textUseGraphicsValue)

Sets the value of ODFDOM attribute representation TextUseGraphicsAttribute , See text:use-graphics

Parameters:

textUseGraphicsValue - 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

getTextUseObjectsAttribute

public Boolean getTextUseObjectsAttribute()

Receives the value of the ODFDOM attribute representation TextUseObjectsAttribute , See text:use-objects

Returns:

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

setTextUseObjectsAttribute

public void setTextUseObjectsAttribute(Boolean textUseObjectsValue)

Sets the value of ODFDOM attribute representation TextUseObjectsAttribute , See text:use-objects

Parameters:

textUseObjectsValue - The type is Boolean

getTextUseTablesAttribute

public Boolean getTextUseTablesAttribute()

Receives the value of the ODFDOM attribute representation TextUseTablesAttribute , See text:use-tables

Returns:

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

setTextUseTablesAttribute

public void setTextUseTablesAttribute(Boolean textUseTablesValue)

Sets the value of ODFDOM attribute representation TextUseTablesAttribute , See text:use-tables

Parameters:

textUseTablesValue - 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

newTextUserIndexEntryTemplateElement

public TextUserIndexEntryTemplateElement newTextUserIndexEntryTemplateElement(int textOutlineLevelValue,
                                                                              String textStyleNameValue)

Create child element text:user-index-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:user-index-entry-template

accept

public void accept(ElementVisitor visitor)

Description copied from class: OdfElement

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