Verified Owner
Top Description Methods
org.jabref.gui

public Interface StateManager

extends SrvStateManager
Known Direct Implementers
org.jabref.gui.JabRefGuiStateManager
Imports
java.util.List, .Optional, javafx.beans.property.BooleanProperty, .IntegerProperty, .StringProperty, javafx.collections.ObservableList, javafx.concurrent.Task, javafx.scene.Node, org.jabref.gui.ai.chat.AiGroupChatWindow, org.jabref.gui.search.SearchType, org.jabref.gui.sidepane.SidePaneType, org.jabref.gui.undo.GuiUndoManager, org.jabref.gui.util.CustomLocalDragboard, .DialogWindowState, org.jabref.gui.walkthrough.Walkthrough, org.jabref.http.SrvStateManager, org.jabref.logic.search.SearchContext, org.jabref.logic.util.BackgroundTask, .OptionalObjectProperty, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntry, org.jabref.model.groups.GroupTreeNode, org.jabref.model.search.query.SearchQuery, com.tobiasdiez.easybind.EasyBinding, org.jspecify.annotations.NonNull
This class manages the GUI-state of JabRef, including:

Method Summary

Modifier and TypeMethod and Description
public org.jabref.logic.util.OptionalObjectProperty<SearchQuery>
activeSearchQuery(SearchType type)

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

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

public void
addSearchHistory(String search)

public BooleanProperty
canGoBackProperty()

public BooleanProperty
canGoForwardProperty()

public void
clearSearchHistory()

public void
clearSelectedGroups(BibDatabaseContext context)

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

public Optional<Walkthrough>
getActiveWalkthrough()

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

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

public ObservableList<Task<?>>
getBackgroundTasks()

public DialogWindowState
getDialogWindowState(String className)

public BooleanProperty
getEditorShowing()

public Optional<Node>
getFocusOwner()

public List<String>
getLastSearchHistory(int size)

public CustomLocalDragboard
getLocalDragboard()

public ObservableList<Task<?>>
getRunningBackgroundTasks()

public ObservableList<GroupTreeNode>
getSelectedGroups(BibDatabaseContext context)

public GuiUndoManager
getUndoManager(BibDatabaseContext context)

The undo journal of the library context describes.

public ObservableList<SidePaneType>
getVisibleSidePaneComponents()

public ObservableList<String>
getWholeSearchHistory()

public void
removeAiChatWindowForGroup(BibDatabaseContext context, String groupName)

public void
removeUndoManager(BibDatabaseContext context)

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

public IntegerProperty
searchResultSize(SearchType type)

public void
setActiveDatabase(BibDatabaseContext database)

public void
setActiveWalkthrough(Walkthrough walkthrough)

public void
setAiChatWindowForGroup(BibDatabaseContext context, String groupName, AiGroupChatWindow aiGroupChatWindow)

public void
setDialogWindowState(String className, DialogWindowState state)

public void
setSearchContext(BibDatabaseContext database, SearchContext searchContext)

public void
setSelectedEntries(List<BibEntry> newSelectedEntries)

public void
setSelectedGroups(BibDatabaseContext context, List<GroupTreeNode> newSelectedGroups)

Method Detail

activeSearchQueryback to summary
public org.jabref.logic.util.OptionalObjectProperty<SearchQuery> activeSearchQuery(SearchType type)
activeTabPropertyback to summary
public org.jabref.logic.util.OptionalObjectProperty<LibraryTab> activeTabProperty()
addBackgroundTaskback to summary
public void addBackgroundTask(org.jabref.logic.util.BackgroundTask<?> backgroundTask, Task<?> task)
addSearchHistoryback to summary
public void addSearchHistory(String search)
canGoBackPropertyback to summary
public BooleanProperty canGoBackProperty()
canGoForwardPropertyback to summary
public BooleanProperty canGoForwardProperty()
clearSearchHistoryback to summary
public void clearSearchHistory()
clearSelectedGroupsback to summary
public void clearSelectedGroups(BibDatabaseContext context)
focusOwnerPropertyback to summary
public org.jabref.logic.util.OptionalObjectProperty<Node> focusOwnerProperty()
getActiveWalkthroughback to summary
public Optional<Walkthrough> getActiveWalkthrough()
getAiChatWindowForGroupback to summary
public Optional<AiGroupChatWindow> getAiChatWindowForGroup(BibDatabaseContext context, String groupName)
getAnyTasksThatWillNotBeRecoveredRunningback to summary
public com.tobiasdiez.easybind.EasyBinding<Boolean> getAnyTasksThatWillNotBeRecoveredRunning()
getBackgroundTasksback to summary
public ObservableList<Task<?>> getBackgroundTasks()
getDialogWindowStateback to summary
public DialogWindowState getDialogWindowState(String className)
getEditorShowingback to summary
public BooleanProperty getEditorShowing()
getFocusOwnerback to summary
public Optional<Node> getFocusOwner()
getLastSearchHistoryback to summary
public List<String> getLastSearchHistory(int size)
getLocalDragboardback to summary
public CustomLocalDragboard getLocalDragboard()
getRunningBackgroundTasksback to summary
public ObservableList<Task<?>> getRunningBackgroundTasks()
getSelectedGroupsback to summary
public ObservableList<GroupTreeNode> getSelectedGroups(BibDatabaseContext context)
getUndoManagerback to summary
public GuiUndoManager getUndoManager(BibDatabaseContext context)

The undo journal of the library context describes.

Each library has its own, so a caller names the library it is recording against instead of holding a journal handed to it when it was built. Which library that is has to be decided where the change is made, not where the change lands: a task that finishes after the user switched libraries still belongs to the one it ran on.

This is where a library's journal lives, so it hands out the whole of it. A caller that only records says so by what it declares — the parameter it passes the journal to, or org.jabref.gui.LibraryTab#getUndoManager, which hands its collaborators the recording half.

getVisibleSidePaneComponentsback to summary
public ObservableList<SidePaneType> getVisibleSidePaneComponents()
getWholeSearchHistoryback to summary
public ObservableList<String> getWholeSearchHistory()
removeAiChatWindowForGroupback to summary
public void removeAiChatWindowForGroup(BibDatabaseContext context, String groupName)
removeUndoManagerback to summary
public void removeUndoManager(BibDatabaseContext context)

Discards the journal of a library that is closing, with the changes it holds and the entries those changes keep alive.

replaceActiveDatabaseback to summary
public void replaceActiveDatabase(@NonNull BibDatabaseContext database)
searchQueryPropertyback to summary
public StringProperty searchQueryProperty()
searchResultSizeback to summary
public IntegerProperty searchResultSize(SearchType type)
setActiveDatabaseback to summary
public void setActiveDatabase(BibDatabaseContext database)
setActiveWalkthroughback to summary
public void setActiveWalkthrough(Walkthrough walkthrough)
setAiChatWindowForGroupback to summary
public void setAiChatWindowForGroup(BibDatabaseContext context, String groupName, AiGroupChatWindow aiGroupChatWindow)
setDialogWindowStateback to summary
public void setDialogWindowState(String className, DialogWindowState state)
setSearchContextback to summary
public void setSearchContext(BibDatabaseContext database, SearchContext searchContext)
setSelectedEntriesback to summary
public void setSelectedEntries(List<BibEntry> newSelectedEntries)
setSelectedGroupsback to summary
public void setSelectedGroups(BibDatabaseContext context, List<GroupTreeNode> newSelectedGroups)