Package com.intellij.openapi.fileEditor.impl.text

Class TextEditorProvider.EditorWrapper

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.fileEditor.impl.text.TextEditorProvider.EditorWrapper

All Implemented Interfaces:

Disposable, FileEditor, NavigatableFileEditor, TextEditor, UserDataHolder, UserDataHolderEx

Enclosing class:

TextEditorProvider

protected class TextEditorProvider.EditorWrapper
extends UserDataHolderBase
implements TextEditor

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

Method Summary

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
void	deselectNotify() This method is invoked each time when the editor is deselected.
void	dispose() Usually not invoked directly, see class javadoc.
BackgroundEditorHighlighter	getBackgroundHighlighter()
javax.swing.JComponent	getComponent()
FileEditorLocation	getCurrentLocation() The method is optional.
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()
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.

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.util.UserDataHolder

getUserData, putUserData

Method Detail

getEditor

public Editor getEditor()

Specified by:

getEditor in interface TextEditor

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.

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

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.

getStructureViewBuilder

public StructureViewBuilder getStructureViewBuilder()

Specified by:

getStructureViewBuilder in interface FileEditor

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.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

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

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.

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

getFile

public VirtualFile getFile()

Specified by:

getFile in interface FileEditor