public final class HSLFHyperlink extends java.lang.Object implements Hyperlink<HSLFShape,HSLFTextParagraph>
Modifier | Constructor and Description |
---|---|
protected |
HSLFHyperlink(ExHyperlink exHyper,
InteractiveInfo info) |
Modifier and Type | Method and Description |
---|---|
protected static HSLFHyperlink |
find(HSLFShape shape)
Find hyperlink assigned to the supplied shape
|
static java.util.List<HSLFHyperlink> |
find(HSLFTextShape shape)
Find hyperlinks in a text shape
|
protected static java.util.List<HSLFHyperlink> |
find(java.util.List<HSLFTextParagraph> paragraphs)
Find hyperlinks in a text paragraph
|
java.lang.String |
getAddress()
Hyperlink address.
|
int |
getEndIndex()
Gets the ending character position
|
ExHyperlink |
getExHyperlink() |
int |
getId() |
InteractiveInfo |
getInfo() |
java.lang.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.
|
void |
linkToEmail(java.lang.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(java.lang.String url)
Link to a web page / URL
|
void |
setAddress(java.lang.String str)
Hyperlink address.
|
void |
setEndIndex(int endIndex)
Sets the ending character position
|
void |
setLabel(java.lang.String label)
Sets text label for this hyperlink
|
void |
setStartIndex(int startIndex)
Sets the beginning character position
|
protected void |
setTextRunInfo(TxInteractiveInfoAtom txinfo) |
protected HSLFHyperlink(ExHyperlink exHyper, InteractiveInfo info)
public ExHyperlink getExHyperlink()
public InteractiveInfo getInfo()
public TxInteractiveInfoAtom getTextRunInfo()
protected void setTextRunInfo(TxInteractiveInfoAtom txinfo)
public HyperlinkType getType()
LINK_*
constantgetType
in interface Hyperlink
InteractiveInfoAtom
public void linkToEmail(java.lang.String emailAddress)
Hyperlink
emailAddress
- the email addresspublic void linkToUrl(java.lang.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 java.lang.String getAddress()
Hyperlink
getAddress
in interface Hyperlink
public void setAddress(java.lang.String str)
Hyperlink
setAddress
in interface Hyperlink
str
- the address of this hyperlinkpublic int getId()
public java.lang.String getLabel()
Hyperlink
public void setLabel(java.lang.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 java.util.List<HSLFHyperlink> find(HSLFTextShape shape)
shape
- TextRun
to lookup hyperlinks innull
if not foundprotected static java.util.List<HSLFHyperlink> find(java.util.List<HSLFTextParagraph> paragraphs)
paragraphs
- List of TextParagraph
to lookup hyperlinksprotected static HSLFHyperlink find(HSLFShape shape)
shape
- Shape
to lookup hyperlink innull
Copyright 2022 The Apache Software Foundation or its licensors, as applicable.