Package com.intellij.openapi.fileEditor.impl

Class FileEditorManagerImpl

java.lang.Object

com.intellij.openapi.fileEditor.FileEditorManager

com.intellij.openapi.fileEditor.ex.FileEditorManagerEx

com.intellij.openapi.fileEditor.impl.FileEditorManagerImpl

All Implemented Interfaces:

PersistentStateComponent<Element>, Disposable

Direct Known Subclasses:

PsiAwareFileEditorManagerImpl

public class FileEditorManagerImpl
extends FileEditorManagerEx
implements PersistentStateComponent<Element>, Disposable

Nested Class Summary

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	CLOSING_TO_REOPEN
static java.lang.String	FILE_EDITOR_MANAGER

Fields inherited from class com.intellij.openapi.fileEditor.FileEditorManager

SEPARATOR_DISABLED, USE_CURRENT_WINDOW

Constructor Summary

Constructors

Constructor and Description
FileEditorManagerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
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) Adds specified listener
void	addFileEditorManagerListener(FileEditorManagerListener listener, Disposable parentDisposable)
void	addSelectionRecord(VirtualFile file, EditorWindow window)
void	addTopComponent(FileEditor editor, javax.swing.JComponent component) Adds the specified component above the editor and paints a separator line below it.
void	changeSplitterOrientation()
void	closeAllFiles() Closes all files IN ACTIVE SPLITTER (window).
void	closeFile(VirtualFile file) Closes all editors opened for the file.
void	closeFile(VirtualFile file, boolean moveFocus, boolean closeAllCopies)
void	closeFile(VirtualFile file, EditorWindow window) Closes editors for the file opened in particular window.
void	closeFile(VirtualFile file, EditorWindow window, boolean transferFocus)
void	createSplitter(int orientation, EditorWindow window)
void	dispose() Usually not invoked directly, see class javadoc.
void	fireSelectionChanged(EditorComposite newSelectedComposite)
Promise<EditorWindow>	getActiveWindow() Asynchronous version of FileEditorManagerEx.getCurrentWindow().
FileEditor []	getAllEditors()
FileEditor []	getAllEditors(VirtualFile file)
java.util.Set<EditorsSplitters>	getAllSplitters()
javax.swing.JComponent	getComponent()
VirtualFile	getCurrentFile()
EditorWindow	getCurrentWindow() Synchronous version of FileEditorManagerEx.getActiveWindow().
FileEditor []	getEditors(VirtualFile file)
Pair<FileEditor[],FileEditorProvider[]>	getEditorsWithProviders(VirtualFile file)
VirtualFile	getFile(FileEditor editor)
java.awt.Color	getFileColor(VirtualFile file)
java.lang.String	getFileTooltipText(VirtualFile file)
EditorsSplitters	getMainSplitters()
EditorWindow	getNextWindow(EditorWindow window)
VirtualFile []	getOpenFiles()
javax.swing.JComponent	getPreferredFocusedComponent()
EditorWindow	getPrevWindow(EditorWindow window)
Project	getProject() Returns the project with which the file editor manager is associated.
ActionCallback	getReady(java.lang.Object requestor)
FileEditor	getSelectedEditor()
FileEditor	getSelectedEditor(VirtualFile file)
FileEditor []	getSelectedEditors()
FileEditorWithProvider	getSelectedEditorWithProvider(VirtualFile file)
VirtualFile []	getSelectedFiles()
Editor	getSelectedTextEditor()
Editor	getSelectedTextEditor(boolean lockfree)
java.util.List<Pair<VirtualFile,EditorWindow>>	getSelectionHistory()
VirtualFile []	getSiblings(VirtualFile file)
EditorsSplitters	getSplitters()
EditorsSplitters	getSplittersFor(java.awt.Component c)
Element	getState()
java.util.List<javax.swing.JComponent>	getTopComponents(FileEditor editor)
EditorWindow []	getWindows()
int	getWindowSplitCount()
boolean	hasOpenedFile()
boolean	hasOpenFiles()
boolean	hasSplitOrUndockedWindows()
void	initDockableContentFactory()
boolean	isChanged(EditorComposite editor)
static boolean	isDumbAware(FileEditor editor)
boolean	isFileOpen(VirtualFile file)
boolean	isInsideChange()
boolean	isInSplitter()
boolean	isProblem(VirtualFile file)
void	loadState(Element state) This method is called when new component state is loaded.
ActionCallback	notifyPublisher(java.lang.Runnable runnable)
java.util.List<FileEditor>	openEditor(OpenFileDescriptor descriptor, boolean focusEditor) Must be called from EDT.
Pair<FileEditor[],FileEditorProvider[]>	openFileImpl2(EditorWindow window, VirtualFile file, boolean focusEditor)
Pair<FileEditor[],FileEditorProvider[]>	openFileInNewWindow(VirtualFile file)
Pair<FileEditor[],FileEditorProvider[]>	openFileWithProviders(VirtualFile file, boolean focusEditor, boolean searchForSplitter)
Pair<FileEditor[],FileEditorProvider[]>	openFileWithProviders(VirtualFile file, boolean focusEditor, EditorWindow window)
Editor	openTextEditor(OpenFileDescriptor descriptor, boolean focusEditor) Works as FileEditorManager.openFile(VirtualFile, boolean) but forces opening of text editor (see TextEditor).
protected void	projectOpened(MessageBusConnection connection)
void	removeBottomComponent(FileEditor editor, javax.swing.JComponent component)
void	removeFileEditorManagerListener(FileEditorManagerListener listener) Removes specified listener
void	removeTopComponent(FileEditor editor, javax.swing.JComponent component)
void	setCurrentWindow(EditorWindow window)
void	setSelectedEditor(VirtualFile file, java.lang.String fileEditorProviderId) Selects a specified file editor tab for the specified editor.
void	unsplitAllWindow()
void	unsplitWindow()
protected void	updateFileIcon(VirtualFile file) Updates tab icon for the specified file.
void	updateFilePresentation(VirtualFile file) Refreshes the text, colors and icon of the editor tabs representing the specified file.

Methods inherited from class com.intellij.openapi.fileEditor.ex.FileEditorManagerEx

getData, getInstanceEx, openFile, openFile, refreshIcons, registerExtraEditorDataProvider, runWhenLoaded

Methods inherited from class com.intellij.openapi.fileEditor.FileEditorManager

getInstance, navigateToTextEditor

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.components.PersistentStateComponent

initializeComponent, noStateLoaded

Field Detail

CLOSING_TO_REOPEN

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

FILE_EDITOR_MANAGER

public static final java.lang.String FILE_EDITOR_MANAGER

See Also:

Constant Field Values

Constructor Detail

FileEditorManagerImpl

public FileEditorManagerImpl(Project project)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

initDockableContentFactory

public void initDockableContentFactory()

isDumbAware

public static boolean isDumbAware(FileEditor editor)

getComponent

public javax.swing.JComponent getComponent()

Specified by:

getComponent in class FileEditorManagerEx

Returns:

JComponent which represent the place where all editors are located

getMainSplitters

public EditorsSplitters getMainSplitters()

getAllSplitters

public java.util.Set<EditorsSplitters> getAllSplitters()

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Specified by:

getPreferredFocusedComponent in class FileEditorManagerEx

Returns:

preferred focused component inside myEditor tabbed container. This method does similar things like FileEditor.getPreferredFocusedComponent() but it also tracks (and remember) focus movement inside tabbed container.

See Also:

EditorComposite.getPreferredFocusedComponent()

getFileColor

public java.awt.Color getFileColor(VirtualFile file)

Returns:

color of the file which corresponds to the file's status

isProblem

public boolean isProblem(VirtualFile file)

getFileTooltipText

public java.lang.String getFileTooltipText(VirtualFile file)

updateFilePresentation

public void updateFilePresentation(VirtualFile file)

Description copied from class: FileEditorManagerEx

Refreshes the text, colors and icon of the editor tabs representing the specified file.

Specified by:

updateFilePresentation in class FileEditorManagerEx

Parameters:

file - the file to refresh.

updateFileIcon

protected void updateFileIcon(VirtualFile file)

Updates tab icon for the specified file. The file should be opened in the myEditor, otherwise the method throws an assertion.

getFile

public VirtualFile getFile(FileEditor editor)

Specified by:

getFile in class FileEditorManagerEx

unsplitWindow

public void unsplitWindow()

Specified by:

unsplitWindow in class FileEditorManagerEx

unsplitAllWindow

public void unsplitAllWindow()

Specified by:

unsplitAllWindow in class FileEditorManagerEx

getWindowSplitCount

public int getWindowSplitCount()

Specified by:

getWindowSplitCount in class FileEditorManagerEx

hasSplitOrUndockedWindows

public boolean hasSplitOrUndockedWindows()

Specified by:

hasSplitOrUndockedWindows in class FileEditorManagerEx

getWindows

public EditorWindow [] getWindows()

Specified by:

getWindows in class FileEditorManagerEx

getNextWindow

public EditorWindow getNextWindow(EditorWindow window)

Specified by:

getNextWindow in class FileEditorManagerEx

getPrevWindow

public EditorWindow getPrevWindow(EditorWindow window)

Specified by:

getPrevWindow in class FileEditorManagerEx

createSplitter

public void createSplitter(int orientation,
                           EditorWindow window)

Specified by:

createSplitter in class FileEditorManagerEx

changeSplitterOrientation

public void changeSplitterOrientation()

Specified by:

changeSplitterOrientation in class FileEditorManagerEx

isInSplitter

public boolean isInSplitter()

Specified by:

isInSplitter in class FileEditorManagerEx

hasOpenedFile

public boolean hasOpenedFile()

Specified by:

hasOpenedFile in class FileEditorManagerEx

getCurrentFile

public VirtualFile getCurrentFile()

Specified by:

getCurrentFile in class FileEditorManagerEx

getActiveWindow

public Promise<EditorWindow> getActiveWindow()

Description copied from class: FileEditorManagerEx

Asynchronous version of FileEditorManagerEx.getCurrentWindow(). Execution happens after focus settle down. Can be invoked on any thread.

Specified by:

getActiveWindow in class FileEditorManagerEx

getCurrentWindow

public EditorWindow getCurrentWindow()

Description copied from class: FileEditorManagerEx

Synchronous version of FileEditorManagerEx.getActiveWindow(). Will return null if invoked not from EDT.

Specified by:

getCurrentWindow in class FileEditorManagerEx

Returns:

current window in splitters

setCurrentWindow

public void setCurrentWindow(EditorWindow window)

Specified by:

setCurrentWindow in class FileEditorManagerEx

closeFile

public void closeFile(VirtualFile file,
                      EditorWindow window,
                      boolean transferFocus)

closeFile

public void closeFile(VirtualFile file,
                      EditorWindow window)

Description copied from class: FileEditorManagerEx

Closes editors for the file opened in particular window.

Specified by:

closeFile in class FileEditorManagerEx

Parameters:

file - file to be closed. Cannot be null.

closeFile

public void closeFile(VirtualFile file)

Description copied from class: FileEditorManager

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

Specified by:

closeFile in class FileEditorManager

Parameters:

file - file to be closed.

closeFile

public void closeFile(VirtualFile file,
                      boolean moveFocus,
                      boolean closeAllCopies)

openFileWithProviders

public Pair<FileEditor[],FileEditorProvider[]> openFileWithProviders(VirtualFile file,
                                                                     boolean focusEditor,
                                                                     boolean searchForSplitter)

Specified by:

openFileWithProviders in class FileEditorManagerEx

openFileInNewWindow

public Pair<FileEditor[],FileEditorProvider[]> openFileInNewWindow(VirtualFile file)

openFileWithProviders

public Pair<FileEditor[],FileEditorProvider[]> openFileWithProviders(VirtualFile file,
                                                                     boolean focusEditor,
                                                                     EditorWindow window)

Specified by:

openFileWithProviders in class FileEditorManagerEx

openFileImpl2

public Pair<FileEditor[],FileEditorProvider[]> openFileImpl2(EditorWindow window,
                                                             VirtualFile file,
                                                             boolean focusEditor)

notifyPublisher

public ActionCallback notifyPublisher(java.lang.Runnable runnable)

Specified by:

notifyPublisher in class FileEditorManagerEx

setSelectedEditor

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

Description copied from class: FileEditorManager

Selects a specified file editor tab for the specified editor.

Specified by:

setSelectedEditor in class FileEditorManager

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()

openEditor

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

Description copied from class: FileEditorManager

Must be called from EDT.

Specified by:

openEditor in class FileEditorManager

Returns:

opened file editors

getProject

public Project getProject()

Description copied from class: FileEditorManager

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

Specified by:

getProject in class FileEditorManager

Returns:

the project instance.

openTextEditor

public Editor openTextEditor(OpenFileDescriptor descriptor,
                             boolean focusEditor)

Description copied from class: FileEditorManager

Works as FileEditorManager.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.

Specified by:

openTextEditor in class FileEditorManager

Returns:

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

getSelectedTextEditor

public Editor getSelectedTextEditor()

Specified by:

getSelectedTextEditor in class FileEditorManager

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.

getSelectedTextEditor

public Editor getSelectedTextEditor(boolean lockfree)

isFileOpen

public boolean isFileOpen(VirtualFile file)

Specified by:

isFileOpen in class FileEditorManager

Returns:

true if file is opened, false otherwise

getOpenFiles

public VirtualFile [] getOpenFiles()

Specified by:

getOpenFiles in class FileEditorManager

Returns:

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

hasOpenFiles

public boolean hasOpenFiles()

Overrides:

hasOpenFiles in class FileEditorManager

getSelectedFiles

public VirtualFile [] getSelectedFiles()

Specified by:

getSelectedFiles in class FileEditorManager

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 FileEditor [] getSelectedEditors()

Specified by:

getSelectedEditors in class FileEditorManager

Returns:

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

getSplitters

public EditorsSplitters getSplitters()

Specified by:

getSplitters in class FileEditorManagerEx

getSelectedEditor

public FileEditor getSelectedEditor()

Overrides:

getSelectedEditor in class FileEditorManager

Returns:

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

getSelectedEditor

public FileEditor getSelectedEditor(VirtualFile file)

Specified by:

getSelectedEditor in class FileEditorManager

Returns:

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

getSelectedEditorWithProvider

public FileEditorWithProvider getSelectedEditorWithProvider(VirtualFile file)

Specified by:

getSelectedEditorWithProvider in class FileEditorManagerEx

getEditorsWithProviders

public Pair<FileEditor[],FileEditorProvider[]> getEditorsWithProviders(VirtualFile file)

Specified by:

getEditorsWithProviders in class FileEditorManagerEx

getEditors

public FileEditor [] getEditors(VirtualFile file)

Specified by:

getEditors in class FileEditorManager

Returns:

current editors for the specified file

getAllEditors

public FileEditor [] getAllEditors(VirtualFile file)

Specified by:

getAllEditors in class FileEditorManager

Returns:

all editors for the specified file

getAllEditors

public FileEditor [] getAllEditors()

Specified by:

getAllEditors in class FileEditorManager

Returns:

all open editors

getTopComponents

public java.util.List<javax.swing.JComponent> getTopComponents(FileEditor editor)

addTopComponent

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

Description copied from class: FileEditorManager

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.

Specified by:

addTopComponent in class FileEditorManager

removeTopComponent

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

Specified by:

removeTopComponent in class FileEditorManager

addBottomComponent

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

Description copied from class: FileEditorManager

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.

Specified by:

addBottomComponent in class FileEditorManager

removeBottomComponent

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

Specified by:

removeBottomComponent in class FileEditorManager

addFileEditorManagerListener

public void addFileEditorManagerListener(FileEditorManagerListener listener)

Description copied from class: FileEditorManager

Adds specified listener

Overrides:

addFileEditorManagerListener in class FileEditorManager

Parameters:

listener - listener to be added

addFileEditorManagerListener

public void addFileEditorManagerListener(FileEditorManagerListener listener,
                                         Disposable parentDisposable)

Overrides:

addFileEditorManagerListener in class FileEditorManager

removeFileEditorManagerListener

public void removeFileEditorManagerListener(FileEditorManagerListener listener)

Description copied from class: FileEditorManager

Removes specified listener

Overrides:

removeFileEditorManagerListener in class FileEditorManager

Parameters:

listener - listener to be removed

projectOpened

protected void projectOpened(MessageBusConnection connection)

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(Element state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

fireSelectionChanged

public void fireSelectionChanged(EditorComposite newSelectedComposite)

isChanged

public boolean isChanged(EditorComposite editor)

Specified by:

isChanged in class FileEditorManagerEx

isInsideChange

public boolean isInsideChange()

Specified by:

isInsideChange in class FileEditorManagerEx

closeAllFiles

public void closeAllFiles()

Description copied from class: FileEditorManagerEx

Closes all files IN ACTIVE SPLITTER (window).

Specified by:

closeAllFiles in class FileEditorManagerEx

See Also:

DockManager.getContainers(), DockContainer.closeAll()

getSiblings

public VirtualFile [] getSiblings(VirtualFile file)

Specified by:

getSiblings in class FileEditorManagerEx

Returns:

arrays of all files (including file itself) that belong to the same tabbed container. The method returns empty array if file is not open. The returned files have the same order as they have in the tabbed container.

getSplittersFor

public EditorsSplitters getSplittersFor(java.awt.Component c)

Specified by:

getSplittersFor in class FileEditorManagerEx

getSelectionHistory

public java.util.List<Pair<VirtualFile,EditorWindow>> getSelectionHistory()

addSelectionRecord

public void addSelectionRecord(VirtualFile file,
                               EditorWindow window)

getReady

public ActionCallback getReady(java.lang.Object requestor)