Package com.intellij.openapi.fileEditor

Interface FileEditorProvider

All Known Subinterfaces:

AsyncFileEditorProvider, DefaultPlatformFileEditorProvider

All Known Implementing Classes:

EditorConfigEditorProvider, LargeFileEditorProvider, LargeFileEditorProvider, MarkdownPreviewFileEditorProvider, MarkdownSplitEditorProvider, PerspectiveFileEditorProvider, PsiAwareTextEditorProvider, ResourceBundleEditorProvider, RestSplitEditorProvider, SceneBuilderEditorProvider, SplitTextEditorProvider, TerminalSessionEditorProvider, TextEditorProvider, UIFormEditorProvider, WeighedFileEditorProvider

public interface FileEditorProvider

Should be registered via EP_FILE_EDITOR_PROVIDER.

See Also:

DumbAware

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<FileEditorProvider>	EP_FILE_EDITOR_PROVIDER
static Key<FileEditorProvider>	KEY

Method Summary

Modifier and Type	Method and Description
boolean	accept(Project project, VirtualFile file) Method is expected to run fast.
FileEditor	createEditor(Project project, VirtualFile file) Creates editor for the specified file.
default void	disposeEditor(FileEditor editor) Disposes the specified editor.
java.lang.String	getEditorTypeId()
FileEditorPolicy	getPolicy()
default FileEditorState	readState(Element sourceElement, Project project, VirtualFile file) Deserialize state from the specified sourceElement.
default void	writeState(FileEditorState state, Project project, Element targetElement) Serializes state into the specified targetElement.

Field Detail

EP_FILE_EDITOR_PROVIDER

static final ExtensionPointName<FileEditorProvider> EP_FILE_EDITOR_PROVIDER

KEY

static final Key<FileEditorProvider> KEY

Method Detail

accept

boolean accept(Project project,
               VirtualFile file)

Method is expected to run fast.

Parameters:

file - file to be tested for acceptance.

Returns:

true if provider can create valid editor for the specified file.

createEditor

FileEditor createEditor(Project project,
                        VirtualFile file)

Creates editor for the specified file.

This method is called only if the provider has accepted this file (i.e. method accept(Project, VirtualFile) returned true). The provider should return only valid editor.

Returns:

created editor for specified file.

disposeEditor

default void disposeEditor(FileEditor editor)

Disposes the specified editor. It is guaranteed that this method is invoked only for editors created with this provider.

Parameters:

editor - editor to be disposed.

readState

default FileEditorState readState(Element sourceElement,
                                  Project project,
                                  VirtualFile file)

Deserialize state from the specified sourceElement.

writeState

default void writeState(FileEditorState state,
                        Project project,
                        Element targetElement)

Serializes state into the specified targetElement.

getEditorTypeId

java.lang.String getEditorTypeId()

Returns:

id of type of the editors created with this FileEditorProvider. Each FileEditorProvider should have unique nonnull id. The id is used for saving/loading of EditorStates.

getPolicy

FileEditorPolicy getPolicy()

Returns:

policy that specifies how editor created via this provider should be opened.

See Also:

FileEditorPolicy.NONE, FileEditorPolicy.HIDE_DEFAULT_EDITOR, FileEditorPolicy.PLACE_BEFORE_DEFAULT_EDITOR