Eclipse Platform
Release 3.0

org.eclipse.jface.text.source
Interface IAnnotationHover

All Known Implementing Classes:
LineChangeHover

public interface IAnnotationHover

Provides the information to be displayed in a hover popup window which appears over the presentation area of annotations.

In order to provide backward compatibility for clients of IAnnotationHover, extension interfaces are used as a means of evolution. The following extension interfaces exist:

Clients may implement this interface.

See Also:
IAnnotationHoverExtension

Method Summary
 String getHoverInfo(ISourceViewer sourceViewer, int lineNumber)
          Returns the text which should be presented in the a hover popup window.
 

Method Detail

getHoverInfo

public String getHoverInfo(ISourceViewer sourceViewer,
                           int lineNumber)
Returns the text which should be presented in the a hover popup window. This information is requested based on the specified line number.

Parameters:
sourceViewer - the source viewer this hover is registered with
lineNumber - the line number for which information is requested
Returns:
the requested information or null if no such information exists

Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.