JabRef 6.0-beta.1 · org.jabref.gui.walkthrough.WindowOverlay

Field Summary

Modifier and Type	Field and Description
private final List<Runnable>	cleanupTasks Mutable list of clean up tasks that are executed when the overlay is hidden or detached.
private @Nullable Node	currentContentNode
private final KeyBindingRepository	keyBindingRepository
private static final Logger	LOGGER
private final WalkthroughPane	pane
private static final double	POPOVER_ARROW_GAP Negative = distance between the arrow tip and the target node.
private static final int	POPOVER_CREATION_DELAY
private @Nullable Button	quitButton
private final WalkthroughRenderer	renderer
private boolean	showing
private final StateManager	stateManager
private final Walkthrough	walkthrough
private final Window	window

Constructor Summary

Access	Constructor and Description
public	WindowOverlay(Window window, WalkthroughPane pane, Walkthrough walkthrough)

Method Summary

Modifier and Type	Method and Description
private void	addQuitButton(VisibleComponent component)
private PopOver	createPopover(TooltipStep step, Runnable beforeNavigate)
private Button	createQuitButton()
public void	detach() Detaches the overlay.
public void	hide() Hide the overlay and clean up any resources.
private void	listenKeybindings(EventTarget target, Scene scene) Adds keybinding listeners to the scene to handle key events for the walkthrough.
private Optional<PopOver.ArrowLocation>	mapToArrowLocation(TooltipPosition position)
private void	positionQuitButton(Button button, QuitButtonPosition position)
private void	removeQuitButton()
private QuitButtonPosition	resolveQuitButtonPosition(VisibleComponent component)
public void	showPanel(PanelStep step, Runnable beforeNavigate) Convenience method to show a panel for the given step without a node.
public void	showPanel(PanelStep The step to display. step, @Nullable Node The node to anchor highlight to (e.g., BackdropHighlight may poke a hole at the position of the node), or null to use fallback effect of corresponding position. node, Runnable A runnable to execute before navigating to the next step. More precisely, the runnable to execute immediately upon the button press before Walkthrough's state change to the next step and before the original button/node's action is executed. Usually used to prevent automatic revert from unexpected reverting to the previous step when the node is not yet ready to be displayed beforeNavigate) Display a Panel for the given step at the specified node.
public void	showTooltip(TooltipStep The step to display. step, @Nullable Node The node to anchor the tooltip to, or null to show it at the window. The node is expected to be positionable by `WalkthroughUtils#cannotPositionNode(Node)` standard. node, Runnable A runnable to execute before navigating to the next step. beforeNavigate) Display a tooltip for the given step at the specified node.

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

Field Detail

cleanupTasks	back to summary
private final List<Runnable> cleanupTasks Mutable list of clean up tasks that are executed when the overlay is hidden or detached.

currentContentNode	back to summary
private @Nullable Node currentContentNode

keyBindingRepository	back to summary
private final KeyBindingRepository keyBindingRepository

LOGGER	back to summary
private static final Logger LOGGER

pane	back to summary
private final WalkthroughPane pane

POPOVER_ARROW_GAP	back to summary
private static final double POPOVER_ARROW_GAP Negative = distance between the arrow tip and the target node. The popup window is ~22px larger than the visible box (arrow plus drop shadow) and swallows clicks in that margin, so with the default overlap of 4px an icon button next to the arrow could not be clicked.

POPOVER_CREATION_DELAY	back to summary
private static final int POPOVER_CREATION_DELAY

quitButton	back to summary
private @Nullable Button quitButton

renderer	back to summary
private final WalkthroughRenderer renderer

showing	back to summary
private boolean showing

stateManager	back to summary
private final StateManager stateManager

walkthrough	back to summary
private final Walkthrough walkthrough

window	back to summary
private final Window window

Constructor Detail

WindowOverlay	back to summary
public WindowOverlay(Window window, WalkthroughPane pane, Walkthrough walkthrough)

Method Detail

addQuitButton	back to summary
private void addQuitButton(VisibleComponent component)

createPopover	back to summary
private PopOver createPopover(TooltipStep step, Runnable beforeNavigate)

createQuitButton	back to summary
private Button createQuitButton()

detach	back to summary
public void detach() Detaches the overlay. The pane it drew into belongs to the window and stays.

hide	back to summary
public void hide() Hide the overlay and clean up any resources.

listenKeybindings back to summary

listenKeybindings	back to summary
private void listenKeybindings(EventTarget target, Scene scene) Adds keybinding listeners to the scene to handle key events for the walkthrough. This method is necessary because: PopOver is in a separate scene, so the `org.jabref.gui.JabRefGUI`'s keybindings registration on the main scene doesn't/cannot capture the key events on the PopOver scene. If a user, presumably, focus on the PopOver and press Esc, quit Walkthrough will not work. Likewise, for new dialog windows, the keybindings doesn't work. If a user is interested in copy/paste walkthrough text, they will not be able to do so.

private void listenKeybindings(EventTarget target, Scene scene)

Adds keybinding listeners to the scene to handle key events for the walkthrough.

This method is necessary because:

PopOver is in a separate scene, so the org.jabref.gui.JabRefGUI's keybindings registration on the main scene doesn't/cannot capture the key events on the PopOver scene. If a user, presumably, focus on the PopOver and press Esc, quit Walkthrough will not work.
Likewise, for new dialog windows, the keybindings doesn't work. If a user is interested in copy/paste walkthrough text, they will not be able to do so.

mapToArrowLocation	back to summary
private Optional<PopOver.ArrowLocation> mapToArrowLocation(TooltipPosition position)

positionQuitButton	back to summary
private void positionQuitButton(Button button, QuitButtonPosition position)

removeQuitButton	back to summary
private void removeQuitButton()

resolveQuitButtonPosition	back to summary
private QuitButtonPosition resolveQuitButtonPosition(VisibleComponent component)

showPanel back to summary

showPanel	back to summary
public void showPanel(PanelStep step, Runnable beforeNavigate) Convenience method to show a panel for the given step without a node. See `WindowOverlay#showPanel(PanelStep, Node, Runnable)` for details.

public void showPanel(PanelStep step, Runnable beforeNavigate)

Convenience method to show a panel for the given step without a node.

See WindowOverlay#showPanel(PanelStep, Node, Runnable) for details.

showPanel back to summary

showPanel	back to summary
public void showPanel(PanelStep step, @Nullable Node node, Runnable beforeNavigate) Display a Panel for the given step at the specified node. Parameters step:PanelStep The step to display. node:@Nullable Node The node to anchor highlight to (e.g., BackdropHighlight may poke a hole at the position of the node), or null to use fallback effect of corresponding position. beforeNavigate:Runnable A runnable to execute before navigating to the next step. More precisely, the runnable to execute immediately upon the button press before Walkthrough's state change to the next step and before the original button/node's action is executed. Usually used to prevent automatic revert from unexpected reverting to the previous step when the node is not yet ready to be displayed See Also `WindowOverlay#showPanel(PanelStep, Runnable)`, `WindowOverlay#showTooltip(TooltipStep, Node, Runnable)`

public void showPanel(PanelStep step, @Nullable Node node, Runnable beforeNavigate)

Display a Panel for the given step at the specified node.

Parameters

step:PanelStep: The step to display.
node:@Nullable Node: The node to anchor highlight to (e.g., BackdropHighlight may poke a hole at the position of the node), or null to use fallback effect of corresponding position.
beforeNavigate:Runnable: A runnable to execute before navigating to the next step. More precisely, the runnable to execute immediately upon the button press before Walkthrough's state change to the next step and before the original button/node's action is executed. Usually used to prevent automatic revert from unexpected reverting to the previous step when the node is not yet ready to be displayed

showTooltip back to summary

showTooltip	back to summary
public void showTooltip(TooltipStep step, @Nullable Node node, Runnable beforeNavigate) Display a tooltip for the given step at the specified node. Note on `beforeNavigate` runnable: The runnable to execute immediately upon the button press before Walkthrough's state change to the next step and before the original button/node's action is executed. Usually used to prevent automatic revert from unexpected reverting to the previous step when the node is not yet ready to be displayed. Implementation Note The requirement for the node to be positionable by `WalkthroughUtils#cannotPositionNode(Node)` standard is just to make things easier to define. This requirement come from `javafx.stage.PopupWindow#show(Node)`, which check whether the node is tree visible before showing the popup and `PopOver#show(Node)`, which checks whether the node contains a scene and window to assign the owning window to the popover. Parameters step:TooltipStep The step to display. node:@Nullable Node The node to anchor the tooltip to, or null to show it at the window. The node is expected to be positionable by `WalkthroughUtils#cannotPositionNode(Node)` standard. beforeNavigate:Runnable A runnable to execute before navigating to the next step. See Also `WindowOverlay#showPanel(PanelStep, Runnable)`, `WindowOverlay#showPanel(PanelStep, Node, Runnable)`

public void showTooltip(TooltipStep step, @Nullable Node node, Runnable beforeNavigate)

Display a tooltip for the given step at the specified node.

Note on beforeNavigate runnable: The runnable to execute immediately upon the button press before Walkthrough's state change to the next step and before the original button/node's action is executed. Usually used to prevent automatic revert from unexpected reverting to the previous step when the node is not yet ready to be displayed.

Implementation Note

The requirement for the node to be positionable by WalkthroughUtils#cannotPositionNode(Node) standard is just to make things easier to define. This requirement come from javafx.stage.PopupWindow#show(Node), which check whether the node is tree visible before showing the popup and PopOver#show(Node), which checks whether the node contains a scene and window to assign the owning window to the popover.