Eclipse Platform
Release 3.1

org.eclipse.jface.text.hyperlink
Interface IHyperlinkDetector

All Known Implementing Classes:
URLHyperlinkDetector

public interface IHyperlinkDetector

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

Clients may implement this interface.

Since:
3.1

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

public 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

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.