Eclipse Plug-in Developer Guide (Galileo) - IHyperlinkDetector (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 IHyperlinkDetector

All Known Implementing Classes:: AbstractHyperlinkDetector, URLHyperlinkDetector

public interface IHyperlinkDetector

A hyperlink detector tries to find a hyperlink at a given location in a given text viewer.

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:

IHyperlinkDetectorExtension since version 3.3, adds the ability to dispose a hyperlink detector
IHyperlinkDetectorExtension2 since version 3.3, adds the ability to specify the state mask of the modifier keys that need to be pressed for this hyperlink detector

Clients may implement this interface.

Since:: 3.1
See Also:: SourceViewerConfiguration.getHyperlinkDetectors(org.eclipse.jface.text.source.ISourceViewer)

Method Summary

IHyperlink[] detectHyperlinks ( ITextViewer textViewer, IRegion region, boolean canShowMultipleHyperlinks)
Tries to detect hyperlinks for the given region in the given text viewer and returns them.

Method Detail

detectHyperlinks


IHyperlink[] detectHyperlinks(
ITextViewer textViewer,
                              
IRegion region,
                              boolean canShowMultipleHyperlinks)

Tries to detect hyperlinks for the given region in the given text viewer and returns them.

In most of the cases only one hyperlink should be returned.

Parameters:: textViewer - the text viewer on which the hover popup should be shown; region - the text range in the text viewer which is used to detect the hyperlinks; canShowMultipleHyperlinks - tells whether the caller is able to show multiple links to the user. If true IHyperlink.open() should directly open the link and not show any additional UI to select from a list. If false this method should only return one hyperlink which upon IHyperlink.open() may allow to select from a list.
Returns:: the hyperlinks or null if no hyperlink was detected