Eclipse Platform
Release 3.1

org.eclipse.jface.text.hyperlink
Interface IHyperlink

All Known Implementing Classes:
URLHyperlink

public interface IHyperlink

Represents a hyperlink.

Clients may implement this interface.

Since:
3.1

Method Summary
 IRegion getHyperlinkRegion()
          The region covered by this type of hyperlink.
 String getHyperlinkText()
          Optional text for this hyperlink.
 String getTypeLabel()
          Optional label for this type of hyperlink.
 void open()
          Opens the given hyperlink.
 

Method Detail

getHyperlinkRegion

public IRegion getHyperlinkRegion()
The region covered by this type of hyperlink.

Returns:
the hyperlink region

getTypeLabel

public String getTypeLabel()
Optional label for this type of hyperlink.

This type label can be used by IHyperlinkPresenters which show several hyperlinks at once.

Returns:
the type label or null if none

getHyperlinkText

public String getHyperlinkText()
Optional text for this hyperlink.

This can be used in situations where there are several targets for the same hyperlink location.

Returns:
the text or null if none

open

public void open()
Opens the given hyperlink.


Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

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