org.eclipse.jface.text
Interface ITextHover

public interface ITextHover

Provides a hover popup which appears on top of the text viewer with relevant display information. 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.

Clients may implement this interface.

See Also:

ITextViewer

Method Summary

String	getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) Returns the text which should be presented if a hover popup is shown for the specified hover region.
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.

Method Detail

getHoverInfo

public String getHoverInfo(ITextViewer textViewer,
                           IRegion hoverRegion)

Returns the text which should be presented if 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 string is null or empty no hover popup will be shown.

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

getHoverRegion

public 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. 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 shown

offset - the offset for which the hover request has been issued

Returns:

the hover region used to compute the hover display information