PerspectiveFileEditor (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.util.xml.ui.PerspectiveFileEditor

All Implemented Interfaces:

Disposable, DocumentsEditor, FileEditor, UserDataHolder, UserDataHolderEx, Committable

Direct Known Subclasses:

DomFileEditor
```
public abstract class PerspectiveFileEditor
extends UserDataHolderBase
implements DocumentsEditor, Committable
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable
  Disposable.Parent

Field Summary
- Fields inherited from interface com.intellij.openapi.fileEditor.FileEditor
  PROP_MODIFIED, PROP_VALID

Constructor Summary

Constructors
Modifier Constructor and Description

protected PerspectiveFileEditor(Project project, VirtualFile file)

Constructors
Modifier	Constructor and Description
`protected`	`PerspectiveFileEditor(Project project, VirtualFile file)`

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
`void`	`addWatchedElement(DomElement domElement)`
`protected boolean`	`checkIsValid()`
`protected abstract javax.swing.JComponent`	`createCustomComponent()`
`void`	`deselectNotify()` This method is invoked each time when the editor is deselected.
`void`	`dispose()` Usually not invoked directly, see class javadoc.
`protected void`	`ensureInitialized()`
`BackgroundEditorHighlighter`	`getBackgroundHighlighter()`
`javax.swing.JComponent`	`getComponent()`
`FileEditorLocation`	`getCurrentLocation()` The method is optional.
`protected PsiDocumentManager`	`getDocumentManager()`
`Document[]`	`getDocuments()`
`Project`	`getProject()`
`PsiFile`	`getPsiFile()`
`protected abstract DomElement`	`getSelectedDomElement()`
`StructureViewBuilder`	`getStructureViewBuilder()`
`VirtualFile`	`getVirtualFile()`
`Wrapper`	`getWrapper()`
`protected boolean`	`isInitialised()`
`boolean`	`isModified()`
`boolean`	`isValid()`
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Adds specified listener
`void`	`selectNotify()` This method is invoked each time when the editor is selected.
`protected abstract void`	`setSelectedDomElement(DomElement domElement)`
`protected void`	`setShowing(boolean b)`
`void`	`setState(FileEditorState state)` Applies given state to the editor.

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, toString, wait, wait, wait

Methods inherited from interface com.intellij.openapi.fileEditor.FileEditor
getFile, getName, getPreferredFocusedComponent, getState, setState

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

Methods inherited from interface com.intellij.util.xml.ui.Committable
commit, reset

- Constructor Detail
  - PerspectiveFileEditor
```
protected PerspectiveFileEditor(Project project,
                                VirtualFile file)
```
- Method Detail
  - getSelectedDomElement
```
protected abstract DomElement getSelectedDomElement()
```
  - setSelectedDomElement
```
protected abstract void setSelectedDomElement(DomElement domElement)
```
  - addWatchedElement
```
public final void addWatchedElement(DomElement domElement)
```
  - getDocumentManager
```
protected final PsiDocumentManager getDocumentManager()
```
  - getPsiFile
```
public final PsiFile getPsiFile()
```
  - getDocuments
```
public final Document[] getDocuments()
```
    Specified by:
    
    getDocuments in interface DocumentsEditor
  - getProject
```
public final Project getProject()
```
  - getVirtualFile
```
public final VirtualFile getVirtualFile()
```
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Usually not invoked directly, see class javadoc.
    
    Specified by:
    
    dispose in interface Disposable
  - isModified
```
public final 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
  - setShowing
```
protected final void setShowing(boolean b)
```
  - ensureInitialized
```
protected final void ensureInitialized()
```
  - 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
  - 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
  - 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
  - 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
  - checkIsValid
```
protected boolean checkIsValid()
```
  - getComponent
```
public javax.swing.JComponent getComponent()
```
    Specified by:
    
    getComponent in interface FileEditor
    
    Returns:
    
    component which represents editor in the UI. The method should never return null.
  - createCustomComponent
```
protected abstract javax.swing.JComponent createCustomComponent()
```
  - getWrapper
```
public Wrapper getWrapper()
```
  - isInitialised
```
protected final boolean isInitialised()
```

Class PerspectiveFileEditor

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 com.intellij.openapi.util.UserDataHolderBase

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface com.intellij.util.xml.ui.Committable

Constructor Detail

PerspectiveFileEditor

Method Detail

getSelectedDomElement

setSelectedDomElement

addWatchedElement

getDocumentManager

getPsiFile

getDocuments

getProject

getVirtualFile

dispose

isModified

isValid

selectNotify

setShowing

ensureInitialized

deselectNotify

getBackgroundHighlighter

getCurrentLocation

getStructureViewBuilder

setState

addPropertyChangeListener

removePropertyChangeListener

checkIsValid

getComponent

createCustomComponent

getWrapper

isInitialised