Package com.intellij.openapi.editor.event

Interface CaretListener

All Superinterfaces:

java.util.EventListener

All Known Subinterfaces:

EditorEventListener

All Known Implementing Classes:

CaretAdapter, EditorMarkupModelImpl, EditPropertyValueTooltipManager, LightEditPositionWidget, PositionPanel, SearchResults, SelectInEditorManagerImpl, SubstitutionShortInfoHandler

public interface CaretListener
extends java.util.EventListener

Allows to receive notifications about caret movement, and caret additions/removal

See Also:

CaretModel.addCaretListener(CaretListener), EditorEventMulticaster.addCaretListener(CaretListener, Disposable)

Method Summary

Modifier and Type	Method and Description
default void	caretAdded(CaretEvent event) Called when a new caret was added to the document.
default void	caretPositionChanged(CaretEvent event) Called when the caret position has changed.
default void	caretRemoved(CaretEvent event) Called when a caret was removed from the document.

Method Detail

caretPositionChanged

default void caretPositionChanged(CaretEvent event)

Called when the caret position has changed.

Only explicit caret movements (caused by 'move' methods in Caret and CaretModel) are reported, 'induced' changes of caret offset due to document modifications are not reported.

Parameters:

event - the event containing information about the caret movement.

caretAdded

default void caretAdded(CaretEvent event)

Called when a new caret was added to the document.

caretRemoved

default void caretRemoved(CaretEvent event)

Called when a caret was removed from the document.