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

public Class Walkthrough

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List, .Objects, javafx.beans.property.BooleanProperty, .IntegerProperty, .ReadOnlyIntegerProperty, .SimpleBooleanProperty, .SimpleIntegerProperty, javafx.stage.Stage, org.jabref.gui.StateManager, org.jabref.gui.walkthrough.declarative.step.PanelStep, .SideEffect, .TooltipStep, .WalkthroughStep, org.jspecify.annotations.NonNull, .Nullable, org.slf4j.Logger, .LoggerFactory
Maintains the state of a walkthrough.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Walkthrough.Builder

Field Summary

Modifier and TypeField and Description
private final BooleanProperty
active

private Stage
currentStage

private final IntegerProperty
currentStep

private static final Logger
LOGGER

private @Nullable WalkthroughOverlay
overlay

private final StateManager
stateManager

private final List<WalkthroughStep>
steps

Constructor Summary

AccessConstructor and Description
public
Walkthrough(StateManager stateManager, List<WalkthroughStep> steps)

public
Walkthrough(StateManager stateManager, @NonNull WalkthroughStep... steps)

Method Summary

Modifier and TypeMethod and Description
public static Walkthrough.Builder
create(StateManager stateManager)

public ReadOnlyIntegerProperty

Returns:

The current step index property.
currentStepProperty()

Gets the current step index property.

private void
deactivate()

public @NonNull WalkthroughStep
getCurrentStep()

public @NonNull WalkthroughStep
getStepAtIndex(int index)

public void
goToStep(int stepIndex)

public void
nextStep()

Moves to the next step in the walkthrough.

public void
previousStep()

Moves to the previous step in the walkthrough.

public void
quit()

public void
quitAfterReversion()

Ends a walkthrough after its reverter already reversed the side effects.

public void
showQuitConfirmationAndQuit()

public void
skip()

public void
start(Stage
The stage to display the walkthrough on
stage)

Starts the walkthrough from the first step.

private void
stop()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

activeback to summary
private final BooleanProperty active
currentStageback to summary
private Stage currentStage
currentStepback to summary
private final IntegerProperty currentStep
LOGGERback to summary
private static final Logger LOGGER
overlayback to summary
private @Nullable WalkthroughOverlay overlay
stateManagerback to summary
private final StateManager stateManager
stepsback to summary
private final List<WalkthroughStep> steps

Constructor Detail

Walkthroughback to summary
public Walkthrough(StateManager stateManager, List<WalkthroughStep> steps)
Walkthroughback to summary
public Walkthrough(StateManager stateManager, @NonNull WalkthroughStep... steps)

Method Detail

createback to summary
public static Walkthrough.Builder create(StateManager stateManager)
currentStepPropertyback to summary
public ReadOnlyIntegerProperty currentStepProperty()

Gets the current step index property.

Returns:ReadOnlyIntegerProperty

The current step index property.

deactivateback to summary
private void deactivate()
getCurrentStepback to summary
public @NonNull WalkthroughStep getCurrentStep()
getStepAtIndexback to summary
public @NonNull WalkthroughStep getStepAtIndex(int index)
goToStepback to summary
public void goToStep(int stepIndex)
nextStepback to summary
public void nextStep()

Moves to the next step in the walkthrough.

previousStepback to summary
public void previousStep()

Moves to the previous step in the walkthrough.

quitback to summary
public void quit()
quitAfterReversionback to summary
public void quitAfterReversion()

Ends a walkthrough after its reverter already reversed the side effects.

showQuitConfirmationAndQuitback to summary
public void showQuitConfirmationAndQuit()
skipback to summary
public void skip()
startback to summary
public void start(Stage stage)

Starts the walkthrough from the first step.

Parameters
stage:Stage

The stage to display the walkthrough on

stopback to summary
private void stop()
org.jabref.gui.walkthrough back to summary

public Class Walkthrough.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final StateManager
stateManager

private final List<WalkthroughStep>
steps

Constructor Summary

AccessConstructor and Description
private
Builder(StateManager stateManager)

Method Summary

Modifier and TypeMethod and Description
public Walkthrough.Builder
addStep(@NonNull WalkthroughStep step)

public Walkthrough.Builder
addStep(@NonNull TooltipStep.Builder step)

public Walkthrough.Builder
addStep(@NonNull PanelStep.Builder step)

public Walkthrough.Builder
addStep(@NonNull SideEffect.Builder step)

public Walkthrough
build()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

stateManagerback to summary
private final StateManager stateManager
stepsback to summary
private final List<WalkthroughStep> steps

Constructor Detail

Builderback to summary
private Builder(StateManager stateManager)

Method Detail

addStepback to summary
public Walkthrough.Builder addStep(@NonNull WalkthroughStep step)
addStepback to summary
public Walkthrough.Builder addStep(@NonNull TooltipStep.Builder step)
addStepback to summary
public Walkthrough.Builder addStep(@NonNull PanelStep.Builder step)
addStepback to summary
public Walkthrough.Builder addStep(@NonNull SideEffect.Builder step)
buildback to summary
public Walkthrough build()