Package com.intellij.openapi.editor.event

Interface DocumentListener

All Superinterfaces:

java.util.EventListener

All Known Subinterfaces:

BulkAwareDocumentListener, BulkAwareDocumentListener.Simple, EditorEventListener, EditorHighlighter, PrioritizedDocumentListener

All Known Implementing Classes:

CaretModelImpl, ChangeSignatureDialogBase.UpdateSignatureListener, ComboboxEditorTextField, DocumentAdapter, DocumentUndoProvider, EditorComboBox, EditorMarkupModelImpl, EditorTextField, EmptyEditorHighlighter, FoldingModelImpl, FragmentedEditorHighlighter, GrMethodSignatureComponent, GroovyEditorHighlighter, InlayModelImpl, InplaceChangeSignature, JBTableRowEditor.RowEditorChangeListener, LanguageTextField, LayeredLexerEditorHighlighter, LexerEditorHighlighter, LightEditPositionWidget, LivePreview, LookupOffsets, MethodSignatureComponent, PositionPanel, PsiDocumentManagerBase, PsiDocumentManagerBase.PriorityEventCollector, PsiDocumentManagerImpl, PushTargetTextField, PyConsoleStartFolding, PythonEditorHighlighter, QuickEditHandler, RangeMarkerSpy, RestEditorHighlighter, SearchResults, SoftWrapModelImpl, StructuralSearchDialog, SubstitutionShortInfoHandler, TextFieldWithAutoCompletion, TextFieldWithCompletion, TextViewer

public interface DocumentListener
extends java.util.EventListener

Allows to receive notifications about changes in edited documents. Implementations shouldn't modify the document, for which event is emitted, in listener methods.

Implement BulkAwareDocumentListener.Simple instead of this interface whenever possible to improve performance.

See Also:

Document.addDocumentListener(DocumentListener), Document.addDocumentListener(DocumentListener, Disposable), EditorEventMulticaster.addDocumentListener(DocumentListener, Disposable)

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayFactory<DocumentListener>	ARRAY_FACTORY
static DocumentListener[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
default void	beforeDocumentChange(DocumentEvent event) Called before the text of the document is changed.
default void	bulkUpdateFinished(Document document) Notifies about bulk mode being disabled.
default void	bulkUpdateStarting(Document document) Notifies about bulk mode being enabled.
default void	documentChanged(DocumentEvent event) Called after the text of the document has been changed.

Field Detail

EMPTY_ARRAY

static final DocumentListener[] EMPTY_ARRAY

ARRAY_FACTORY

static final ArrayFactory<DocumentListener> ARRAY_FACTORY

Method Detail

beforeDocumentChange

default void beforeDocumentChange(DocumentEvent event)

Called before the text of the document is changed.

Parameters:

event - the event containing the information about the change.

documentChanged

default void documentChanged(DocumentEvent event)

Called after the text of the document has been changed.

Parameters:

event - the event containing the information about the change.

bulkUpdateStarting

default void bulkUpdateStarting(Document document)

Notifies about bulk mode being enabled.

bulkUpdateFinished

default void bulkUpdateFinished(Document document)

Notifies about bulk mode being disabled.