Verified Owner
Top Description Constructors Methods
org.jabref.gui.walkthrough

public Class WalkthroughRenderer

extends Object
Class Inheritance
Imports
javafx.geometry.Pos, javafx.scene.Node, javafx.scene.control.Button, javafx.scene.layout.HBox, .Priority, .Region, .StackPane, .VBox, org.jabref.gui.icon.IconTheme, .JabRefIconView, org.jabref.gui.util.component.MarkdownTextFlow, org.jabref.gui.walkthrough.declarative.richtext.ArbitraryJFXBlock, .InfoBlock, .TextBlock, org.jabref.gui.walkthrough.declarative.step.PanelPosition, .PanelStep, .TooltipStep, .VisibleComponent

Renders walkthrough steps and content blocks into JavaFX nodes.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private void
private HBox
createActions(VisibleComponent component, Walkthrough walkthrough, Runnable beforeNavigate)

private VBox
createContent(VisibleComponent component, Walkthrough walkthrough, Runnable beforeNavigate)

private Button
makeButton(String
the already localized button text
text
,
boolean isDefault, Runnable beforeNavigate, Runnable navigationAction)

private VBox
public Node

Returns:

The rendered tooltip content node
render
(TooltipStep
The tooltip step to render
step
,
Walkthrough
The walkthrough context for navigation
walkthrough
,
Runnable
Runnable to execute before any navigation action
beforeNavigate
)

Renders a tooltip step into a JavaFX node.

public Node

Returns:

The rendered panel node
render
(PanelStep
The panel step to render
step
,
Walkthrough
The walkthrough context for navigation
walkthrough
,
Runnable
Runnable to execute before any navigation action
beforeNavigate
)

Renders a panel step into a JavaFX node.

private Node
render(ArbitraryJFXBlock block, Walkthrough walkthrough, Runnable beforeNavigate)

private Node
render(TextBlock textBlock)

private Node
render(InfoBlock infoBlock)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

WalkthroughRendererback to summary
public WalkthroughRenderer()

Method Detail

configurePanelSizeback to summary
private void configurePanelSize(VBox panel, PanelStep step)
createActionsback to summary
private HBox createActions(VisibleComponent component, Walkthrough walkthrough, Runnable beforeNavigate)
createContentback to summary
private VBox createContent(VisibleComponent component, Walkthrough walkthrough, Runnable beforeNavigate)
makeButtonback to summary
private Button makeButton(String text, boolean isDefault, Runnable beforeNavigate, Runnable navigationAction)
Parameters
text:String

the already localized button text

makePanelback to summary
private VBox makePanel()
renderback to summary
public Node render(TooltipStep step, Walkthrough walkthrough, Runnable beforeNavigate)

Renders a tooltip step into a JavaFX node.

Parameters
step:TooltipStep

The tooltip step to render

walkthrough:Walkthrough

The walkthrough context for navigation

beforeNavigate:Runnable

Runnable to execute before any navigation action

Returns:Node

The rendered tooltip content node

renderback to summary
public Node render(PanelStep step, Walkthrough walkthrough, Runnable beforeNavigate)

Renders a panel step into a JavaFX node.

Parameters
step:PanelStep

The panel step to render

walkthrough:Walkthrough

The walkthrough context for navigation

beforeNavigate:Runnable

Runnable to execute before any navigation action

Returns:Node

The rendered panel node

renderback to summary
private Node render(ArbitraryJFXBlock block, Walkthrough walkthrough, Runnable beforeNavigate)
renderback to summary
private Node render(TextBlock textBlock)
renderback to summary
private Node render(InfoBlock infoBlock)