public final class HSLFHyperlink extends Object implements Hyperlink<HSLFShape,HSLFTextParagraph>
Modifier and Type | Method and Description |
---|---|
static List<HSLFHyperlink> |
find(HSLFTextShape shape)
Find hyperlinks in a text shape
|
String |
getAddress()
Hyperlink address.
|
int |
getEndIndex()
Gets the ending character position
|
ExHyperlink |
getExHyperlink() |
int |
getId() |
InteractiveInfo |
getInfo() |
String |
getLabel()
Return text label for this hyperlink
|
int |
getStartIndex()
Gets the beginning character position
|
TxInteractiveInfoAtom |
getTextRunInfo() |
HyperlinkType |
getType()
Gets the type of the hyperlink action.
|
HyperlinkType |
getTypeEnum()
Deprecated.
use
getType instead |
void |
linkToEmail(String emailAddress)
Link to an email
|
void |
linkToFirstSlide()
Link to the first slide in this slideshow
|
void |
linkToLastSlide()
Link to the last slide in this slideshow
|
void |
linkToNextSlide()
Link to the next slide (relative from the current)
|
void |
linkToPreviousSlide()
Link to the previous slide (relative from the current)
|
void |
linkToSlide(Slide<HSLFShape,HSLFTextParagraph> slide)
Link to a slide in this slideshow
|
void |
linkToUrl(String url)
Link to a web page / URL
|
void |
setAddress(String str)
Hyperlink address.
|
void |
setEndIndex(int endIndex)
Sets the ending character position
|
void |
setLabel(String label)
Sets text label for this hyperlink
|
void |
setStartIndex(int startIndex)
Sets the beginning character position
|
public ExHyperlink getExHyperlink()
public InteractiveInfo getInfo()
public TxInteractiveInfoAtom getTextRunInfo()
public HyperlinkType getType()
LINK_*
constantgetType
in interface Hyperlink
InteractiveInfoAtom
@Deprecated @Removal(version="4.2") public HyperlinkType getTypeEnum()
getType
insteadLINK_*
constantgetTypeEnum
in interface Hyperlink
InteractiveInfoAtom
public void linkToEmail(String emailAddress)
Hyperlink
emailAddress
- the email addresspublic void linkToUrl(String url)
Hyperlink
url
- the urlpublic void linkToSlide(Slide<HSLFShape,HSLFTextParagraph> slide)
Hyperlink
slide
- the linked slidepublic void linkToNextSlide()
Hyperlink
public void linkToPreviousSlide()
Hyperlink
public void linkToFirstSlide()
Hyperlink
public void linkToLastSlide()
Hyperlink
public String getAddress()
Hyperlink
getAddress
in interface Hyperlink
public void setAddress(String str)
Hyperlink
setAddress
in interface Hyperlink
str
- the address of this hyperlinkpublic int getId()
public String getLabel()
Hyperlink
public void setLabel(String label)
Hyperlink
public int getStartIndex()
public void setStartIndex(int startIndex)
startIndex
- the beginning character positionpublic int getEndIndex()
public void setEndIndex(int endIndex)
endIndex
- the ending character positionpublic static List<HSLFHyperlink> find(HSLFTextShape shape)
shape
- TextRun
to lookup hyperlinks innull
if not foundCopyright © 2010 - 2020 Adobe. All Rights Reserved