org.eclipse.xtext.ui.editor.hyperlinking

Class SingleHoverShowingHyperlinkPresenter

java.lang.Object

org.eclipse.xtext.ui.editor.hyperlinking.SingleHoverShowingHyperlinkPresenter

All Implemented Interfaces:

InvocationHandler

@FinalFieldsConstructor
public class SingleHoverShowingHyperlinkPresenter
extends Object
implements InvocationHandler

The MultipleHyperLinkPresenter only shows the hyper link text when more then one hyper link exists. This is not always desired as some hyperlinks might have special meaning, and without showing the user what the hyperlink does only simple go to declaration hyperlinks should be treated like that. Thus this class introduces a protocol for IHyperLinks to make sure their label is shown even if they are the only one. To do so the property IHyperLink#getTypeLabel needs to be set to the constant SHOW_ALWAYS.

Since:

2.8

Author:

Sven Efftinge - Initial contribution and API

Field Summary

Fields

Modifier and Type	Field and Description
static String	SHOW_ALWAYS constant text needs to set into IHyperLink#getTypeLabel (which doesn't seem to be used otherwise) if a hyperlink's label should be shown even if it's the only hyper link.

Constructor Summary

Constructors

Constructor and Description
SingleHoverShowingHyperlinkPresenter(org.eclipse.jface.text.hyperlink.MultipleHyperlinkPresenter delegate)

Method Summary

Methods

Modifier and Type	Method and Description
Object	invoke(Object proxy, Method method, Object[] args)
protected org.eclipse.jface.text.hyperlink.IHyperlink[]	makeNullsafe(org.eclipse.jface.text.hyperlink.IHyperlink[] arr)

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_ALWAYS

public static final String SHOW_ALWAYS

constant text needs to set into IHyperLink#getTypeLabel (which doesn't seem to be used otherwise) if a hyperlink's label should be shown even if it's the only hyper link.

See Also:

Constant Field Values

Constructor Detail

SingleHoverShowingHyperlinkPresenter

public SingleHoverShowingHyperlinkPresenter(org.eclipse.jface.text.hyperlink.MultipleHyperlinkPresenter delegate)

Method Detail

invoke

public Object invoke(Object proxy,
            Method method,
            Object[] args)
              throws Throwable

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable

makeNullsafe

protected org.eclipse.jface.text.hyperlink.IHyperlink[] makeNullsafe(org.eclipse.jface.text.hyperlink.IHyperlink[] arr)

Since:

2.9