Package com.intellij.openapi.editor

Interface EditorGutter

All Known Implementing Classes:

EditorGutterComponentEx

public interface EditorGutter

Provides services for drawing custom text annotations in the editor gutter. Such annotations are used, for example, by the "Annotate" feature of version control integrations.
It's also possible to control the display of line numbers in gutter.

See Also:

Editor.getGutter()

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<EditorGutter>	KEY

Method Summary

Modifier and Type	Method and Description
void	closeAllAnnotations() Removes all text annotations from the gutter.
void	closeTextAnnotations(java.util.Collection<? extends TextAnnotationGutterProvider> annotations)
java.util.List<TextAnnotationGutterProvider>	getTextAnnotations()
boolean	isAnnotationsShown()
void	registerTextAnnotation(TextAnnotationGutterProvider provider) Adds a provider for drawing custom text annotations in the editor gutter.
void	registerTextAnnotation(TextAnnotationGutterProvider provider, EditorGutterAction action) Adds a provider for drawing custom text annotations in the editor gutter, with the possibility to execute an action when the annotation is clicked.
default void	setLineNumberConverter(LineNumberConverter converter) Changes the display of line numbers in gutter.
void	setLineNumberConverter(LineNumberConverter primaryConverter, LineNumberConverter additionalConverter) Changes the display of line numbers in gutter

Field Detail

KEY

static final DataKey<EditorGutter> KEY

Method Detail

registerTextAnnotation

void registerTextAnnotation(TextAnnotationGutterProvider provider)

Adds a provider for drawing custom text annotations in the editor gutter.

Parameters:

provider - the provider instance.

registerTextAnnotation

void registerTextAnnotation(TextAnnotationGutterProvider provider,
                            EditorGutterAction action)

Adds a provider for drawing custom text annotations in the editor gutter, with the possibility to execute an action when the annotation is clicked.

Parameters:

provider - the provider instance.

action - the action to execute when the annotation is clicked.

isAnnotationsShown

boolean isAnnotationsShown()

getTextAnnotations

java.util.List<TextAnnotationGutterProvider> getTextAnnotations()

closeAllAnnotations

void closeAllAnnotations()

Removes all text annotations from the gutter.

closeTextAnnotations

void closeTextAnnotations(java.util.Collection<? extends TextAnnotationGutterProvider> annotations)

setLineNumberConverter

default void setLineNumberConverter(LineNumberConverter converter)

Changes the display of line numbers in gutter. Disables showing additional line numbers.

See Also:

setLineNumberConverter(LineNumberConverter, LineNumberConverter)

setLineNumberConverter

void setLineNumberConverter(LineNumberConverter primaryConverter,
                            LineNumberConverter additionalConverter)

Changes the display of line numbers in gutter

Parameters:

primaryConverter - converter for primary line number shown in gutter

additionalConverter - if not null, defines an additional column of numbers to be displayed in gutter