Top Description Methods
org.apache.poi.common.usermodel

public Interface Hyperlink

Known Direct Subinterfaces
org.apache.poi.sl.usermodel.Hyperlink, org.apache.poi.ss.usermodel.Hyperlink

Represents a hyperlink.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the address of this hyperlink
getAddress
()

Hyperlink address.

public String

Returns:

text to display
getLabel
()

Return text label for this hyperlink

public HyperlinkType

Returns:

the type of this hyperlink
getType
()

Return the type of this hyperlink

public void
setAddress(String
the address of this hyperlink
address
)

Hyperlink address.

public void
setLabel(String
text label for this hyperlink
label
)

Sets text label for this hyperlink

Method Detail

getAddressback to summary
public String getAddress()

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

Returns:String

the address of this hyperlink

getLabelback to summary
public String getLabel()

Return text label for this hyperlink

Returns:String

text to display

getTypeback to summary
public HyperlinkType getType()

Return the type of this hyperlink

Returns:HyperlinkType

the type of this hyperlink

setAddressback to summary
public void setAddress(String address)

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

Parameters
address:String

the address of this hyperlink

setLabelback to summary
public void setLabel(String label)

Sets text label for this hyperlink

Parameters
label:String

text label for this hyperlink