Verified Owner
Top Inners Fields Constructors Methods
org.jabref.gui.walkthrough.declarative.step

public final Record PanelStep

extends Record
implements VisibleComponent
Class Inheritance
All Implemented Interfaces
org.jabref.gui.walkthrough.declarative.step.VisibleComponent, org.jabref.gui.walkthrough.declarative.step.WalkthroughStep
Record Components
title:@NonNull String 
content:@NonNull List<WalkthroughRichTextBlock> 
resolverValue:@Nullable NodeResolver 
continueButtonTextValue:@Nullable String 
skipButtonTextValue:@Nullable String 
backButtonTextValue:@Nullable String 
triggerValue:@Nullable Trigger 
position:@NonNull PanelPosition 
widthValue:@Nullable Double 
heightValue:@Nullable Double 
highlightValue:@Nullable WalkthroughEffect 
activeWindowResolverValue:@Nullable WindowResolver 
showQuitButtonValue:boolean 
quitButtonPositionValue:@NonNull QuitButtonPosition 
Imports
java.util.List, .Optional, .OptionalDouble, org.jabref.gui.walkthrough.declarative.NodeResolver, .Trigger, .WindowResolver, org.jabref.gui.walkthrough.declarative.effect.HighlightEffect, .WalkthroughEffect, .WindowEffect, org.jabref.gui.walkthrough.declarative.richtext.WalkthroughRichTextBlock, org.jspecify.annotations.NonNull, .Nullable

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
PanelStep.Builder

Field Summary

Modifier and TypeField and Description
private final @Nullable WindowResolver
activeWindowResolverValue

Record Component accessed by activeWindowResolverValue().

private final @Nullable String
backButtonTextValue

Record Component accessed by backButtonTextValue().

private final @NonNull List<WalkthroughRichTextBlock>
content

Record Component accessed by content().

private final @Nullable String
continueButtonTextValue

Record Component accessed by continueButtonTextValue().

private final @Nullable Double
heightValue

Record Component accessed by heightValue().

private final @Nullable WalkthroughEffect
highlightValue

Record Component accessed by highlightValue().

private final @NonNull PanelPosition
position

Record Component accessed by position().

private final @NonNull QuitButtonPosition
quitButtonPositionValue

Record Component accessed by quitButtonPositionValue().

private final @Nullable NodeResolver
resolverValue

Record Component accessed by resolverValue().

private final boolean
showQuitButtonValue

Record Component accessed by showQuitButtonValue().

private final @Nullable String
skipButtonTextValue

Record Component accessed by skipButtonTextValue().

private final @NonNull String
title

Record Component accessed by title().

private final @Nullable Trigger
triggerValue

Record Component accessed by triggerValue().

private final @Nullable Double
widthValue

Record Component accessed by widthValue().

Constructor Summary

AccessConstructor and Description
public
PanelStep(@NonNull String title, @NonNull List<WalkthroughRichTextBlock> content, @Nullable NodeResolver resolverValue, @Nullable String continueButtonTextValue, @Nullable String skipButtonTextValue, @Nullable String backButtonTextValue, @Nullable Trigger triggerValue, @NonNull PanelPosition position, @Nullable Double widthValue, @Nullable Double heightValue, @Nullable WalkthroughEffect highlightValue, @Nullable WindowResolver activeWindowResolverValue, boolean showQuitButtonValue, @NonNull QuitButtonPosition quitButtonPositionValue)

Method Summary

Modifier and TypeMethod and Description
public @Nullable WindowResolver
activeWindowResolverValue()

Record Component getter of activeWindowResolverValue.

public Optional<String>
backButtonText()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.backButtonText.

Custom text for the back button.

public @Nullable String
backButtonTextValue()

Record Component getter of backButtonTextValue.

public static PanelStep.Builder
builder(@NonNull String title)

public @NonNull List<WalkthroughRichTextBlock>
content()

Record Component getter of content.

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.content.

Content blocks to display

public Optional<String>
continueButtonText()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.continueButtonText.

Custom text for the continue button.

public @Nullable String
continueButtonTextValue()

Record Component getter of continueButtonTextValue.

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public @Nullable Double
heightValue()

Record Component getter of heightValue.

public Optional<WalkthroughEffect>
highlight()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.highlight.

Highlight effect to apply.

public @Nullable WalkthroughEffect
highlightValue()

Record Component getter of highlightValue.

public OptionalDouble
maxHeight()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.maxHeight.

Maximum height for the display element.

public OptionalDouble
maxWidth()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.maxWidth.

Maximum width for the display element.

public Optional<NodeResolver>
nodeResolver()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.nodeResolver.

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

public @NonNull PanelPosition
position()

Record Component getter of position.

public QuitButtonPosition
quitButtonPosition()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.quitButtonPosition.

Position of the quit button.

public @NonNull QuitButtonPosition
quitButtonPositionValue()

Record Component getter of quitButtonPositionValue.

public @Nullable NodeResolver
resolverValue()

Record Component getter of resolverValue.

public boolean
showQuitButton()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.showQuitButton.

Whether to show the quit button.

public boolean
showQuitButtonValue()

Record Component getter of showQuitButtonValue.

public Optional<String>
skipButtonText()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.skipButtonText.

Custom text for the skip button.

public @Nullable String
skipButtonTextValue()

Record Component getter of skipButtonTextValue.

public @NonNull String
title()

Record Component getter of title.

Implements org.jabref.gui.walkthrough.declarative.step.WalkthroughStep.title.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

public Optional<Trigger>
trigger()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.trigger.

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

public @Nullable Trigger
triggerValue()

Record Component getter of triggerValue.

public @Nullable Double
widthValue()

Record Component getter of widthValue.

public Optional<WindowResolver>
windowResolver()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.windowResolver.

Window resolver for targeting specific windows.

Field Detail

activeWindowResolverValueback to summary
private final @Nullable WindowResolver activeWindowResolverValue

Record Component accessed by activeWindowResolverValue().

backButtonTextValueback to summary
private final @Nullable String backButtonTextValue

Record Component accessed by backButtonTextValue().

contentback to summary
private final @NonNull List<WalkthroughRichTextBlock> content

Record Component accessed by content().

continueButtonTextValueback to summary
private final @Nullable String continueButtonTextValue

Record Component accessed by continueButtonTextValue().

heightValueback to summary
private final @Nullable Double heightValue

Record Component accessed by heightValue().

highlightValueback to summary
private final @Nullable WalkthroughEffect highlightValue

Record Component accessed by highlightValue().

positionback to summary
private final @NonNull PanelPosition position

Record Component accessed by position().

quitButtonPositionValueback to summary
private final @NonNull QuitButtonPosition quitButtonPositionValue

Record Component accessed by quitButtonPositionValue().

resolverValueback to summary
private final @Nullable NodeResolver resolverValue

Record Component accessed by resolverValue().

showQuitButtonValueback to summary
private final boolean showQuitButtonValue

Record Component accessed by showQuitButtonValue().

skipButtonTextValueback to summary
private final @Nullable String skipButtonTextValue

Record Component accessed by skipButtonTextValue().

titleback to summary
private final @NonNull String title

Record Component accessed by title().

triggerValueback to summary
private final @Nullable Trigger triggerValue

Record Component accessed by triggerValue().

widthValueback to summary
private final @Nullable Double widthValue

Record Component accessed by widthValue().

Constructor Detail

PanelStepback to summary
public PanelStep(@NonNull String title, @NonNull List<WalkthroughRichTextBlock> content, @Nullable NodeResolver resolverValue, @Nullable String continueButtonTextValue, @Nullable String skipButtonTextValue, @Nullable String backButtonTextValue, @Nullable Trigger triggerValue, @NonNull PanelPosition position, @Nullable Double widthValue, @Nullable Double heightValue, @Nullable WalkthroughEffect highlightValue, @Nullable WindowResolver activeWindowResolverValue, boolean showQuitButtonValue, @NonNull QuitButtonPosition quitButtonPositionValue)

Method Detail

activeWindowResolverValueback to summary
public @Nullable WindowResolver activeWindowResolverValue()

Record Component getter of activeWindowResolverValue.

backButtonTextback to summary
public Optional<String> backButtonText()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.backButtonText.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.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.
Annotations
@Override
backButtonTextValueback to summary
public @Nullable String backButtonTextValue()

Record Component getter of backButtonTextValue.

builderback to summary
public static PanelStep.Builder builder(@NonNull String title)
contentback to summary
public @NonNull List<WalkthroughRichTextBlock> content()

Record Component getter of content.

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.content.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.content.

Content blocks to display

continueButtonTextback to summary
public Optional<String> continueButtonText()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.continueButtonText.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.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.
Annotations
@Override
continueButtonTextValueback to summary
public @Nullable String continueButtonTextValue()

Record Component getter of continueButtonTextValue.

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

heightValueback to summary
public @Nullable Double heightValue()

Record Component getter of heightValue.

highlightback to summary
public Optional<WalkthroughEffect> highlight()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.highlight.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.highlight.

Highlight effect to apply.

Annotations
@Override
highlightValueback to summary
public @Nullable WalkthroughEffect highlightValue()

Record Component getter of highlightValue.

maxHeightback to summary
public OptionalDouble maxHeight()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.maxHeight.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.maxHeight.

Maximum height for the display element.

Annotations
@Override
maxWidthback to summary
public OptionalDouble maxWidth()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.maxWidth.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.maxWidth.

Maximum width for the display element.

Annotations
@Override
nodeResolverback to summary
public Optional<NodeResolver> nodeResolver()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.nodeResolver.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.nodeResolver.

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

Annotations
@Override
positionback to summary
public @NonNull PanelPosition position()

Record Component getter of position.

quitButtonPositionback to summary
public QuitButtonPosition quitButtonPosition()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.quitButtonPosition.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.quitButtonPosition.

Position of the quit button.

Annotations
@Override
quitButtonPositionValueback to summary
public @NonNull QuitButtonPosition quitButtonPositionValue()

Record Component getter of quitButtonPositionValue.

resolverValueback to summary
public @Nullable NodeResolver resolverValue()

Record Component getter of resolverValue.

showQuitButtonback to summary
public boolean showQuitButton()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.showQuitButton.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.showQuitButton.

Whether to show the quit button.

Annotations
@Override
showQuitButtonValueback to summary
public boolean showQuitButtonValue()

Record Component getter of showQuitButtonValue.

skipButtonTextback to summary
public Optional<String> skipButtonText()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.skipButtonText.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.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.
Annotations
@Override
skipButtonTextValueback to summary
public @Nullable String skipButtonTextValue()

Record Component getter of skipButtonTextValue.

titleback to summary
public @NonNull String title()

Record Component getter of title.

Implements org.jabref.gui.walkthrough.declarative.step.WalkthroughStep.title.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

triggerback to summary
public Optional<Trigger> trigger()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.trigger.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.trigger.

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

Annotations
@Override
triggerValueback to summary
public @Nullable Trigger triggerValue()

Record Component getter of triggerValue.

widthValueback to summary
public @Nullable Double widthValue()

Record Component getter of widthValue.

windowResolverback to summary
public Optional<WindowResolver> windowResolver()

Implements org.jabref.gui.walkthrough.declarative.step.VisibleComponent.windowResolver.

Doc from org.jabref.gui.walkthrough.declarative.step.VisibleComponent.windowResolver.

Window resolver for targeting specific windows.

Annotations
@Override
org.jabref.gui.walkthrough.declarative.step back to summary

public Class PanelStep.Builder

extends Object
Class Inheritance
  • java.lang.Object
  • org.jabref.gui.walkthrough.declarative.step.PanelStep.Builder

Field Summary

Modifier and TypeField and Description
private @Nullable WindowResolver
activeWindowResolver

private @Nullable String
backButtonText

private List<WalkthroughRichTextBlock>
content

private @Nullable String
continueButtonText

private @Nullable Double
height

private @Nullable WalkthroughEffect
highlight

private PanelPosition
position

private QuitButtonPosition
quitButtonPosition

private @Nullable NodeResolver
resolver

private boolean
showQuitButton

private @Nullable String
skipButtonText

private final String
title

private @Nullable Trigger
trigger

private @Nullable Double
width

Constructor Summary

AccessConstructor and Description
private
Builder(@NonNull String title)

Method Summary

Modifier and TypeMethod and Description
public PanelStep.Builder
activeWindow(@NonNull WindowResolver activeWindowResolver)

public PanelStep.Builder
backButton(@NonNull String text)

public PanelStep
build()

public PanelStep.Builder
content(@NonNull WalkthroughRichTextBlock... blocks)

public PanelStep.Builder
content(@NonNull List<WalkthroughRichTextBlock> content)

public PanelStep.Builder
continueButton(@NonNull String text)

public PanelStep.Builder
height(double height)

public PanelStep.Builder
highlight(@NonNull WalkthroughEffect highlight)

public PanelStep.Builder
highlight(@NonNull WindowEffect effect)

public PanelStep.Builder
highlight(@NonNull HighlightEffect effect)

public PanelStep.Builder
position(@NonNull PanelPosition position)

public PanelStep.Builder
quitButtonPosition(@NonNull QuitButtonPosition quitButtonPosition)

public PanelStep.Builder
resolver(@NonNull NodeResolver resolver)

public PanelStep.Builder
showQuitButton(boolean showQuitButton)

public PanelStep.Builder
skipButton(@NonNull String text)

public PanelStep.Builder
trigger(@NonNull Trigger trigger)

public PanelStep.Builder
trigger(@NonNull Trigger.Builder triggerBuilder)

public PanelStep.Builder
width(double width)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

activeWindowResolverback to summary
private @Nullable WindowResolver activeWindowResolver
backButtonTextback to summary
private @Nullable String backButtonText
contentback to summary
private List<WalkthroughRichTextBlock> content
continueButtonTextback to summary
private @Nullable String continueButtonText
heightback to summary
private @Nullable Double height
highlightback to summary
private @Nullable WalkthroughEffect highlight
positionback to summary
private PanelPosition position
quitButtonPositionback to summary
private QuitButtonPosition quitButtonPosition
resolverback to summary
private @Nullable NodeResolver resolver
showQuitButtonback to summary
private boolean showQuitButton
skipButtonTextback to summary
private @Nullable String skipButtonText
titleback to summary
private final String title
triggerback to summary
private @Nullable Trigger trigger
widthback to summary
private @Nullable Double width

Constructor Detail

Builderback to summary
private Builder(@NonNull String title)

Method Detail

activeWindowback to summary
public PanelStep.Builder activeWindow(@NonNull WindowResolver activeWindowResolver)
backButtonback to summary
public PanelStep.Builder backButton(@NonNull String text)
buildback to summary
public PanelStep build()
contentback to summary
public PanelStep.Builder content(@NonNull WalkthroughRichTextBlock... blocks)
contentback to summary
public PanelStep.Builder content(@NonNull List<WalkthroughRichTextBlock> content)
continueButtonback to summary
public PanelStep.Builder continueButton(@NonNull String text)
heightback to summary
public PanelStep.Builder height(double height)
highlightback to summary
public PanelStep.Builder highlight(@NonNull WalkthroughEffect highlight)
highlightback to summary
public PanelStep.Builder highlight(@NonNull WindowEffect effect)
highlightback to summary
public PanelStep.Builder highlight(@NonNull HighlightEffect effect)
positionback to summary
public PanelStep.Builder position(@NonNull PanelPosition position)
quitButtonPositionback to summary
public PanelStep.Builder quitButtonPosition(@NonNull QuitButtonPosition quitButtonPosition)
resolverback to summary
public PanelStep.Builder resolver(@NonNull NodeResolver resolver)
showQuitButtonback to summary
public PanelStep.Builder showQuitButton(boolean showQuitButton)
skipButtonback to summary
public PanelStep.Builder skipButton(@NonNull String text)
triggerback to summary
public PanelStep.Builder trigger(@NonNull Trigger trigger)
triggerback to summary
public PanelStep.Builder trigger(@NonNull Trigger.Builder triggerBuilder)
widthback to summary
public PanelStep.Builder width(double width)