org.apache.poi.hssf.usermodel: public class: HSSFHyperlink

org.apache.poi.hssf.usermodel
public class: HSSFHyperlink [javadoc | source]

java.lang.Object
   org.apache.poi.hssf.usermodel.HSSFHyperlink

Represents an Excel hyperlink.

author: Yegor - Kozlov (yegor at apache dot org)

Field Summary
public static final int	LINK_URL	Link to a existing file or web page
public static final int	LINK_DOCUMENT	Link to a place in this document
public static final int	LINK_EMAIL	Link to an E-mail address
public static final int	LINK_FILE	Link to a file
protected HyperlinkRecord	record	Low-level record object that stores the actual hyperlink data
protected int	link_type	If we create a new hypelrink remember its type

Constructor:

Constructor:
public HSSFHyperlink(int type) { this.link_type = type; record = new HyperlinkRecord(); switch(type){ case LINK_URL: case LINK_EMAIL: record.newUrlLink(); break; case LINK_FILE: record.newFileLink(); break; case LINK_DOCUMENT: record.newDocumentLink(); break; } } Construct a new hyperlink Parameters: `type` - the type of hyperlink to create
protected HSSFHyperlink(HyperlinkRecord record) { this.record = record; } Initialize the hyperlink by a `HyperlinkRecord` record Parameters: `record` -

 public HSSFHyperlink(int type) {
                     
        this.link_type = type;
        record = new HyperlinkRecord();
        switch(type){
            case LINK_URL:
            case LINK_EMAIL:
                record.newUrlLink();
                break;
            case LINK_FILE:
                record.newFileLink();
                break;
            case LINK_DOCUMENT:
                record.newDocumentLink();
                break;
        }
}

Construct a new hyperlink

Parameters:

type - the type of hyperlink to create

 protected HSSFHyperlink(HyperlinkRecord record) {
        this.record = record;
}

HyperlinkRecord

Parameters:

record -

Method from org.apache.poi.hssf.usermodel.HSSFHyperlink Summary:
getAddress, getFirstColumn, getFirstRow, getLabel, getLastColumn, getLastRow, getType, setAddress, setFirstColumn, setFirstRow, setLabel, setLastColumn, setLastRow

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.poi.hssf.usermodel.HSSFHyperlink Detail:
public String getAddress() { return record.getAddress(); } Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
public short getFirstColumn() { return record.getFirstColumn(); } Return the column of the first cell that contains the hyperlink
public int getFirstRow() { return record.getFirstRow(); } Return the row of the first cell that contains the hyperlink
public String getLabel() { return record.getLabel(); } Return text label for this hyperlink
public short getLastColumn() { return record.getLastColumn(); } Return the column of the last cell that contains the hyperlink
public int getLastRow() { return record.getLastRow(); } Return the row of the last cell that contains the hyperlink
protected int getType() { return link_type; } Return the type of this hyperlink
public void setAddress(String address) { record.setAddress(address); } Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
public void setFirstColumn(short col) { record.setFirstColumn(col); } Set the column of the first cell that contains the hyperlink
public void setFirstRow(int row) { record.setFirstRow(row); } Set the row of the first cell that contains the hyperlink
public void setLabel(String label) { record.setLabel(label); } Sets text label for this hyperlink
public void setLastColumn(short col) { record.setLastColumn(col); } Set the column of the last cell that contains the hyperlink
public void setLastRow(int row) { record.setLastRow(row); } Set the row of the last cell that contains the hyperlink

Method from org.apache.poi.hssf.usermodel.HSSFHyperlink Detail:

 public String getAddress() {
        return record.getAddress();
}

Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.

 public short getFirstColumn() {
        return record.getFirstColumn();
}

Return the column of the first cell that contains the hyperlink

 public int getFirstRow() {
        return record.getFirstRow();
}

Return the row of the first cell that contains the hyperlink

 public String getLabel() {
        return record.getLabel();
}

Return text label for this hyperlink

 public short getLastColumn() {
        return record.getLastColumn();
}

Return the column of the last cell that contains the hyperlink

 public int getLastRow() {
        return record.getLastRow();
}

Return the row of the last cell that contains the hyperlink

 protected int getType() {
        return link_type;
}

Return the type of this hyperlink

 public  void setAddress(String address) {
        record.setAddress(address);
}

Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.

 public  void setFirstColumn(short col) {
        record.setFirstColumn(col);
}

Set the column of the first cell that contains the hyperlink

 public  void setFirstRow(int row) {
        record.setFirstRow(row);
}

Set the row of the first cell that contains the hyperlink

 public  void setLabel(String label) {
        record.setLabel(label);
}

Sets text label for this hyperlink

 public  void setLastColumn(short col) {
        record.setLastColumn(col);
}

Set the column of the last cell that contains the hyperlink

 public  void setLastRow(int row) {
        record.setLastRow(row);
}

Set the row of the last cell that contains the hyperlink