Eclipse Plug-in Developer Guide (Galileo) - IHyperlinkPresenter (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:

IHyperlinkPresenterExtension since version 3.4, adds the ability to query whether the currently shown hyperlinks can be hidden.

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

hyperlinks is empty
canShowMultipleHyperlinks() returns false and hyperlinks contains more than one element

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.