JabRef 6.0-beta.1 · org.jabref.gui.walkthrough.declarative.NodeResolver

Method Summary

Modifier and Type	Method and Description
public static NodeResolver	Returns: a resolver that finds the button by action action(@NonNull StandardActions the StandardAction associated with the button action) Creates a resolver that finds a button by its StandardAction.
public static NodeResolver	Returns: a resolver that finds the button by button type buttonType(@NonNull ButtonType the button type to find buttonType) Creates a resolver that finds a button by its button type, assuming the node resolved is a `javafx.scene.control.DialogPane`.
public static NodeResolver	Returns: a resolver that finds the button by graphic buttonWithGraphic(IconTheme.JabRefIcons the graphic of the button glyph) Creates a resolver that finds a button by its graphic.
public static NodeResolver	buttonWithGraphicIn(Class<? extends Node> container, IconTheme.JabRefIcons glyph) Creates a resolver that finds a button by its graphic below the first visible node of type `container`.
private static boolean	containsGlyph(@Nullable Node graphic, IconTheme.JabRefIcons glyph)
private static @Nullable Node	findNode(@NonNull Node root, @NonNull Predicate<Node> predicate)
public static NodeResolver	firstOf(NodeResolver... resolvers) Creates a resolver that returns the first node any of the given resolvers finds, in order.
public static NodeResolver	Returns: a resolver that finds the node by fx:id fxId(@NonNull String the fx:id of the node fxId) Creates a resolver that finds a node by its fx:id. The returned node is guaranteed to be visible.
private static boolean	isVisible(@Nullable Node node)
public static NodeResolver	Returns: a resolver that finds the menu item by text menuItem(@NonNull String the already localized text of the menu item text) Creates a resolver that finds a menu item by its text.
public static NodeResolver	Returns: a resolver that finds the node matching the predicate predicate(@NonNull Predicate<Node> the predicate to match the node predicate) Creates a resolver that finds a node by a predicate.
public Optional<Node>	Returns: an optional containing the found node, or empty if not found resolve(@NonNull Scene the scene to search in scene) Resolves a node from the given scene.
public static NodeResolver	Returns: a resolver that finds the node by selector selector(@NonNull String the CSS selector to find the node selector) Creates a resolver that finds a node by CSS selector.
public static NodeResolver	Returns: a resolver that finds the node by style class and text content selectorWithText(@NonNull String the style class to match selector, @NonNull Predicate<String> predicate to match text content in LabeledText children textMatcher) Creates a resolver that finds a node by selector first, then matches text content in the node and the node's LabeledText children.

Method Detail

action	back to summary
public static NodeResolver action(@NonNull StandardActions action) Creates a resolver that finds a button by its StandardAction. The button is matched by its tooltip text or button text. The returned button is guaranteed to be visible. Parameters action:@NonNull StandardActions the StandardAction associated with the button Returns:NodeResolver a resolver that finds the button by action

action

back to summary

public static NodeResolver action(@NonNull StandardActions action)

Creates a resolver that finds a button by its StandardAction. The button is matched by its tooltip text or button text. The returned button is guaranteed to be visible.

Parameters

action:@NonNull StandardActions: the StandardAction associated with the button

Returns:NodeResolver

a resolver that finds the button by action

buttonType back to summary

buttonType	back to summary
public static NodeResolver buttonType(@NonNull ButtonType buttonType) Creates a resolver that finds a button by its button type, assuming the node resolved is a `javafx.scene.control.DialogPane`. Parameters buttonType:@NonNull ButtonType the button type to find Returns:NodeResolver a resolver that finds the button by button type

public static NodeResolver buttonType(@NonNull ButtonType buttonType)

Creates a resolver that finds a button by its button type, assuming the node resolved is a javafx.scene.control.DialogPane.

Parameters

buttonType:@NonNull ButtonType: the button type to find

Returns:NodeResolver

a resolver that finds the button by button type

buttonWithGraphic	back to summary
public static NodeResolver buttonWithGraphic(IconTheme.JabRefIcons glyph) Creates a resolver that finds a button by its graphic. The returned button is guaranteed to be visible. Parameters glyph:IconTheme.JabRefIcons the graphic of the button Returns:NodeResolver a resolver that finds the button by graphic

buttonWithGraphic

back to summary

public static NodeResolver buttonWithGraphic(IconTheme.JabRefIcons glyph)

Creates a resolver that finds a button by its graphic. The returned button is guaranteed to be visible.

Parameters

glyph:IconTheme.JabRefIcons: the graphic of the button

Returns:NodeResolver

a resolver that finds the button by graphic

buttonWithGraphicIn	back to summary
public static NodeResolver buttonWithGraphicIn(Class<? extends Node> container, IconTheme.JabRefIcons glyph) Creates a resolver that finds a button by its graphic below the first visible node of type `container`. Use it when the same glyph occurs elsewhere in the scene (e.g. the DOI row's "Look up" button shares its icon with the file editor's "Get fulltext").

containsGlyph	back to summary
private static boolean containsGlyph(@Nullable Node graphic, IconTheme.JabRefIcons glyph)

findNode	back to summary
private static @Nullable Node findNode(@NonNull Node root, @NonNull Predicate<Node> predicate)

firstOf	back to summary
public static NodeResolver firstOf(NodeResolver... resolvers) Creates a resolver that returns the first node any of the given resolvers finds, in order.

fxId	back to summary
public static NodeResolver fxId(@NonNull String fxId) Creates a resolver that finds a node by its fx:id. The returned node is guaranteed to be visible. Parameters fxId:@NonNull String the fx:id of the node Returns:NodeResolver a resolver that finds the node by fx:id

fxId

back to summary

public static NodeResolver fxId(@NonNull String fxId)

Creates a resolver that finds a node by its fx:id. The returned node is guaranteed to be visible.

Parameters

fxId:@NonNull String: the fx:id of the node

Returns:NodeResolver

a resolver that finds the node by fx:id

isVisible	back to summary
private static boolean isVisible(@Nullable Node node)

menuItem	back to summary
public static NodeResolver menuItem(@NonNull String text) Creates a resolver that finds a menu item by its text. Parameters text:@NonNull String the already localized text of the menu item Returns:NodeResolver a resolver that finds the menu item by text

menuItem

back to summary

public static NodeResolver menuItem(@NonNull String text)

Creates a resolver that finds a menu item by its text.

Parameters

text:@NonNull String: the already localized text of the menu item

Returns:NodeResolver

a resolver that finds the menu item by text

predicate	back to summary
public static NodeResolver predicate(@NonNull Predicate<Node> predicate) Creates a resolver that finds a node by a predicate. The returned node is guaranteed to be visible. Parameters predicate:@NonNull Predicate<Node> the predicate to match the node Returns:NodeResolver a resolver that finds the node matching the predicate

predicate

back to summary

public static NodeResolver predicate(@NonNull Predicate<Node> predicate)

Creates a resolver that finds a node by a predicate. The returned node is guaranteed to be visible.

Parameters

predicate:@NonNull Predicate<Node>: the predicate to match the node

Returns:NodeResolver

a resolver that finds the node matching the predicate

resolve	back to summary
public Optional<Node> resolve(@NonNull Scene scene) Resolves a node from the given scene. Parameters scene:@NonNull Scene the scene to search in Returns:Optional<Node> an optional containing the found node, or empty if not found

resolve

back to summary

public Optional<Node> resolve(@NonNull Scene scene)

Resolves a node from the given scene.

Parameters

scene:@NonNull Scene: the scene to search in

Returns:Optional<Node>

an optional containing the found node, or empty if not found

selector	back to summary
public static NodeResolver selector(@NonNull String selector) Creates a resolver that finds a node by CSS selector. The returned node is guaranteed to be visible. Parameters selector:@NonNull String the CSS selector to find the node Returns:NodeResolver a resolver that finds the node by selector

selector

back to summary

public static NodeResolver selector(@NonNull String selector)

Creates a resolver that finds a node by CSS selector. The returned node is guaranteed to be visible.

Parameters

selector:@NonNull String: the CSS selector to find the node

Returns:NodeResolver

a resolver that finds the node by selector

selectorWithText	back to summary
public static NodeResolver selectorWithText(@NonNull String selector, @NonNull Predicate<String> textMatcher) Creates a resolver that finds a node by selector first, then matches text content in the node and the node's LabeledText children. The returned node is guaranteed to be visible. Parameters selector:@NonNull String the style class to match textMatcher:@NonNull Predicate<String> predicate to match text content in LabeledText children Returns:NodeResolver a resolver that finds the node by style class and text content

selectorWithText

back to summary

public static NodeResolver selectorWithText(@NonNull String selector, @NonNull Predicate<String> textMatcher)

Creates a resolver that finds a node by selector first, then matches text content in the node and the node's LabeledText children. The returned node is guaranteed to be visible.

Parameters

selector:@NonNull String: the style class to match
textMatcher:@NonNull Predicate<String>: predicate to match text content in LabeledText children

Returns:NodeResolver

a resolver that finds the node by style class and text content

public Interface NodeResolver

Method Summary

Method Detail