TextEditorImpl (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.openapi.fileEditor.impl.text.TextEditorImpl

All Implemented Interfaces:

Disposable, FileEditor, NavigatableFileEditor, TextEditor, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

LargeFileEditorProvider.LargeTextFileEditor, PsiAwareTextEditorImpl
```
public class TextEditorImpl
extends UserDataHolderBase
implements 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

protected VirtualFile myFile

protected Project myProject
- Fields inherited from interface com.intellij.openapi.fileEditor.FileEditor
  PROP_MODIFIED, PROP_VALID

Fields
Modifier and Type	Field and Description
`protected VirtualFile`	`myFile`
`protected Project`	`myProject`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Removes specified listener
`boolean`	`canNavigateTo(Navigatable navigatable)` Check whatever the editor can navigate to the given element
`protected com.intellij.openapi.fileEditor.impl.text.TextEditorComponent`	`createEditorComponent(Project project, VirtualFile file)`
`void`	`deselectNotify()` This method is invoked each time when the editor is deselected.
`void`	`dispose()` Usually not invoked directly, see class javadoc.
`BackgroundEditorHighlighter`	`getBackgroundHighlighter()`
`com.intellij.openapi.fileEditor.impl.text.TextEditorComponent`	`getComponent()`
`FileEditorLocation`	`getCurrentLocation()` The method is optional.
`static Language`	`getDocumentLanguage(Editor editor)`
`Editor`	`getEditor()`
`VirtualFile`	`getFile()`
`java.lang.String`	`getName()`
`javax.swing.JComponent`	`getPreferredFocusedComponent()` Returns component to be focused when editor is opened.
`FileEditorState`	`getState(FileEditorStateLevel level)`
`StructureViewBuilder`	`getStructureViewBuilder()`
`boolean`	`isModified()`
`boolean`	`isValid()`
`protected java.lang.Runnable`	`loadEditorInBackground()`
`void`	`navigateTo(Navigatable navigatable)` Navigate editor to the given navigatable if `NavigatableFileEditor.canNavigateTo(com.intellij.pom.Navigatable)` is true
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Adds specified listener
`void`	`selectNotify()` This method is invoked each time when the editor is selected.
`void`	`setState(FileEditorState state)` Applies given state to the editor.
`void`	`setState(FileEditorState state, boolean exactState)` In some cases, it's desirable to set state exactly as requested (e.g.
`java.lang.String`	`toString()`
`void`	`updateModifiedProperty()`

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase
changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.openapi.util.UserDataHolder
getUserData, putUserData

- Field Detail
  - myProject
```
protected final Project myProject
```
  - myFile
```
protected final VirtualFile myFile
```
- Method Detail
  - loadEditorInBackground
```
protected java.lang.Runnable loadEditorInBackground()
```
    Returns:
    
    a continuation to be called in EDT
  - getDocumentLanguage
```
public static Language getDocumentLanguage(Editor editor)
```
  - createEditorComponent
```
protected com.intellij.openapi.fileEditor.impl.text.TextEditorComponent createEditorComponent(Project project,
                                                                                              VirtualFile file)
```
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Usually not invoked directly, see class javadoc.
    
    Specified by:
    
    dispose in interface Disposable
  - getFile
```
public VirtualFile getFile()
```
    Specified by:
    
    getFile in interface FileEditor
  - getComponent
```
public com.intellij.openapi.fileEditor.impl.text.TextEditorComponent getComponent()
```
    Specified by:
    
    getComponent in interface FileEditor
    
    Returns:
    
    component which represents editor in the UI. The method should never return null.
  - getPreferredFocusedComponent
```
public javax.swing.JComponent getPreferredFocusedComponent()
```
    Description copied from interface: FileEditor
    
    Returns component to be focused when editor is opened.
    
    Specified by:
    
    getPreferredFocusedComponent in interface FileEditor
  - getEditor
```
public Editor getEditor()
```
    Specified by:
    
    getEditor in interface TextEditor
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface FileEditor
    
    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
```
public FileEditorState getState(FileEditorStateLevel level)
```
    Specified by:
    
    getState in interface FileEditor
    
    Returns:
    
    editor's internal state. Method should never return null.
  - setState
```
public void setState(FileEditorState state)
```
    Description copied from interface: FileEditor
    
    Applies given state to the editor.
    
    Specified by:
    
    setState in interface FileEditor
    
    Parameters:
    
    state - cannot be null
  - setState
```
public void setState(FileEditorState state,
                     boolean exactState)
```
    Description copied from interface: FileEditor
    
    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.
    
    Specified by:
    
    setState in interface FileEditor
  - isModified
```
public boolean isModified()
```
    Specified by:
    
    isModified in interface FileEditor
    
    Returns:
    
    whether the editor's content is modified in comparison with its file.
  - isValid
```
public boolean isValid()
```
    Specified by:
    
    isValid in interface FileEditor
    
    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
```
public void selectNotify()
```
    Description copied from interface: FileEditor
    
    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.
    
    Specified by:
    
    selectNotify in interface FileEditor
  - deselectNotify
```
public void deselectNotify()
```
    Description copied from interface: FileEditor
    
    This method is invoked each time when the editor is deselected.
    
    Specified by:
    
    deselectNotify in interface FileEditor
  - updateModifiedProperty
```
public void updateModifiedProperty()
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Description copied from interface: FileEditor
    
    Removes specified listener
    
    Specified by:
    
    addPropertyChangeListener in interface FileEditor
    
    Parameters:
    
    listener - to be added
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Description copied from interface: FileEditor
    
    Adds specified listener
    
    Specified by:
    
    removePropertyChangeListener in interface FileEditor
    
    Parameters:
    
    listener - to be removed
  - getBackgroundHighlighter
```
public BackgroundEditorHighlighter getBackgroundHighlighter()
```
    Specified by:
    
    getBackgroundHighlighter in interface FileEditor
    
    Returns:
    
    highlighter object to perform background analysis and highlighting activities. Return null if no background highlighting activity necessary for this file editor.
  - getCurrentLocation
```
public FileEditorLocation getCurrentLocation()
```
    Description copied from interface: FileEditor
    
    The method is optional. Currently is used only by find usages subsystem
    
    Specified by:
    
    getCurrentLocation in interface FileEditor
    
    Returns:
    
    the location of user focus. Typically it's a caret or any other form of selection start.
  - getStructureViewBuilder
```
public StructureViewBuilder getStructureViewBuilder()
```
    Specified by:
    
    getStructureViewBuilder in interface FileEditor
  - canNavigateTo
```
public boolean canNavigateTo(Navigatable navigatable)
```
    Description copied from interface: NavigatableFileEditor
    
    Check whatever the editor can navigate to the given element
    
    Specified by:
    
    canNavigateTo in interface NavigatableFileEditor
    
    Returns:
    
    true if editor can navigate, false otherwise
  - navigateTo
```
public void navigateTo(Navigatable navigatable)
```
    Description copied from interface: NavigatableFileEditor
    
    Navigate editor to the given navigatable if NavigatableFileEditor.canNavigateTo(com.intellij.pom.Navigatable) is true
    
    Specified by:
    
    navigateTo in interface NavigatableFileEditor
    
    Parameters:
    
    navigatable - navigation target
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TextEditorImpl

Nested Class Summary

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

Field Summary

Fields inherited from interface com.intellij.openapi.fileEditor.FileEditor

Method Summary

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

Methods inherited from class java.lang.Object

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

Field Detail

myProject

myFile

Method Detail

loadEditorInBackground

getDocumentLanguage

createEditorComponent

dispose

getFile

getComponent

getPreferredFocusedComponent

getEditor

getName

getState

setState

setState

isModified

isValid

selectNotify

deselectNotify

updateModifiedProperty

addPropertyChangeListener

removePropertyChangeListener

getBackgroundHighlighter

getCurrentLocation

getStructureViewBuilder

canNavigateTo

navigateTo

toString