Package com.intellij.openapi.editor

Interface TextAnnotationGutterProvider

All Known Subinterfaces:

ActiveAnnotationGutter

All Known Implementing Classes:

AnnotationFieldGutter, AnnotationGutterLineConvertorProxy, AspectAnnotationFieldGutter, ExtraFieldGutter

public interface TextAnnotationGutterProvider

Interface which should be implemented in order to draw custom text annotations in the editor gutter.

See Also:

EditorGutter.registerTextAnnotation(TextAnnotationGutterProvider)

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getBgColor(int line, Editor editor) Returns the background color for the text
ColorKey	getColor(int line, Editor editor)
java.lang.String	getLineText(int line, Editor editor) Returns the text which should be drawn for the line with the specified number in the specified editor.
java.util.List<AnAction>	getPopupActions(int line, Editor editor) enables annotation view modifications
EditorFontType	getStyle(int line, Editor editor)
java.lang.String	getToolTip(int line, Editor editor)
void	gutterClosed() Called when the annotations are removed from the editor gutter.
default boolean	useMargin() If true, a couple of pixels will be added at both sides of displayed text (if it's not empty), otherwise the width of annotation will be equal to the width of provided text.

Method Detail

getLineText

java.lang.String getLineText(int line,
                             Editor editor)

Returns the text which should be drawn for the line with the specified number in the specified editor.

Parameters:

line - the line for which the text is requested.

editor - the editor in which the text will be drawn.

Returns:

the text to draw, or null if no text should be drawn.

getToolTip

java.lang.String getToolTip(int line,
                            Editor editor)

getStyle

EditorFontType getStyle(int line,
                        Editor editor)

getColor

ColorKey getColor(int line,
                  Editor editor)

getBgColor

java.awt.Color getBgColor(int line,
                          Editor editor)

Returns the background color for the text

Parameters:

line - the line for which the background color is requested.

editor - the editor in which the text will be drawn.

Returns:

the text to draw, or null if no text should be drawn.

getPopupActions

java.util.List<AnAction> getPopupActions(int line,
                                         Editor editor)

enables annotation view modifications

gutterClosed

void gutterClosed()

Called when the annotations are removed from the editor gutter.

See Also:

EditorGutter.closeAllAnnotations()

useMargin

default boolean useMargin()

If true, a couple of pixels will be added at both sides of displayed text (if it's not empty), otherwise the width of annotation will be equal to the width of provided text.