Package com.intellij.openapi.fileEditor

Interface FileEditor

All Superinterfaces:

Disposable, UserDataHolder

All Known Subinterfaces:

DocumentsEditor, ImageFileEditor, LargeFileEditor, NavigatableFileEditor, TextEditor

All Known Implementing Classes:

BaseRemoteFileEditor, DesignerEditor, DomFileEditor, EditorConfigEditorWithPreview, EditorConfigPreviewFileEditor, LargeFileEditorImpl, LargeFileEditorProvider.LargeTextFileEditor, MarkdownPreviewFileEditor, MarkdownSplitEditor, PerspectiveFileEditor, PsiAwareTextEditorImpl, ResourceBundleEditor, RestPreviewFileEditor, SceneBuilderEditor, SplitFileEditor, TerminalSessionEditor, TextEditorImpl, TextEditorProvider.EditorWrapper, TextEditorWithPreview, UIFormEditor

public interface FileEditor
extends UserDataHolder, Disposable

See Also:

TextEditor

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_MODIFIED
static java.lang.String	PROP_VALID

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Removes specified listener
default void	deselectNotify() This method is invoked each time when the editor is deselected.
default BackgroundEditorHighlighter	getBackgroundHighlighter()
javax.swing.JComponent	getComponent()
FileEditorLocation	getCurrentLocation() The method is optional.
default VirtualFile	getFile()
java.lang.String	getName()
javax.swing.JComponent	getPreferredFocusedComponent() Returns component to be focused when editor is opened.
default FileEditorState	getState(FileEditorStateLevel level)
default StructureViewBuilder	getStructureViewBuilder()
boolean	isModified()
boolean	isValid()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Adds specified listener
default void	selectNotify() This method is invoked each time when the editor is selected.
void	setState(FileEditorState state) Applies given state to the editor.
default void	setState(FileEditorState state, boolean exactState) In some cases, it's desirable to set state exactly as requested (e.g.

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Field Detail

PROP_MODIFIED

static final java.lang.String PROP_MODIFIED

See Also:

isModified(), Constant Field Values

PROP_VALID

static final java.lang.String PROP_VALID

See Also:

isValid(), Constant Field Values

Method Detail

getComponent

javax.swing.JComponent getComponent()

Returns:

component which represents editor in the UI. The method should never return null.

getPreferredFocusedComponent

javax.swing.JComponent getPreferredFocusedComponent()

Returns component to be focused when editor is opened.

getName

java.lang.String getName()

Returns:

editor's name, a string that identifies editor among other editors. For example, UI form might have two editor: "GUI Designer" and "Text". So "GUI Designer" can be a name of one editor and "Text" can be a name of other editor. The method should never return null.

getState

default FileEditorState getState(FileEditorStateLevel level)

Returns:

editor's internal state. Method should never return null.

setState

void setState(FileEditorState state)

Applies given state to the editor.

Parameters:

state - cannot be null

setState

default void setState(FileEditorState state,
                      boolean exactState)

In some cases, it's desirable to set state exactly as requested (e.g. on tab splitting), in other cases a different behaviour is preferred, e.g. bringing caret into view on text editor opening. This method passes additional flag to FileEditor to indicate the desired way to set state.

isModified

boolean isModified()

Returns:

whether the editor's content is modified in comparison with its file.

isValid

boolean isValid()

Returns:

whether the editor is valid or not. An editor is valid if the contents displayed in it still exists. For example, an editor displaying the contents of a file stops being valid if the file is deleted. Editor can also become invalid when it's disposed.

selectNotify

default void selectNotify()

This method is invoked each time when the editor is selected. This can happen in two cases: editor is selected because the selected file has been changed or editor for the selected file has been changed.

deselectNotify

default void deselectNotify()

This method is invoked each time when the editor is deselected.

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes specified listener

Parameters:

listener - to be added

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds specified listener

Parameters:

listener - to be removed

getBackgroundHighlighter

default BackgroundEditorHighlighter getBackgroundHighlighter()

Returns:

highlighter object to perform background analysis and highlighting activities. Return null if no background highlighting activity necessary for this file editor.

getCurrentLocation

FileEditorLocation getCurrentLocation()

The method is optional. Currently is used only by find usages subsystem

Returns:

the location of user focus. Typically it's a caret or any other form of selection start.

getStructureViewBuilder

default StructureViewBuilder getStructureViewBuilder()

getFile

default VirtualFile getFile()