JabRef 6.0-beta.1 · org.jabref.gui.walkthrough.effects.BaseWindowEffect

Base class for walkthrough effects Spotlight, FullScreenDarken, and Ping.

Field Summary

Modifier and Type	Field and Description
private final WalkthroughUtils.DebouncedInvalidationListener	debouncedUpdater
protected final Pane	pane
protected final List<com.tobiasdiez.easybind.Subscription>	subscriptions

Access	Constructor and Description
protected	BaseWindowEffect(@NonNull Pane The pane where the effect will be applied. Usually obtained from `javafx.stage.Window#getScene()` and `Scene#getRoot()` pane) Constructor for WalkthroughEffect.

Modifier and Type	Method and Description
protected void	cleanupListeners()
public void	detach() The effect is no longer usable and permanently removed from the scene graph.
protected abstract void	hideEffect() Hides the effect.
protected void	setupListeners(@NonNull Node node)
protected void	setupPaneListeners()
private void	setupWindowListeners(@NonNull Window window)
protected abstract void	updateLayout() Updates the layout of the effect.

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

debouncedUpdater	back to summary
private final WalkthroughUtils.DebouncedInvalidationListener debouncedUpdater

pane	back to summary
protected final Pane pane

subscriptions	back to summary
protected final List<com.tobiasdiez.easybind.Subscription> subscriptions

BaseWindowEffect back to summary

BaseWindowEffect	back to summary
protected BaseWindowEffect(@NonNull Pane pane) Constructor for WalkthroughEffect. No scene graph modification is done here. The effect is not attached to the pane until `attach(Node)` is called. Parameters pane:@NonNull Pane The pane where the effect will be applied. Usually obtained from `javafx.stage.Window#getScene()` and `Scene#getRoot()`

protected BaseWindowEffect(@NonNull Pane pane)

Constructor for WalkthroughEffect. No scene graph modification is done here. The effect is not attached to the pane until attach(Node) is called.

Parameters

pane:@NonNull Pane: The pane where the effect will be applied. Usually obtained from javafx.stage.Window#getScene() and Scene#getRoot()

cleanupListeners	back to summary
protected void cleanupListeners()

detach	back to summary
public void 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`.

hideEffect	back to summary
protected abstract void 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.

setupListeners	back to summary
protected void setupListeners(@NonNull Node node)

setupPaneListeners	back to summary
protected void setupPaneListeners()

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

updateLayout	back to summary
protected abstract void 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.