Package com.intellij.openapi.fileEditor.impl

Class IdeDocumentHistoryImpl

java.lang.Object

com.intellij.openapi.fileEditor.ex.IdeDocumentHistory

com.intellij.openapi.fileEditor.impl.IdeDocumentHistoryImpl

All Implemented Interfaces:

PersistentStateComponent<IdeDocumentHistoryImpl.RecentlyChangedFilesState>, Disposable

public class IdeDocumentHistoryImpl
extends IdeDocumentHistory
implements Disposable, PersistentStateComponent<IdeDocumentHistoryImpl.RecentlyChangedFilesState>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdeDocumentHistoryImpl.PlaceInfo
static class	IdeDocumentHistoryImpl.RecentlyChangedFilesState
static interface	IdeDocumentHistoryImpl.RecentPlacesListener IdeDocumentHistoryImpl.RecentPlacesListener listens recently viewed or changed place adding and removing events.

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

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
IdeDocumentHistoryImpl(Project project)

Method Summary

Modifier and Type	Method and Description
static void	appendTimestamp(Project project, SimpleColoredComponent component, VirtualFile file)
void	back()
void	clearHistory()
protected IdeDocumentHistoryImpl.PlaceInfo	createPlaceInfo(FileEditor fileEditor, FileEditorProvider fileProvider)
void	dispose() Usually not invoked directly, see class javadoc.
protected void	executeCommand(java.lang.Runnable runnable, java.lang.String name, java.lang.Object groupId)
void	forward()
java.util.List<IdeDocumentHistoryImpl.PlaceInfo>	getBackPlaces()
VirtualFile[]	getChangedFiles()
java.util.List<IdeDocumentHistoryImpl.PlaceInfo>	getChangePlaces()
protected FileEditorManagerEx	getFileEditorManager()
PersistentHashMap<java.lang.String,java.lang.Long>	getRecentFilesTimestamps()
protected FileEditorWithProvider	getSelectedEditor()
IdeDocumentHistoryImpl.RecentlyChangedFilesState	getState()
void	gotoPlaceInfo(IdeDocumentHistoryImpl.PlaceInfo info)
void	gotoPlaceInfo(IdeDocumentHistoryImpl.PlaceInfo info, boolean wasActive)
void	includeCurrentCommandAsNavigation()
void	includeCurrentPlaceAsChangePlace()
boolean	isBackAvailable()
boolean	isForwardAvailable()
boolean	isNavigateNextChangeAvailable()
boolean	isNavigatePreviousChangeAvailable()
static boolean	isSame(IdeDocumentHistoryImpl.PlaceInfo first, IdeDocumentHistoryImpl.PlaceInfo second)
void	loadState(IdeDocumentHistoryImpl.RecentlyChangedFilesState state) This method is called when new component state is loaded.
void	navigateNextChange()
void	navigatePreviousChange()
void	onSelectionChanged()
void	removeBackPlace(IdeDocumentHistoryImpl.PlaceInfo placeInfo)
void	removeChangePlace(IdeDocumentHistoryImpl.PlaceInfo placeInfo)
void	setCurrentCommandHasMoves()

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

getInstance

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

Constructor Detail

IdeDocumentHistoryImpl

public IdeDocumentHistoryImpl(Project project)

Method Detail

getFileEditorManager

protected FileEditorManagerEx getFileEditorManager()

appendTimestamp

public static void appendTimestamp(Project project,
                                   SimpleColoredComponent component,
                                   VirtualFile file)

getState

public IdeDocumentHistoryImpl.RecentlyChangedFilesState getState()

Specified by:

getState in interface PersistentStateComponent<IdeDocumentHistoryImpl.RecentlyChangedFilesState>

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(IdeDocumentHistoryImpl.RecentlyChangedFilesState 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<IdeDocumentHistoryImpl.RecentlyChangedFilesState>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

onSelectionChanged

public final void onSelectionChanged()

includeCurrentCommandAsNavigation

public final void includeCurrentCommandAsNavigation()

Specified by:

includeCurrentCommandAsNavigation in class IdeDocumentHistory

setCurrentCommandHasMoves

public void setCurrentCommandHasMoves()

Specified by:

setCurrentCommandHasMoves in class IdeDocumentHistory

includeCurrentPlaceAsChangePlace

public final void includeCurrentPlaceAsChangePlace()

Specified by:

includeCurrentPlaceAsChangePlace in class IdeDocumentHistory

getChangedFiles

public VirtualFile[] getChangedFiles()

Specified by:

getChangedFiles in class IdeDocumentHistory

getRecentFilesTimestamps

public PersistentHashMap<java.lang.String,java.lang.Long> getRecentFilesTimestamps()

Specified by:

getRecentFilesTimestamps in class IdeDocumentHistory

clearHistory

public final void clearHistory()

Specified by:

clearHistory in class IdeDocumentHistory

back

public final void back()

Specified by:

back in class IdeDocumentHistory

forward

public final void forward()

Specified by:

forward in class IdeDocumentHistory

isBackAvailable

public final boolean isBackAvailable()

Specified by:

isBackAvailable in class IdeDocumentHistory

isForwardAvailable

public final boolean isForwardAvailable()

Specified by:

isForwardAvailable in class IdeDocumentHistory

navigatePreviousChange

public final void navigatePreviousChange()

Specified by:

navigatePreviousChange in class IdeDocumentHistory

getBackPlaces

public java.util.List<IdeDocumentHistoryImpl.PlaceInfo> getBackPlaces()

Specified by:

getBackPlaces in class IdeDocumentHistory

getChangePlaces

public java.util.List<IdeDocumentHistoryImpl.PlaceInfo> getChangePlaces()

Specified by:

getChangePlaces in class IdeDocumentHistory

removeBackPlace

public void removeBackPlace(IdeDocumentHistoryImpl.PlaceInfo placeInfo)

Specified by:

removeBackPlace in class IdeDocumentHistory

removeChangePlace

public void removeChangePlace(IdeDocumentHistoryImpl.PlaceInfo placeInfo)

Specified by:

removeChangePlace in class IdeDocumentHistory

isNavigatePreviousChangeAvailable

public final boolean isNavigatePreviousChangeAvailable()

Specified by:

isNavigatePreviousChangeAvailable in class IdeDocumentHistory

navigateNextChange

public void navigateNextChange()

Specified by:

navigateNextChange in class IdeDocumentHistory

isNavigateNextChangeAvailable

public boolean isNavigateNextChangeAvailable()

Specified by:

isNavigateNextChangeAvailable in class IdeDocumentHistory

gotoPlaceInfo

public void gotoPlaceInfo(IdeDocumentHistoryImpl.PlaceInfo info)

Specified by:

gotoPlaceInfo in class IdeDocumentHistory

gotoPlaceInfo

public void gotoPlaceInfo(IdeDocumentHistoryImpl.PlaceInfo info,
                          boolean wasActive)

Specified by:

gotoPlaceInfo in class IdeDocumentHistory

getSelectedEditor

protected FileEditorWithProvider getSelectedEditor()

Returns:

currently selected FileEditor or null.

createPlaceInfo

protected IdeDocumentHistoryImpl.PlaceInfo createPlaceInfo(FileEditor fileEditor,
                                                           FileEditorProvider fileProvider)

dispose

public final void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

executeCommand

protected void executeCommand(java.lang.Runnable runnable,
                              java.lang.String name,
                              java.lang.Object groupId)

isSame

public static boolean isSame(IdeDocumentHistoryImpl.PlaceInfo first,
                             IdeDocumentHistoryImpl.PlaceInfo second)