jxl.read.biff
Class HyperlinkRecord

java.lang.Object
  extended byjxl.biff.RecordData
      extended byjxl.read.biff.HyperlinkRecord
All Implemented Interfaces:
Hyperlink

public class HyperlinkRecord
extends RecordData
implements Hyperlink

A number record. This is stored as 8 bytes, as opposed to the 4 byte RK record


Method Summary
 int getColumn()
          Returns the column number of the top left 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
 java.lang.String getLocation()
          Gets the location referenced by this hyperlink
 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
 Record getRecord()
          Exposes the base class method.
 int getRow()
          Returns the row number of the top left 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
 
Methods inherited from class jxl.biff.RecordData
getCode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isFile

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

Specified by:
isFile in interface Hyperlink
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

Specified by:
isURL in interface Hyperlink
Returns:
TRUE if this is a URL

isLocation

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

Specified by:
isLocation in interface Hyperlink
Returns:
TRUE if this is a link to an internal location

getRow

public int getRow()
Returns the row number of the top left cell

Specified by:
getRow in interface Hyperlink
Returns:
the row number of this cell

getColumn

public int getColumn()
Returns the column number of the top left cell

Specified by:
getColumn in interface Hyperlink
Returns:
the column number of this cell

getLastRow

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

Specified by:
getLastRow in interface Hyperlink
Returns:
the row number of this cell

getLastColumn

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

Specified by:
getLastColumn in interface Hyperlink
Returns:
the column number of this cell

getURL

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

Specified by:
getURL in interface 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

Specified by:
getFile in interface Hyperlink
Returns:
the file, or NULL if this hyperlink is not a file

getRecord

public Record getRecord()
Exposes the base class method. This is used when copying hyperlinks

Overrides:
getRecord in class RecordData
Returns:
the Record data

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

Specified by:
getRange in interface Hyperlink
Returns:
the range of cells which activate the hyperlink

getLocation

public java.lang.String getLocation()
Gets the location referenced by this hyperlink

Returns:
the location