Eclipse Platform
Release 3.6

org.eclipse.jface.text.hyperlink
Interface IHyperlinkPresenter

All Known Implementing Classes:
DefaultHyperlinkPresenter, MultipleHyperlinkPresenter

public interface IHyperlinkPresenter

A hyperlink presenter shows hyperlinks on the installed text viewer and allows to pick one on of the hyperlinks.

In order to provide backward compatibility for clients of IHyperlinkDetector, extension interfaces are used to provide a means of evolution. The following extension interfaces exist:

Clients may implement this interface. A default implementation is provided through DefaultHyperlinkPresenter.

Since:
3.1
See Also:
IHyperlinkPresenterExtension

Method Summary
 boolean canShowMultipleHyperlinks()
          Tells whether this presenter is able to handle more than one hyperlink.
 void hideHyperlinks()
          Tells this hyperlink presenter to hide the hyperlinks requested to be shown by showHyperlinks(IHyperlink[]).
 void install(ITextViewer textViewer)
          Installs this hyperlink presenter on the given text viewer.
 void showHyperlinks(IHyperlink[] hyperlinks)
          Tells this hyperlink presenter to show the given hyperlinks on the installed text viewer.
 void uninstall()
          Uninstalls this hyperlink presenter.
 

Method Detail

canShowMultipleHyperlinks

boolean canShowMultipleHyperlinks()
Tells whether this presenter is able to handle more than one hyperlink.

Returns:
true if this presenter can handle more than one hyperlink

showHyperlinks

void showHyperlinks(IHyperlink[] hyperlinks)
                    throws IllegalArgumentException
Tells this hyperlink presenter to show the given hyperlinks on the installed text viewer.

Parameters:
hyperlinks - the hyperlinks to show
Throws:
IllegalArgumentException - if

hideHyperlinks

void hideHyperlinks()
Tells this hyperlink presenter to hide the hyperlinks requested to be shown by showHyperlinks(IHyperlink[]).


install

void install(ITextViewer textViewer)
Installs this hyperlink presenter on the given text viewer.

Parameters:
textViewer - the text viewer

uninstall

void uninstall()
Uninstalls this hyperlink presenter.


Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.