org.eclipse.xtext.ui.editor.hover
Class DispatchingEObjectTextHover

java.lang.Object
  org.eclipse.xtext.ui.editor.hover.AbstractHover
      org.eclipse.xtext.ui.editor.hover.AbstractEObjectHover
          org.eclipse.xtext.ui.editor.hover.DispatchingEObjectTextHover

All Implemented Interfaces:

org.eclipse.jface.text.ITextHover, org.eclipse.jface.text.ITextHoverExtension, org.eclipse.jface.text.ITextHoverExtension2, IEObjectHover, ISourceViewerAware

public class DispatchingEObjectTextHover
extends AbstractEObjectHover

Author:

Sven Efftinge - Initial contribution and API

Field Summary

Fields inherited from class org.eclipse.xtext.ui.editor.hover.AbstractHover

sourceViewer

Constructor Summary

DispatchingEObjectTextHover()

Method Summary

org.eclipse.jface.text.IInformationControlCreator	getHoverControlCreator() Returns the hover control creator of this text hover or null
java.lang.Object	getHoverInfo(org.eclipse.emf.ecore.EObject first, org.eclipse.jface.text.ITextViewer textViewer, org.eclipse.jface.text.IRegion hoverRegion)
java.lang.String	getHoverInfo(org.eclipse.jface.text.ITextViewer textViewer, org.eclipse.jface.text.IRegion hoverRegion) Deprecated.

Methods inherited from class org.eclipse.xtext.ui.editor.hover.AbstractEObjectHover

getHoverInfo2, getHoverRegion, getXtextElementAt, getXtextElementAt

Methods inherited from class org.eclipse.xtext.ui.editor.hover.AbstractHover

getDocument, getLineNumber, setSourceViewer

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatchingEObjectTextHover

public DispatchingEObjectTextHover()

Method Detail

getHoverInfo

public java.lang.Object getHoverInfo(org.eclipse.emf.ecore.EObject first,
                                     org.eclipse.jface.text.ITextViewer textViewer,
                                     org.eclipse.jface.text.IRegion hoverRegion)

Specified by:

getHoverInfo in interface IEObjectHover

Specified by:

getHoverInfo in class AbstractEObjectHover

getHoverControlCreator

public org.eclipse.jface.text.IInformationControlCreator getHoverControlCreator()

Description copied from interface: org.eclipse.jface.text.ITextHoverExtension

Returns the hover control creator of this text hover or null

Specified by:

getHoverControlCreator in interface org.eclipse.jface.text.ITextHoverExtension

Overrides:

getHoverControlCreator in class AbstractHover

Returns:

the hover control creator or null

getHoverInfo

@Deprecated
public java.lang.String getHoverInfo(org.eclipse.jface.text.ITextViewer textViewer,
                                                org.eclipse.jface.text.IRegion hoverRegion)

Deprecated.

Description copied from interface: org.eclipse.jface.text.ITextHover

Returns the information which should be presented when a hover popup is shown for the specified hover region. The hover region has the same semantics as the region returned by getHoverRegion. If the returned information is null or empty no hover popup will be shown.

Specified by:

getHoverInfo in interface org.eclipse.jface.text.ITextHover

Overrides:

getHoverInfo in class AbstractHover

Parameters:

textViewer - the viewer on which the hover popup should be shown

hoverRegion - the text range in the viewer which is used to determine the hover display information

Returns:

the hover popup display information, or null if none available