Modifier and Type	Class and Description
private static record	WalkthroughHighlighter.EffectState

Modifier and Type	Field and Description
private final Map<Window, Spotlight>	backdropHighlights
private final Map<Window, WalkthroughHighlighter.EffectState>	currentEffects
private final Map<Window, FullScreenDarken>	fullScreenDarkens
private static final Logger	LOGGER
private final Map<Window, Ping>	pulseIndicators

Access	Constructor and Description
public	WalkthroughHighlighter()

Method Summary

Modifier and Type	Method and Description
private void	applyBackdropHighlight(@NonNull Window window, @NonNull Node targetNode)
private void	applyEffect(@NonNull Window window, @NonNull HighlightEffect effect, @Nullable Node targetNode)
private void	applyFullScreenDarken(@NonNull Window window)
public void	applyHighlight(@Nullable WalkthroughEffect The highlight configuration to apply. Default to BackdropHighlight on the primary windows if null. config, @NonNull Scene The primary scene to apply the highlight to. scene, @Nullable Node The fallback target node to use if no highlight configuration is provided. fallbackTarget) Applies the specified highlight configuration.
private void	applyPulseAnimation(@NonNull Window window, @NonNull Node targetNode)
private Map<Window, WalkthroughHighlighter.EffectState>	computeNewEffects(@Nullable WalkthroughEffect config, @NonNull Scene fallbackWindow, @Nullable Node fallbackTarget)
public void	detach(@NonNull Window window) Sets a handler to be called when the user clicks on backdrop or darkened areas.
public void	detachAll() Detaches all effects from all windows.
private void	diffEffects(Map<Window, WalkthroughHighlighter.EffectState> current, Map<Window, WalkthroughHighlighter.EffectState> desired, Map<Window, WalkthroughHighlighter.EffectState> toUpdate, Map<Window, WalkthroughHighlighter.EffectState> toCreate, Map<Window, WalkthroughHighlighter.EffectState> toRemove)
private Spotlight	getOrCreateBackdropHighlight(@NonNull Window window, @NonNull WalkthroughPane pane)
private FullScreenDarken	getOrCreateFullScreenDarken(@NonNull Window window, @NonNull WalkthroughPane pane)
private Ping	getOrCreatePulseIndicator(@NonNull Window window, @NonNull WalkthroughPane pane)
private static void	logMissingPane(Window window) A highlight is decoration: a window that cannot host the pane still gets its step, just without the effect.
private void	updateExistingEffect(@NonNull Window window, @NonNull WalkthroughHighlighter.EffectState newState)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

backdropHighlights	back to summary
private final Map<Window, Spotlight> backdropHighlights

currentEffects	back to summary
private final Map<Window, WalkthroughHighlighter.EffectState> currentEffects

fullScreenDarkens	back to summary
private final Map<Window, FullScreenDarken> fullScreenDarkens

LOGGER	back to summary
private static final Logger LOGGER

pulseIndicators	back to summary
private final Map<Window, Ping> pulseIndicators

WalkthroughHighlighter	back to summary
public WalkthroughHighlighter()

Method Detail

applyBackdropHighlight	back to summary
private void applyBackdropHighlight(@NonNull Window window, @NonNull Node targetNode)

applyEffect	back to summary
private void applyEffect(@NonNull Window window, @NonNull HighlightEffect effect, @Nullable Node targetNode)

applyFullScreenDarken	back to summary
private void applyFullScreenDarken(@NonNull Window window)

applyHighlight	back to summary
public void applyHighlight(@Nullable WalkthroughEffect config, @NonNull Scene scene, @Nullable Node fallbackTarget) Applies the specified highlight configuration. Parameters config:@Nullable WalkthroughEffect The highlight configuration to apply. Default to BackdropHighlight on the primary windows if null. scene:@NonNull Scene The primary scene to apply the highlight to. fallbackTarget:@Nullable Node The fallback target node to use if no highlight configuration is provided.

applyHighlight

back to summary

public void applyHighlight(@Nullable WalkthroughEffect config, @NonNull Scene scene, @Nullable Node fallbackTarget)

Applies the specified highlight configuration.

Parameters

config:@Nullable WalkthroughEffect: The highlight configuration to apply. Default to BackdropHighlight on the primary windows if null.
scene:@NonNull Scene: The primary scene to apply the highlight to.
fallbackTarget:@Nullable Node: The fallback target node to use if no highlight configuration is provided.

applyPulseAnimation	back to summary
private void applyPulseAnimation(@NonNull Window window, @NonNull Node targetNode)

computeNewEffects	back to summary
private Map<Window, WalkthroughHighlighter.EffectState> computeNewEffects(@Nullable WalkthroughEffect config, @NonNull Scene fallbackWindow, @Nullable Node fallbackTarget)

detach	back to summary
public void detach(@NonNull Window window) Sets a handler to be called when the user clicks on backdrop or darkened areas.

detachAll	back to summary
public void detachAll() Detaches all effects from all windows. See `WalkthroughHighlighter#detach`.

diffEffects	back to summary
private void diffEffects(Map<Window, WalkthroughHighlighter.EffectState> current, Map<Window, WalkthroughHighlighter.EffectState> desired, Map<Window, WalkthroughHighlighter.EffectState> toUpdate, Map<Window, WalkthroughHighlighter.EffectState> toCreate, Map<Window, WalkthroughHighlighter.EffectState> toRemove)

getOrCreateBackdropHighlight	back to summary
private Spotlight getOrCreateBackdropHighlight(@NonNull Window window, @NonNull WalkthroughPane pane)

getOrCreateFullScreenDarken	back to summary
private FullScreenDarken getOrCreateFullScreenDarken(@NonNull Window window, @NonNull WalkthroughPane pane)

getOrCreatePulseIndicator	back to summary
private Ping getOrCreatePulseIndicator(@NonNull Window window, @NonNull WalkthroughPane pane)

logMissingPane	back to summary
private static void logMissingPane(Window window) A highlight is decoration: a window that cannot host the pane still gets its step, just without the effect.

updateExistingEffect	back to summary
private void updateExistingEffect(@NonNull Window window, @NonNull WalkthroughHighlighter.EffectState newState)

org.jabref.gui.walkthrough back to summary

private final Record WalkthroughHighlighter.EffectState

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.gui.walkthrough.WalkthroughHighlighter.EffectState

Record Components

effect:HighlightEffect
targetNode:@Nullable Node

Field Summary

Modifier and Type	Field and Description
private final HighlightEffect	effect Record Component accessed by effect().
private final @Nullable Node	targetNode Record Component accessed by targetNode().

Constructor Summary

Access	Constructor and Description
private	EffectState(HighlightEffect effect, @Nullable Node targetNode)

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	canTransitionTo(WalkthroughHighlighter.EffectState other)
public HighlightEffect	effect() Record Component getter of effect.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public @Nullable Node	targetNode() Record Component getter of targetNode.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

effect	back to summary
private final HighlightEffect effect Record Component accessed by effect().

targetNode	back to summary
private final @Nullable Node targetNode Record Component accessed by targetNode().

Constructor Detail

EffectState	back to summary
private EffectState(HighlightEffect effect, @Nullable Node targetNode)

Method Detail

canTransitionTo	back to summary
pack-priv boolean canTransitionTo(WalkthroughHighlighter.EffectState other)

effect	back to summary
public HighlightEffect effect() Record Component getter of effect.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

targetNode	back to summary
public @Nullable Node targetNode() Record Component getter of targetNode.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class WalkthroughHighlighter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record WalkthroughHighlighter.EffectState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail