org.apache.poi.hslf.model
Class Hyperlink

java.lang.Object
  org.apache.poi.hslf.model.Hyperlink

public class Hyperlink
extends java.lang.Object

Represents a hyperlink in a PowerPoint document

Author:

Yegor Kozlov

Constructor Summary

Hyperlink()

Method Summary

protected static Hyperlink	find(Shape shape) Find hyperlink assigned to the supplied shape
protected static Hyperlink[]	find(TextRun run) Find hyperlinks in a text run
java.lang.String	getAddress() Gets the hyperlink URL
int	getEndIndex() Gets the ending character position
int	getStartIndex() Gets the beginning character position
java.lang.String	getTitle() Gets the hyperlink user-friendly title (if different from URL)
int	getType() Gets the type of the hyperlink action.

Methods inherited from class java.lang.Object

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

Constructor Detail

Hyperlink

public Hyperlink()

Method Detail

getType

public int getType()

Gets the type of the hyperlink action. Must be a ACTION_* constant defined in InteractiveInfoAtom

Returns:

the hyperlink URL

See Also:

InteractiveInfoAtom

getAddress

public java.lang.String getAddress()

Gets the hyperlink URL

Returns:

the hyperlink URL

getTitle

public java.lang.String getTitle()

Gets the hyperlink user-friendly title (if different from URL)

Returns:

the hyperlink user-friendly title

getStartIndex

public int getStartIndex()

Gets the beginning character position

Returns:

the beginning character position

getEndIndex

public int getEndIndex()

Gets the ending character position

Returns:

the ending character position

find

protected static Hyperlink[] find(TextRun run)

Find hyperlinks in a text run

Parameters:

run - TextRun to lookup hyperlinks in

Returns:

found hyperlinks or null if not found

find

protected static Hyperlink find(Shape shape)

Find hyperlink assigned to the supplied shape

Parameters:

shape - Shape to lookup hyperlink in

Returns:

found hyperlink or null