Verified Owner
Top Fields Constructors Methods
org.jabref.gui.walkthrough.effects

public final Class Spotlight

extends BaseWindowEffect
Class Inheritance
Imports
javafx.animation.Interpolator, .KeyFrame, .KeyValue, .Timeline, javafx.beans.InvalidationListener, javafx.event.Event, javafx.geometry.Bounds, javafx.scene.Node, javafx.scene.layout.Pane, javafx.scene.shape.Rectangle, .Shape, javafx.util.Duration, org.jabref.gui.walkthrough.utils.WalkthroughUtils, com.tobiasdiez.easybind.EasyBind, org.jspecify.annotations.NonNull, .Nullable

Field Summary

Modifier and TypeField and Description
private Rectangle
backdrop

private Rectangle
hole

private @Nullable Node
node

private volatile @Nullable Shape
overlayShape

private static final Duration
TRANSITION_DURATION

private @Nullable Timeline
transitionAnimation

Inherited from org.jabref.gui.walkthrough.effects.BaseWindowEffect:
panesubscriptions

Constructor Summary

AccessConstructor and Description
public
Spotlight(@NonNull Pane pane)

Method Summary

Modifier and TypeMethod and Description
public void
attach(@NonNull Node node)

public void
detach()

Overrides org.jabref.gui.walkthrough.effects.BaseWindowEffect.detach.

The effect is no longer usable and permanently removed from the scene graph.

protected void
hideEffect()

Implements abstract org.jabref.gui.walkthrough.effects.BaseWindowEffect.hideEffect.

Hides the effect.

public void
transitionTo(@NonNull Node newNode)

protected void
updateLayout()

Implements abstract org.jabref.gui.walkthrough.effects.BaseWindowEffect.updateLayout.

Updates the layout of the effect.

private void
updateOverlayShape()

Inherited from org.jabref.gui.walkthrough.effects.BaseWindowEffect:
cleanupListenerssetupListenerssetupPaneListeners

Field Detail

backdropback to summary
private Rectangle backdrop
holeback to summary
private Rectangle hole
nodeback to summary
private @Nullable Node node
overlayShapeback to summary
private volatile @Nullable Shape overlayShape
TRANSITION_DURATIONback to summary
private static final Duration TRANSITION_DURATION
transitionAnimationback to summary
private @Nullable Timeline transitionAnimation

Constructor Detail

Spotlightback to summary
public Spotlight(@NonNull Pane pane)

Method Detail

attachback to summary
public void attach(@NonNull Node node)
detachback to summary
public void detach()

Overrides org.jabref.gui.walkthrough.effects.BaseWindowEffect.detach.

Doc from org.jabref.gui.walkthrough.effects.BaseWindowEffect.detach.

The effect is no longer usable and permanently removed from the scene graph. To use this effect again, you can ONLY create a new instance of BaseWindowEffect.

Annotations
@Override
hideEffectback to summary
protected void hideEffect()

Implements abstract org.jabref.gui.walkthrough.effects.BaseWindowEffect.hideEffect.

Doc from org.jabref.gui.walkthrough.effects.BaseWindowEffect.hideEffect.

Hides the effect. The WalkthroughEffect can still be shown again after this method is called by calling BaseWindowEffect#updateLayout(), either manually or due to a layout change in the pane or the target node.

Annotations
@Override
transitionToback to summary
public void transitionTo(@NonNull Node newNode)
updateLayoutback to summary
protected void updateLayout()

Implements abstract org.jabref.gui.walkthrough.effects.BaseWindowEffect.updateLayout.

Doc from org.jabref.gui.walkthrough.effects.BaseWindowEffect.updateLayout.

Updates the layout of the effect. This method is called whenever the pane or the target node (if any) changes its size or position.

Annotations
@Override
updateOverlayShapeback to summary
private void updateOverlayShape()