uk.co.strangeskies.fx

Class FxUtilities

java.lang.Object

uk.co.strangeskies.fx.FxUtilities

public class FxUtilities
extends java.lang.Object

A collection of general utility methods for working with JavaFX and e(fx)clipse.

Method Summary

Modifier and Type	Method and Description
static <T> javafx.collections.ObservableList<T>	asList(javafx.collections.ObservableSet<T> component) Create an observable list view of an observable set.
static <T> javafx.collections.ObservableSet<T>	asSet(javafx.collections.ObservableList<T> component) Create an observable set view of an observable list.
static java.net.URL	getResource(java.lang.Class<?> controllerClass) Find the .fxml resource associated with a given controller class by location and naming conventions.
static java.net.URL	getResource(java.lang.Class<?> controllerClass, java.lang.String resourceName) Find the .fxml resource for a given controller class by location conventions.
static java.lang.String	getResourceName(java.lang.Class<?> controllerClass) Find the name of the .fxml resource associated with a given controller class by convention.
static <T,U> javafx.collections.ObservableList<T>	map(javafx.collections.ObservableList<U> component, java.util.function.Function<U,T> mapper) Create a new observable list as a transformation of a component observable list.
static <T,U> javafx.collections.ObservableSet<T>	map(javafx.collections.ObservableSet<U> component, java.util.function.Function<U,T> mapper) Create a new observable set as a transformation of a component observable set.
static void	runNow(java.lang.Runnable runnable) Perform the given action on the JavaFX event thread as soon as possible, returning upon completion.
static <T> T	runNow(java.util.function.Supplier<T> runnable) Perform the given action on the JavaFX event thread as soon as possible, returning the result upon completion.
static <T> javafx.beans.value.ObservableValue<T>	wrap(Observable<T> observable, T initial) Wrap an Observable with a JavaFX equivalent ObservableValue.
static <T> javafx.beans.value.ObservableValue<T>	wrap(ObservableValue<T> observable) Wrap an ObservableValue with a JavaFX equivalent ObservableValue.

Methods inherited from class java.lang.Object

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

Method Detail

runNow

public static void runNow(java.lang.Runnable runnable)

Perform the given action on the JavaFX event thread as soon as possible, returning upon completion. This method is safe whether or not the invoking thread is the event thread.

Parameters:

runnable - The action to execute

runNow

public static <T> T runNow(java.util.function.Supplier<T> runnable)

Perform the given action on the JavaFX event thread as soon as possible, returning the result upon completion. This method is safe whether or not the invoking thread is the event thread.

Type Parameters:

T - The type of value to result from the action

Parameters:

runnable - The action to execute

Returns:

The result of invoking the given supplier

map

public static <T,U> javafx.collections.ObservableList<T> map(javafx.collections.ObservableList<U> component,
                                                             java.util.function.Function<U,T> mapper)

Create a new observable list as a transformation of a component observable list.

Type Parameters:

T - the type of the elements of the new list

U - the type of the elements of the component list

Parameters:

component - the component list

mapper - a mapping from the type of the elements of the component list to the type of the elements of the new list

Returns:

a new observable list, backed by the given list, with each element in that list transformed according to the given function

map

public static <T,U> javafx.collections.ObservableSet<T> map(javafx.collections.ObservableSet<U> component,
                                                            java.util.function.Function<U,T> mapper)

Create a new observable set as a transformation of a component observable set.

Type Parameters:

T - the type of the elements of the new set

U - the type of the elements of the component set

Parameters:

component - the component set

mapper - a mapping from the type of the elements of the component set to the type of the elements of the new set

Returns:

a new observable set, backed by the given set, with each element in that set transformed according to the given function

asList

public static <T> javafx.collections.ObservableList<T> asList(javafx.collections.ObservableSet<T> component)

Create an observable list view of an observable set.

Type Parameters:

T - the type of the elements of the set

Parameters:

component - the set to wrap as a list

Returns:

a list whose contents are backed by the given set

asSet

public static <T> javafx.collections.ObservableSet<T> asSet(javafx.collections.ObservableList<T> component)

Create an observable set view of an observable list.

Type Parameters:

T - the type of the elements of the list

Parameters:

component - the list to wrap as a set

Returns:

a set whose contents are backed by the given list

wrap

public static <T> javafx.beans.value.ObservableValue<T> wrap(Observable<T> observable,
                                                             T initial)

Wrap an Observable with a JavaFX equivalent ObservableValue.

Type Parameters:

T - the type of the value

Parameters:

observable - the observable value to wrap

initial - the initial value of the wrapping observable value

Returns:

a JavaFX observable value backed by the given observable

wrap

public static <T> javafx.beans.value.ObservableValue<T> wrap(ObservableValue<T> observable)

Wrap an ObservableValue with a JavaFX equivalent ObservableValue.

Type Parameters:

T - the type of the value

Parameters:

observable - the observable value to wrap

Returns:

a JavaFX observable value backed by the given observable value

getResource

public static java.net.URL getResource(java.lang.Class<?> controllerClass)

Find the .fxml resource associated with a given controller class by location and naming conventions. The location of the file is assumed to be the same package as the controller class. The name of the file is determined according to the convention described by getResourceName(Class).

Parameters:

controllerClass - The controller class whose resource we wish to locate

Returns:

The URL for the resource associated with the given controller class.

getResourceName

public static java.lang.String getResourceName(java.lang.Class<?> controllerClass)

Find the name of the .fxml resource associated with a given controller class by convention. The name of the file is assumed to be [classname].fxml, or if [classname] takes the form [classnameprefix]Controller, the name of the file is assumed to be [classnameprefix].fxml.

Parameters:

controllerClass - The controller class whose resource we wish to locate

Returns:

The URL for the resource associated with the given controller class.

getResource

public static java.net.URL getResource(java.lang.Class<?> controllerClass,
                                       java.lang.String resourceName)

Find the .fxml resource for a given controller class by location conventions. The location of the file is assumed to be the same package as the controller class.

Parameters:

controllerClass - The controller class whose resource we wish to locate

resourceName - The name of the resource file

Returns:

The URL for the resource associated with the given controller class.