BaseRemoteFileEditor (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.fileEditor.impl.BaseRemoteFileEditor

All Implemented Interfaces:

Disposable, FileEditor, NavigatableFileEditor, TextEditor, UserDataHolder, java.beans.PropertyChangeListener, java.util.EventListener
```
public abstract class BaseRemoteFileEditor
extends java.lang.Object
implements TextEditor, java.beans.PropertyChangeListener
```

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 Project myProject
- Fields inherited from interface com.intellij.openapi.fileEditor.FileEditor
  PROP_MODIFIED, PROP_VALID

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseRemoteFileEditor(Project project)

Constructors
Modifier	Constructor and Description
`protected`	`BaseRemoteFileEditor(Project project)`

Method Summary

All Methods Instance Methods Abstract 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 void`	`contentLoaded()`
`protected void`	`contentRejected()`
`void`	`dispose()` Usually not invoked directly, see class javadoc.
`BackgroundEditorHighlighter`	`getBackgroundHighlighter()`
`FileEditorLocation`	`getCurrentLocation()` The method is optional.
`Editor`	`getEditor()`
`FileEditorState`	`getState(FileEditorStateLevel level)`
`StructureViewBuilder`	`getStructureViewBuilder()`
`protected abstract TextEditor`	`getTextEditor()`
`<T> T`	`getUserData(Key<T> key)`
`boolean`	`isModified()`
`boolean`	`isValid()`
`void`	`navigateTo(Navigatable navigatable)` Navigate editor to the given navigatable if `NavigatableFileEditor.canNavigateTo(com.intellij.pom.Navigatable)` is true
`void`	`propertyChange(java.beans.PropertyChangeEvent event)`
`<T> void`	`putUserData(Key<T> key, T value)` Add a new user data value to this object.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Adds specified listener
`void`	`setState(FileEditorState state)` Applies given state to the editor.

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

Methods inherited from interface com.intellij.openapi.fileEditor.FileEditor
deselectNotify, getComponent, getFile, getName, getPreferredFocusedComponent, selectNotify, setState

- Field Detail
  - myProject
```
protected final Project myProject
```
- Constructor Detail
  - BaseRemoteFileEditor
```
protected BaseRemoteFileEditor(Project project)
```
- Method Detail
  - getStructureViewBuilder
```
public StructureViewBuilder getStructureViewBuilder()
```
    Specified by:
    
    getStructureViewBuilder in interface FileEditor
  - getEditor
```
public Editor getEditor()
```
    Specified by:
    
    getEditor in interface TextEditor
  - getTextEditor
```
protected abstract TextEditor getTextEditor()
```
  - 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.
  - 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.
  - 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
  - getUserData
```
public <T> T getUserData(Key<T> key)
```
    Specified by:
    
    getUserData in interface UserDataHolder
    
    Returns:
    
    a user data value associated with this object. Doesn't require read action.
  - putUserData
```
public <T> void putUserData(Key<T> key,
                            T value)
```
    Description copied from interface: UserDataHolder
    
    Add a new user data value to this object. Doesn't require write action.
    
    Specified by:
    
    putUserData in interface UserDataHolder
  - 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.
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Usually not invoked directly, see class javadoc.
    
    Specified by:
    
    dispose in interface Disposable
  - 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
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent event)
```
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
  - 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 final 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
  - contentLoaded
```
protected final void contentLoaded()
```
  - contentRejected
```
protected final void contentRejected()
```

Class BaseRemoteFileEditor

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

myProject

Constructor Detail

BaseRemoteFileEditor

Method Detail

getStructureViewBuilder

getEditor

getTextEditor

getCurrentLocation

getBackgroundHighlighter

getState

setState

getUserData

putUserData

isModified

isValid

dispose

addPropertyChangeListener

removePropertyChangeListener

propertyChange

canNavigateTo

navigateTo

contentLoaded

contentRejected