Package com.intellij.openapi.fileEditor

Class FileEditorManager

java.lang.Object

com.intellij.openapi.fileEditor.FileEditorManager

Direct Known Subclasses:

FileEditorManagerEx

public abstract class FileEditorManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	SEPARATOR_DISABLED
static Key<java.lang.Boolean>	USE_CURRENT_WINDOW

Constructor Summary

Constructors

Constructor and Description
FileEditorManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addBottomComponent(FileEditor editor, javax.swing.JComponent component) Adds the specified component below the editor and paints a separator line above it.
void	addFileEditorManagerListener(FileEditorManagerListener listener) Deprecated. Use MessageBus instead: see FileEditorManagerListener.FILE_EDITOR_MANAGER
void	addFileEditorManagerListener(FileEditorManagerListener listener, Disposable parentDisposable) Deprecated. Use FileEditorManagerListener.FILE_EDITOR_MANAGER instead
abstract void	addTopComponent(FileEditor editor, javax.swing.JComponent component) Adds the specified component above the editor and paints a separator line below it.
abstract void	closeFile(VirtualFile file) Closes all editors opened for the file.
abstract FileEditor []	getAllEditors()
abstract FileEditor []	getAllEditors(VirtualFile file)
abstract java.lang.Object	getData(java.lang.String dataId, Editor editor, Caret caret) Returns data associated with given editor/caret context.
abstract FileEditor []	getEditors(VirtualFile file)
static FileEditorManager	getInstance(Project project)
abstract VirtualFile []	getOpenFiles()
abstract Project	getProject() Returns the project with which the file editor manager is associated.
FileEditor	getSelectedEditor()
abstract FileEditor	getSelectedEditor(VirtualFile file)
abstract FileEditor []	getSelectedEditors()
abstract VirtualFile []	getSelectedFiles()
abstract Editor	getSelectedTextEditor()
boolean	hasOpenFiles()
abstract boolean	isFileOpen(VirtualFile file)
void	navigateToTextEditor(OpenFileDescriptor descriptor, boolean focusEditor) Deprecated. use openTextEditor(OpenFileDescriptor, boolean)
abstract java.util.List<FileEditor>	openEditor(OpenFileDescriptor descriptor, boolean focusEditor) Must be called from EDT.
abstract FileEditor []	openFile(VirtualFile file, boolean focusEditor)
FileEditor []	openFile(VirtualFile file, boolean focusEditor, boolean searchForOpen) Opens a file.
abstract Editor	openTextEditor(OpenFileDescriptor descriptor, boolean focusEditor) Works as openFile(VirtualFile, boolean) but forces opening of text editor (see TextEditor).
abstract void	registerExtraEditorDataProvider(EditorDataProvider provider, Disposable parentDisposable)
abstract void	removeBottomComponent(FileEditor editor, javax.swing.JComponent component)
void	removeFileEditorManagerListener(FileEditorManagerListener listener) Deprecated. Use FileEditorManagerListener.FILE_EDITOR_MANAGER instead
abstract void	removeTopComponent(FileEditor editor, javax.swing.JComponent component)
abstract void	runWhenLoaded(Editor editor, java.lang.Runnable runnable) FileEditorManager supports asynchronous opening of text editors, i.e.
abstract void	setSelectedEditor(VirtualFile file, java.lang.String fileEditorProviderId) Selects a specified file editor tab for the specified editor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USE_CURRENT_WINDOW

public static final Key<java.lang.Boolean> USE_CURRENT_WINDOW

SEPARATOR_DISABLED

public static final Key<java.lang.Boolean> SEPARATOR_DISABLED

Constructor Detail

FileEditorManager

public FileEditorManager()

Method Detail

getInstance

public static FileEditorManager getInstance(Project project)

openFile

public abstract FileEditor [] openFile(VirtualFile file,
                                       boolean focusEditor)

Parameters:

file - file to open. File should be valid. Must be called from EDT.

Returns:

array of opened editors

openFile

public FileEditor [] openFile(VirtualFile file,
                              boolean focusEditor,
                              boolean searchForOpen)

Opens a file. Must be called from EDT.

Parameters:

file - file to open

focusEditor - true if need to focus

Returns:

array of opened editors

closeFile

public abstract void closeFile(VirtualFile file)

Closes all editors opened for the file. Must be called from EDT.

Parameters:

file - file to be closed.

openTextEditor

public abstract Editor openTextEditor(OpenFileDescriptor descriptor,
                                      boolean focusEditor)

Works as openFile(VirtualFile, boolean) but forces opening of text editor (see TextEditor). If several text editors are opened, including the default one, default text editor is focused (if requested) and returned. Must be called from EDT.

Returns:

opened text editor. The method returns null in case if text editor wasn't opened.

navigateToTextEditor

@Deprecated
public void navigateToTextEditor(OpenFileDescriptor descriptor,
                                 boolean focusEditor)

Deprecated. use openTextEditor(OpenFileDescriptor, boolean)

getSelectedTextEditor

public abstract Editor getSelectedTextEditor()

Returns:

currently selected text editor. The method returns null in case there is no selected editor at all or selected editor is not a text one. Must be called from EDT.

isFileOpen

public abstract boolean isFileOpen(VirtualFile file)

Returns:

true if file is opened, false otherwise

getOpenFiles

public abstract VirtualFile [] getOpenFiles()

Returns:

all opened files. Order of files in the array corresponds to the order of editor tabs.

hasOpenFiles

public boolean hasOpenFiles()

getSelectedFiles

public abstract VirtualFile [] getSelectedFiles()

Returns:

files currently selected. The method returns empty array if there are no selected files. If more than one file is selected (split), the file with most recent focused editor is returned first.

getSelectedEditors

public abstract FileEditor [] getSelectedEditors()

Returns:

editors currently selected. The method returns empty array if no editors are open.

getSelectedEditor

public FileEditor getSelectedEditor()

Returns:

currently selected file editor or null if there is no selected editor at all.

getSelectedEditor

public abstract FileEditor getSelectedEditor(VirtualFile file)

Returns:

editor which is currently selected for given file. The method returns null if file is not opened.

getEditors

public abstract FileEditor [] getEditors(VirtualFile file)

Returns:

current editors for the specified file

getAllEditors

public abstract FileEditor [] getAllEditors(VirtualFile file)

Returns:

all editors for the specified file

getAllEditors

public abstract FileEditor [] getAllEditors()

Returns:

all open editors

addTopComponent

public abstract void addTopComponent(FileEditor editor,
                                     javax.swing.JComponent component)

Adds the specified component above the editor and paints a separator line below it. If a separator line is not needed, set the client property to true:

    component.putClientProperty(SEPARATOR_DISABLED, true);    

Otherwise, a separator line will be painted by a SEPARATOR_ABOVE_COLOR or TEARLINE_COLOR if it is not set.

This method allows to add several components above the editor. To change an order of components the specified component may implement the Weighted interface.

removeTopComponent

public abstract void removeTopComponent(FileEditor editor,
                                        javax.swing.JComponent component)

addBottomComponent

public abstract void addBottomComponent(FileEditor editor,
                                        javax.swing.JComponent component)

Adds the specified component below the editor and paints a separator line above it. If a separator line is not needed, set the client property to true:

    component.putClientProperty(SEPARATOR_DISABLED, true);    

Otherwise, a separator line will be painted by a SEPARATOR_BELOW_COLOR or TEARLINE_COLOR if it is not set.

This method allows to add several components below the editor. To change an order of components the specified component may implement the Weighted interface.

removeBottomComponent

public abstract void removeBottomComponent(FileEditor editor,
                                           javax.swing.JComponent component)

addFileEditorManagerListener

@Deprecated
public void addFileEditorManagerListener(FileEditorManagerListener listener)

Deprecated. Use MessageBus instead: see FileEditorManagerListener.FILE_EDITOR_MANAGER

Adds specified listener

Parameters:

listener - listener to be added

addFileEditorManagerListener

@Deprecated
public void addFileEditorManagerListener(FileEditorManagerListener listener,
                                         Disposable parentDisposable)

Deprecated. Use FileEditorManagerListener.FILE_EDITOR_MANAGER instead

removeFileEditorManagerListener

@Deprecated
public void removeFileEditorManagerListener(FileEditorManagerListener listener)

Deprecated. Use FileEditorManagerListener.FILE_EDITOR_MANAGER instead

Removes specified listener

Parameters:

listener - listener to be removed

openEditor

public abstract java.util.List<FileEditor> openEditor(OpenFileDescriptor descriptor,
                                                      boolean focusEditor)

Must be called from EDT.

Returns:

opened file editors

getProject

public abstract Project getProject()

Returns the project with which the file editor manager is associated.

Returns:

the project instance.

registerExtraEditorDataProvider

public abstract void registerExtraEditorDataProvider(EditorDataProvider provider,
                                                     Disposable parentDisposable)

getData

public abstract java.lang.Object getData(java.lang.String dataId,
                                         Editor editor,
                                         Caret caret)

Returns data associated with given editor/caret context. Data providers are registered via registerExtraEditorDataProvider(EditorDataProvider, Disposable) method.

setSelectedEditor

public abstract void setSelectedEditor(VirtualFile file,
                                       java.lang.String fileEditorProviderId)

Selects a specified file editor tab for the specified editor.

Parameters:

file - a file to switch the file editor tab for. The function does nothing if the file is not currently open in the editor.

fileEditorProviderId - the ID of the file editor to open; matches the return value of FileEditorProvider.getEditorTypeId()

runWhenLoaded

public abstract void runWhenLoaded(Editor editor,
                                   java.lang.Runnable runnable)

FileEditorManager supports asynchronous opening of text editors, i.e. when one of 'openFile' methods returns, returned editor might not be fully initialized yet. This method allows to delay (if needed) execution of given runnable until editor is fully loaded.