Class HSSFHyperlink

    • Field Detail

      • record

        protected final HyperlinkRecord record
        Low-level record object that stores the actual hyperlink data
      • link_type

        protected final HyperlinkType link_type
        If we create a new hyperlink remember its type
    • Method Detail

      • getFirstRow

        public int getFirstRow()
        Return the row of the first cell that contains the hyperlink
        Specified by:
        getFirstRow in interface Hyperlink
        Returns:
        the 0-based row of the cell that contains the hyperlink
      • setFirstRow

        public void setFirstRow​(int row)
        Set the row of the first cell that contains the hyperlink
        Specified by:
        setFirstRow in interface Hyperlink
        Parameters:
        row - the 0-based row of the first cell that contains the hyperlink
      • getLastRow

        public int getLastRow()
        Return the row of the last cell that contains the hyperlink
        Specified by:
        getLastRow in interface Hyperlink
        Returns:
        the 0-based row of the last cell that contains the hyperlink
      • setLastRow

        public void setLastRow​(int row)
        Set the row of the last cell that contains the hyperlink
        Specified by:
        setLastRow in interface Hyperlink
        Parameters:
        row - the 0-based row of the last cell that contains the hyperlink
      • getFirstColumn

        public int getFirstColumn()
        Return the column of the first cell that contains the hyperlink
        Specified by:
        getFirstColumn in interface Hyperlink
        Returns:
        the 0-based column of the first cell that contains the hyperlink
      • setFirstColumn

        public void setFirstColumn​(int col)
        Set the column of the first cell that contains the hyperlink
        Specified by:
        setFirstColumn in interface Hyperlink
        Parameters:
        col - the 0-based column of the first cell that contains the hyperlink
      • getLastColumn

        public int getLastColumn()
        Return the column of the last cell that contains the hyperlink
        Specified by:
        getLastColumn in interface Hyperlink
        Returns:
        the 0-based column of the last cell that contains the hyperlink
      • setLastColumn

        public void setLastColumn​(int col)
        Set the column of the last cell that contains the hyperlink
        Specified by:
        setLastColumn in interface Hyperlink
        Parameters:
        col - the 0-based column of the last cell that contains the hyperlink
      • getAddress

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

        public String getTextMark()
      • setTextMark

        public void setTextMark​(String textMark)
        Convenience method equivalent to setAddress(String)
        Parameters:
        textMark - the place in worksheet this hyperlink refers to, e.g. 'Target Sheet'!A1'
      • getShortFilename

        public String getShortFilename()
      • setShortFilename

        public void setShortFilename​(String shortFilename)
        Convenience method equivalent to setAddress(String)
        Parameters:
        shortFilename - the path to a file this hyperlink points to, e.g. 'readme.txt'
      • setAddress

        public void setAddress​(String address)
        Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
        Specified by:
        setAddress in interface Hyperlink
        Parameters:
        address - the address of this hyperlink
      • getLabel

        public String getLabel()
        Return text label for this hyperlink
        Specified by:
        getLabel in interface Hyperlink
        Returns:
        text to display
      • setLabel

        public void setLabel​(String label)
        Sets text label for this hyperlink
        Specified by:
        setLabel in interface Hyperlink
        Parameters:
        label - text label for this hyperlink
      • getType

        public HyperlinkType getType()
        Return the type of this hyperlink
        Specified by:
        getType in interface Hyperlink
        Returns:
        the type of this hyperlink
      • copy

        public Duplicatable copy()
        Specified by:
        copy in interface Duplicatable
        Returns:
        a new HSSFHyperlink based on this
        Since:
        POI 5.1.0
      • equals

        public boolean equals​(Object other)
        Overrides:
        equals in class Object
        Returns:
        whether the objects have the same HyperlinkRecord
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object