org.eclipse.xtext.xbase.ui.navigation

Class XbaseHyperLinkHelper

java.lang.Object

org.eclipse.xtext.ui.editor.hyperlinking.HyperlinkHelper

org.eclipse.xtext.common.types.xtext.ui.TypeAwareHyperlinkHelper

org.eclipse.xtext.xbase.ui.navigation.XbaseHyperLinkHelper

All Implemented Interfaces:

IHyperlinkHelper, ISourceViewerAware

Direct Known Subclasses:

StaticallyImportedMemberAwareHyperlinkHelper

public class XbaseHyperLinkHelper
extends TypeAwareHyperlinkHelper
implements ISourceViewerAware

Author:

Dennis Huebner - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	XbaseHyperLinkHelper.XbaseHyperlinkAcceptor An acceptor that knows if it can accept more than one useful hyperlink.

Nested classes/interfaces inherited from class org.eclipse.xtext.ui.editor.hyperlinking.HyperlinkHelper

HyperlinkHelper.HyperlinkAcceptor

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jface.text.source.ISourceViewer	sourceViewer

Constructor Summary

Constructors

Constructor and Description
XbaseHyperLinkHelper()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addOpenInferredTypeHyperlink(XtextResource resource, JvmIdentifiableElement typedElement, ILeafNode node, IHyperlinkAcceptor acceptor)
protected boolean	canBeOverridden(org.eclipse.jdt.core.IMethod method)
protected boolean	canShowMany(IHyperlinkAcceptor acceptor) Returns false if the acceptor can definitely not accept more than one hyperlink.
org.eclipse.jface.text.hyperlink.IHyperlink[]	createHyperlinksByOffset(XtextResource resource, int offset, boolean createMultipleHyperlinks) If multiple links are requested, all ambiguous candidates are provided for feature and constructor calls.
void	createHyperlinksByOffset(XtextResource resource, int offset, IHyperlinkAcceptor acceptor)
protected void	createHyperlinksForCrossRef(XtextResource resource, INode crossRefNode, IHyperlinkAcceptor acceptor)
protected void	createHyperlinksTo(XtextResource resource, INode node, org.eclipse.emf.ecore.EObject target, IHyperlinkAcceptor acceptor) Produces hyperlinks for the given node which is associated with a cross reference that points to the referenced target.
IBatchTypeResolver	getBatchTypeResolver()
protected boolean	isNameNode(org.eclipse.emf.ecore.EObject element, org.eclipse.emf.ecore.EStructuralFeature feature, ILeafNode node)
void	setSourceViewer(org.eclipse.jface.text.source.ISourceViewer sourceViewer)

Methods inherited from class org.eclipse.xtext.common.types.xtext.ui.TypeAwareHyperlinkHelper

createHyperlinksTo, getJdtHyperlinkFactory, setJdtHyperlinkFactory

Methods inherited from class org.eclipse.xtext.ui.editor.hyperlinking.HyperlinkHelper

getEObjectAtOffsetHelper, getHyperlinkProvider, getLabelProvider, getParentNodeWithCrossReference

Methods inherited from class java.lang.Object

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

Field Detail

sourceViewer

protected org.eclipse.jface.text.source.ISourceViewer sourceViewer

Constructor Detail

XbaseHyperLinkHelper

public XbaseHyperLinkHelper()

Method Detail

setSourceViewer

public void setSourceViewer(org.eclipse.jface.text.source.ISourceViewer sourceViewer)

Specified by:

setSourceViewer in interface ISourceViewerAware

createHyperlinksByOffset

public org.eclipse.jface.text.hyperlink.IHyperlink[] createHyperlinksByOffset(XtextResource resource,
                                                                     int offset,
                                                                     boolean createMultipleHyperlinks)

If multiple links are requested, all ambiguous candidates are provided for feature and constructor calls.

Specified by:

createHyperlinksByOffset in interface IHyperlinkHelper

Overrides:

createHyperlinksByOffset in class HyperlinkHelper

createHyperlinksByOffset

public void createHyperlinksByOffset(XtextResource resource,
                            int offset,
                            IHyperlinkAcceptor acceptor)

Overrides:

createHyperlinksByOffset in class HyperlinkHelper

canShowMany

protected boolean canShowMany(IHyperlinkAcceptor acceptor)

Returns false if the acceptor can definitely not accept more than one hyperlink. Otherwise or if in doubt, returns true. Only handles XbaseHyperlinkAcceptors well. All other cases will assume true.

Since:

2.8

addOpenInferredTypeHyperlink

protected void addOpenInferredTypeHyperlink(XtextResource resource,
                                JvmIdentifiableElement typedElement,
                                ILeafNode node,
                                IHyperlinkAcceptor acceptor)

isNameNode

protected boolean isNameNode(org.eclipse.emf.ecore.EObject element,
                 org.eclipse.emf.ecore.EStructuralFeature feature,
                 ILeafNode node)

createHyperlinksForCrossRef

protected void createHyperlinksForCrossRef(XtextResource resource,
                               INode crossRefNode,
                               IHyperlinkAcceptor acceptor)

canBeOverridden

protected boolean canBeOverridden(org.eclipse.jdt.core.IMethod method)

createHyperlinksTo

protected void createHyperlinksTo(XtextResource resource,
                      INode node,
                      org.eclipse.emf.ecore.EObject target,
                      IHyperlinkAcceptor acceptor)

Description copied from class: HyperlinkHelper

Produces hyperlinks for the given node which is associated with a cross reference that points to the referenced target.

Overrides:

createHyperlinksTo in class HyperlinkHelper

See Also:

HyperlinkHelper.createHyperlinksTo(XtextResource, Region, EObject, IHyperlinkAcceptor)

getBatchTypeResolver

public IBatchTypeResolver getBatchTypeResolver()