Package org.apache.poi.xslf.usermodel
Class XSLFHyperlink
- java.lang.Object
-
- org.apache.poi.xslf.usermodel.XSLFHyperlink
-
- All Implemented Interfaces:
Hyperlink
,Hyperlink<XSLFShape,XSLFTextParagraph>
public class XSLFHyperlink extends java.lang.Object implements Hyperlink<XSLFShape,XSLFTextParagraph>
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAddress()
Hyperlink address.java.lang.String
getLabel()
Return text label for this hyperlinkHyperlinkType
getType()
Return the type of this hyperlinkCTHyperlink
getXmlObject()
void
linkToEmail(java.lang.String emailAddress)
Link to an emailvoid
linkToFirstSlide()
Link to the first slide in this slideshowvoid
linkToLastSlide()
Link to the last slide in this slideshowvoid
linkToNextSlide()
Link to the next slide (relative from the current)void
linkToPreviousSlide()
Link to the previous slide (relative from the current)void
linkToSlide(Slide<XSLFShape,XSLFTextParagraph> slide)
Link to a slide in this slideshowvoid
linkToUrl(java.lang.String url)
Link to a web page / URLvoid
setAddress(java.lang.String address)
Hyperlink address.void
setLabel(java.lang.String label)
Sets text label for this hyperlink
-
-
-
Method Detail
-
getXmlObject
@Internal public CTHyperlink getXmlObject()
-
setAddress
public void setAddress(java.lang.String address)
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
public java.lang.String 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
public java.lang.String getLabel()
Description copied from interface:Hyperlink
Return text label for this hyperlink
-
setLabel
public void setLabel(java.lang.String label)
Description copied from interface:Hyperlink
Sets text label for this hyperlink
-
getType
public HyperlinkType getType()
Description copied from interface:Hyperlink
Return the type of this hyperlink
-
linkToEmail
public void linkToEmail(java.lang.String emailAddress)
Description copied from interface:Hyperlink
Link to an email- Specified by:
linkToEmail
in interfaceHyperlink<XSLFShape,XSLFTextParagraph>
- Parameters:
emailAddress
- the email address
-
linkToUrl
public void linkToUrl(java.lang.String url)
Description copied from interface:Hyperlink
Link to a web page / URL- Specified by:
linkToUrl
in interfaceHyperlink<XSLFShape,XSLFTextParagraph>
- Parameters:
url
- the url
-
linkToSlide
public void linkToSlide(Slide<XSLFShape,XSLFTextParagraph> slide)
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>
-
-