Package com.independentsoft.office.odf

Class BookmarkReference

java.lang.Object
com.independentsoft.office.odf.BookmarkReference
All Implemented Interfaces:
IContentElement, IParagraphContent
public class BookmarkReference extends Object implements IParagraphContent
Represents a reference to a BookmarkStart or Bookmark object in a text.

  • Constructor Details

    • BookmarkReference

      public BookmarkReference()
      Initializes a new instance of the BookmarkReference 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 BookmarkReference 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 IParagraphContent
      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 BookmarkReference object to its equivalent string representation.
      Overrides:
      toString in class Object
      Returns:
      the string

    • getName

      public String getName()
      Gets the name attribute of Bookmark or BookmarkStart object in a text.
      Returns:
      the name

    • setName

      public void setName​(String name)
      Sets the name attribute of Bookmark or BookmarkStart object in a text.
      Parameters:
      name - the new name

    • getFormat

      public ReferenceFormat getFormat()
      Specifies what information about a reference is displayed. If the reference format is not specified, the page format is used as the default.
      Returns:
      the format

    • setFormat

      public void setFormat​(ReferenceFormat format)
      Specifies what information about a reference is displayed. If the reference format is not specified, the page format is used as the default.
      Parameters:
      format - the new format

    • getValue

      public String getValue()
      Gets the reference to a Bookmark or BookmarkStart object.
      Returns:
      the value

    • setValue

      public void setValue​(String value)
      Sets the reference to a Bookmark or BookmarkStart object.
      Parameters:
      value - the new value