Package org.apache.poi.xslf.usermodel
Class XSLFHyperlink
java.lang.Object
org.apache.poi.xslf.usermodel.XSLFHyperlink
- All Implemented Interfaces:
Hyperlink
,Hyperlink<XSLFShape,
XSLFTextParagraph>
-
Method Summary
Modifier and TypeMethodDescriptionHyperlink address.getLabel()
Return text label for this hyperlinkgetType()
Return the type of this hyperlinkDeprecated.org.openxmlformats.schemas.drawingml.x2006.main.CTHyperlink
void
linkToEmail
(String emailAddress) Link to an emailvoid
Link to the first slide in this slideshowvoid
Link to the last slide in this slideshowvoid
Link to the next slide (relative from the current)void
Link to the previous slide (relative from the current)void
linkToSlide
(Slide<XSLFShape, XSLFTextParagraph> slide) Link to a slide in this slideshowvoid
Link to a web page / URLvoid
setAddress
(String address) Hyperlink address.void
Sets text label for this hyperlink
-
Method Details
-
getXmlObject
-
setAddress
Description copied from interface:Hyperlink
Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Specified by:
setAddress
in interfaceHyperlink
- Parameters:
address
- the address of this hyperlink
-
getAddress
Description copied from interface:Hyperlink
Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Specified by:
getAddress
in interfaceHyperlink
- Returns:
- the address of this hyperlink
-
getLabel
Description copied from interface:Hyperlink
Return text label for this hyperlink -
setLabel
Description copied from interface:Hyperlink
Sets text label for this hyperlink -
getType
Description copied from interface:Hyperlink
Return the type of this hyperlink -
getTypeEnum
Deprecated.Description copied from interface:Hyperlink
Return the type of this hyperlink- Specified by:
getTypeEnum
in interfaceHyperlink
- Returns:
- the type of this hyperlink
-
linkToEmail
Description copied from interface:Hyperlink
Link to an email- Specified by:
linkToEmail
in interfaceHyperlink<XSLFShape,
XSLFTextParagraph> - Parameters:
emailAddress
- the email address
-
linkToUrl
Description copied from interface:Hyperlink
Link to a web page / URL- Specified by:
linkToUrl
in interfaceHyperlink<XSLFShape,
XSLFTextParagraph> - Parameters:
url
- the url
-
linkToSlide
Description copied from interface:Hyperlink
Link to a slide in this slideshow- Specified by:
linkToSlide
in interfaceHyperlink<XSLFShape,
XSLFTextParagraph> - Parameters:
slide
- the linked slide
-
linkToNextSlide
public void linkToNextSlide()Description copied from interface:Hyperlink
Link to the next slide (relative from the current)- Specified by:
linkToNextSlide
in interfaceHyperlink<XSLFShape,
XSLFTextParagraph>
-
linkToPreviousSlide
public void linkToPreviousSlide()Description copied from interface:Hyperlink
Link to the previous slide (relative from the current)- Specified by:
linkToPreviousSlide
in interfaceHyperlink<XSLFShape,
XSLFTextParagraph>
-
linkToFirstSlide
public void linkToFirstSlide()Description copied from interface:Hyperlink
Link to the first slide in this slideshow- Specified by:
linkToFirstSlide
in interfaceHyperlink<XSLFShape,
XSLFTextParagraph>
-
linkToLastSlide
public void linkToLastSlide()Description copied from interface:Hyperlink
Link to the last slide in this slideshow- Specified by:
linkToLastSlide
in interfaceHyperlink<XSLFShape,
XSLFTextParagraph>
-