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

Class TextObjectIndexElement

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

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • TextObjectIndexElement

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

    • newTextIndexBodyElement

      public TextIndexBodyElement newTextIndexBodyElement()
      Create child element <text:index-body>.

      Child element is mandatory.

      Returns:
      the element <text:index-body>

    • newTextObjectIndexSourceElement

      public TextObjectIndexSourceElement newTextObjectIndexSourceElement()
      Create child element <text:object-index-source>.

      Child element is mandatory.

      Returns:
      the element <text:object-index-source>

    • 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