Package org.apache.poi.common.usermodel

Interface Hyperlink

All Known Subinterfaces:
Hyperlink<S,P>, Hyperlink
All Known Implementing Classes:
HSLFHyperlink, HSSFHyperlink, XSLFHyperlink, XSSFHyperlink
public interface Hyperlink
Represents a hyperlink.

  • Method Details

    • getAddress

      String getAddress()
      Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
      Returns:
      the address of this hyperlink

    • setAddress

      void setAddress(String address)
      Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
      Parameters:
      address - the address of this hyperlink

    • getLabel

      String getLabel()
      Return text label for this hyperlink
      Returns:
      text to display

    • setLabel

      void setLabel(String label)
      Sets text label for this hyperlink
      Parameters:
      label - text label for this hyperlink

    • getType

      HyperlinkType getType()
      Return the type of this hyperlink
      Returns:
      the type of this hyperlink