Class TextIllustrationIndexSourceElement

All Implemented Interfaces:
Serializable, Cloneable, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo

public class TextIllustrationIndexSourceElement extends OdfElement
DOM implementation of OpenDocument element <text:illustration-index-source>.
See Also:
  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME
  • Constructor Details

    • TextIllustrationIndexSourceElement

      public TextIllustrationIndexSourceElement(OdfFileDom ownerDoc)
      Create the instance of TextIllustrationIndexSourceElement
      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:illustration-index-source>.
    • getTextCaptionSequenceFormatAttribute

      public String getTextCaptionSequenceFormatAttribute()
      Receives the value of the ODFDOM attribute representation TextCaptionSequenceFormatAttribute , See @text:caption-sequence-format
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.
    • setTextCaptionSequenceFormatAttribute

      public void setTextCaptionSequenceFormatAttribute(String textCaptionSequenceFormatValue)
      Sets the value of ODFDOM attribute representation TextCaptionSequenceFormatAttribute , See @text:caption-sequence-format
      Parameters:
      textCaptionSequenceFormatValue - The type is String
    • getTextCaptionSequenceNameAttribute

      public String getTextCaptionSequenceNameAttribute()
      Receives the value of the ODFDOM attribute representation TextCaptionSequenceNameAttribute , See @text:caption-sequence-name
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.
    • setTextCaptionSequenceNameAttribute

      public void setTextCaptionSequenceNameAttribute(String textCaptionSequenceNameValue)
      Sets the value of ODFDOM attribute representation TextCaptionSequenceNameAttribute , See @text:caption-sequence-name
      Parameters:
      textCaptionSequenceNameValue - 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
    • getTextUseCaptionAttribute

      public Boolean getTextUseCaptionAttribute()
      Receives the value of the ODFDOM attribute representation TextUseCaptionAttribute , See @text:use-caption
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.
    • setTextUseCaptionAttribute

      public void setTextUseCaptionAttribute(Boolean textUseCaptionValue)
      Sets the value of ODFDOM attribute representation TextUseCaptionAttribute , See @text:use-caption
      Parameters:
      textUseCaptionValue - The type is Boolean
    • newTextIllustrationIndexEntryTemplateElement

      public TextIllustrationIndexEntryTemplateElement newTextIllustrationIndexEntryTemplateElement(String textStyleNameValue)
      Parameters:
      textStyleNameValue - the String value of TextStyleNameAttribute, see @text:style-name at specification
      Returns:
      the element <text:illustration-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