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.CTHyperlinkvoidlinkToEmail(String emailAddress) Link to an emailvoidLink to the first slide in this slideshowvoidLink to the last slide in this slideshowvoidLink to the next slide (relative from the current)voidLink to the previous slide (relative from the current)voidlinkToSlide(Slide<XSLFShape, XSLFTextParagraph> slide) Link to a slide in this slideshowvoidLink to a web page / URLvoidsetAddress(String address) Hyperlink address.voidSets text label for this hyperlink
-
Method Details
-
getXmlObject
-
setAddress
Description copied from interface:HyperlinkHyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Specified by:
setAddressin interfaceHyperlink- Parameters:
address- the address of this hyperlink
-
getAddress
Description copied from interface:HyperlinkHyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Specified by:
getAddressin interfaceHyperlink- Returns:
- the address of this hyperlink
-
getLabel
Description copied from interface:HyperlinkReturn text label for this hyperlink -
setLabel
Description copied from interface:HyperlinkSets text label for this hyperlink -
getType
Description copied from interface:HyperlinkReturn the type of this hyperlink -
getTypeEnum
Deprecated.Description copied from interface:HyperlinkReturn the type of this hyperlink- Specified by:
getTypeEnumin interfaceHyperlink- Returns:
- the type of this hyperlink
-
linkToEmail
Description copied from interface:HyperlinkLink to an email- Specified by:
linkToEmailin interfaceHyperlink<XSLFShape,XSLFTextParagraph> - Parameters:
emailAddress- the email address
-
linkToUrl
Description copied from interface:HyperlinkLink to a web page / URL- Specified by:
linkToUrlin interfaceHyperlink<XSLFShape,XSLFTextParagraph> - Parameters:
url- the url
-
linkToSlide
Description copied from interface:HyperlinkLink to a slide in this slideshow- Specified by:
linkToSlidein interfaceHyperlink<XSLFShape,XSLFTextParagraph> - Parameters:
slide- the linked slide
-
linkToNextSlide
public void linkToNextSlide()Description copied from interface:HyperlinkLink to the next slide (relative from the current)- Specified by:
linkToNextSlidein interfaceHyperlink<XSLFShape,XSLFTextParagraph>
-
linkToPreviousSlide
public void linkToPreviousSlide()Description copied from interface:HyperlinkLink to the previous slide (relative from the current)- Specified by:
linkToPreviousSlidein interfaceHyperlink<XSLFShape,XSLFTextParagraph>
-
linkToFirstSlide
public void linkToFirstSlide()Description copied from interface:HyperlinkLink to the first slide in this slideshow- Specified by:
linkToFirstSlidein interfaceHyperlink<XSLFShape,XSLFTextParagraph>
-
linkToLastSlide
public void linkToLastSlide()Description copied from interface:HyperlinkLink to the last slide in this slideshow- Specified by:
linkToLastSlidein interfaceHyperlink<XSLFShape,XSLFTextParagraph>
-