org.eclipse.xtext.ui.editor.hyperlinking
Class AbstractHyperlink

java.lang.Object
  org.eclipse.xtext.ui.editor.hyperlinking.AbstractHyperlink

All Implemented Interfaces:

org.eclipse.jface.text.hyperlink.IHyperlink

Direct Known Subclasses:

JdtHyperlink, XtextHyperlink

public abstract class AbstractHyperlink
extends java.lang.Object
implements org.eclipse.jface.text.hyperlink.IHyperlink

Author:

Sebastian Zarnekow - Initial contribution and API

Constructor Summary

AbstractHyperlink()

Method Summary

org.eclipse.jface.text.Region	getHyperlinkRegion() The region covered by this type of hyperlink.
java.lang.String	getHyperlinkText() Optional text for this hyperlink.
java.lang.String	getTypeLabel() Optional label for this type of hyperlink.
void	setHyperlinkRegion(org.eclipse.jface.text.Region hyperlinkRegion)
void	setHyperlinkText(java.lang.String hyperlinkText)
void	setTypeLabel(java.lang.String typeLabel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jface.text.hyperlink.IHyperlink

open

Constructor Detail

AbstractHyperlink

public AbstractHyperlink()

Method Detail

getHyperlinkText

public java.lang.String getHyperlinkText()

Description copied from interface: org.eclipse.jface.text.hyperlink.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 org.eclipse.jface.text.hyperlink.IHyperlink

Returns:

the text or null if none

setHyperlinkText

public void setHyperlinkText(java.lang.String hyperlinkText)

getTypeLabel

public java.lang.String getTypeLabel()

Description copied from interface: org.eclipse.jface.text.hyperlink.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 org.eclipse.jface.text.hyperlink.IHyperlink

Returns:

the type label or null if none

setTypeLabel

public void setTypeLabel(java.lang.String typeLabel)

getHyperlinkRegion

public org.eclipse.jface.text.Region getHyperlinkRegion()

Description copied from interface: org.eclipse.jface.text.hyperlink.IHyperlink

The region covered by this type of hyperlink.

Specified by:

getHyperlinkRegion in interface org.eclipse.jface.text.hyperlink.IHyperlink

Returns:

the hyperlink region

setHyperlinkRegion

public void setHyperlinkRegion(org.eclipse.jface.text.Region hyperlinkRegion)