Package com.intellij.openapi.fileEditor.impl

Class EditorHistoryManager

java.lang.Object

com.intellij.openapi.fileEditor.impl.EditorHistoryManager

All Implemented Interfaces:

PersistentStateComponent<Element>, Disposable

public final class EditorHistoryManager
extends java.lang.Object
implements PersistentStateComponent<Element>, Disposable

Nested Class Summary

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

Disposable.Parent

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
java.util.List<VirtualFile>	getFileList()
VirtualFile []	getFiles()
java.util.LinkedHashSet<VirtualFile>	getFileSet() Deprecated. use getFileList()
static EditorHistoryManager	getInstance(Project project)
FileEditorProvider	getSelectedProvider(VirtualFile file)
Element	getState()
FileEditorState	getState(VirtualFile file, FileEditorProvider provider)
boolean	hasBeenOpen(VirtualFile f)
void	loadState(Element state) This method is called when new component state is loaded.
void	removeAllFiles() For internal or test-only usage.
void	removeFile(VirtualFile file) Removes specified file from history.
void	updateHistoryEntry(VirtualFile file, boolean changeEntryOrderOnly)

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

Method Detail

getInstance

public static EditorHistoryManager getInstance(Project project)

updateHistoryEntry

public void updateHistoryEntry(VirtualFile file,
                               boolean changeEntryOrderOnly)

getFiles

public VirtualFile [] getFiles()

Returns:

array of valid files that are in the history, oldest first.

removeAllFiles

public void removeAllFiles()

For internal or test-only usage.

getFileList

public java.util.List<VirtualFile> getFileList()

Returns:

a set of valid files that are in the history, oldest first.

getFileSet

@Deprecated
public java.util.LinkedHashSet<VirtualFile> getFileSet()

Deprecated. use getFileList()

hasBeenOpen

public boolean hasBeenOpen(VirtualFile f)

removeFile

public void removeFile(VirtualFile file)

Removes specified file from history. The method does nothing if file is not in the history.

Throws:

java.lang.IllegalArgumentException - if file is null

getState

public FileEditorState getState(VirtualFile file,
                                FileEditorProvider provider)

getSelectedProvider

public FileEditorProvider getSelectedProvider(VirtualFile file)

Returns:

may be null

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)

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

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable