|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.Clients may implement this interface.
ITextHoverExtension
,
ITextViewer
Method Summary | |
---|---|
String |
getHoverInfo(ITextViewer textViewer,
IRegion hoverRegion)
Returns the information which should be presented when 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 |
public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion)
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 information
public IRegion 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
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.