Modifier and Type	Class and Description
public static class	Trigger.Builder

Modifier and Type	Field and Description
public static final Logger	LOGGER

Modifier and Type	Method and Description
public Runnable	Returns: a runnable to clean up the listeners attach(@NonNull Node the node to attach the listeners to node, Runnable the runnable to execute before navigation beforeNavigate, Runnable the runnable to execute when navigation occurs onNavigate) Attaches the navigation triggers to the target node.
public static Trigger.Builder	create()
public static Trigger	onClick()
public static Trigger	onDoubleClick()
public static Trigger	onFetchFulltextCompleted()
public static Trigger	onFileAddedToListView()
public static Trigger	onHover()
public static Trigger	onTextEquals(String expected)
public static Trigger	onTextInput()
public static Trigger	onTextMatchesRegex(String regex)

LOGGER	back to summary
public static final Logger LOGGER

Method Detail

attach back to summary

attach	back to summary
public Runnable attach(@NonNull Node node, Runnable beforeNavigate, Runnable onNavigate) Attaches the navigation triggers to the target node. `beforeNavigate` and `onNavigate` are guaranteed to run at most once. Parameters node:@NonNull Node the node to attach the listeners to beforeNavigate:Runnable the runnable to execute before navigation onNavigate:Runnable the runnable to execute when navigation occurs Returns:Runnable a runnable to clean up the listeners

public Runnable attach(@NonNull Node node, Runnable beforeNavigate, Runnable onNavigate)

Attaches the navigation triggers to the target node. beforeNavigate and onNavigate are guaranteed to run at most once.

Parameters

node:@NonNull Node: the node to attach the listeners to
beforeNavigate:Runnable: the runnable to execute before navigation
onNavigate:Runnable: the runnable to execute when navigation occurs

Returns:Runnable

a runnable to clean up the listeners

create	back to summary
public static Trigger.Builder create()

onClick	back to summary
public static Trigger onClick()

onDoubleClick	back to summary
public static Trigger onDoubleClick()

onFetchFulltextCompleted	back to summary
public static Trigger onFetchFulltextCompleted()

onFileAddedToListView	back to summary
public static Trigger onFileAddedToListView()

onHover	back to summary
public static Trigger onHover()

onTextEquals	back to summary
public static Trigger onTextEquals(String expected)

onTextInput	back to summary
public static Trigger onTextInput()

onTextMatchesRegex	back to summary
public static Trigger onTextMatchesRegex(String regex)

org.jabref.gui.walkthrough.declarative back to summary

public Class Trigger.Builder

Class Inheritance

extends Object

java.lang.Object
org.jabref.gui.walkthrough.declarative.Trigger.Builder

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static interface	Trigger.Builder.PredicateGenerator

Field Summary

Modifier and Type	Field and Description
private static final Duration	DEFAULT_TIMEOUT
private Trigger.Builder.PredicateGenerator	generator
private static final Duration	NAVIGATION_DELAY
private static final Supplier<Void>	NOTHING
private Duration	timeout
private boolean	withWindowChangeListener

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public Trigger	build()
public Trigger.Builder	onClick() Triggers navigation on a single mouse click (more precisely, press) or when an action is performed (for Menu and Button)
public Trigger.Builder	onDoubleClick()
public Trigger.Builder	onFetchFulltextCompleted()
public Trigger.Builder	onFileAddedToListView()
public Trigger.Builder	onHover()
public Trigger.Builder	onRightClick()
public Trigger.Builder	onTextEquals(@NonNull String expected)
public Trigger.Builder	onTextInput()
public Trigger.Builder	onTextMatchesRegex(@NonNull String regex)
private void	setGenerator(Trigger.Builder.PredicateGenerator newGenerator)
public Trigger.Builder	Returns: this builder withTimeout(Duration The timeout duration. Defaults to 1000ms. timeout) The timeout after which navigation is triggered automatically.
public Trigger.Builder	Returns: this builder withWindowChangeListener() If set, navigation will also be triggered when a window is closed.

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

Field Detail

DEFAULT_TIMEOUT	back to summary
private static final Duration DEFAULT_TIMEOUT

generator	back to summary
private Trigger.Builder.PredicateGenerator generator

NAVIGATION_DELAY	back to summary
private static final Duration NAVIGATION_DELAY

NOTHING	back to summary
private static final Supplier<Void> NOTHING

timeout	back to summary
private Duration timeout

withWindowChangeListener	back to summary
private boolean withWindowChangeListener

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public Trigger build()

onClick	back to summary
public Trigger.Builder onClick() Triggers navigation on a single mouse click (more precisely, press) or when an action is performed (for Menu and Button)

onDoubleClick	back to summary
public Trigger.Builder onDoubleClick()

onFetchFulltextCompleted	back to summary
public Trigger.Builder onFetchFulltextCompleted()

onFileAddedToListView	back to summary
public Trigger.Builder onFileAddedToListView()

onHover	back to summary
public Trigger.Builder onHover()

onRightClick	back to summary
public Trigger.Builder onRightClick()

onTextEquals	back to summary
public Trigger.Builder onTextEquals(@NonNull String expected)

onTextInput	back to summary
public Trigger.Builder onTextInput()

onTextMatchesRegex	back to summary
public Trigger.Builder onTextMatchesRegex(@NonNull String regex)

setGenerator	back to summary
private void setGenerator(Trigger.Builder.PredicateGenerator newGenerator)

withTimeout	back to summary
public Trigger.Builder withTimeout(Duration timeout) The timeout after which navigation is triggered automatically. Parameters timeout:Duration The timeout duration. Defaults to 1000ms. Returns:Trigger.Builder this builder

withTimeout

back to summary

public Trigger.Builder withTimeout(Duration timeout)

The timeout after which navigation is triggered automatically.

Parameters

timeout:Duration: The timeout duration. Defaults to 1000ms.

Returns:Trigger.Builder

this builder

withWindowChangeListener	back to summary
public Trigger.Builder withWindowChangeListener() If set, navigation will also be triggered when a window is closed. Returns:Trigger.Builder this builder

withWindowChangeListener

back to summary

public Trigger.Builder withWindowChangeListener()

If set, navigation will also be triggered when a window is closed.

Returns:Trigger.Builder: this builder

org.jabref.gui.walkthrough.declarative back to summary

private Interface Trigger.Builder.PredicateGenerator

Annotations

@FunctionalInterface

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public Runnable	Returns: A cleanup runnable that detaches the trigger. create(Node The node to attach the trigger to. node, Function<Supplier<?>, ?> A function that wraps the original event handler. It takes a Supplier representing the original action and returns the result of that action. onNavigate) Modify the node's event dispatch chain or register custom logic to trigger `Trigger` when desired conditions are met.

public Runnable

Returns:

A cleanup runnable that detaches the trigger.

create(Node

The node to attach the trigger to.

node, Function<Supplier<?>, ?>

A function that wraps the original event handler. It takes a Supplier representing the original action and returns the result of that action.

onNavigate)

Modify the node's event dispatch chain or register custom logic to trigger Trigger when desired conditions are met.

Method Detail

create back to summary

create	back to summary
public Runnable create(Node node, Function<Supplier<?>, ?> onNavigate) Modify the node's event dispatch chain or register custom logic to trigger `Trigger` when desired conditions are met. Parameters node:Node The node to attach the trigger to. onNavigate:Function<Supplier<?>, ?> A function that wraps the original event handler. It takes a Supplier representing the original action and returns the result of that action. Returns:Runnable A cleanup runnable that detaches the trigger.

public Runnable create(Node node, Function<Supplier<?>, ?> onNavigate)

Modify the node's event dispatch chain or register custom logic to trigger Trigger when desired conditions are met.

Parameters

node:Node: The node to attach the trigger to.
onNavigate:Function<Supplier<?>, ?>: A function that wraps the original event handler. It takes a Supplier representing the original action and returns the result of that action.

Returns:Runnable

A cleanup runnable that detaches the trigger.

public Interface Trigger

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class Trigger.Builder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface Trigger.Builder.PredicateGenerator

Method Summary

Method Detail