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

public Interface WalkthroughSideEffect

Known Direct Implementers
org.jabref.gui.walkthrough.declarative.sideeffect.EnsureMainTabVisibleSideEffect, org.jabref.gui.walkthrough.declarative.sideeffect.EnsureSearchSettingsSideEffect, org.jabref.gui.walkthrough.declarative.sideeffect.OpenLibrarySideEffect, org.jabref.gui.walkthrough.declarative.sideeffect.OpenPreferencesSideEffect, org.jabref.gui.walkthrough.declarative.sideeffect.PrepareGroupsWalkthroughSideEffect
Imports
java.util.List, javafx.beans.Observable, org.jabref.gui.walkthrough.Walkthrough, org.jspecify.annotations.NonNull

Walkthrough side effects that can be executed between steps.

Field Summary

Modifier and TypeField and Description
public static final int

Method Summary

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

Backward effect (what should be done when going back).

public default @NonNull List<Observable>
dependencies()

List of observables that should trigger re-evaluation of the expected condition.

public @NonNull String
description()

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

public @NonNull ExpectedCondition
expectedCondition()

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

public boolean
forward(@NonNull Walkthrough walkthrough)

Forward effect (what should be done).

public default long
timeoutMs()

Timeout in milliseconds for waiting for the expected condition to become true.

Field Detail

DEFAULT_TIMEOUT_MSback to summary
public static final int DEFAULT_TIMEOUT_MS

Method Detail

backwardback to summary
public boolean backward(@NonNull Walkthrough walkthrough)

Backward effect (what should be done when going back).

dependenciesback to summary
public default @NonNull List<Observable> dependencies()

List of observables that should trigger re-evaluation of the expected condition.

descriptionback to summary
public @NonNull String description()

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

expectedConditionback to summary
public @NonNull ExpectedCondition expectedCondition()

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

forwardback to summary
public boolean forward(@NonNull Walkthrough walkthrough)

Forward effect (what should be done).

timeoutMsback to summary
public default long timeoutMs()

Timeout in milliseconds for waiting for the expected condition to become true. Defaults to 2500ms if not overridden.