Package 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.IHyperlinkPresenterExtension2
since version 3.7, adds the ability distinguish between the modes in which the control either takes focus or not when visible.
Clients may implement this interface. A default implementation is provided through
DefaultHyperlinkPresenter
.- Since:
- 3.1
- See Also:
IHyperlinkPresenterExtension
,IHyperlinkPresenterExtension2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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 byshowHyperlinks(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
- ifhyperlinks
is emptycanShowMultipleHyperlinks()
returnsfalse
andhyperlinks
contains more than one element
-
hideHyperlinks
void hideHyperlinks()
Tells this hyperlink presenter to hide the hyperlinks requested to be shown byshowHyperlinks(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.
-
-