Package org.apache.poi.xssf.usermodel

Class XSSFHyperlink

java.lang.Object

org.apache.poi.xssf.usermodel.XSSFHyperlink

All Implemented Interfaces:

Duplicatable, Hyperlink, Hyperlink

public class XSSFHyperlink
extends Object
implements Hyperlink, Duplicatable

XSSF Implementation of a Hyperlink. Note - unlike with HSSF, many kinds of hyperlink are largely stored as relations of the sheet

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XSSFHyperlink(HyperlinkType type)	Create a new XSSFHyperlink.
	XSSFHyperlink(Hyperlink other)	Create a new XSSFHyperlink.
protected	XSSFHyperlink(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHyperlink ctHyperlink, PackageRelationship hyperlinkRel)	Create a XSSFHyperlink and initialize it from the supplied CTHyperlink bean and package relationship

Method Summary

Modifier and Type	Method	Description
Duplicatable	copy()
protected void	generateRelationIfNeeded(PackagePart sheetPart)	Generates the relation if required
String	getAddress()	Hyperlink address.
String	getCellRef()	Get the address of the cell this hyperlink applies to, e.g.
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHyperlink	getCTHyperlink()
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
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
String	getLocation()	Location within target.
String	getTooltip()
HyperlinkType	getType()	Return the type of this hyperlink
boolean	needsRelationToo()	Do we need to a relation too, to represent this hyperlink?
void	setAddress(String address)	Hyperlink address.
void	setCellReference(String ref)	Assigns this hyperlink to the given cell reference
void	setCellReference(CellReference ref)
void	setFirstColumn(int col)	Set the column of the first cell that contains the hyperlink
void	setFirstRow(int row)	Set the row of the first cell that contains the hyperlink
void	setLabel(String label)	Sets text label for this hyperlink
void	setLastColumn(int col)	Set the column of the last cell that contains the hyperlink.
void	setLastRow(int row)	Set the row of the last cell that contains the hyperlink.
void	setLocation(String location)	Location within target.
void	setTooltip(String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

XSSFHyperlink

protected XSSFHyperlink(HyperlinkType type)

Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper.createHyperlink(HyperlinkType).

Parameters:

type - - the type of hyperlink to create

XSSFHyperlink

protected XSSFHyperlink(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHyperlink ctHyperlink,
                        PackageRelationship hyperlinkRel)

Create a XSSFHyperlink and initialize it from the supplied CTHyperlink bean and package relationship

Parameters:

ctHyperlink - the xml bean containing xml properties

hyperlinkRel - the relationship in the underlying OPC package which stores the actual link's address

XSSFHyperlink

@Internal
public XSSFHyperlink(Hyperlink other)

Create a new XSSFHyperlink. This method is for Internal use only. XSSFHyperlinks can be created by XSSFCreationHelper. See the spreadsheet quick-guide for an example.

Parameters:

other - the hyperlink to copy

Method Detail

getCTHyperlink

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHyperlink getCTHyperlink()

Returns:

the underlying CTHyperlink object

needsRelationToo

public boolean needsRelationToo()

Do we need to a relation too, to represent this hyperlink?

generateRelationIfNeeded

protected void generateRelationIfNeeded(PackagePart sheetPart)

Generates the relation if required

getType

public HyperlinkType getType()

Return the type of this hyperlink

Specified by:

getType in interface Hyperlink

Returns:

the type of this hyperlink

getCellRef

public String getCellRef()

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

getAddress

public 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 Hyperlink

Returns:

the address of this hyperlink

getLabel

public String getLabel()

Return text label for this hyperlink

Specified by:

getLabel in interface Hyperlink

Returns:

text to display

getLocation

public 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

setLabel

public void setLabel(String label)

Sets text label for this hyperlink

Specified by:

setLabel in interface Hyperlink

Parameters:

label - text label for this hyperlink

setLocation

public void setLocation(String location)

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.

Parameters:

location - - string representing a location of this hyperlink

setAddress

public void setAddress(String address)

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

Specified by:

setAddress in interface Hyperlink

Parameters:

address - - the address of this hyperlink

setCellReference

@Internal
public void setCellReference(String ref)

Assigns this hyperlink to the given cell reference

setCellReference

@Internal
public void setCellReference(CellReference ref)

getFirstColumn

public int getFirstColumn()

Return the column of the first cell that contains the hyperlink

Specified by:

getFirstColumn in interface 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

Specified by:

getLastColumn in interface 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

Specified by:

getFirstRow in interface 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

Specified by:

getLastRow in interface Hyperlink

Returns:

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

setFirstColumn

public void setFirstColumn(int col)

Set the column of the first cell that contains the hyperlink

Specified by:

setFirstColumn in interface Hyperlink

Parameters:

col - the 0-based column of the first cell that contains the hyperlink

setLastColumn

public void setLastColumn(int col)

Set the column of the last cell that contains the hyperlink.

Specified by:

setLastColumn in interface Hyperlink

Parameters:

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

setFirstRow

public void setFirstRow(int row)

Set the row of the first cell that contains the hyperlink

Specified by:

setFirstRow in interface Hyperlink

Parameters:

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

setLastRow

public void setLastRow(int row)

Set the row of the last cell that contains the hyperlink.

Specified by:

setLastRow in interface Hyperlink

Parameters:

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

getTooltip

public String getTooltip()

Returns:

additional text to help the user understand more about the hyperlink

setTooltip

public void setTooltip(String text)

Parameters:

text - additional text to help the user understand more about the hyperlink

copy

public Duplicatable copy()

Specified by:

copy in interface Duplicatable

Returns:

a new XSSFHyperlink based on this

Since:

POI 5.1.0