jxl
Interface Hyperlink

All Known Implementing Classes:
WritableHyperlink

public interface Hyperlink

Hyperlink information. Only URLs or file links are supported Hyperlinks may apply to a range of cells; in such cases the methods getRow and getColumn return the cell at the top left of the range the hyperlink refers to. Hyperlinks have no specific cell format information applied to them, so the getCellFormat method will return null


Method Summary
 int getColumn()
          Returns the column number of this cell
 java.io.File getFile()
          Returns the local file eferenced by this Hyperlink
 int getLastColumn()
          Returns the column number of the bottom right cell
 int getLastRow()
          Returns the row number of the bottom right cell
 Range getRange()
          Gets the range of cells which activate this hyperlink The get sheet index methods will all return -1, because the cells will all be present on the same sheet
 int getRow()
          Returns the row number of this cell
 java.net.URL getURL()
          Gets the URL referenced by this Hyperlink
 boolean isFile()
          Determines whether this is a hyperlink to a file
 boolean isLocation()
          Determines whether this is a hyperlink to a location in this workbook
 boolean isURL()
          Determines whether this is a hyperlink to a web resource
 

Method Detail

getRow

public int getRow()
Returns the row number of this cell

Returns:
the row number of this cell

getColumn

public int getColumn()
Returns the column number of this cell

Returns:
the column number of this cell

getRange

public Range getRange()
Gets the range of cells which activate this hyperlink The get sheet index methods will all return -1, because the cells will all be present on the same sheet

Returns:
the range of cells which activate the hyperlink

isFile

public boolean isFile()
Determines whether this is a hyperlink to a file

Returns:
TRUE if this is a hyperlink to a file, FALSE otherwise

isURL

public boolean isURL()
Determines whether this is a hyperlink to a web resource

Returns:
TRUE if this is a URL

isLocation

public boolean isLocation()
Determines whether this is a hyperlink to a location in this workbook

Returns:
TRUE if this is a link to an internal location

getLastRow

public int getLastRow()
Returns the row number of the bottom right cell

Returns:
the row number of this cell

getLastColumn

public int getLastColumn()
Returns the column number of the bottom right cell

Returns:
the column number of this cell

getURL

public java.net.URL getURL()
Gets the URL referenced by this Hyperlink

Returns:
the URL, or NULL if this hyperlink is not a URL

getFile

public java.io.File getFile()
Returns the local file eferenced by this Hyperlink

Returns:
the file, or NULL if this hyperlink is not a file