Package com.independentsoft.office.odf

Class IndexTitle

java.lang.Object
com.independentsoft.office.odf.IndexTitle
All Implemented Interfaces:
IContentElement, IIndexContent
public class IndexTitle extends Object implements IIndexContent
Represents the title of an index.

  • Constructor Details

    • IndexTitle

      public IndexTitle()
      Initializes a new instance of the IndexTitle class.

  • Method Details

    • getContentElements

      public List<IContentElement> getContentElements()
      Returns all content elements.
      Specified by:
      getContentElements in interface IContentElement
      Returns:
      A collection of content elements.

    • getParent

      public IContentElement getParent()
      Returns the parent content element.
      Specified by:
      getParent in interface IContentElement
      Returns:
      the parent

    • setParent

      public void setParent​(IContentElement parent)
      Sets the parent content element.
      Specified by:
      setParent in interface IContentElement
      Parameters:
      parent - the new parent

    • clone

      public IndexTitle clone()
      Creates a new object that is a deep copy of the current instance.
      Specified by:
      clone in interface IContentElement
      Specified by:
      clone in interface IIndexContent
      Overrides:
      clone in class Object
      Returns:
      A new object that is a copy of this instance.

    • toString

      public String toString()
      Converts the value of the current IndexTitle object to its equivalent string representation.
      Overrides:
      toString in class Object
      Returns:
      the string

    • getContent

      public List<IIndexContent> getContent()
      Contains a collection of IIndexContent objects.
      Returns:
      the content

    • getName

      public String getName()
      Gets the name for an index title. The name serves as a unique identifier for an index title.
      Returns:
      the name

    • setName

      public void setName​(String name)
      Sets the name for an index title. The name serves as a unique identifier for an index title.
      Parameters:
      name - the new name

    • getStyle

      public String getStyle()
      Gets the style.
      Returns:
      the style

    • setStyle

      public void setStyle​(String style)
      Sets the style.
      Parameters:
      style - the new style

    • isProtected

      public boolean isProtected()
      Specifies whether a section is protected.
      Returns:
      true, if is protected

    • setProtected

      public void setProtected​(boolean isProtected)
      Specifies whether a section is protected.
      Parameters:
      isProtected - the new protected

    • getProtectionKey

      public String getProtectionKey()
      Specifies that an authorization is required for removing the protection of a section.
      Returns:
      the protection key

    • setProtectionKey

      public void setProtectionKey​(String protectionKey)
      Specifies that an authorization is required for removing the protection of a section.
      Parameters:
      protectionKey - the new protection key