Package org.apache.poi.hssf.record

Class HyperlinkRecord

  • All Implemented Interfaces:
    java.lang.Cloneable
    public final class HyperlinkRecord
extends StandardRecord
implements java.lang.Cloneable
    The HyperlinkRecord (0x01B8) wraps an HLINK-record from the Excel-97 format. Supports only external links for now (eg http://)

    • Constructor Detail

      • HyperlinkRecord

        public HyperlinkRecord()
        Create a new hyperlink

    • Method Detail

      • getFirstColumn

        public int getFirstColumn()
        Returns:
        the 0-based column of the first cell that contains this hyperlink

      • setFirstColumn

        public void setFirstColumn​(int firstCol)
        Set the first column (zero-based) of the range that contains this hyperlink
        Parameters:
        firstCol - the first column (zero-based)

      • getLastColumn

        public int getLastColumn()
        Returns:
        the 0-based column of the last cell that contains this hyperlink

      • setLastColumn

        public void setLastColumn​(int lastCol)
        Set the last column (zero-based) of the range that contains this hyperlink
        Parameters:
        lastCol - the last column (zero-based)

      • getFirstRow

        public int getFirstRow()
        Returns:
        the 0-based row of the first cell that contains this hyperlink

      • setFirstRow

        public void setFirstRow​(int firstRow)
        Set the first row (zero-based) of the range that contains this hyperlink
        Parameters:
        firstRow - the first row (zero-based)

      • getLastRow

        public int getLastRow()
        Returns:
        the 0-based row of the last cell that contains this hyperlink

      • setLastRow

        public void setLastRow​(int lastRow)
        Set the last row (zero-based) of the range that contains this hyperlink
        Parameters:
        lastRow - the last row (zero-based)

      • getLabel

        public java.lang.String getLabel()
        Return text label for this hyperlink
        Returns:
        text to display

      • setLabel

        public void setLabel​(java.lang.String label)
        Sets text label for this hyperlink
        Parameters:
        label - text label for this hyperlink

      • getTargetFrame

        public java.lang.String getTargetFrame()

      • getAddress

        public java.lang.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

        public void setAddress​(java.lang.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

      • getShortFilename

        public java.lang.String getShortFilename()

      • setShortFilename

        public void setShortFilename​(java.lang.String shortFilename)

      • getTextMark

        public java.lang.String getTextMark()

      • setTextMark

        public void setTextMark​(java.lang.String textMark)

      • getLabelOptions

        public int getLabelOptions()
        Returns:
        Label options

      • getFileOptions

        public int getFileOptions()
        Returns:
        Options for a file link

      • getSid

        public short getSid()
        Description copied from class: Record
        return the non static version of the id for this record.
        Specified by:
        getSid in class Record
        Returns:
        he id for this record

      • toString

        public java.lang.String toString()
        Description copied from class: Record
        get a string representation of the record (for biffview/debugging)
        Overrides:
        toString in class Record

      • isUrlLink

        public boolean isUrlLink()
        Based on the link options, is this a url?
        Returns:
        true, if this is a url link

      • isFileLink

        public boolean isFileLink()
        Based on the link options, is this a file?
        Returns:
        true, if this is a file link

      • isDocumentLink

        public boolean isDocumentLink()
        Based on the link options, is this a document?
        Returns:
        true, if this is a docment link

      • newUrlLink

        public void newUrlLink()
        Initialize a new url link

      • newFileLink

        public void newFileLink()
        Initialize a new file link

      • newDocumentLink

        public void newDocumentLink()
        Initialize a new document link