Top Description Inners Fields Constructors Methods
org.jabref.gui.frame

public Class JabRefFrame

extends BorderPane
implements LibraryTabContainer, UiMessageHandler
Class Inheritance
All Implemented Interfaces
org.jabref.gui.frame.UiMessageHandler, org.jabref.gui.LibraryTabContainer
Imports
java.io.IOException, java.nio.file.Path, java.util.Collections, .List, .Objects, .Optional, java.util.function.Supplier, javafx.application.Platform, javafx.beans.InvalidationListener, javafx.beans.binding.Bindings, .StringBinding, javafx.collections.transformation.FilteredList, javafx.event.Event, javafx.scene.control.ContextMenu, .SeparatorMenuItem, .SplitPane, .Tab, .TabPane, javafx.scene.input.KeyEvent, javafx.scene.layout.BorderPane, .VBox, javafx.stage.Stage, org.jabref.gui.ClipBoardManager, .DialogService, .LibraryTab, .LibraryTabContainer, .StateManager, org.jabref.gui.actions.ActionFactory, .ActionHelper, .SimpleCommand, .StandardActions, org.jabref.gui.desktop.JabRefDesktop, org.jabref.gui.importer.NewEntryAction, org.jabref.gui.importer.actions.OpenDatabaseAction, org.jabref.gui.keyboard.KeyBinding, org.jabref.gui.libraryproperties.LibraryPropertiesAction, org.jabref.gui.push.PushToApplicationCommand, org.jabref.gui.search.GlobalSearchBar, .SearchType, org.jabref.gui.sidepane.SidePane, .SidePaneType, org.jabref.gui.undo.CountingUndoManager, org.jabref.gui.util.TaskExecutor, org.jabref.logic.UiCommand, org.jabref.logic.journals.JournalAbbreviationRepository, org.jabref.logic.util.OS, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntryTypesManager, org.jabref.model.entry.types.StandardEntryType, org.jabref.model.util.FileUpdateMonitor, org.jabref.preferences.PreferencesService, com.airhacks.afterburner.injection.Injector, com.tobiasdiez.easybind.EasyBind, com.tobiasdiez.easybind.EasyObservableList, com.tobiasdiez.easybind.Subscription, org.fxmisc.richtext.CodeArea, org.jspecify.annotations.NonNull, org.slf4j.Logger, .LoggerFactory
Represents the inner frame of the JabRef window

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static class
JabRefFrame.CloseAction

The action concerned with closing the window.

private class
JabRefFrame.CloseAllDatabaseAction

protected static class
JabRefFrame.CloseDatabaseAction

private class
JabRefFrame.CloseOthersDatabaseAction

private class
JabRefFrame.OpenDatabaseFolder

Field Summary

Modifier and TypeField and Description
private final ClipBoardManager
clipBoardManager

private final DialogService
dialogService

private com.tobiasdiez.easybind.Subscription
dividerSubscription

private final BibEntryTypesManager
entryTypesManager

private final FileHistoryMenu
fileHistory

private final FileUpdateMonitor
fileUpdateMonitor

public static final String
FRAME_TITLE

private final FrameDndHandler
frameDndHandler

private final GlobalSearchBar
globalSearchBar

private static final Logger
LOGGER

private final Stage
mainStage

private com.tobiasdiez.easybind.EasyObservableList<BibDatabaseContext>
openDatabaseList

private final PreferencesService
prefs

private final PushToApplicationCommand
pushToApplicationCommand

private final SidePane
sidePane

private final SplitPane
splitPane

private final StateManager
stateManager

private final TabPane
tabbedPane

private final TaskExecutor
taskExecutor

private final CountingUndoManager
undoManager

private final JabRefFrameViewModel
viewModel

Constructor Summary

AccessConstructor and Description
public
JabRefFrame(Stage mainStage, DialogService dialogService, FileUpdateMonitor fileUpdateMonitor, PreferencesService preferencesService, StateManager stateManager, CountingUndoManager undoManager, BibEntryTypesManager entryTypesManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor)

Method Summary

Modifier and TypeMethod and Description
public void
addTab(@NonNull BibDatabaseContext databaseContext, boolean raisePanel)

Implements org.jabref.gui.LibraryTabContainer.addTab.

Opens a new tab with existing data.

public void
addTab(@NonNull LibraryTab libraryTab, boolean raisePanel)

Implements org.jabref.gui.LibraryTabContainer.addTab.

public boolean
close()

public boolean
closeTab(LibraryTab tab)

public boolean
closeTabs(@NonNull List<LibraryTab> tabs)

private ContextMenu
createTabContextMenuFor(LibraryTab tab)

public LibraryTab
getCurrentLibraryTab()

Implements org.jabref.gui.LibraryTabContainer.getCurrentLibraryTab.

Returns the currently viewed LibraryTab.

public @NonNull List<LibraryTab>
getLibraryTabs()

Implements org.jabref.gui.LibraryTabContainer.getLibraryTabs.

Returns a list of all LibraryTabs in this frame.

public Stage
getMainStage()

private OpenDatabaseAction
getOpenDatabaseAction()

public void
handleUiCommands(List<UiCommand> uiCommands)

Implements org.jabref.gui.frame.UiMessageHandler.handleUiCommands.

private void
initBindings()

private void
initKeyBindings()

private void
initLayout()

public void
openLastEditedDatabases()

public void
refresh()

Implements org.jabref.gui.LibraryTabContainer.refresh.

Refreshes the ui after preferences changes

public void
showLibraryTab(@NonNull LibraryTab libraryTab)

Implements org.jabref.gui.LibraryTabContainer.showLibraryTab.

public void
updateDividerPosition()

private void
updateSidePane()

Inherited from javafx.scene.layout.BorderPane:
bottomPropertycenterPropertyclearConstraintscomputeMinHeightcomputeMinWidthcomputePrefHeightcomputePrefWidthgetAlignmentgetBottomgetCentergetContentBiasgetLeftgetMargingetRightgetToplayoutChildrenleftPropertyrightPropertysetAlignmentsetBottomsetCentersetLeftsetMarginsetRightsetToptopProperty

Field Detail

clipBoardManagerback to summary
private final ClipBoardManager clipBoardManager
dialogServiceback to summary
private final DialogService dialogService
dividerSubscriptionback to summary
private com.tobiasdiez.easybind.Subscription dividerSubscription
entryTypesManagerback to summary
private final BibEntryTypesManager entryTypesManager
fileHistoryback to summary
private final FileHistoryMenu fileHistory
fileUpdateMonitorback to summary
private final FileUpdateMonitor fileUpdateMonitor
FRAME_TITLEback to summary
public static final String FRAME_TITLE
frameDndHandlerback to summary
private final FrameDndHandler frameDndHandler
globalSearchBarback to summary
private final GlobalSearchBar globalSearchBar
LOGGERback to summary
private static final Logger LOGGER
mainStageback to summary
private final Stage mainStage
openDatabaseListback to summary
private com.tobiasdiez.easybind.EasyObservableList<BibDatabaseContext> openDatabaseList
Annotations
@SuppressWarnings:FieldCanBeLocal
prefsback to summary
private final PreferencesService prefs
pushToApplicationCommandback to summary
private final PushToApplicationCommand pushToApplicationCommand
sidePaneback to summary
private final SidePane sidePane
splitPaneback to summary
private final SplitPane splitPane
stateManagerback to summary
private final StateManager stateManager
tabbedPaneback to summary
private final TabPane tabbedPane
taskExecutorback to summary
private final TaskExecutor taskExecutor
undoManagerback to summary
private final CountingUndoManager undoManager
viewModelback to summary
private final JabRefFrameViewModel viewModel

Constructor Detail

JabRefFrameback to summary
public JabRefFrame(Stage mainStage, DialogService dialogService, FileUpdateMonitor fileUpdateMonitor, PreferencesService preferencesService, StateManager stateManager, CountingUndoManager undoManager, BibEntryTypesManager entryTypesManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor)

Method Detail

addTabback to summary
public void addTab(@NonNull BibDatabaseContext databaseContext, boolean raisePanel)

Implements org.jabref.gui.LibraryTabContainer.addTab.

Opens a new tab with existing data. Asynchronous loading is done at LibraryTab#createLibraryTab. Similar method: OpenDatabaseAction#openTheFile(Path)

addTabback to summary
public void addTab(@NonNull LibraryTab libraryTab, boolean raisePanel)

Implements org.jabref.gui.LibraryTabContainer.addTab.

closeback to summary
public boolean close()
closeTabback to summary
public boolean closeTab(LibraryTab tab)
closeTabsback to summary
public boolean closeTabs(@NonNull List<LibraryTab> tabs)
createTabContextMenuForback to summary
private ContextMenu createTabContextMenuFor(LibraryTab tab)
getCurrentLibraryTabback to summary
public LibraryTab getCurrentLibraryTab()

Implements org.jabref.gui.LibraryTabContainer.getCurrentLibraryTab.

Returns the currently viewed LibraryTab.

getLibraryTabsback to summary
public @NonNull List<LibraryTab> getLibraryTabs()

Implements org.jabref.gui.LibraryTabContainer.getLibraryTabs.

Returns a list of all LibraryTabs in this frame.

getMainStageback to summary
public Stage getMainStage()
getOpenDatabaseActionback to summary
private OpenDatabaseAction getOpenDatabaseAction()
handleUiCommandsback to summary
public void handleUiCommands(List<UiCommand> uiCommands)

Implements org.jabref.gui.frame.UiMessageHandler.handleUiCommands.

Annotations
@Override
initBindingsback to summary
private void initBindings()
initKeyBindingsback to summary
private void initKeyBindings()
initLayoutback to summary
private void initLayout()
openLastEditedDatabasesback to summary
public void openLastEditedDatabases()
refreshback to summary
public void refresh()

Implements org.jabref.gui.LibraryTabContainer.refresh.

Refreshes the ui after preferences changes

showLibraryTabback to summary
public void showLibraryTab(@NonNull LibraryTab libraryTab)

Implements org.jabref.gui.LibraryTabContainer.showLibraryTab.

updateDividerPositionback to summary
public void updateDividerPosition()
updateSidePaneback to summary
private void updateSidePane()
org.jabref.gui.frame back to summary

protected Class JabRefFrame.CloseAction

extends SimpleCommand
Class Inheritance
The action concerned with closing the window.

Field Summary

Modifier and TypeField and Description
private final JabRefFrame
frame

Inherited from org.jabref.gui.actions.SimpleCommand:
statusMessage

Constructor Summary

AccessConstructor and Description
public
CloseAction(JabRefFrame frame)

Method Summary

Modifier and TypeMethod and Description
public void
execute()

Inherited from org.jabref.gui.actions.SimpleCommand:
getProgressprogressPropertysetExecutablestatusMessageProperty

Field Detail

frameback to summary
private final JabRefFrame frame

Constructor Detail

CloseActionback to summary
public CloseAction(JabRefFrame frame)

Method Detail

executeback to summary
public void execute()
Annotations
@Override
org.jabref.gui.frame back to summary

private Class JabRefFrame.CloseAllDatabaseAction

extends SimpleCommand
Class Inheritance

Field Summary

Inherited from org.jabref.gui.actions.SimpleCommand:
statusMessage

Constructor Summary

AccessConstructor and Description
private
CloseAllDatabaseAction()

Method Summary

Modifier and TypeMethod and Description
public void
execute()

Inherited from org.jabref.gui.actions.SimpleCommand:
getProgressprogressPropertysetExecutablestatusMessageProperty

Constructor Detail

CloseAllDatabaseActionback to summary
private CloseAllDatabaseAction()

Method Detail

executeback to summary
public void execute()
Annotations
@Override
org.jabref.gui.frame back to summary

protected Class JabRefFrame.CloseDatabaseAction

extends SimpleCommand
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final LibraryTab
libraryTab

private final LibraryTabContainer
tabContainer

Inherited from org.jabref.gui.actions.SimpleCommand:
statusMessage

Constructor Summary

AccessConstructor and Description
public
CloseDatabaseAction(LibraryTabContainer tabContainer, LibraryTab libraryTab, StateManager stateManager)

public
CloseDatabaseAction(LibraryTabContainer tabContainer, StateManager stateManager)

Using this constructor will result in executing the command on the currently open library tab

Method Summary

Modifier and TypeMethod and Description
public void
execute()

Inherited from org.jabref.gui.actions.SimpleCommand:
getProgressprogressPropertysetExecutablestatusMessageProperty

Field Detail

libraryTabback to summary
private final LibraryTab libraryTab
tabContainerback to summary
private final LibraryTabContainer tabContainer

Constructor Detail

CloseDatabaseActionback to summary
public CloseDatabaseAction(LibraryTabContainer tabContainer, LibraryTab libraryTab, StateManager stateManager)
CloseDatabaseActionback to summary
public CloseDatabaseAction(LibraryTabContainer tabContainer, StateManager stateManager)

Using this constructor will result in executing the command on the currently open library tab

Method Detail

executeback to summary
public void execute()
Annotations
@Override
org.jabref.gui.frame back to summary

private Class JabRefFrame.CloseOthersDatabaseAction

extends SimpleCommand
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final LibraryTab
libraryTab

Inherited from org.jabref.gui.actions.SimpleCommand:
statusMessage

Constructor Summary

AccessConstructor and Description
public
CloseOthersDatabaseAction(LibraryTab libraryTab)

Method Summary

Modifier and TypeMethod and Description
public void
execute()

Inherited from org.jabref.gui.actions.SimpleCommand:
getProgressprogressPropertysetExecutablestatusMessageProperty

Field Detail

libraryTabback to summary
private final LibraryTab libraryTab

Constructor Detail

CloseOthersDatabaseActionback to summary
public CloseOthersDatabaseAction(LibraryTab libraryTab)

Method Detail

executeback to summary
public void execute()
Annotations
@Override
org.jabref.gui.frame back to summary

private Class JabRefFrame.OpenDatabaseFolder

extends SimpleCommand
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final Supplier<BibDatabaseContext>
databaseContext

Inherited from org.jabref.gui.actions.SimpleCommand:
statusMessage

Constructor Summary

AccessConstructor and Description
public
OpenDatabaseFolder(Supplier<BibDatabaseContext> databaseContext)

Method Summary

Modifier and TypeMethod and Description
public void
execute()

Inherited from org.jabref.gui.actions.SimpleCommand:
getProgressprogressPropertysetExecutablestatusMessageProperty

Field Detail

databaseContextback to summary
private final Supplier<BibDatabaseContext> databaseContext

Constructor Detail

OpenDatabaseFolderback to summary
public OpenDatabaseFolder(Supplier<BibDatabaseContext> databaseContext)

Method Detail

executeback to summary
public void execute()
Annotations
@Override