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

Class TextAlphabeticalIndexSourceElement

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.TextAlphabeticalIndexSourceElement
All Implemented Interfaces:
Serializable, Cloneable, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class TextAlphabeticalIndexSourceElement extends OdfElement
DOM implementation of OpenDocument element <text:alphabetical-index-source>.
See Also:

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • TextAlphabeticalIndexSourceElement

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