org.eclipse.fx.ui.controls

Class Util

java.lang.Object

org.eclipse.fx.ui.controls.Util

public class Util
extends java.lang.Object

Utility methods

Since:

1.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIND_NODE_EXCLUDE Tag used to exclude a node from finding
static java.lang.String	FIND_NODE_RESPECT_DRAWING_ORDER System property to force findNode(Node, double, double) to respect the drawing order
static boolean	MNEMONICS_FIX Boolean to indicate if mnemonic fixing is enabled
static java.lang.String	OPTIMIZE_ATTACH An application property to optimize the performances of attaching a sub-graph to a Scene.

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static void	attachNode(javafx.scene.Node node, java.util.function.Consumer<javafx.scene.Node> attachToParent) Attach the given node to an existing scene graph, via the given consumer.
static void	attachNode(javafx.scene.Node node, java.lang.Runnable attachToParent) Attach the given node to an existing scene graph, via the given runnable.
static <T,E> Subscription	bindContent(java.util.List<T> target, javafx.collections.ObservableList<E> sourceList, java.util.function.Function<E,T> converterFunction) Deprecated. use FXObservableUtils#bindContent(List, ObservableList, Function)
static javafx.beans.property.BooleanProperty	createPseudoClassProperty(javafx.css.PseudoClass cls, javafx.scene.Node node, java.lang.String name, boolean def) creates a new pseudo class property.
static javafx.beans.property.BooleanProperty	createPseudoClassProperty(java.lang.String pseudoClass, javafx.scene.Node node, java.lang.String name, boolean def) creates a new pseudo class property.
static javafx.beans.binding.DoubleBinding	createTextHeightBinding(java.lang.String text, javafx.beans.value.ObservableValue<javafx.scene.text.Font> font, javafx.beans.value.ObservableValue<java.lang.Number> fontZoomFactor)
static javafx.beans.binding.DoubleBinding	createTextWidthBinding(javafx.beans.value.ObservableValue<java.lang.String> text, javafx.beans.value.ObservableValue<javafx.scene.text.Font> font, javafx.beans.value.ObservableValue<java.lang.Number> fontZoomFactor) Create a binding for text width calculation.
static javafx.beans.binding.DoubleBinding	createTextWidthBinding(java.lang.String text, javafx.beans.value.ObservableValue<javafx.scene.text.Font> font, javafx.beans.value.ObservableValue<java.lang.Number> fontZoomFactor)
static void	disableStyle(javafx.scene.Node node) Disable styling on the given node, if OPTIMIZE_ATTACH is true.
static java.lang.String	dumpSceneGraph(javafx.scene.Node n) Dump the scene graph to a formatted string
static void	enterNestedEventLoop(java.lang.String id) Enter a nested event loop
static void	exitNestedEventLoop(java.lang.String id) Exit the nested event loop
static javafx.scene.Node	findNode(javafx.scene.Node n, double screenX, double screenY) Find all node at the given x/y location starting the search from the given node
static javafx.scene.Node	findNode(javafx.stage.Window w, double screenX, double screenY) Find a node in all windows
static javafx.scene.layout.Background	getSimpleBackground(javafx.scene.paint.Paint p) Create a simple background fill
static Size	getSize(javafx.scene.text.Font font, char c) Get the size for the provided character
static double	getTextHeight(java.lang.String text, javafx.scene.text.Font font, double fontZoomFactor)
static double	getTextWidth(java.lang.String text, javafx.scene.text.Font font, double fontZoomFactor) Calculate the size of the text with the given font
static Subscription	installHoverCallback(javafx.scene.Node node, javafx.util.Duration delay, java.util.function.Consumer<javafx.scene.input.MouseEvent> hoverConsumer) Install a hover callback
static boolean	isCopyEvent(javafx.scene.input.MouseEvent event)
static <E extends javafx.event.Event> javafx.event.EventHandler<E>	onEvent(java.lang.Runnable r) Run the provided runnable when the event occurs
static <E extends javafx.event.Event> javafx.event.EventHandler<E>	onEventConsume(java.util.function.BooleanSupplier r) Run the provided supplier when the event occurs and if true is returned consume the event
static void	restoreStyle(javafx.scene.Node node) Restore & reapply styling on the given node, if OPTIMIZE_ATTACH is true.
static javafx.scene.Node	toNode(StyledString s) Create a scenegraph node from the styled string
static <T,E> java.util.List<T>	transformList(java.util.List<? extends E> list, java.util.function.Function<E,T> converterFunction) Transform the list to another list
static <T> T	waitUntil(<any> blockCondition) Deprecated. deprecated since 3.0 to to be replaced by ThreadSynchronize#block(BlockCondition)
static javafx.beans.value.ObservableValue<javafx.stage.Window>	windowProperty(javafx.scene.Node n) Get the window property of a node

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIND_NODE_EXCLUDE

public static final java.lang.String FIND_NODE_EXCLUDE

Tag used to exclude a node from finding

See Also:

Constant Field Values

FIND_NODE_RESPECT_DRAWING_ORDER

public static final java.lang.String FIND_NODE_RESPECT_DRAWING_ORDER

System property to force findNode(Node, double, double) to respect the drawing order

See Also:

Constant Field Values

MNEMONICS_FIX

public static final boolean MNEMONICS_FIX

Boolean to indicate if mnemonic fixing is enabled

OPTIMIZE_ATTACH

public static final java.lang.String OPTIMIZE_ATTACH

An application property to optimize the performances of attaching a sub-graph to a Scene.

Set this property to true to workaround performance issues from https://bugs.openjdk.java.net/browse/JDK-8151756 and https://bugs.openjdk.java.net/browse/JDK-8193445

See Also:

Constant Field Values

Constructor Detail

Util

public Util()

Method Detail

dumpSceneGraph

public static java.lang.String dumpSceneGraph(javafx.scene.Node n)

Dump the scene graph to a formatted string

Parameters:

n - the node to start with

Returns:

the dump as a formatted XML

toNode

public static javafx.scene.Node toNode(StyledString s)

Create a scenegraph node from the styled string

Parameters:

s - the string

Returns:

a scenegraph node

findNode

public static javafx.scene.Node findNode(javafx.stage.Window w,
                                         double screenX,
                                         double screenY)

Find a node in all windows

Parameters:

w - the preferred window

screenX - the screen x

screenY - the screen y

Returns:

the node or null

findNode

public static javafx.scene.Node findNode(javafx.scene.Node n,
                                         double screenX,
                                         double screenY)

Find all node at the given x/y location starting the search from the given node

Parameters:

n - the node to use as the start

screenX - the screen x

screenY - the screen y

Returns:

the node or null

windowProperty

public static javafx.beans.value.ObservableValue<javafx.stage.Window> windowProperty(javafx.scene.Node n)

Get the window property of a node

Parameters:

n - the node the window property to observe

Returns:

the property

bindContent

public static <T,E> Subscription bindContent(java.util.List<T> target,
                                             javafx.collections.ObservableList<E> sourceList,
                                             java.util.function.Function<E,T> converterFunction)

Deprecated. use FXObservableUtils#bindContent(List, ObservableList, Function)

Bind the content to the source list to the target and apply the converter in between

Type Parameters:

T - the target type

E - the source type

Parameters:

target - the target list

sourceList - the source list

converterFunction - the function used to convert

Returns:

the subscription to dispose the binding

transformList

public static <T,E> java.util.List<T> transformList(java.util.List<? extends E> list,
                                                    java.util.function.Function<E,T> converterFunction)

Transform the list to another list

Parameters:

list - the list

converterFunction - the converter function

Returns:

the list

installHoverCallback

public static Subscription installHoverCallback(javafx.scene.Node node,
                                                javafx.util.Duration delay,
                                                java.util.function.Consumer<javafx.scene.input.MouseEvent> hoverConsumer)

Install a hover callback

Parameters:

node - the node the hover is installed on

delay - the delay

hoverConsumer - the consumer

Returns:

subscription

enterNestedEventLoop

public static void enterNestedEventLoop(java.lang.String id)

Enter a nested event loop

Parameters:

id - the id of the nested event loop

Since:

2.3.0

exitNestedEventLoop

public static void exitNestedEventLoop(java.lang.String id)

Exit the nested event loop

Parameters:

id - the nested event loop

Since:

2.3.0

waitUntil

@Deprecated
public static <T> T waitUntil(<any> blockCondition)

Deprecated. deprecated since 3.0 to to be replaced by ThreadSynchronize#block(BlockCondition)

Wait until the condition is satisfied without blocking the UI-Thread

Parameters:

blockCondition - the condition

Returns:

the return value of the condition

Since:

2.3.0

getTextWidth

public static double getTextWidth(java.lang.String text,
                                  javafx.scene.text.Font font,
                                  double fontZoomFactor)

Calculate the size of the text with the given font

Parameters:

text - the text

font - the font

Returns:

the width

Since:

2.3.0

createTextWidthBinding

public static javafx.beans.binding.DoubleBinding createTextWidthBinding(javafx.beans.value.ObservableValue<java.lang.String> text,
                                                                        javafx.beans.value.ObservableValue<javafx.scene.text.Font> font,
                                                                        javafx.beans.value.ObservableValue<java.lang.Number> fontZoomFactor)

Create a binding for text width calculation.

Parameters:

text -

font -

Returns:

createTextWidthBinding

public static javafx.beans.binding.DoubleBinding createTextWidthBinding(java.lang.String text,
                                                                        javafx.beans.value.ObservableValue<javafx.scene.text.Font> font,
                                                                        javafx.beans.value.ObservableValue<java.lang.Number> fontZoomFactor)

getTextHeight

public static double getTextHeight(java.lang.String text,
                                   javafx.scene.text.Font font,
                                   double fontZoomFactor)

createTextHeightBinding

public static javafx.beans.binding.DoubleBinding createTextHeightBinding(java.lang.String text,
                                                                         javafx.beans.value.ObservableValue<javafx.scene.text.Font> font,
                                                                         javafx.beans.value.ObservableValue<java.lang.Number> fontZoomFactor)

isCopyEvent

public static boolean isCopyEvent(javafx.scene.input.MouseEvent event)

getSize

public static Size getSize(javafx.scene.text.Font font,
                           char c)

Get the size for the provided character

Parameters:

font - the font

c - the character

Returns:

the size

getSimpleBackground

public static javafx.scene.layout.Background getSimpleBackground(javafx.scene.paint.Paint p)

Create a simple background fill

Parameters:

p - the paint

Returns:

the background

createPseudoClassProperty

public static javafx.beans.property.BooleanProperty createPseudoClassProperty(javafx.css.PseudoClass cls,
                                                                              javafx.scene.Node node,
                                                                              java.lang.String name,
                                                                              boolean def)

creates a new pseudo class property.

A pseudo class property is a BooleanProperty which updates the containers pseudo class state on invalidation.

Parameters:

cls - the pseudo class

node - the container node

name - the properties name (not to confuse with the pseudo class name, those may be different)

def - the initial value

Returns:

the new property

createPseudoClassProperty

public static javafx.beans.property.BooleanProperty createPseudoClassProperty(java.lang.String pseudoClass,
                                                                              javafx.scene.Node node,
                                                                              java.lang.String name,
                                                                              boolean def)

creates a new pseudo class property.

A pseudo class property is a BooleanProperty which updates the containers pseudo class state on invalidation.

Convenience method if you do not need to hold the instance of the PseudoClass

Parameters:

pseudoClass - the pseudo class string

node - the container node

name - the properties name (not to confuse with the pseudo class name, those may be different)

def - the initial value

Returns:

the new property

onEvent

public static <E extends javafx.event.Event> javafx.event.EventHandler<E> onEvent(java.lang.Runnable r)

Run the provided runnable when the event occurs

Parameters:

r - the runnable

Returns:

the event handler

Since:

3.5.0

onEventConsume

public static <E extends javafx.event.Event> javafx.event.EventHandler<E> onEventConsume(java.util.function.BooleanSupplier r)

Run the provided supplier when the event occurs and if true is returned consume the event

Parameters:

r - the supplier

Returns:

the event handler

Since:

3.5.0

attachNode

public static void attachNode(javafx.scene.Node node,
                              java.util.function.Consumer<javafx.scene.Node> attachToParent)

Attach the given node to an existing scene graph, via the given consumer. This method is meant to increase performances for this operation, on some JavaFX versions, and should be used when attaching a significant sub-graph to an existing scene. Since the performance patch is related to the current JavaFX version, it has to be explicitly enabled via the efxclipse.optimize.attach system property

Parameters:

node - The node to attach to an existing scene graph

attachToParent - The method used to attach the node to the scene graph (e.g. pane.getChildren()::add or borderPane::setCenter)

See Also:

OPTIMIZE_ATTACH

attachNode

public static void attachNode(javafx.scene.Node node,
                              java.lang.Runnable attachToParent)

Attach the given node to an existing scene graph, via the given runnable. This method is meant to increase performances for this operation, on some JavaFX versions, and should be used when attaching a significant sub-graph to an existing scene. Since the performance patch is related to the current JavaFX version, it has to be explicitly enabled via the efxclipse.optimize.attach system property

Parameters:

node - The node to attach to an existing scene graph

attachToParent - The method used to attach the node to the scene graph (e.g. () -> pane.getChildren().add(node) or () -> borderPane.setCenter(node))

See Also:

OPTIMIZE_ATTACH

disableStyle

public static void disableStyle(javafx.scene.Node node)

Disable styling on the given node, if OPTIMIZE_ATTACH is true. This method can be called before attaching a sub-graph to a scene, to increase performances. After invoking this method, styling should be explicitly re-enabled with restoreStyle(Node)

If OPTIMIZE_ATTACH is false, this is a no-op.

This method will be applied recursively on the node's children.

Parameters:

node - The node for which styling should be disabled

See Also:

OPTIMIZE_ATTACH

restoreStyle

public static void restoreStyle(javafx.scene.Node node)

Restore & reapply styling on the given node, if OPTIMIZE_ATTACH is true.

This method will be applied recursively on the node's children.

If OPTIMIZE_ATTACH is false, this is a no-op.

Parameters:

node - The node for which styling should be restored