Verified Owner
Top Description Fields Constructors Methods
org.jabref.gui

public Class JabRefGUI

extends Application
Class Inheritance
Imports
java.io.IOException, .InputStream, java.util.List, .Optional, java.util.concurrent.ExecutorService, .Executors, javafx.application.Application, .Platform, javafx.beans.binding.Bindings, javafx.collections.ListChangeListener, javafx.concurrent.Task, javafx.geometry.Rectangle2D, javafx.scene.Scene, javafx.scene.input.KeyEvent, javafx.scene.layout.Region, javafx.scene.text.Font, javafx.stage.Screen, .Stage, .WindowEvent, org.jabref.gui.clipboard.ClipBoardManager, org.jabref.gui.frame.JabRefFrame, org.jabref.gui.help.VersionWorker, org.jabref.gui.icon.IconTheme, org.jabref.gui.keyboard.KeyBindingRepository, .SelectableTextFlowKeyBindings, .TextInputKeyBindings, .WalkthroughKeyBindings, org.jabref.gui.openoffice.OOBibBaseConnect, org.jabref.gui.preferences.GuiPreferences, org.jabref.gui.remote.CLIMessageHandler, org.jabref.gui.theme.ThemeManager, org.jabref.gui.util.DefaultFileUpdateMonitor, .DirectoryMonitor, .UiTaskExecutor, org.jabref.gui.walkthrough.WalkthroughPane, org.jabref.http.manager.HttpServerManager, org.jabref.languageserver.controller.LanguageServerController, org.jabref.logic.UiCommand, org.jabref.logic.ai.AiService, org.jabref.logic.citation.SearchCitationsRelationsService, org.jabref.logic.git.GitSsh, org.jabref.logic.git.util.GitHandlerRegistry, org.jabref.logic.journals.JournalAbbreviationLoader, .JournalAbbreviationRepository, org.jabref.logic.l10n.Localization, org.jabref.logic.net.ProxyRegisterer, org.jabref.logic.os.OS, org.jabref.logic.protectedterms.ProtectedTermsLoader, org.jabref.logic.remote.RemotePreferences, org.jabref.logic.remote.server.RemoteListenerServerManager, org.jabref.logic.search.sqlbased.IndexManager, .PostgresServer, org.jabref.logic.util.BuildInfo, .FallbackExceptionHandler, .HeadlessExecutorService, .TaskExecutor, org.jabref.logic.util.strings.StringUtil, org.jabref.model.entry.BibEntryTypesManager, org.jabref.model.util.FileUpdateMonitor, com.airhacks.afterburner.injection.Injector, com.dlsc.gemsfx.PowerPane, com.dlsc.gemsfx.infocenter.InfoCenterPane, .InfoCenterViewPos, com.tobiasdiez.easybind.EasyBind, io.github.kusoroadeolu.veneer.BibTeXSyntaxHighlighter, kong.unirest.core.Unirest, org.controlsfx.control.decoration.Decorator, .GraphicDecoration, org.controlsfx.dialog.ExceptionDialog, org.slf4j.Logger, .LoggerFactory

Represents the outer stage and the scene of the JabRef window.

Field Summary

Modifier and TypeField and Description
private static AiService
private static final String
private static BibTeXSyntaxHighlighter
private static SearchCitationsRelationsService
private static ClipBoardManager
private static DialogService
private static FileUpdateMonitor
private static GitHandlerRegistry
private static HttpServerManager
private static JournalAbbreviationRepository
private static LanguageServerController
private static final Logger
private static JabRefFrame
private Stage
private static GuiPreferences
private static RemoteListenerServerManager
private static StateManager
private static TaskExecutor
private static ThemeManager
private static List<UiCommand>
Inherited from javafx.application.Application:
STYLESHEET_CASPIANSTYLESHEET_MODENA

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private void
debugLogWindowState(Stage
JabRef's stage
mainStage
)

prints the data from the screen (only in debug mode)

public void
private static void
installControlsFxDecorationPane(PowerPane powerpane)

Installs ControlsFX's decoration root before validation is first used.

private boolean
isWindowPositionInBounds()

Tests if the window coordinates are inside any screen

private void
loadBundledFonts()

Registers bundled fonts so they can be referenced by family name in CSS.

private boolean
public void
public void
public void
private void
private void
public static void
setup(List<UiCommand> uiCommands, GuiPreferences preferences)

private void
private void
private void
showCriticalErrorDialog(String header, Throwable throwable)

impl->req~ux.startup.critical-error-dialog~1

Used both for startup failures (from start(Stage)'s catch block) and for uncaught exceptions on other threads (FallbackExceptionHandler, installed before initialize() so it also covers background threads started during startup).

public void
start(Stage stage)

Implements abstract javafx.application.Application.start.

The main entry point for all JavaFX applications.

public void
public void
stop()

Overrides javafx.application.Application.stop.

This method is called when the application should stop, and provides a convenient place to prepare for application exit and destroy resources.

private boolean
Inherited from javafx.application.Application:
getHostServicesgetParametersgetUserAgentStylesheetinitlaunchlaunchnotifyPreloadersetUserAgentStylesheet

Field Detail

aiServiceback to summary
private static AiService aiService
BIBTEX_EDITOR_FONT_RESOURCEback to summary
private static final String BIBTEX_EDITOR_FONT_RESOURCE
bibTeXSyntaxHighlighterback to summary
private static BibTeXSyntaxHighlighter bibTeXSyntaxHighlighter
citationsAndRelationsSearchServiceback to summary
private static SearchCitationsRelationsService citationsAndRelationsSearchService
clipBoardManagerback to summary
private static ClipBoardManager clipBoardManager
dialogServiceback to summary
private static DialogService dialogService
fileUpdateMonitorback to summary
private static FileUpdateMonitor fileUpdateMonitor
gitHandlerRegistryback to summary
private static GitHandlerRegistry gitHandlerRegistry
httpServerManagerback to summary
private static HttpServerManager httpServerManager
journalAbbreviationRepositoryback to summary
private static JournalAbbreviationRepository journalAbbreviationRepository
languageServerControllerback to summary
private static LanguageServerController languageServerController
LOGGERback to summary
private static final Logger LOGGER
mainFrameback to summary
private static JabRefFrame mainFrame
mainStageback to summary
private Stage mainStage
preferencesback to summary
private static GuiPreferences preferences
remoteListenerServerManagerback to summary
private static RemoteListenerServerManager remoteListenerServerManager
stateManagerback to summary
private static StateManager stateManager
taskExecutorback to summary
private static TaskExecutor taskExecutor
themeManagerback to summary
private static ThemeManager themeManager
uiCommandsback to summary
private static List<UiCommand> uiCommands

Constructor Detail

JabRefGUIback to summary
public JabRefGUI()

Method Detail

debugLogWindowStateback to summary
private void debugLogWindowState(Stage mainStage)

prints the data from the screen (only in debug mode)

Parameters
mainStage:Stage

JabRef's stage

initializeback to summary
public void initialize()
installControlsFxDecorationPaneback to summary
private static void installControlsFxDecorationPane(PowerPane powerpane)

Installs ControlsFX's decoration root before validation is first used.

ControlsFX injects its internal DecorationPane as the scene root on the first decoration. Doing that during startup avoids replacing the root while opening the entry editor, which would otherwise trigger a large CSS reapplication on the critical path.

isWindowPositionInBoundsback to summary
private boolean isWindowPositionInBounds()

Tests if the window coordinates are inside any screen

loadBundledFontsback to summary
private void loadBundledFonts()

Registers bundled fonts so they can be referenced by family name in CSS.

lowerLeftIsInBoundsback to summary
private boolean lowerLeftIsInBounds(CoreGuiPreferences coreGuiPreferences)
onCloseRequestback to summary
public void onCloseRequest(WindowEvent event)
onHidingback to summary
public void onHiding(WindowEvent event)
onShowingback to summary
public void onShowing(WindowEvent event)
openWindowback to summary
private void openWindow()
saveWindowStateback to summary
private void saveWindowState()
setupback to summary
public static void setup(List<UiCommand> uiCommands, GuiPreferences preferences)
setupHttpServerEnabledListenerback to summary
private void setupHttpServerEnabledListener()
setupProxyback to summary
private void setupProxy()
showCriticalErrorDialogback to summary
private void showCriticalErrorDialog(String header, Throwable throwable)

impl->req~ux.startup.critical-error-dialog~1

Used both for startup failures (from start(Stage)'s catch block) and for uncaught exceptions on other threads (FallbackExceptionHandler, installed before initialize() so it also covers background threads started during startup). In both cases, DialogService or Scene may not exist yet: DialogService is only set up in initialize(), and Scene is only set in openWindow(). Calling DialogService or Dialog.initOwner before then throws a NullPointerException, so this falls back to an ownerless ExceptionDialog instead.

startback to summary
public void start(Stage stage)

Implements abstract javafx.application.Application.start.

Doc from javafx.application.Application.start.

The main entry point for all JavaFX applications. The start method is called after the init method has returned, and after the system is ready for the application to begin running.

Note

This method is called on the JavaFX Application Thread.

Annotations
@Override
startBackgroundTasksback to summary
public void startBackgroundTasks()
stopback to summary
public void stop()

Overrides javafx.application.Application.stop.

Doc from javafx.application.Application.stop.

This method is called when the application should stop, and provides a convenient place to prepare for application exit and destroy resources.

The implementation of this method provided by the Application class does nothing.

Note

This method is called on the JavaFX Application Thread.

Annotations
@Override
upperRightIsInBoundsback to summary
private boolean upperRightIsInBounds(CoreGuiPreferences coreGuiPreferences)