Package org.eclipse.jface.text
Interface ITextHover
- All Known Implementing Classes:
DefaultTextHover
public interface ITextHover
Computes the information to be shown in a hover popup which appears on top of the text viewer's
text widget when a hover event occurs. If the text hover does not provide information no hover
popup is shown. Any implementer of this interface must be capable of operating in a non-UI
thread.
In order to provide backward compatibility for clients of ITextHover
, extension
interfaces are used as a means of evolution. The following extension interfaces exist:
ITextHoverExtension
since version 3.0 allowing a text hover to provide a creator for the hover control. This allows for sophisticated hovers in a way that information computed by the hover can be displayed in the best possible form.ITextHoverExtension2
since version 3.4 allowing a text hover to return hover-specific information objects.
Clients may implement this interface.
-
Method Summary
Modifier and TypeMethodDescriptiongetHoverInfo
(ITextViewer textViewer, IRegion hoverRegion) Deprecated.getHoverRegion
(ITextViewer textViewer, int offset) Returns the text region which should serve as the source of information to compute the hover popup display information.
-
Method Details
-
getHoverInfo
Deprecated.As of 3.4, replaced byITextHoverExtension2.getHoverInfo2(ITextViewer, IRegion)
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 bygetHoverRegion
. If the returned information isnull
or empty no hover popup will be shown.- 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
-
getHoverRegion
Returns the text region which should serve as the source of information to compute the hover popup display information. The popup has been requested for the given offset.For example, if hover information can be provided on a per method basis in a source viewer, the offset should be used to find the enclosing method and the source range of the method should be returned.
- Parameters:
textViewer
- the viewer on which the hover popup should be shownoffset
- the offset for which the hover request has been issued- Returns:
- the hover region used to compute the hover display information
-
ITextHoverExtension2.getHoverInfo2(ITextViewer, IRegion)