|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectorg.eclipse.jface.text.DefaultTextHover
Standard implementation of ITextHover.
| Constructor Summary | |
|---|---|
DefaultTextHover(ISourceViewer sourceViewer)
Creates a new annotation hover. |
|
| 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. |
protected boolean |
isIncluded(Annotation annotation)
Tells whether the annotation should be included in the computation. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public DefaultTextHover(ISourceViewer sourceViewer)
sourceViewer - this hover's annotation model| Method Detail |
public String getHoverInfo(ITextViewer textViewer,
IRegion hoverRegion)
ITextHovergetHoverRegion. If the returned
information is null or empty no hover popup will be shown.
getHoverInfo in interface ITextHovertextViewer - 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)
ITextHoverFor 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.
getHoverRegion in interface ITextHovertextViewer - the viewer on which the hover popup should be shownoffset - the offset for which the hover request has been issued
protected boolean isIncluded(Annotation annotation)
annotation - the annotation to test
true if the annotation is included in the computation
|
Eclipse Platform Release 3.3 |
|||||||||||
| 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, 2007. All rights reserved.