jxl.write
Class WritableHyperlink

java.lang.Object
  jxl.biff.RecordData
      jxl.biff.WritableRecordData
          jxl.write.biff.HyperlinkRecord
              jxl.write.WritableHyperlink

All Implemented Interfaces:

jxl.biff.ByteData, Hyperlink

public class WritableHyperlink

extends jxl.write.biff.HyperlinkRecord

implements Hyperlink

A writable hyperlink. Provides API to modify the contents of the hyperlink

Constructor Summary

WritableHyperlink(Hyperlink h, WritableSheet ws)
Constructor used internally by the worksheet when making a copy of worksheet

WritableHyperlink(int col, int row, java.io.File file)
Constructs a file hyperlink in a single cell

WritableHyperlink(int col, int row, java.io.File file, java.lang.String desc)
Constructs a file hyperlink in a single cell

WritableHyperlink(int col, int row, int lastcol, int lastrow, java.io.File file)
Constructs a File hyperlink to a range of cells

WritableHyperlink(int col, int row, int lastcol, int lastrow, java.io.File file, java.lang.String desc)
Constructs a File hyperlink to a range of cells

WritableHyperlink(int col, int row, int lastcol, int lastrow, java.lang.String desc, WritableSheet sheet, int destcol, int destrow, int lastdestcol, int lastdestrow)
Constructs a hyperlink to some cells within this workbook

WritableHyperlink(int col, int row, int lastcol, int lastrow, java.net.URL url)
Constructs a url hyperlink to a range of cells

WritableHyperlink(int col, int row, int lastcol, int lastrow, java.net.URL url, java.lang.String desc)
Constructs a url hyperlink to a range of cells

WritableHyperlink(int col, int row, java.lang.String desc, WritableSheet sheet, int destcol, int destrow)
Constructs a hyperlink to some cells within this workbook

WritableHyperlink(int col, int row, java.net.URL url)
Constructs a URL hyperlink in a single cell

Method Summary

void	setDescription(java.lang.String desc) Sets the description to appear in the hyperlink cell
void	setFile(java.io.File file) Sets the file activated by this hyperlink
void	setLocation(java.lang.String desc, WritableSheet sheet, int destcol, int destrow, int lastdestcol, int lastdestrow) Sets the location of the cells to be linked to within this workbook
void	setURL(java.net.URL url) Sets the URL of this hyperlink

Methods inherited from class jxl.write.biff.HyperlinkRecord

getColumn, getData, getFile, getLastColumn, getLastRow, getRange, getRow, getURL, isFile, isLocation, isUNC, isURL, toString

Methods inherited from class jxl.biff.WritableRecordData

getBytes

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jxl.Hyperlink

getColumn, getFile, getLastColumn, getLastRow, getRange, getRow, getURL, isFile, isLocation, isURL

Constructor Detail

WritableHyperlink

public WritableHyperlink(Hyperlink h,
                         WritableSheet ws)

Constructor used internally by the worksheet when making a copy of worksheet

Parameters:

h - the hyperlink being read in

ws - the writable sheet containing the hyperlink

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         java.net.URL url)

Constructs a URL hyperlink in a single cell

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

url - the hyperlink

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         int lastcol,
                         int lastrow,
                         java.net.URL url)

Constructs a url hyperlink to a range of cells

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

lastcol - the last column which activates this hyperlink

lastrow - the last row which activates this hyperlink

url - the hyperlink

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         int lastcol,
                         int lastrow,
                         java.net.URL url,
                         java.lang.String desc)

Constructs a url hyperlink to a range of cells

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

lastcol - the last column which activates this hyperlink

lastrow - the last row which activates this hyperlink

url - the hyperlink

desc - the description text to place in the cell

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         java.io.File file)

Constructs a file hyperlink in a single cell

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

file - the hyperlink

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         java.io.File file,
                         java.lang.String desc)

Constructs a file hyperlink in a single cell

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

file - the hyperlink

desc - the hyperlink description

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         int lastcol,
                         int lastrow,
                         java.io.File file)

Constructs a File hyperlink to a range of cells

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

lastcol - the last column which activates this hyperlink

lastrow - the last row which activates this hyperlink

file - the hyperlink

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         int lastcol,
                         int lastrow,
                         java.io.File file,
                         java.lang.String desc)

Constructs a File hyperlink to a range of cells

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

lastcol - the last column which activates this hyperlink

lastrow - the last row which activates this hyperlink

file - the hyperlink

desc - the description

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         java.lang.String desc,
                         WritableSheet sheet,
                         int destcol,
                         int destrow)

Constructs a hyperlink to some cells within this workbook

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

desc - the cell contents for this hyperlink

sheet - the sheet containing the cells to be linked to

destcol - the column number of the first destination linked cell

destrow - the row number of the first destination linked cell

WritableHyperlink

public WritableHyperlink(int col,
                         int row,
                         int lastcol,
                         int lastrow,
                         java.lang.String desc,
                         WritableSheet sheet,
                         int destcol,
                         int destrow,
                         int lastdestcol,
                         int lastdestrow)

Constructs a hyperlink to some cells within this workbook

Parameters:

col - the column containing this hyperlink

row - the row containing this hyperlink

lastcol - the last column which activates this hyperlink

lastrow - the last row which activates this hyperlink

desc - the cell contents for this hyperlink

sheet - the sheet containing the cells to be linked to

destcol - the column number of the first destination linked cell

destrow - the row number of the first destination linked cell

lastdestcol - the column number of the last destination linked cell

lastdestrow - the row number of the last destination linked cell

Method Detail

setURL

public void setURL(java.net.URL url)

Sets the URL of this hyperlink

Parameters:

url - the url

setFile

public void setFile(java.io.File file)

Sets the file activated by this hyperlink

Parameters:

file - the file

setDescription

public void setDescription(java.lang.String desc)

Sets the description to appear in the hyperlink cell

Parameters:

desc - the description

setLocation

public void setLocation(java.lang.String desc,
                        WritableSheet sheet,
                        int destcol,
                        int destrow,
                        int lastdestcol,
                        int lastdestrow)

Sets the location of the cells to be linked to within this workbook

Parameters:

desc - the label describing the link

sheet - the sheet containing the cells to be linked to

destcol - the column number of the first destination linked cell

destrow - the row number of the first destination linked cell

lastdestcol - the column number of the last destination linked cell

lastdestrow - the row number of the last destination linked cell