org.odftoolkit.odfdom.dom.element.text

Class TextAlphabeticalIndexElement

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

org.odftoolkit.odfdom.dom.element.text.TextAlphabeticalIndexElement

All Implemented Interfaces:

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

public class TextAlphabeticalIndexElement
extends OdfStylableElement

DOM implementation of OpenDocument element text:alphabetical-index.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static OdfName	ELEMENT_NAME

Fields inherited from class org.odftoolkit.odfdom.dom.element.OdfStylableElement

mFamily, mStyleNameAttrib

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

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
String	getTextNameAttribute() Receives the value of the ODFDOM attribute representation TextNameAttribute , See text:name
Boolean	getTextProtectedAttribute() Receives the value of the ODFDOM attribute representation TextProtectedAttribute , See text:protected
String	getTextProtectionKeyAttribute() Receives the value of the ODFDOM attribute representation TextProtectionKeyAttribute , See text:protection-key
String	getTextProtectionKeyDigestAlgorithmAttribute() Receives the value of the ODFDOM attribute representation TextProtectionKeyDigestAlgorithmAttribute , See text:protection-key-digest-algorithm
String	getTextStyleNameAttribute() Receives the value of the ODFDOM attribute representation TextStyleNameAttribute , See text:style-name
String	getXmlIdAttribute() Receives the value of the ODFDOM attribute representation XmlIdAttribute , See xml:id
TextAlphabeticalIndexSourceElement	newTextAlphabeticalIndexSourceElement() Create child element text:alphabetical-index-source.
TextIndexBodyElement	newTextIndexBodyElement() Create child element text:index-body.
void	setTextNameAttribute(String textNameValue) Sets the value of ODFDOM attribute representation TextNameAttribute , See text:name
void	setTextProtectedAttribute(Boolean textProtectedValue) Sets the value of ODFDOM attribute representation TextProtectedAttribute , See text:protected
void	setTextProtectionKeyAttribute(String textProtectionKeyValue) Sets the value of ODFDOM attribute representation TextProtectionKeyAttribute , See text:protection-key
void	setTextProtectionKeyDigestAlgorithmAttribute(String textProtectionKeyDigestAlgorithmValue) Sets the value of ODFDOM attribute representation TextProtectionKeyDigestAlgorithmAttribute , See text:protection-key-digest-algorithm
void	setTextStyleNameAttribute(String textStyleNameValue) Sets the value of ODFDOM attribute representation TextStyleNameAttribute , See text:style-name
void	setXmlIdAttribute(String xmlIdValue) Sets the value of ODFDOM attribute representation XmlIdAttribute , See xml:id

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

getAutomaticStyle, getAutomaticStyles, getDocumentStyle, getOrCreateUnqiueAutomaticStyle, getProperties, getProperty, getStrictProperties, getStyleFamily, getStyleName, hasAutomaticStyle, hasDocumentStyle, hasProperty, onInsertNode, onRemoveNode, removeProperty, reuseDocumentStyle, setAttributeNS, setDocumentStyle, setProperties, setProperty, setStyleName

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

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

TextAlphabeticalIndexElement

public TextAlphabeticalIndexElement(OdfFileDom ownerDoc)

Create the instance of TextAlphabeticalIndexElement

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:alphabetical-index.

getTextNameAttribute

public String getTextNameAttribute()

Receives the value of the ODFDOM attribute representation TextNameAttribute , See text:name

Attribute is mandatory.

Returns:

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

setTextNameAttribute

public void setTextNameAttribute(String textNameValue)

Sets the value of ODFDOM attribute representation TextNameAttribute , See text:name

Parameters:

textNameValue - The type is String

getTextProtectedAttribute

public Boolean getTextProtectedAttribute()

Receives the value of the ODFDOM attribute representation TextProtectedAttribute , See text:protected

Returns:

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

setTextProtectedAttribute

public void setTextProtectedAttribute(Boolean textProtectedValue)

Sets the value of ODFDOM attribute representation TextProtectedAttribute , See text:protected

Parameters:

textProtectedValue - The type is Boolean

getTextProtectionKeyAttribute

public String getTextProtectionKeyAttribute()

Receives the value of the ODFDOM attribute representation TextProtectionKeyAttribute , See text:protection-key

Returns:

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

setTextProtectionKeyAttribute

public void setTextProtectionKeyAttribute(String textProtectionKeyValue)

Sets the value of ODFDOM attribute representation TextProtectionKeyAttribute , See text:protection-key

Parameters:

textProtectionKeyValue - The type is String

getTextProtectionKeyDigestAlgorithmAttribute

public String getTextProtectionKeyDigestAlgorithmAttribute()

Receives the value of the ODFDOM attribute representation TextProtectionKeyDigestAlgorithmAttribute , See text:protection-key-digest-algorithm

Returns:

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

setTextProtectionKeyDigestAlgorithmAttribute

public void setTextProtectionKeyDigestAlgorithmAttribute(String textProtectionKeyDigestAlgorithmValue)

Sets the value of ODFDOM attribute representation TextProtectionKeyDigestAlgorithmAttribute , See text:protection-key-digest-algorithm

Parameters:

textProtectionKeyDigestAlgorithmValue - The type is String

getTextStyleNameAttribute

public String getTextStyleNameAttribute()

Receives the value of the ODFDOM attribute representation TextStyleNameAttribute , See text:style-name

Returns:

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

setTextStyleNameAttribute

public void setTextStyleNameAttribute(String textStyleNameValue)

Sets the value of ODFDOM attribute representation TextStyleNameAttribute , See text:style-name

Parameters:

textStyleNameValue - The type is String

getXmlIdAttribute

public String getXmlIdAttribute()

Receives the value of the ODFDOM attribute representation XmlIdAttribute , See xml:id

Returns:

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

setXmlIdAttribute

public void setXmlIdAttribute(String xmlIdValue)

Sets the value of ODFDOM attribute representation XmlIdAttribute , See xml:id

Parameters:

xmlIdValue - The type is String

newTextAlphabeticalIndexSourceElement

public TextAlphabeticalIndexSourceElement newTextAlphabeticalIndexSourceElement()

Create child element text:alphabetical-index-source.

Child element is mandatory.

Returns:

the element text:alphabetical-index-source

newTextIndexBodyElement

public TextIndexBodyElement newTextIndexBodyElement()

Create child element text:index-body.

Child element is mandatory.

Returns:

the element text:index-body

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