Package org.eclipse.jface.text
Interface ITextHoverExtension2
public interface ITextHoverExtension2
Extension interface for
ITextHover
.
Provides a way for hovers to return hover-specific information objects.
- Since:
- 3.4
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetHoverInfo2
(ITextViewer textViewer, IRegion hoverRegion) Returns the information which should be presented when a hover popup is shown for the specified hover region.
-
Method Details
-
getHoverInfo2
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 byITextHover.getHoverRegion(ITextViewer, int)
. If the returned information isnull
, no hover popup will be shown.Note: Implementers have to ensure that
ITextHoverExtension.getHoverControlCreator()
returnsIInformationControl
s that implementIInformationControlExtension2
and whoseIInformationControlExtension2.setInput(Object)
can handle the information objects returned by this method.Callers should ignore the text returned by
ITextHover.getHoverInfo(ITextViewer, IRegion)
.- Parameters:
textViewer
- the viewer on which the hover popup should be shownhoverRegion
- 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
-