Verified Owner
Top Description Fields Constructors Methods
org.jabref.gui.walkthrough.declarative.sideeffect

public Class OpenLibrarySideEffect

extends Object
implements WalkthroughSideEffect
Class Inheritance
All Implemented Interfaces
org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect
Imports
java.io.IOException, .InputStream, java.util.Collection, .Optional, org.jabref.gui.DialogService, .LibraryTab, .LibraryTabContainer, .StateManager, org.jabref.gui.clipboard.ClipBoardManager, org.jabref.gui.preferences.GuiPreferences, org.jabref.gui.walkthrough.Walkthrough, org.jabref.logic.ai.AiService, org.jabref.logic.git.util.GitHandlerRegistry, org.jabref.logic.importer.OpenDatabase, org.jabref.logic.util.TaskExecutor, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntryTypesManager, org.jabref.model.util.FileUpdateMonitor, com.airhacks.afterburner.injection.Injector, org.jspecify.annotations.NonNull, .Nullable, org.slf4j.Logger, .LoggerFactory
Side effect that opens a specified library in a new tab.

Field Summary

Modifier and TypeField and Description
private @Nullable LibraryTab
createdTab

private final String
libraryName

private static final Logger
LOGGER

private final StateManager
stateManager

private final LibraryTabContainer
tabContainer

private static final String
WALKTHROUGH_LIBRARY_TEMPLATE

Constructor Summary

AccessConstructor and Description
public
OpenLibrarySideEffect(LibraryTabContainer frame)

public
OpenLibrarySideEffect(LibraryTabContainer frame, String libraryName)

Method Summary

Modifier and TypeMethod and Description
public boolean
backward(@NonNull Walkthrough walkthrough)

public @NonNull String
description()

Implements org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect.description.

Gets a description of what this side effect does (for logging and debugging).

public @NonNull ExpectedCondition
expectedCondition()

Implements org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect.expectedCondition.

Expected condition that determines when this side effect can be executed.

private Optional<LibraryTab>
findLibraryTab()

pack-priv static Optional<LibraryTab>
findWalkthroughLibraryTab(Collection<LibraryTab> libraryTabs, @Nullable LibraryTab createdTab, String libraryName)

public boolean
forward(@NonNull Walkthrough walkthrough)

private Optional<BibDatabaseContext>
loadExampleLibrary()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

createdTabback to summary
private @Nullable LibraryTab createdTab
libraryNameback to summary
private final String libraryName
LOGGERback to summary
private static final Logger LOGGER
stateManagerback to summary
private final StateManager stateManager
tabContainerback to summary
private final LibraryTabContainer tabContainer
WALKTHROUGH_LIBRARY_TEMPLATEback to summary
private static final String WALKTHROUGH_LIBRARY_TEMPLATE

Constructor Detail

OpenLibrarySideEffectback to summary
public OpenLibrarySideEffect(LibraryTabContainer frame)
OpenLibrarySideEffectback to summary
public OpenLibrarySideEffect(LibraryTabContainer frame, String libraryName)

Method Detail

backwardback to summary
public boolean backward(@NonNull Walkthrough walkthrough)
Annotations
@Override
descriptionback to summary
public @NonNull String description()

Implements org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect.description.

Doc from org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect.description.

Gets a description of what this side effect does (for logging and debugging).

Annotations
@Override
expectedConditionback to summary
public @NonNull ExpectedCondition expectedCondition()

Implements org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect.expectedCondition.

Doc from org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect.expectedCondition.

Expected condition that determines when this side effect can be executed.

Annotations
@Override
findLibraryTabback to summary
private Optional<LibraryTab> findLibraryTab()
findWalkthroughLibraryTabback to summary
pack-priv static Optional<LibraryTab> findWalkthroughLibraryTab(Collection<LibraryTab> libraryTabs, @Nullable LibraryTab createdTab, String libraryName)
forwardback to summary
public boolean forward(@NonNull Walkthrough walkthrough)
Annotations
@Override
loadExampleLibraryback to summary
private Optional<BibDatabaseContext> loadExampleLibrary()