org.eclipse.xtext.ui.editor.hover

Class AbstractCompositeHover

java.lang.Object

org.eclipse.xtext.ui.editor.hover.AbstractCompositeHover

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultCompositeHover

public abstract class AbstractCompositeHover
extends java.lang.Object
implements org.eclipse.jface.text.ITextHover, org.eclipse.jface.text.ITextHoverExtension, org.eclipse.jface.text.ITextHoverExtension2, ISourceViewerAware

The CompositeHover is a hover which delegates calls to a list of hovers. It iterates through this list of hovers and chooses the first one which provides a region in getHoverRegion(). Override the method createHovers() to configure the list of hovers.

Author:

Christoph Kulla - Initial contribution and API, Holger Schill

Constructor Summary

Constructors

Constructor and Description
AbstractCompositeHover()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.util.List<org.eclipse.jface.text.ITextHover>	createHovers()
org.eclipse.jface.text.IInformationControlCreator	getHoverControlCreator()
java.lang.String	getHoverInfo(org.eclipse.jface.text.ITextViewer textViewer, org.eclipse.jface.text.IRegion hoverRegion) Deprecated.
java.lang.Object	getHoverInfo2(org.eclipse.jface.text.ITextViewer textViewer, org.eclipse.jface.text.IRegion hoverRegion)
org.eclipse.jface.text.IRegion	getHoverRegion(org.eclipse.jface.text.ITextViewer textViewer, int offset)
java.util.List<org.eclipse.jface.text.ITextHover>	getHovers()
void	setSourceViewer(org.eclipse.jface.text.source.ISourceViewer sourceViewer)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCompositeHover

public AbstractCompositeHover()

Method Detail

getHovers

public java.util.List<org.eclipse.jface.text.ITextHover> getHovers()

createHovers

protected abstract java.util.List<org.eclipse.jface.text.ITextHover> createHovers()

setSourceViewer

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

Specified by:

setSourceViewer in interface ISourceViewerAware

getHoverRegion

public org.eclipse.jface.text.IRegion getHoverRegion(org.eclipse.jface.text.ITextViewer textViewer,
                                            int offset)

Specified by:

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

getHoverInfo

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

Deprecated.

Specified by:

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

getHoverInfo2

public java.lang.Object getHoverInfo2(org.eclipse.jface.text.ITextViewer textViewer,
                             org.eclipse.jface.text.IRegion hoverRegion)

Specified by:

getHoverInfo2 in interface org.eclipse.jface.text.ITextHoverExtension2

getHoverControlCreator

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

Specified by:

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