Package org.apache.poi.common.usermodel
Interface Hyperlink
-
- All Known Implementing Classes:
HSLFHyperlink
,HSSFHyperlink
,XSLFHyperlink
,XSSFHyperlink
public interface Hyperlink
Represents a hyperlink.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description String
getAddress()
Hyperlink address.String
getLabel()
Return text label for this hyperlinkHyperlinkType
getType()
Return the type of this hyperlinkHyperlinkType
getTypeEnum()
Deprecated.usegetType()
insteadvoid
setAddress(String address)
Hyperlink address.void
setLabel(String label)
Sets text label for this hyperlink
-
-
-
Method Detail
-
getAddress
String getAddress()
Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Returns:
- the address of this hyperlink
-
setAddress
void setAddress(String address)
Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Parameters:
address
- the address of this hyperlink
-
getLabel
String getLabel()
Return text label for this hyperlink- Returns:
- text to display
-
setLabel
void setLabel(String label)
Sets text label for this hyperlink- Parameters:
label
- text label for this hyperlink
-
getType
HyperlinkType getType()
Return the type of this hyperlink- Returns:
- the type of this hyperlink
- See Also:
HyperlinkType.forInt(int)
-
getTypeEnum
@Deprecated @Removal(version="4.2") HyperlinkType getTypeEnum()
Deprecated.usegetType()
insteadReturn the type of this hyperlink- Returns:
- the type of this hyperlink
- Since:
- POI 3.15 beta 3
-
-