Eclipse Platform
Release 3.1

org.eclipse.jface.text.hyperlink
Class URLHyperlink

java.lang.Object
  extended byorg.eclipse.jface.text.hyperlink.URLHyperlink
All Implemented Interfaces:
IHyperlink

public class URLHyperlink
extends Object
implements IHyperlink

URL hyperlink.

Since:
3.1

Constructor Summary
URLHyperlink(IRegion region, String urlString)
          Creates a new URL hyperlink.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

URLHyperlink

public URLHyperlink(IRegion region,
                    String urlString)
Creates a new URL hyperlink.

Parameters:
region -
urlString -
Method Detail

getHyperlinkRegion

public IRegion getHyperlinkRegion()
Description copied from interface: IHyperlink
The region covered by this type of hyperlink.

Specified by:
getHyperlinkRegion in interface IHyperlink
Returns:
the hyperlink region

open

public void open()
Description copied from interface: IHyperlink
Opens the given hyperlink.

Specified by:
open in interface IHyperlink

getTypeLabel

public String getTypeLabel()
Description copied from interface: IHyperlink
Optional label for this type of hyperlink.

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

Specified by:
getTypeLabel in interface IHyperlink
Returns:
the type label or null if none

getHyperlinkText

public String getHyperlinkText()
Description copied from interface: IHyperlink
Optional text for this hyperlink.

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

Specified by:
getHyperlinkText in interface IHyperlink
Returns:
the text or null if none

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

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