com.github.pjfanning.xlsx.impl

Class XlsxHyperlink

java.lang.Object

com.github.pjfanning.xlsx.impl.XlsxHyperlink

All Implemented Interfaces:

org.apache.poi.common.usermodel.Hyperlink

public class XlsxHyperlink
extends java.lang.Object
implements org.apache.poi.ss.usermodel.Hyperlink

A read-only implementation of Hyperlink

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddress() Hyperlink address.
java.lang.String	getCellRef() Get the address of the cell this hyperlink applies to, e.g.
int	getFirstColumn() Return the column of the first cell that contains the hyperlink
int	getFirstRow() Return the row of the first cell that contains the hyperlink
java.lang.String	getLabel() Return text label for this hyperlink
int	getLastColumn() Return the column of the last cell that contains the hyperlink
int	getLastRow() Return the row of the last cell that contains the hyperlink
java.lang.String	getLocation() Location within target.
java.lang.String	getTooltip()
org.apache.poi.common.usermodel.HyperlinkType	getType() Return the type of this hyperlink
void	setAddress(java.lang.String address)
void	setFirstColumn(int col)
void	setFirstRow(int row)
void	setLabel(java.lang.String label)
void	setLastColumn(int col)
void	setLastRow(int row)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getType

public org.apache.poi.common.usermodel.HyperlinkType getType()

Return the type of this hyperlink

Specified by:

getType in interface org.apache.poi.common.usermodel.Hyperlink

Returns:

the type of this hyperlink

getCellRef

public java.lang.String getCellRef()

Get the address of the cell this hyperlink applies to, e.g. A55

getAddress

public java.lang.String getAddress()

Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file. The is the hyperlink target.

Specified by:

getAddress in interface org.apache.poi.common.usermodel.Hyperlink

Returns:

the address of this hyperlink

getLabel

public java.lang.String getLabel()

Return text label for this hyperlink

Specified by:

getLabel in interface org.apache.poi.common.usermodel.Hyperlink

Returns:

text to display

getLocation

public java.lang.String getLocation()

Location within target. If target is a workbook (or this workbook) this shall refer to a sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.

Returns:

location

getFirstColumn

public int getFirstColumn()

Return the column of the first cell that contains the hyperlink

Returns:

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

Returns:

the 0-based column of the last cell that contains the hyperlink

getFirstRow

public int getFirstRow()

Return the row of the first cell that contains the hyperlink

Returns:

the 0-based row of the cell that contains the hyperlink

getLastRow

public int getLastRow()

Return the row of the last cell that contains the hyperlink

Returns:

the 0-based row of the last cell that contains the hyperlink

getTooltip

public java.lang.String getTooltip()

Returns:

additional text to help the user understand more about the hyperlink

setAddress

public void setAddress(java.lang.String address)

Specified by:

setAddress in interface org.apache.poi.common.usermodel.Hyperlink

Throws:

java.lang.UnsupportedOperationException

setLabel

public void setLabel(java.lang.String label)

Specified by:

setLabel in interface org.apache.poi.common.usermodel.Hyperlink

Throws:

java.lang.UnsupportedOperationException

setFirstColumn

public void setFirstColumn(int col)

Throws:

java.lang.UnsupportedOperationException

setLastColumn

public void setLastColumn(int col)

Throws:

java.lang.UnsupportedOperationException

setFirstRow

public void setFirstRow(int row)

Throws:

java.lang.UnsupportedOperationException

setLastRow

public void setLastRow(int row)

Throws:

java.lang.UnsupportedOperationException