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

public Class PrepareGroupsWalkthroughSideEffect

extends Object
implements WalkthroughSideEffect
Class Inheritance
All Implemented Interfaces
org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect
Annotations
@NullMarked
Imports
java.util.Optional, java.util.function.Supplier, javafx.collections.ObservableList, javafx.scene.control.TextInputControl, javafx.stage.Stage, org.jabref.gui.StateManager, org.jabref.gui.sidepane.SidePaneType, org.jabref.gui.walkthrough.Walkthrough, org.jabref.gui.walkthrough.declarative.WalkthroughNodeIds, org.jspecify.annotations.NonNull, .NullMarked
Makes the groups pane and all entries available while the groups walkthrough is active.

Field Summary

Modifier and TypeField and Description
private boolean
groupsPaneWasVisible

private String
previousSearchQuery

private Optional<TextInputControl>
searchField

private final Supplier<Optional<TextInputControl>>
searchFieldSupplier

private final StateManager
stateManager

Constructor Summary

AccessConstructor and Description
public
PrepareGroupsWalkthroughSideEffect(StateManager stateManager, Stage stage)

pack-priv
PrepareGroupsWalkthroughSideEffect(StateManager stateManager, Supplier<Optional<TextInputControl>> searchFieldSupplier)

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 static Optional<TextInputControl>
findSearchField(Stage stage)

public boolean
forward(@NonNull Walkthrough walkthrough)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

groupsPaneWasVisibleback to summary
private boolean groupsPaneWasVisible
previousSearchQueryback to summary
private String previousSearchQuery
searchFieldback to summary
private Optional<TextInputControl> searchField
searchFieldSupplierback to summary
private final Supplier<Optional<TextInputControl>> searchFieldSupplier
stateManagerback to summary
private final StateManager stateManager

Constructor Detail

PrepareGroupsWalkthroughSideEffectback to summary
public PrepareGroupsWalkthroughSideEffect(StateManager stateManager, Stage stage)
PrepareGroupsWalkthroughSideEffectback to summary
pack-priv PrepareGroupsWalkthroughSideEffect(StateManager stateManager, Supplier<Optional<TextInputControl>> searchFieldSupplier)

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
findSearchFieldback to summary
private static Optional<TextInputControl> findSearchField(Stage stage)
forwardback to summary
public boolean forward(@NonNull Walkthrough walkthrough)
Annotations
@Override