Package org.apache.poi.common.usermodel
Interface Hyperlink
- All Known Implementing Classes:
HSLFHyperlink,HSSFHyperlink,XSLFHyperlink,XSSFHyperlink
public interface Hyperlink
Represents a hyperlink.
-
Method Summary
Modifier and TypeMethodDescriptionHyperlink address.getLabel()Return text label for this hyperlinkgetType()Return the type of this hyperlinkDeprecated.voidsetAddress(String address) Hyperlink address.voidSets text label for this hyperlink
-
Method Details
-
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
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
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:
-
getTypeEnum
Deprecated.usegetType()insteadReturn the type of this hyperlink- Returns:
- the type of this hyperlink
- Since:
- POI 3.15 beta 3
-
getType()instead