org.apache.poi.common.usermodel
Interface Hyperlink

All Known Subinterfaces:
Hyperlink<S,P>, Hyperlink
All Known Implementing Classes:
HSSFHyperlink

public interface Hyperlink

Represents a hyperlink.


Method Summary
 java.lang.String getAddress()
          Hyperlink address.
 java.lang.String getLabel()
          Return text label for this hyperlink
 int getType()
          Deprecated. POI 3.15 beta 3. Use getTypeEnum() getType will return a HyperlinkType enum in the future.
 HyperlinkType getTypeEnum()
          Return the type of this hyperlink
 void setAddress(java.lang.String address)
          Hyperlink address.
 void setLabel(java.lang.String label)
          Sets text label for this hyperlink
 

Method Detail

getAddress

java.lang.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(java.lang.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

java.lang.String getLabel()
Return text label for this hyperlink

Returns:
text to display

setLabel

void setLabel(java.lang.String label)
Sets text label for this hyperlink

Parameters:
label - text label for this hyperlink

getType

int getType()
Deprecated. POI 3.15 beta 3. Use getTypeEnum() getType will return a HyperlinkType enum in the future.

Return the type of this hyperlink

Returns:
the type of this hyperlink
See Also:
HyperlinkType.forInt(int)

getTypeEnum

HyperlinkType getTypeEnum()
Return the type of this hyperlink

Returns:
the type of this hyperlink
Since:
POI 3.15 beta 3