org.odftoolkit.simple.text
Interface TextHyperlinkContainer

All Known Implementing Classes:

Paragraph, Span

public interface TextHyperlinkContainer

TextHyperlinkContainer is a container which maintains text hyperlinks. Hyperlinks can be added and removed in this container.

Since:

0.6.5

See Also:

TextHyperlink

Method Summary

TextHyperlink	appendHyperlink(String text, URI linkto) Append a hyperlink at the end of the container
TextHyperlink	applyHyperlink(URI linkto) Add a hypertext reference to this hyperlink container.
Iterator<TextHyperlink>	getHyperlinkIterator() Get the iterator of hyperlinks within this container element
void	removeHyperlinks() Remove all the hyperlinks in this container element.

Method Detail

applyHyperlink

TextHyperlink applyHyperlink(URI linkto)

Add a hypertext reference to this hyperlink container.

Parameters:

linkto - the hyperlink

Returns:

an instance of TextHyperlink

removeHyperlinks

void removeHyperlinks()

Remove all the hyperlinks in this container element.

appendHyperlink

TextHyperlink appendHyperlink(String text,
                              URI linkto)

Append a hyperlink at the end of the container

Parameters:

text - - the text content

linkto - - the URI of this hyperlink

Returns:

an instance of TextHyperlink

getHyperlinkIterator

Iterator<TextHyperlink> getHyperlinkIterator()

Get the iterator of hyperlinks within this container element

Returns:

the iterator of hyperlinks within this container element