org.eclipse.xtext.ui.editor.hyperlinking

Class HyperlinkHelper

java.lang.Object

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

All Implemented Interfaces:

IHyperlinkHelper

public class HyperlinkHelper
extends Object
implements IHyperlinkHelper

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HyperlinkHelper.HyperlinkAcceptor

Constructor Summary

Constructors

Constructor and Description
HyperlinkHelper()

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.jface.text.hyperlink.IHyperlink[]	createHyperlinksByOffset(XtextResource resource, int offset, boolean createMultipleHyperlinks) Create hyperlinks at the given offset.
void	createHyperlinksByOffset(XtextResource resource, int offset, 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.
void	createHyperlinksTo(XtextResource from, org.eclipse.jface.text.Region region, org.eclipse.emf.ecore.EObject target, IHyperlinkAcceptor acceptor) Produces hyperlinks for the given region that point to the referenced target.
protected EObjectAtOffsetHelper	getEObjectAtOffsetHelper()
protected com.google.inject.Provider<XtextHyperlink>	getHyperlinkProvider()
protected org.eclipse.jface.viewers.ILabelProvider	getLabelProvider()
protected INode	getParentNodeWithCrossReference(INode startNode) Deprecated. use EObjectAtOffsetHelper.getCrossReferenceNode(XtextResource, org.eclipse.xtext.util.ITextRegion)

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperlinkHelper

public HyperlinkHelper()

Method Detail

getHyperlinkProvider

protected com.google.inject.Provider<XtextHyperlink> getHyperlinkProvider()

getLabelProvider

protected org.eclipse.jface.viewers.ILabelProvider getLabelProvider()

getEObjectAtOffsetHelper

protected EObjectAtOffsetHelper getEObjectAtOffsetHelper()

Since:

2.5

createHyperlinksByOffset

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

Description copied from interface: IHyperlinkHelper

Create hyperlinks at the given offset. Return null if no hyperlinks are available.

Specified by:

createHyperlinksByOffset in interface IHyperlinkHelper

createHyperlinksByOffset

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

createHyperlinksTo

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.

Since:

2.4

See Also:

createHyperlinksTo(XtextResource, Region, EObject, IHyperlinkAcceptor)

getParentNodeWithCrossReference

@Deprecated
protected INode getParentNodeWithCrossReference(INode startNode)

Deprecated. use EObjectAtOffsetHelper.getCrossReferenceNode(XtextResource, org.eclipse.xtext.util.ITextRegion)

createHyperlinksTo

public void createHyperlinksTo(XtextResource from,
                      org.eclipse.jface.text.Region region,
                      org.eclipse.emf.ecore.EObject target,
                      IHyperlinkAcceptor acceptor)

Produces hyperlinks for the given region that point to the referenced target.