public interface ITextHover
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.
ITextHoverExtension
,
ITextHoverExtension2
,
ITextViewer
Modifier and Type | Method and Description |
---|---|
String |
getHoverInfo(ITextViewer textViewer,
IRegion hoverRegion)
Deprecated.
As of 3.4, replaced by
ITextHoverExtension2.getHoverInfo2(ITextViewer, IRegion) |
IRegion |
getHoverRegion(ITextViewer textViewer,
int offset)
Returns the text region which should serve as the source of information
to compute the hover popup display information.
|
String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion)
ITextHoverExtension2.getHoverInfo2(ITextViewer, IRegion)
getHoverRegion
. If the returned
information is null
or empty no hover popup will be shown.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 informationnull
if none availableIRegion getHoverRegion(ITextViewer textViewer, int 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.
textViewer
- the viewer on which the hover popup should be shownoffset
- the offset for which the hover request has been issued
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.