Package 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:

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • TextUserIndexSourceElement

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