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

public Class EnsureSearchSettingsSideEffect

extends Object
implements WalkthroughSideEffect
Class Inheritance
All Implemented Interfaces
org.jabref.gui.walkthrough.declarative.sideeffect.WalkthroughSideEffect
Imports
org.jabref.gui.walkthrough.Walkthrough, org.jabref.logic.l10n.Localization, org.jabref.logic.search.SearchPreferences, org.jabref.model.search.SearchDisplayMode, .SearchFlags, org.jspecify.annotations.NonNull
Ensures the search bar starts with unfiltered mode and regex disabled, then restores previous settings on exit.

Field Summary

Modifier and TypeField and Description
private final boolean
previousCaseSensitive

private final SearchDisplayMode
previousDisplayMode

private final boolean
previousRegex

private final SearchPreferences
searchPreferences

Constructor Summary

AccessConstructor and Description
public
EnsureSearchSettingsSideEffect(SearchPreferences searchPreferences)

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.

public boolean
forward(@NonNull Walkthrough walkthrough)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

previousCaseSensitiveback to summary
private final boolean previousCaseSensitive
previousDisplayModeback to summary
private final SearchDisplayMode previousDisplayMode
previousRegexback to summary
private final boolean previousRegex
searchPreferencesback to summary
private final SearchPreferences searchPreferences

Constructor Detail

EnsureSearchSettingsSideEffectback to summary
public EnsureSearchSettingsSideEffect(SearchPreferences searchPreferences)

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
forwardback to summary
public boolean forward(@NonNull Walkthrough walkthrough)
Annotations
@Override