Package com.intellij.openapi.fileEditor.ex

Class FileEditorManagerEx

java.lang.Object

com.intellij.openapi.fileEditor.FileEditorManager

com.intellij.openapi.fileEditor.ex.FileEditorManagerEx

Direct Known Subclasses:

FileEditorManagerImpl

public abstract class FileEditorManagerEx
extends FileEditorManager

Field Summary

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

SEPARATOR_DISABLED, USE_CURRENT_WINDOW

Constructor Summary

Constructors

Constructor and Description
FileEditorManagerEx()

Method Summary

Modifier and Type	Method and Description
abstract void	changeSplitterOrientation()
abstract void	closeAllFiles() Closes all files IN ACTIVE SPLITTER (window).
abstract void	closeFile(VirtualFile file, EditorWindow window) Closes editors for the file opened in particular window.
abstract void	createSplitter(int orientation, EditorWindow window)
abstract Promise<EditorWindow>	getActiveWindow() Asynchronous version of getCurrentWindow().
abstract javax.swing.JComponent	getComponent()
abstract VirtualFile	getCurrentFile()
abstract EditorWindow	getCurrentWindow() Synchronous version of getActiveWindow().
java.lang.Object	getData(java.lang.String dataId, Editor editor, Caret caret) Returns data associated with given editor/caret context.
abstract Pair<FileEditor[],FileEditorProvider[]>	getEditorsWithProviders(VirtualFile file)
abstract VirtualFile	getFile(FileEditor editor)
static FileEditorManagerEx	getInstanceEx(Project project)
abstract EditorWindow	getNextWindow(EditorWindow window)
abstract javax.swing.JComponent	getPreferredFocusedComponent()
abstract EditorWindow	getPrevWindow(EditorWindow window)
abstract FileEditorWithProvider	getSelectedEditorWithProvider(VirtualFile file)
abstract VirtualFile []	getSiblings(VirtualFile file)
abstract EditorsSplitters	getSplitters()
abstract EditorsSplitters	getSplittersFor(java.awt.Component c)
abstract EditorWindow []	getWindows()
abstract int	getWindowSplitCount()
abstract boolean	hasOpenedFile()
abstract boolean	hasSplitOrUndockedWindows()
abstract boolean	isChanged(EditorComposite editor)
abstract boolean	isInsideChange()
abstract boolean	isInSplitter()
abstract ActionCallback	notifyPublisher(java.lang.Runnable runnable)
FileEditor []	openFile(VirtualFile file, boolean focusEditor)
FileEditor []	openFile(VirtualFile file, boolean focusEditor, boolean searchForOpen) Opens a file.
abstract Pair<FileEditor[],FileEditorProvider[]>	openFileWithProviders(VirtualFile file, boolean focusEditor, boolean searchForSplitter)
abstract Pair<FileEditor[],FileEditorProvider[]>	openFileWithProviders(VirtualFile file, boolean focusEditor, EditorWindow window)
void	refreshIcons()
void	registerExtraEditorDataProvider(EditorDataProvider provider, Disposable parentDisposable)
void	runWhenLoaded(Editor editor, java.lang.Runnable runnable) FileEditorManager supports asynchronous opening of text editors, i.e.
abstract void	setCurrentWindow(EditorWindow window)
abstract void	unsplitAllWindow()
abstract void	unsplitWindow()
abstract 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.FileEditorManager

addBottomComponent, addFileEditorManagerListener, addFileEditorManagerListener, addTopComponent, closeFile, getAllEditors, getAllEditors, getEditors, getInstance, getOpenFiles, getProject, getSelectedEditor, getSelectedEditor, getSelectedEditors, getSelectedFiles, getSelectedTextEditor, hasOpenFiles, isFileOpen, navigateToTextEditor, openEditor, openTextEditor, removeBottomComponent, removeFileEditorManagerListener, removeTopComponent, setSelectedEditor

Methods inherited from class java.lang.Object

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

Constructor Detail

FileEditorManagerEx

public FileEditorManagerEx()

Method Detail

getInstanceEx

public static FileEditorManagerEx getInstanceEx(Project project)

getComponent

public abstract javax.swing.JComponent getComponent()

Returns:

JComponent which represent the place where all editors are located

getPreferredFocusedComponent

public abstract javax.swing.JComponent getPreferredFocusedComponent()

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

getEditorsWithProviders

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

getFile

public abstract VirtualFile getFile(FileEditor editor)

updateFilePresentation

public abstract void updateFilePresentation(VirtualFile file)

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

Parameters:

file - the file to refresh.

getCurrentWindow

public abstract EditorWindow getCurrentWindow()

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

Returns:

current window in splitters

getActiveWindow

public abstract Promise<EditorWindow> getActiveWindow()

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

setCurrentWindow

public abstract void setCurrentWindow(EditorWindow window)

closeFile

public abstract void closeFile(VirtualFile file,
                               EditorWindow window)

Closes editors for the file opened in particular window.

Parameters:

file - file to be closed. Cannot be null.

unsplitWindow

public abstract void unsplitWindow()

unsplitAllWindow

public abstract void unsplitAllWindow()

getWindowSplitCount

public abstract int getWindowSplitCount()

hasSplitOrUndockedWindows

public abstract boolean hasSplitOrUndockedWindows()

getWindows

public abstract EditorWindow [] getWindows()

getSiblings

public abstract VirtualFile [] getSiblings(VirtualFile file)

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.

createSplitter

public abstract void createSplitter(int orientation,
                                    EditorWindow window)

changeSplitterOrientation

public abstract void changeSplitterOrientation()

isInSplitter

public abstract boolean isInSplitter()

hasOpenedFile

public abstract boolean hasOpenedFile()

getCurrentFile

public abstract VirtualFile getCurrentFile()

getSelectedEditorWithProvider

public abstract FileEditorWithProvider getSelectedEditorWithProvider(VirtualFile file)

closeAllFiles

public abstract void closeAllFiles()

Closes all files IN ACTIVE SPLITTER (window).

See Also:

DockManager.getContainers(), DockContainer.closeAll()

getSplitters

public abstract EditorsSplitters getSplitters()

openFile

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

Specified by:

openFile in class FileEditorManager

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)

Description copied from class: FileEditorManager

Opens a file. Must be called from EDT.

Overrides:

openFile in class FileEditorManager

Parameters:

file - file to open

focusEditor - true if need to focus

Returns:

array of opened editors

openFileWithProviders

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

openFileWithProviders

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

isChanged

public abstract boolean isChanged(EditorComposite editor)

getNextWindow

public abstract EditorWindow getNextWindow(EditorWindow window)

getPrevWindow

public abstract EditorWindow getPrevWindow(EditorWindow window)

isInsideChange

public abstract boolean isInsideChange()

getData

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

Description copied from class: FileEditorManager

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

Specified by:

getData in class FileEditorManager

registerExtraEditorDataProvider

public void registerExtraEditorDataProvider(EditorDataProvider provider,
                                            Disposable parentDisposable)

Specified by:

registerExtraEditorDataProvider in class FileEditorManager

refreshIcons

public void refreshIcons()

getSplittersFor

public abstract EditorsSplitters getSplittersFor(java.awt.Component c)

notifyPublisher

public abstract ActionCallback notifyPublisher(java.lang.Runnable runnable)

runWhenLoaded

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

Description copied from class: FileEditorManager

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.

Specified by:

runWhenLoaded in class FileEditorManager