Package com.intellij.openapi.fileEditor

Interface FileDocumentManagerListener

All Superinterfaces:

java.util.EventListener

All Known Implementing Classes:

EncodingManager, FileDocumentManagerAdapter, LineEndingsManager, TrailingSpacesStripper

public interface FileDocumentManagerListener
extends java.util.EventListener

See Also:

AppTopics.FILE_DOCUMENT_SYNC

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<FileDocumentManagerListener>	EP_NAME There is a possible case that callback that listens for the events implied by the current interface needs to modify document contents (e.g.

Method Summary

Modifier and Type	Method and Description
default void	beforeAllDocumentsSaving() Fired before processing FileDocumentManager.saveAllDocuments().
default void	beforeDocumentSaving(Document document) NOTE: Vetoing facility is deprecated in this listener implement FileDocumentSynchronizationVetoer instead.
default void	beforeFileContentReload(VirtualFile file, Document document) NOTE: Vetoing facility is deprecated in this listener implement FileDocumentSynchronizationVetoer instead.
default void	fileContentLoaded(VirtualFile file, Document document)
default void	fileContentReloaded(VirtualFile file, Document document)
default void	fileWithNoDocumentChanged(VirtualFile file)
default void	unsavedDocumentDropped(Document document)
default void	unsavedDocumentsDropped()

Field Detail

EP_NAME

static final ExtensionPointName<FileDocumentManagerListener> EP_NAME

There is a possible case that callback that listens for the events implied by the current interface needs to modify document contents (e.g. strip trailing spaces before saving a document). It's too dangerous to do that from message bus callback because that may cause unexpected 'nested modification' (see IDEA-71701 for more details).

That's why this interface is exposed via extension point as well - it's possible to modify document content from the extension callback.

Method Detail

beforeAllDocumentsSaving

default void beforeAllDocumentsSaving()

Fired before processing FileDocumentManager.saveAllDocuments(). Can be used by plugins which need to perform additional save operations when documents, rather than settings, are saved.

beforeDocumentSaving

default void beforeDocumentSaving(Document document)

NOTE: Vetoing facility is deprecated in this listener implement FileDocumentSynchronizationVetoer instead.

beforeFileContentReload

default void beforeFileContentReload(VirtualFile file,
                                     Document document)

NOTE: Vetoing facility is deprecated in this listener implement FileDocumentSynchronizationVetoer instead.

fileWithNoDocumentChanged

default void fileWithNoDocumentChanged(VirtualFile file)

fileContentReloaded

default void fileContentReloaded(VirtualFile file,
                                 Document document)

fileContentLoaded

default void fileContentLoaded(VirtualFile file,
                               Document document)

unsavedDocumentDropped

default void unsavedDocumentDropped(Document document)

unsavedDocumentsDropped

default void unsavedDocumentsDropped()