org.apache.poi.hslf.usermodel

Class HSLFHyperlink

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFHyperlink

All Implemented Interfaces:

Hyperlink

public final class HSLFHyperlink
extends java.lang.Object
implements Hyperlink<HSLFShape,HSLFTextParagraph>

Represents a hyperlink in a PowerPoint document

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HSLFHyperlink(ExHyperlink exHyper, InteractiveInfo info)

Method Summary

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()
int	getEndIndex() Gets the ending character position
ExHyperlink	getExHyperlink()
int	getId()
InteractiveInfo	getInfo()
java.lang.String	getLabel()
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(java.lang.String emailAddress)
void	linkToFirstSlide()
void	linkToLastSlide()
void	linkToNextSlide()
void	linkToPreviousSlide()
void	linkToSlide(Slide<HSLFShape,HSLFTextParagraph> slide)
void	linkToUrl(java.lang.String url)
void	setAddress(java.lang.String str)
void	setEndIndex(int endIndex) Sets the ending character position
void	setLabel(java.lang.String label)
void	setStartIndex(int startIndex) Sets the beginning character position
protected void	setTextRunInfo(TxInteractiveInfoAtom txinfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HSLFHyperlink

protected HSLFHyperlink(ExHyperlink exHyper,
                        InteractiveInfo info)

Method Detail

getExHyperlink

public ExHyperlink getExHyperlink()

getInfo

public InteractiveInfo getInfo()

getTextRunInfo

public TxInteractiveInfoAtom getTextRunInfo()

setTextRunInfo

protected void setTextRunInfo(TxInteractiveInfoAtom txinfo)

getType

public HyperlinkType getType()

Gets the type of the hyperlink action. Must be a LINK_* constant

Specified by:

getType in interface Hyperlink

Returns:

the hyperlink URL

See Also:

InteractiveInfoAtom

getTypeEnum

@Deprecated
 @Removal(version="4.2")
public HyperlinkType getTypeEnum()

Deprecated. use getType instead

Gets the type of the hyperlink action. Must be a LINK_* constant

Specified by:

getTypeEnum in interface Hyperlink

Returns:

the hyperlink URL

See Also:

InteractiveInfoAtom

linkToEmail

public void linkToEmail(java.lang.String emailAddress)

linkToUrl

public void linkToUrl(java.lang.String url)

linkToSlide

public void linkToSlide(Slide<HSLFShape,HSLFTextParagraph> slide)

linkToNextSlide

public void linkToNextSlide()

linkToPreviousSlide

public void linkToPreviousSlide()

linkToFirstSlide

public void linkToFirstSlide()

linkToLastSlide

public void linkToLastSlide()

getAddress

public java.lang.String getAddress()

Specified by:

getAddress in interface Hyperlink

setAddress

public void setAddress(java.lang.String str)

Specified by:

setAddress in interface Hyperlink

getId

public int getId()

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface Hyperlink

setLabel

public void setLabel(java.lang.String label)

Specified by:

setLabel in interface Hyperlink

getStartIndex

public int getStartIndex()

Gets the beginning character position

Returns:

the beginning character position

setStartIndex

public void setStartIndex(int startIndex)

Sets the beginning character position

Parameters:

startIndex - the beginning character position

getEndIndex

public int getEndIndex()

Gets the ending character position

Returns:

the ending character position

setEndIndex

public void setEndIndex(int endIndex)

Sets the ending character position

Parameters:

endIndex - the ending character position

find

public static java.util.List<HSLFHyperlink> find(HSLFTextShape shape)

Find hyperlinks in a text shape

Parameters:

shape - TextRun to lookup hyperlinks in

Returns:

found hyperlinks or null if not found

find

protected static java.util.List<HSLFHyperlink> find(java.util.List<HSLFTextParagraph> paragraphs)

Find hyperlinks in a text paragraph

Parameters:

paragraphs - List of TextParagraph to lookup hyperlinks

Returns:

found hyperlinks

find

protected static HSLFHyperlink find(HSLFShape shape)

Find hyperlink assigned to the supplied shape

Parameters:

shape - Shape to lookup hyperlink in

Returns:

found hyperlink or null