org.eclipse.xtext.ui.editor.hover
Interface IEObjectHoverProvider

All Known Implementing Classes:

DefaultEObjectHoverProvider, JdtHoverProvider, XbaseHoverProvider, XtendHoverProvider

public interface IEObjectHoverProvider

Author:

Sven Efftinge - Initial contribution and API

Nested Class Summary

static interface

IEObjectHoverProvider.IInformationControlCreatorProvider

Method Summary

IEObjectHoverProvider.IInformationControlCreatorProvider

getHoverInfo(org.eclipse.emf.ecore.EObject object, org.eclipse.jface.text.ITextViewer viewer, org.eclipse.jface.text.IRegion region)

Method Detail

getHoverInfo

IEObjectHoverProvider.IInformationControlCreatorProvider getHoverInfo(org.eclipse.emf.ecore.EObject object,
                                                                      org.eclipse.jface.text.ITextViewer viewer,
                                                                      org.eclipse.jface.text.IRegion region)

Parameters:

object - EObject for which to show an information hover.

viewer - - might not contain the given EObject.

region - - might be a cross reference pointing to the given object.

Returns:

an to be shown in a hover pop up, returns null if no hover information exists for the given element.