Package org.eclipse.jface.text.source
Class DefaultAnnotationHover
- java.lang.Object
-
- org.eclipse.jface.text.source.DefaultAnnotationHover
-
- All Implemented Interfaces:
IAnnotationHover
public class DefaultAnnotationHover extends Object implements IAnnotationHover
Standard implementation ofIAnnotationHover.- Since:
- 3.2
-
-
Constructor Summary
Constructors Constructor Description DefaultAnnotationHover()Creates a new default annotation hover.DefaultAnnotationHover(boolean showLineNumber)Creates a new default annotation hover.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StringformatMultipleMessages(List<String> messages)Hook method to formats the given messages.protected StringformatSingleMessage(String message)Hook method to format the given single message.StringgetHoverInfo(ISourceViewer sourceViewer, int lineNumber)Returns the text which should be presented in the a hover popup window.protected booleanisIncluded(Annotation annotation)Tells whether the annotation should be included in the computation.
-
-
-
Constructor Detail
-
DefaultAnnotationHover
public DefaultAnnotationHover()
Creates a new default annotation hover.- Since:
- 3.4
-
DefaultAnnotationHover
public DefaultAnnotationHover(boolean showLineNumber)
Creates a new default annotation hover.- Parameters:
showLineNumber-trueif the line number should be shown when no annotation is found- Since:
- 3.4
-
-
Method Detail
-
getHoverInfo
public String getHoverInfo(ISourceViewer sourceViewer, int lineNumber)
Description copied from interface:IAnnotationHoverReturns the text which should be presented in the a hover popup window. This information is requested based on the specified line number.- Specified by:
getHoverInfoin interfaceIAnnotationHover- Parameters:
sourceViewer- the source viewer this hover is registered withlineNumber- the line number for which information is requested- Returns:
- the requested information or
nullif no such information exists
-
isIncluded
protected boolean isIncluded(Annotation annotation)
Tells whether the annotation should be included in the computation.- Parameters:
annotation- the annotation to test- Returns:
trueif the annotation is included in the computation
-
formatSingleMessage
protected String formatSingleMessage(String message)
Hook method to format the given single message.Subclasses can change this to create a different format like HTML.
- Parameters:
message- the message to format- Returns:
- the formatted message
-
-