|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Extension interface for ITextHover
.
Provides a way for hovers to return hover-specific information objects.
ITextHover
Method Summary | |
Object |
getHoverInfo2(ITextViewer textViewer,
IRegion hoverRegion)
Returns the information which should be presented when a hover popup is shown for the specified hover region. |
Method Detail |
public Object getHoverInfo2(ITextViewer textViewer, IRegion hoverRegion)
ITextHover.getHoverRegion(ITextViewer, int)
.
If the returned information is null
, no hover popup will be shown.
Note: Implementers have to ensure that ITextHoverExtension.getHoverControlCreator()
returns IInformationControl
s that implement
IInformationControlExtension2
and whose
IInformationControlExtension2.setInput(Object)
can handle the
information objects returned by this method.
Callers should ignore the text returned by ITextHover.getHoverInfo(ITextViewer, IRegion)
.
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
null
if none available
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.