org.odftoolkit.odfdom.dom.element.text
Class TextAlphabeticalIndexSourceElement

java.lang.Object
  extended by org.apache.xerces.dom.NodeImpl
      extended by org.apache.xerces.dom.ChildNode
          extended by org.apache.xerces.dom.ParentNode
              extended by org.apache.xerces.dom.ElementImpl
                  extended by org.apache.xerces.dom.ElementNSImpl
                      extended by org.odftoolkit.odfdom.pkg.OdfElement
                          extended by org.odftoolkit.odfdom.dom.element.text.TextAlphabeticalIndexSourceElement
All Implemented Interfaces:
Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo

public class TextAlphabeticalIndexSourceElement
extends OdfElement

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

See Also:
Serialized Form

Field Summary
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
TextAlphabeticalIndexSourceElement(OdfFileDom ownerDoc)
          Create the instance of TextAlphabeticalIndexSourceElement
 
Method Summary
 void accept(ElementVisitor visitor)
          Accept an visitor instance to allow the visitor to do some operations.
 String getFoCountryAttribute()
          Receives the value of the ODFDOM attribute representation FoCountryAttribute , See fo:country
 String getFoLanguageAttribute()
          Receives the value of the ODFDOM attribute representation FoLanguageAttribute , See fo:language
 String getFoScriptAttribute()
          Receives the value of the ODFDOM attribute representation FoScriptAttribute , See fo:script
 OdfName getOdfName()
          Get the element name
 String getStyleRfcLanguageTagAttribute()
          Receives the value of the ODFDOM attribute representation StyleRfcLanguageTagAttribute , See style:rfc-language-tag
 Boolean getTextAlphabeticalSeparatorsAttribute()
          Receives the value of the ODFDOM attribute representation TextAlphabeticalSeparatorsAttribute , See text:alphabetical-separators
 Boolean getTextCapitalizeEntriesAttribute()
          Receives the value of the ODFDOM attribute representation TextCapitalizeEntriesAttribute , See text:capitalize-entries
 Boolean getTextCombineEntriesAttribute()
          Receives the value of the ODFDOM attribute representation TextCombineEntriesAttribute , See text:combine-entries
 Boolean getTextCombineEntriesWithDashAttribute()
          Receives the value of the ODFDOM attribute representation TextCombineEntriesWithDashAttribute , See text:combine-entries-with-dash
 Boolean getTextCombineEntriesWithPpAttribute()
          Receives the value of the ODFDOM attribute representation TextCombineEntriesWithPpAttribute , See text:combine-entries-with-pp
 Boolean getTextCommaSeparatedAttribute()
          Receives the value of the ODFDOM attribute representation TextCommaSeparatedAttribute , See text:comma-separated
 Boolean getTextIgnoreCaseAttribute()
          Receives the value of the ODFDOM attribute representation TextIgnoreCaseAttribute , See text:ignore-case
 String getTextIndexScopeAttribute()
          Receives the value of the ODFDOM attribute representation TextIndexScopeAttribute , See text:index-scope
 String getTextMainEntryStyleNameAttribute()
          Receives the value of the ODFDOM attribute representation TextMainEntryStyleNameAttribute , See text:main-entry-style-name
 Boolean getTextRelativeTabStopPositionAttribute()
          Receives the value of the ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See text:relative-tab-stop-position
 String getTextSortAlgorithmAttribute()
          Receives the value of the ODFDOM attribute representation TextSortAlgorithmAttribute , See text:sort-algorithm
 Boolean getTextUseKeysAsEntriesAttribute()
          Receives the value of the ODFDOM attribute representation TextUseKeysAsEntriesAttribute , See text:use-keys-as-entries
 TextAlphabeticalIndexEntryTemplateElement newTextAlphabeticalIndexEntryTemplateElement(int textOutlineLevelValue, String textStyleNameValue)
          Create child element text:alphabetical-index-entry-template.
 TextIndexTitleTemplateElement newTextIndexTitleTemplateElement()
          Create child element text:index-title-template.
 void setFoCountryAttribute(String foCountryValue)
          Sets the value of ODFDOM attribute representation FoCountryAttribute , See fo:country
 void setFoLanguageAttribute(String foLanguageValue)
          Sets the value of ODFDOM attribute representation FoLanguageAttribute , See fo:language
 void setFoScriptAttribute(String foScriptValue)
          Sets the value of ODFDOM attribute representation FoScriptAttribute , See fo:script
 void setStyleRfcLanguageTagAttribute(String styleRfcLanguageTagValue)
          Sets the value of ODFDOM attribute representation StyleRfcLanguageTagAttribute , See style:rfc-language-tag
 void setTextAlphabeticalSeparatorsAttribute(Boolean textAlphabeticalSeparatorsValue)
          Sets the value of ODFDOM attribute representation TextAlphabeticalSeparatorsAttribute , See text:alphabetical-separators
 void setTextCapitalizeEntriesAttribute(Boolean textCapitalizeEntriesValue)
          Sets the value of ODFDOM attribute representation TextCapitalizeEntriesAttribute , See text:capitalize-entries
 void setTextCombineEntriesAttribute(Boolean textCombineEntriesValue)
          Sets the value of ODFDOM attribute representation TextCombineEntriesAttribute , See text:combine-entries
 void setTextCombineEntriesWithDashAttribute(Boolean textCombineEntriesWithDashValue)
          Sets the value of ODFDOM attribute representation TextCombineEntriesWithDashAttribute , See text:combine-entries-with-dash
 void setTextCombineEntriesWithPpAttribute(Boolean textCombineEntriesWithPpValue)
          Sets the value of ODFDOM attribute representation TextCombineEntriesWithPpAttribute , See text:combine-entries-with-pp
 void setTextCommaSeparatedAttribute(Boolean textCommaSeparatedValue)
          Sets the value of ODFDOM attribute representation TextCommaSeparatedAttribute , See text:comma-separated
 void setTextIgnoreCaseAttribute(Boolean textIgnoreCaseValue)
          Sets the value of ODFDOM attribute representation TextIgnoreCaseAttribute , See text:ignore-case
 void setTextIndexScopeAttribute(String textIndexScopeValue)
          Sets the value of ODFDOM attribute representation TextIndexScopeAttribute , See text:index-scope
 void setTextMainEntryStyleNameAttribute(String textMainEntryStyleNameValue)
          Sets the value of ODFDOM attribute representation TextMainEntryStyleNameAttribute , See text:main-entry-style-name
 void setTextRelativeTabStopPositionAttribute(Boolean textRelativeTabStopPositionValue)
          Sets the value of ODFDOM attribute representation TextRelativeTabStopPositionAttribute , See text:relative-tab-stop-position
 void setTextSortAlgorithmAttribute(String textSortAlgorithmValue)
          Sets the value of ODFDOM attribute representation TextSortAlgorithmAttribute , See text:sort-algorithm
 void setTextUseKeysAsEntriesAttribute(Boolean textUseKeysAsEntriesValue)
          Sets the value of ODFDOM attribute representation TextUseKeysAsEntriesAttribute , See text:use-keys-as-entries
 
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement
cloneNode, 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
getBaseURI, getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setPrefix, setType, setValues
 
Methods inherited from class org.apache.xerces.dom.ElementImpl
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, 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

TextAlphabeticalIndexSourceElement

public TextAlphabeticalIndexSourceElement(OdfFileDom ownerDoc)
Create the instance of TextAlphabeticalIndexSourceElement

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

getFoCountryAttribute

public String getFoCountryAttribute()
Receives the value of the ODFDOM attribute representation FoCountryAttribute , See fo:country

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

setFoCountryAttribute

public void setFoCountryAttribute(String foCountryValue)
Sets the value of ODFDOM attribute representation FoCountryAttribute , See fo:country

Parameters:
foCountryValue - The type is String

getFoLanguageAttribute

public String getFoLanguageAttribute()
Receives the value of the ODFDOM attribute representation FoLanguageAttribute , See fo:language

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

setFoLanguageAttribute

public void setFoLanguageAttribute(String foLanguageValue)
Sets the value of ODFDOM attribute representation FoLanguageAttribute , See fo:language

Parameters:
foLanguageValue - The type is String

getFoScriptAttribute

public String getFoScriptAttribute()
Receives the value of the ODFDOM attribute representation FoScriptAttribute , See fo:script

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

setFoScriptAttribute

public void setFoScriptAttribute(String foScriptValue)
Sets the value of ODFDOM attribute representation FoScriptAttribute , See fo:script

Parameters:
foScriptValue - The type is String

getStyleRfcLanguageTagAttribute

public String getStyleRfcLanguageTagAttribute()
Receives the value of the ODFDOM attribute representation StyleRfcLanguageTagAttribute , See style:rfc-language-tag

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

setStyleRfcLanguageTagAttribute

public void setStyleRfcLanguageTagAttribute(String styleRfcLanguageTagValue)
Sets the value of ODFDOM attribute representation StyleRfcLanguageTagAttribute , See style:rfc-language-tag

Parameters:
styleRfcLanguageTagValue - The type is String

getTextAlphabeticalSeparatorsAttribute

public Boolean getTextAlphabeticalSeparatorsAttribute()
Receives the value of the ODFDOM attribute representation TextAlphabeticalSeparatorsAttribute , See text:alphabetical-separators

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

setTextAlphabeticalSeparatorsAttribute

public void setTextAlphabeticalSeparatorsAttribute(Boolean textAlphabeticalSeparatorsValue)
Sets the value of ODFDOM attribute representation TextAlphabeticalSeparatorsAttribute , See text:alphabetical-separators

Parameters:
textAlphabeticalSeparatorsValue - The type is Boolean

getTextCapitalizeEntriesAttribute

public Boolean getTextCapitalizeEntriesAttribute()
Receives the value of the ODFDOM attribute representation TextCapitalizeEntriesAttribute , See text:capitalize-entries

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

setTextCapitalizeEntriesAttribute

public void setTextCapitalizeEntriesAttribute(Boolean textCapitalizeEntriesValue)
Sets the value of ODFDOM attribute representation TextCapitalizeEntriesAttribute , See text:capitalize-entries

Parameters:
textCapitalizeEntriesValue - The type is Boolean

getTextCombineEntriesAttribute

public Boolean getTextCombineEntriesAttribute()
Receives the value of the ODFDOM attribute representation TextCombineEntriesAttribute , See text:combine-entries

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

setTextCombineEntriesAttribute

public void setTextCombineEntriesAttribute(Boolean textCombineEntriesValue)
Sets the value of ODFDOM attribute representation TextCombineEntriesAttribute , See text:combine-entries

Parameters:
textCombineEntriesValue - The type is Boolean

getTextCombineEntriesWithDashAttribute

public Boolean getTextCombineEntriesWithDashAttribute()
Receives the value of the ODFDOM attribute representation TextCombineEntriesWithDashAttribute , See text:combine-entries-with-dash

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

setTextCombineEntriesWithDashAttribute

public void setTextCombineEntriesWithDashAttribute(Boolean textCombineEntriesWithDashValue)
Sets the value of ODFDOM attribute representation TextCombineEntriesWithDashAttribute , See text:combine-entries-with-dash

Parameters:
textCombineEntriesWithDashValue - The type is Boolean

getTextCombineEntriesWithPpAttribute

public Boolean getTextCombineEntriesWithPpAttribute()
Receives the value of the ODFDOM attribute representation TextCombineEntriesWithPpAttribute , See text:combine-entries-with-pp

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

setTextCombineEntriesWithPpAttribute

public void setTextCombineEntriesWithPpAttribute(Boolean textCombineEntriesWithPpValue)
Sets the value of ODFDOM attribute representation TextCombineEntriesWithPpAttribute , See text:combine-entries-with-pp

Parameters:
textCombineEntriesWithPpValue - The type is Boolean

getTextCommaSeparatedAttribute

public Boolean getTextCommaSeparatedAttribute()
Receives the value of the ODFDOM attribute representation TextCommaSeparatedAttribute , See text:comma-separated

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

setTextCommaSeparatedAttribute

public void setTextCommaSeparatedAttribute(Boolean textCommaSeparatedValue)
Sets the value of ODFDOM attribute representation TextCommaSeparatedAttribute , See text:comma-separated

Parameters:
textCommaSeparatedValue - The type is Boolean

getTextIgnoreCaseAttribute

public Boolean getTextIgnoreCaseAttribute()
Receives the value of the ODFDOM attribute representation TextIgnoreCaseAttribute , See text:ignore-case

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

setTextIgnoreCaseAttribute

public void setTextIgnoreCaseAttribute(Boolean textIgnoreCaseValue)
Sets the value of ODFDOM attribute representation TextIgnoreCaseAttribute , See text:ignore-case

Parameters:
textIgnoreCaseValue - The type is Boolean

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

getTextMainEntryStyleNameAttribute

public String getTextMainEntryStyleNameAttribute()
Receives the value of the ODFDOM attribute representation TextMainEntryStyleNameAttribute , See text:main-entry-style-name

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

setTextMainEntryStyleNameAttribute

public void setTextMainEntryStyleNameAttribute(String textMainEntryStyleNameValue)
Sets the value of ODFDOM attribute representation TextMainEntryStyleNameAttribute , See text:main-entry-style-name

Parameters:
textMainEntryStyleNameValue - 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

getTextSortAlgorithmAttribute

public String getTextSortAlgorithmAttribute()
Receives the value of the ODFDOM attribute representation TextSortAlgorithmAttribute , See text:sort-algorithm

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

setTextSortAlgorithmAttribute

public void setTextSortAlgorithmAttribute(String textSortAlgorithmValue)
Sets the value of ODFDOM attribute representation TextSortAlgorithmAttribute , See text:sort-algorithm

Parameters:
textSortAlgorithmValue - The type is String

getTextUseKeysAsEntriesAttribute

public Boolean getTextUseKeysAsEntriesAttribute()
Receives the value of the ODFDOM attribute representation TextUseKeysAsEntriesAttribute , See text:use-keys-as-entries

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

setTextUseKeysAsEntriesAttribute

public void setTextUseKeysAsEntriesAttribute(Boolean textUseKeysAsEntriesValue)
Sets the value of ODFDOM attribute representation TextUseKeysAsEntriesAttribute , See text:use-keys-as-entries

Parameters:
textUseKeysAsEntriesValue - The type is Boolean

newTextAlphabeticalIndexEntryTemplateElement

public TextAlphabeticalIndexEntryTemplateElement newTextAlphabeticalIndexEntryTemplateElement(int textOutlineLevelValue,
                                                                                              String textStyleNameValue)
Create child element text:alphabetical-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:alphabetical-index-entry-template

newTextIndexTitleTemplateElement

public TextIndexTitleTemplateElement newTextIndexTitleTemplateElement()
Create child element text:index-title-template.

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


Copyright © 2008-2011 The Apache Software Foundation. All Rights Reserved.