Eclipse Platform
Release 3.1

org.eclipse.jface.text.hyperlink
Class URLHyperlinkDetector

java.lang.Object
  extended byorg.eclipse.jface.text.hyperlink.URLHyperlinkDetector
All Implemented Interfaces:
IHyperlinkDetector

public class URLHyperlinkDetector
extends Object
implements IHyperlinkDetector

URL hyperlink detector.

Since:
3.1

Constructor Summary
URLHyperlinkDetector(ITextViewer textViewer)
          Creates a new URL hyperlink detector.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

URLHyperlinkDetector

public URLHyperlinkDetector(ITextViewer textViewer)
Creates a new URL hyperlink detector.

Parameters:
textViewer - the text viewer in which to detect the hyperlink
Method Detail

detectHyperlinks

public IHyperlink[] detectHyperlinks(ITextViewer textViewer,
                                     IRegion region,
                                     boolean canShowMultipleHyperlinks)
Description copied from interface: IHyperlinkDetector
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.

Specified by:
detectHyperlinks in interface IHyperlinkDetector
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.