JabRef 6.0-beta.1 · org.jabref.gui.JabRefGuiStateManager

Field Summary

Modifier and Type	Field and Description
private final org.jabref.logic.util.OptionalObjectProperty<BibDatabaseContext>	activeDatabase
private final org.jabref.logic.util.OptionalObjectProperty<SearchQuery>	activeGlobalSearchQuery
private final org.jabref.logic.util.OptionalObjectProperty<SearchQuery>	activeSearchQuery
private final org.jabref.logic.util.OptionalObjectProperty<LibraryTab>	activeTab
private final org.jabref.logic.util.OptionalObjectProperty<Walkthrough>	activeWalkthrough
private final com.tobiasdiez.easybind.EasyBinding<Boolean>	anyTasksThatWillNotBeRecoveredRunning
private final ObservableList<Task<?>>	backgroundTasks
private final ObservableList<Pair<org.jabref.logic.util.BackgroundTask<?>, Task<?>>>	backgroundTasksPairs
private final BooleanProperty	canGoBack
private final BooleanProperty	canGoForward
private final ObservableMap<String, DialogWindowState>	dialogWindowStates
private final BooleanProperty	editorShowing
private final org.jabref.logic.util.OptionalObjectProperty<Node>	focusOwner
private final IntegerProperty	globalSearchResultSize
private final Map<String, Map<String, AiGroupChatWindow>>	groupAiChatWindows Keyed by `BibDatabaseContext#getUid()` instead of `BibDatabaseContext`, because `BibDatabaseContext#equals(Object)` (and the matching `BibDatabaseContext#hashCode()`) change with the library content and cannot be used as `HashMap` keys.
private final CustomLocalDragboard	localDragboard
private static final Logger	LOGGER
private final ObservableList<BibDatabaseContext>	openDatabases
private final FilteredList<Task<?>>	runningBackgroundTasks
private final ObservableList<String>	searchHistory
private final StringProperty	searchQueryProperty
private final IntegerProperty	searchResultSize
private final ObservableList<BibEntry>	selectedEntries
private final ObservableMap<String, ObservableList<GroupTreeNode>>	selectedGroups
private final Map<String, JabRefGuiUndoManager>	undoManagers Keyed by `BibDatabaseContext#getUid`, as `selectedGroups` is: a context's `hashCode` changes whenever an entry is added, so a map keyed by the context itself loses its entries.
private final ObservableList<SidePaneType>	visibleSidePanes

Constructor Summary

Access	Constructor and Description
public	JabRefGuiStateManager()

Method Summary

Modifier and Type	Method and Description
public org.jabref.logic.util.OptionalObjectProperty<BibDatabaseContext>	activeDatabaseProperty()
public org.jabref.logic.util.OptionalObjectProperty<SearchQuery>	activeSearchQuery(SearchType type) Implements org.jabref.gui.StateManager.activeSearchQuery.
public org.jabref.logic.util.OptionalObjectProperty<LibraryTab>	activeTabProperty() Implements org.jabref.gui.StateManager.activeTabProperty.
public void	addBackgroundTask(org.jabref.logic.util.BackgroundTask<?> backgroundTask, Task<?> task) Implements org.jabref.gui.StateManager.addBackgroundTask.
public void	addSearchHistory(String search) Implements org.jabref.gui.StateManager.addSearchHistory.
public BooleanProperty	canGoBackProperty() Implements org.jabref.gui.StateManager.canGoBackProperty.
public BooleanProperty	canGoForwardProperty() Implements org.jabref.gui.StateManager.canGoForwardProperty.
public void	clearSearchHistory() Implements org.jabref.gui.StateManager.clearSearchHistory.
public void	clearSelectedGroups(BibDatabaseContext context) Implements org.jabref.gui.StateManager.clearSelectedGroups.
public org.jabref.logic.util.OptionalObjectProperty<Node>	focusOwnerProperty() Implements org.jabref.gui.StateManager.focusOwnerProperty.
public Optional<BibDatabaseContext>	getActiveDatabase()
public ObjectBinding<Optional<CommandSelectionTab>>	getActiveSelectionTabProperty()
public Optional<Walkthrough>	getActiveWalkthrough() Implements org.jabref.gui.StateManager.getActiveWalkthrough.
public Optional<AiGroupChatWindow>	getAiChatWindowForGroup(BibDatabaseContext context, String groupName) Implements org.jabref.gui.StateManager.getAiChatWindowForGroup.
public List<String>	getAllDatabasePaths()
public com.tobiasdiez.easybind.EasyBinding<Boolean>	getAnyTasksThatWillNotBeRecoveredRunning() Implements org.jabref.gui.StateManager.getAnyTasksThatWillNotBeRecoveredRunning.
public ObservableList<Task<?>>	getBackgroundTasks() Implements org.jabref.gui.StateManager.getBackgroundTasks.
public DialogWindowState	getDialogWindowState(String className) Implements org.jabref.gui.StateManager.getDialogWindowState.
public BooleanProperty	getEditorShowing() Implements org.jabref.gui.StateManager.getEditorShowing.
public Optional<Node>	getFocusOwner() Implements org.jabref.gui.StateManager.getFocusOwner.
public List<String>	getLastSearchHistory(int size) Implements org.jabref.gui.StateManager.getLastSearchHistory.
public CustomLocalDragboard	getLocalDragboard() Implements org.jabref.gui.StateManager.getLocalDragboard.
public ObservableList<BibDatabaseContext>	getOpenDatabases()
public ObservableList<Task<?>>	getRunningBackgroundTasks() Implements org.jabref.gui.StateManager.getRunningBackgroundTasks.
public ObservableList<BibEntry>	getSelectedEntries() The live selection, not a snapshot of it.
public ObservableList<GroupTreeNode>	getSelectedGroups(BibDatabaseContext context) Implements org.jabref.gui.StateManager.getSelectedGroups.
public GuiUndoManager	getUndoManager(BibDatabaseContext context) Implements org.jabref.gui.StateManager.getUndoManager. Creates the journal on first use, which for a library is while its tab is being built.
public ObservableList<SidePaneType>	getVisibleSidePaneComponents() Implements org.jabref.gui.StateManager.getVisibleSidePaneComponents.
public ObservableList<String>	getWholeSearchHistory() Implements org.jabref.gui.StateManager.getWholeSearchHistory.
public void	removeAiChatWindowForGroup(BibDatabaseContext context, String groupName) Implements org.jabref.gui.StateManager.removeAiChatWindowForGroup.
public void	removeUndoManager(BibDatabaseContext context) Implements org.jabref.gui.StateManager.removeUndoManager. Discards the journal of a library that is closing, with the changes it holds and the entries those changes keep alive.
public void	replaceActiveDatabase(@NonNull BibDatabaseContext database)
public StringProperty	searchQueryProperty() Implements org.jabref.gui.StateManager.searchQueryProperty.
public IntegerProperty	searchResultSize(SearchType type) Implements org.jabref.gui.StateManager.searchResultSize.
public void	setActiveDatabase(@Nullable BibDatabaseContext database) Implements org.jabref.gui.StateManager.setActiveDatabase.
public void	setActiveWalkthrough(Walkthrough walkthrough) Implements org.jabref.gui.StateManager.setActiveWalkthrough.
public void	setAiChatWindowForGroup(BibDatabaseContext context, String groupName, AiGroupChatWindow aiGroupChatWindow) Implements org.jabref.gui.StateManager.setAiChatWindowForGroup.
public void	setDialogWindowState(String className, DialogWindowState state) Implements org.jabref.gui.StateManager.setDialogWindowState.
public void	setSelectedEntries(List<BibEntry> newSelectedEntries) Implements org.jabref.gui.StateManager.setSelectedEntries.
public void	setSelectedGroups(BibDatabaseContext context, List<GroupTreeNode> newSelectedGroups) Implements org.jabref.gui.StateManager.setSelectedGroups.

Field Detail

activeDatabase	back to summary
private final org.jabref.logic.util.OptionalObjectProperty<BibDatabaseContext> activeDatabase

activeGlobalSearchQuery	back to summary
private final org.jabref.logic.util.OptionalObjectProperty<SearchQuery> activeGlobalSearchQuery

activeSearchQuery	back to summary
private final org.jabref.logic.util.OptionalObjectProperty<SearchQuery> activeSearchQuery

activeTab	back to summary
private final org.jabref.logic.util.OptionalObjectProperty<LibraryTab> activeTab

activeWalkthrough	back to summary
private final org.jabref.logic.util.OptionalObjectProperty<Walkthrough> activeWalkthrough

anyTasksThatWillNotBeRecoveredRunning	back to summary
private final com.tobiasdiez.easybind.EasyBinding<Boolean> anyTasksThatWillNotBeRecoveredRunning

backgroundTasks	back to summary
private final ObservableList<Task<?>> backgroundTasks

backgroundTasksPairs	back to summary
private final ObservableList<Pair<org.jabref.logic.util.BackgroundTask<?>, Task<?>>> backgroundTasksPairs

canGoBack	back to summary
private final BooleanProperty canGoBack

canGoForward	back to summary
private final BooleanProperty canGoForward

dialogWindowStates	back to summary
private final ObservableMap<String, DialogWindowState> dialogWindowStates

editorShowing	back to summary
private final BooleanProperty editorShowing

focusOwner	back to summary
private final org.jabref.logic.util.OptionalObjectProperty<Node> focusOwner

globalSearchResultSize	back to summary
private final IntegerProperty globalSearchResultSize

groupAiChatWindows	back to summary
private final Map<String, Map<String, AiGroupChatWindow>> groupAiChatWindows Keyed by `BibDatabaseContext#getUid()` instead of `BibDatabaseContext`, because `BibDatabaseContext#equals(Object)` (and the matching `BibDatabaseContext#hashCode()`) change with the library content and cannot be used as `HashMap` keys.

localDragboard	back to summary
private final CustomLocalDragboard localDragboard

LOGGER	back to summary
private static final Logger LOGGER

openDatabases	back to summary
private final ObservableList<BibDatabaseContext> openDatabases

runningBackgroundTasks	back to summary
private final FilteredList<Task<?>> runningBackgroundTasks

searchHistory	back to summary
private final ObservableList<String> searchHistory

searchQueryProperty	back to summary
private final StringProperty searchQueryProperty

searchResultSize	back to summary
private final IntegerProperty searchResultSize

selectedEntries	back to summary
private final ObservableList<BibEntry> selectedEntries

selectedGroups	back to summary
private final ObservableMap<String, ObservableList<GroupTreeNode>> selectedGroups

undoManagers	back to summary
private final Map<String, JabRefGuiUndoManager> undoManagers Keyed by `BibDatabaseContext#getUid`, as `selectedGroups` is: a context's `hashCode` changes whenever an entry is added, so a map keyed by the context itself loses its entries. Concurrent because changes are recorded from background tasks as well as from the JavaFX thread.

visibleSidePanes	back to summary
private final ObservableList<SidePaneType> visibleSidePanes

Constructor Detail

JabRefGuiStateManager	back to summary
public JabRefGuiStateManager()

Method Detail

activeDatabaseProperty	back to summary
public org.jabref.logic.util.OptionalObjectProperty<BibDatabaseContext> activeDatabaseProperty() Annotations @Override

activeSearchQuery	back to summary
public org.jabref.logic.util.OptionalObjectProperty<SearchQuery> activeSearchQuery(SearchType type) Implements org.jabref.gui.StateManager.activeSearchQuery. Annotations @Override

activeSearchQuery

back to summary

public org.jabref.logic.util.OptionalObjectProperty<SearchQuery> activeSearchQuery(SearchType type)

Implements org.jabref.gui.StateManager.activeSearchQuery.

Annotations

@Override

activeTabProperty	back to summary
public org.jabref.logic.util.OptionalObjectProperty<LibraryTab> activeTabProperty() Implements org.jabref.gui.StateManager.activeTabProperty. Annotations @Override

activeTabProperty

back to summary

public org.jabref.logic.util.OptionalObjectProperty<LibraryTab> activeTabProperty()

Implements org.jabref.gui.StateManager.activeTabProperty.

Annotations

@Override

addBackgroundTask	back to summary
public void addBackgroundTask(org.jabref.logic.util.BackgroundTask<?> backgroundTask, Task<?> task) Implements org.jabref.gui.StateManager.addBackgroundTask. Annotations @Override

addBackgroundTask

back to summary

public void addBackgroundTask(org.jabref.logic.util.BackgroundTask<?> backgroundTask, Task<?> task)

Implements org.jabref.gui.StateManager.addBackgroundTask.

Annotations

@Override

addSearchHistory	back to summary
public void addSearchHistory(String search) Implements org.jabref.gui.StateManager.addSearchHistory. Annotations @Override

addSearchHistory

back to summary

public void addSearchHistory(String search)

Implements org.jabref.gui.StateManager.addSearchHistory.

Annotations

@Override

canGoBackProperty	back to summary
public BooleanProperty canGoBackProperty() Implements org.jabref.gui.StateManager.canGoBackProperty. Annotations @Override

canGoBackProperty

back to summary

public BooleanProperty canGoBackProperty()

Implements org.jabref.gui.StateManager.canGoBackProperty.

Annotations

@Override

canGoForwardProperty	back to summary
public BooleanProperty canGoForwardProperty() Implements org.jabref.gui.StateManager.canGoForwardProperty. Annotations @Override

canGoForwardProperty

back to summary

public BooleanProperty canGoForwardProperty()

Implements org.jabref.gui.StateManager.canGoForwardProperty.

Annotations

@Override

clearSearchHistory	back to summary
public void clearSearchHistory() Implements org.jabref.gui.StateManager.clearSearchHistory. Annotations @Override

clearSearchHistory

back to summary

public void clearSearchHistory()

Implements org.jabref.gui.StateManager.clearSearchHistory.

Annotations

@Override

clearSelectedGroups	back to summary
public void clearSelectedGroups(BibDatabaseContext context) Implements org.jabref.gui.StateManager.clearSelectedGroups. Annotations @Override

clearSelectedGroups

back to summary

public void clearSelectedGroups(BibDatabaseContext context)

Implements org.jabref.gui.StateManager.clearSelectedGroups.

Annotations

@Override

focusOwnerProperty	back to summary
public org.jabref.logic.util.OptionalObjectProperty<Node> focusOwnerProperty() Implements org.jabref.gui.StateManager.focusOwnerProperty. Annotations @Override

focusOwnerProperty

back to summary

public org.jabref.logic.util.OptionalObjectProperty<Node> focusOwnerProperty()

Implements org.jabref.gui.StateManager.focusOwnerProperty.

Annotations

@Override

getActiveDatabase	back to summary
public Optional<BibDatabaseContext> getActiveDatabase() Annotations @Override

getActiveSelectionTabProperty	back to summary
public ObjectBinding<Optional<CommandSelectionTab>> getActiveSelectionTabProperty() Annotations @Override

getActiveWalkthrough	back to summary
public Optional<Walkthrough> getActiveWalkthrough() Implements org.jabref.gui.StateManager.getActiveWalkthrough. Annotations @Override

getActiveWalkthrough

back to summary

public Optional<Walkthrough> getActiveWalkthrough()

Implements org.jabref.gui.StateManager.getActiveWalkthrough.

Annotations

@Override

getAiChatWindowForGroup	back to summary
public Optional<AiGroupChatWindow> getAiChatWindowForGroup(BibDatabaseContext context, String groupName) Implements org.jabref.gui.StateManager.getAiChatWindowForGroup. Annotations @Override

getAiChatWindowForGroup

back to summary

public Optional<AiGroupChatWindow> getAiChatWindowForGroup(BibDatabaseContext context, String groupName)

Implements org.jabref.gui.StateManager.getAiChatWindowForGroup.

Annotations

@Override

getAllDatabasePaths	back to summary
public List<String> getAllDatabasePaths() Annotations @Override

getAnyTasksThatWillNotBeRecoveredRunning	back to summary
public com.tobiasdiez.easybind.EasyBinding<Boolean> getAnyTasksThatWillNotBeRecoveredRunning() Implements org.jabref.gui.StateManager.getAnyTasksThatWillNotBeRecoveredRunning. Annotations @Override

getAnyTasksThatWillNotBeRecoveredRunning

back to summary

public com.tobiasdiez.easybind.EasyBinding<Boolean> getAnyTasksThatWillNotBeRecoveredRunning()

Implements org.jabref.gui.StateManager.getAnyTasksThatWillNotBeRecoveredRunning.

Annotations

@Override

getBackgroundTasks	back to summary
public ObservableList<Task<?>> getBackgroundTasks() Implements org.jabref.gui.StateManager.getBackgroundTasks. Annotations @Override

getBackgroundTasks

back to summary

public ObservableList<Task<?>> getBackgroundTasks()

Implements org.jabref.gui.StateManager.getBackgroundTasks.

Annotations

@Override

getDialogWindowState	back to summary
public DialogWindowState getDialogWindowState(String className) Implements org.jabref.gui.StateManager.getDialogWindowState. Annotations @Override

getDialogWindowState

back to summary

public DialogWindowState getDialogWindowState(String className)

Implements org.jabref.gui.StateManager.getDialogWindowState.

Annotations

@Override

getEditorShowing	back to summary
public BooleanProperty getEditorShowing() Implements org.jabref.gui.StateManager.getEditorShowing. Annotations @Override

getEditorShowing

back to summary

public BooleanProperty getEditorShowing()

Implements org.jabref.gui.StateManager.getEditorShowing.

Annotations

@Override

getFocusOwner	back to summary
public Optional<Node> getFocusOwner() Implements org.jabref.gui.StateManager.getFocusOwner. Annotations @Override

getFocusOwner

back to summary

public Optional<Node> getFocusOwner()

Implements org.jabref.gui.StateManager.getFocusOwner.

Annotations

@Override

getLastSearchHistory

back to summary

public List<String> getLastSearchHistory(int size)

Implements org.jabref.gui.StateManager.getLastSearchHistory.

Annotations

@Override

getLocalDragboard

back to summary

public CustomLocalDragboard getLocalDragboard()

Implements org.jabref.gui.StateManager.getLocalDragboard.

Annotations

@Override

getOpenDatabases	back to summary
public ObservableList<BibDatabaseContext> getOpenDatabases() Annotations @Override

getRunningBackgroundTasks

back to summary

public ObservableList<Task<?>> getRunningBackgroundTasks()

Implements org.jabref.gui.StateManager.getRunningBackgroundTasks.

Annotations

@Override

getSelectedEntries back to summary

public ObservableList<BibEntry> getSelectedEntries()

The live selection, not a snapshot of it.

setSelectedEntries replaces the contents of this very list, which happens every time the user selects different entries or switches to another library.

Copy it before handing it to anything that reads it later, such as a background task. A task holding this list sees the selection as it is when it looks, not as it was when the task started.

Annotations

@Override

getSelectedGroups

back to summary

public ObservableList<GroupTreeNode> getSelectedGroups(BibDatabaseContext context)

Implements org.jabref.gui.StateManager.getSelectedGroups.

Annotations

@Override

getUndoManager back to summary

public GuiUndoManager getUndoManager(BibDatabaseContext context)

Implements org.jabref.gui.StateManager.getUndoManager.

Creates the journal on first use, which for a library is while its tab is being built. A caller that names a library after it closed therefore gets a fresh journal rather than the one that was discarded; org.jabref.gui.LibraryTab#getUndoManager answers with the journal the library had instead, so that path cannot put a new one back into this map.

Annotations