Verified Owner
Top Description Methods
org.jabref.gui.walkthrough.declarative.step

public sealed Interface VisibleComponent

extends WalkthroughStep
permits PanelStep, TooltipStep
Known Direct Implementers
org.jabref.gui.walkthrough.declarative.step.PanelStep, org.jabref.gui.walkthrough.declarative.step.TooltipStep
Imports
java.util.List, .Optional, .OptionalDouble, org.jabref.gui.walkthrough.declarative.NodeResolver, .Trigger, .WindowResolver, org.jabref.gui.walkthrough.declarative.effect.WalkthroughEffect, org.jabref.gui.walkthrough.declarative.richtext.WalkthroughRichTextBlock

Walkthrough steps that display visible UI elements.

Method Summary

Modifier and TypeMethod and Description
public Optional<String>
backButtonText()

Custom text for the back button.

public List<WalkthroughRichTextBlock>
content()

Content blocks to display

public Optional<String>
continueButtonText()

Custom text for the continue button.

public Optional<WalkthroughEffect>
highlight()

Highlight effect to apply.

public OptionalDouble
maxHeight()

Maximum height for the display element.

public OptionalDouble
maxWidth()

Maximum width for the display element.

public Optional<NodeResolver>
nodeResolver()

Node resolver for the node to highlight / tooltip to position / etc.

public QuitButtonPosition
quitButtonPosition()

Position of the quit button.

public boolean
showQuitButton()

Whether to show the quit button.

public Optional<String>
skipButtonText()

Custom text for the skip button.

public Optional<Trigger>
trigger()

Navigation predicate that determines when to advance by attaching to the UI elements that could trigger navigation.

public Optional<WindowResolver>
windowResolver()

Window resolver for targeting specific windows.

Inherited from org.jabref.gui.walkthrough.declarative.step.WalkthroughStep:
panelsideEffecttitletooltip

Method Detail

backButtonTextback to summary
public Optional<String> backButtonText()

Custom text for the back button.

  • If Optional#empty(), no back button is shown.
  • If present, the button will be shown with the provided text.
contentback to summary
public List<WalkthroughRichTextBlock> content()

Content blocks to display

continueButtonTextback to summary
public Optional<String> continueButtonText()

Custom text for the continue button.

  • If Optional#empty(), no continue button is shown.
  • If present, the button will be shown with the provided text.
highlightback to summary
public Optional<WalkthroughEffect> highlight()

Highlight effect to apply.

maxHeightback to summary
public OptionalDouble maxHeight()

Maximum height for the display element.

maxWidthback to summary
public OptionalDouble maxWidth()

Maximum width for the display element.

nodeResolverback to summary
public Optional<NodeResolver> nodeResolver()

Node resolver for the node to highlight / tooltip to position / etc.

quitButtonPositionback to summary
public QuitButtonPosition quitButtonPosition()

Position of the quit button.

showQuitButtonback to summary
public boolean showQuitButton()

Whether to show the quit button.

skipButtonTextback to summary
public Optional<String> skipButtonText()

Custom text for the skip button.

  • If Optional#empty(), no skip button is shown.
  • If present, the button will be shown with the provided text.
triggerback to summary
public Optional<Trigger> trigger()

Navigation predicate that determines when to advance by attaching to the UI elements that could trigger navigation.

windowResolverback to summary
public Optional<WindowResolver> windowResolver()

Window resolver for targeting specific windows.