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.

LINK_URL

@Removal(version="3.17")
static final int LINK_URL

Deprecated. POI 3.15 beta 3. Use HyperlinkType.URL instead.

Link to an existing file or web page

See Also:

Constant Field Values

LINK_DOCUMENT

@Removal(version="3.17")
static final int LINK_DOCUMENT

Deprecated. POI 3.15 beta 3. Use HyperlinkType.DOCUMENT instead.

Link to a place in this document

See Also:

Constant Field Values

LINK_EMAIL

@Removal(version="3.17")
static final int LINK_EMAIL

Deprecated. POI 3.15 beta 3. Use HyperlinkType.EMAIL instead.

Link to an E-mail address

See Also:

Constant Field Values

LINK_FILE

@Removal(version="3.17")
static final int LINK_FILE

Deprecated. POI 3.15 beta 3. Use HyperlinkType.FILE instead.

Link to an file

See Also:

Constant Field Values

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