org.loadui.testfx

Class GuiTest

java.lang.Object

org.loadui.testfx.GuiTest

public abstract class GuiTest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GuiTest.TestFxApp

Field Summary

Fields

Modifier and Type	Field and Description
protected static javafx.stage.Stage	stage

Constructor Summary

Constructors

Constructor and Description
GuiTest()

Method Summary

Methods

Modifier and Type	Method and Description
static File	captureScreenshot()
GuiTest	click(javafx.geometry.Bounds bounds, javafx.scene.input.MouseButton... buttons)
GuiTest	click(org.loadui.testfx.GuiTest.OffsetTarget target, javafx.scene.input.MouseButton... buttons)
GuiTest	click(Iterable<?> iterable, javafx.scene.input.MouseButton... buttons)
GuiTest	click(org.hamcrest.Matcher<javafx.scene.Node> matcher, javafx.scene.input.MouseButton... buttons)
GuiTest	click(javafx.scene.input.MouseButton... buttons)
GuiTest	click(javafx.scene.Node node, javafx.scene.input.MouseButton... buttons)
GuiTest	click(javafx.geometry.Point2D point, javafx.scene.input.MouseButton... buttons)
<T extends javafx.scene.Node> GuiTest	click(com.google.common.base.Predicate<T> p, javafx.scene.input.MouseButton... buttons)
GuiTest	click(javafx.scene.Scene scene, javafx.scene.input.MouseButton... buttons)
GuiTest	click(String query, javafx.scene.input.MouseButton... buttons) Clicks the first Node matching the given query.
GuiTest	click(javafx.stage.Window window, javafx.scene.input.MouseButton... buttons)
GuiTest	closeCurrentWindow() Closes the front-most window using the Alt+F4 keyboard shortcut.
GuiTest	doubleClick()
GuiTest	doubleClick(javafx.geometry.Bounds bounds)
GuiTest	doubleClick(org.loadui.testfx.GuiTest.OffsetTarget target)
GuiTest	doubleClick(Iterable<?> iterable)
GuiTest	doubleClick(org.hamcrest.Matcher<javafx.scene.Node> matcher)
GuiTest	doubleClick(javafx.scene.input.MouseButton button)
GuiTest	doubleClick(javafx.scene.Node node)
GuiTest	doubleClick(javafx.geometry.Point2D point)
<T extends javafx.scene.Node> GuiTest	doubleClick(com.google.common.base.Predicate<T> predicate)
GuiTest	doubleClick(javafx.scene.Scene scene)
GuiTest	doubleClick(String query) Double-clicks a given target.
GuiTest	doubleClick(javafx.stage.Window window)
MouseMotion	drag(Object source, javafx.scene.input.MouseButton... buttons)
GuiTest	eraseCharacters(int characters)
static boolean	exists(String query)
static <T extends javafx.scene.Node> T	find(org.hamcrest.Matcher<Object> matcher)
static <T extends javafx.scene.Node> T	find(com.google.common.base.Predicate<T> predicate)
static <T extends javafx.scene.Node> T	find(String query)
static <T extends javafx.scene.Node> T	find(String selector, Object parent)
static Set<javafx.scene.Node>	findAll(org.hamcrest.Matcher<Object> matcher, javafx.scene.Node parent) Returns all child nodes of parent, that matches the given matcher.
static <T extends javafx.scene.Node> Set<T>	findAll(com.google.common.base.Predicate<T> predicate, javafx.scene.Node parent)
static Set<javafx.scene.Node>	findAll(String query)
static javafx.stage.Stage	findStageByTitle(String titleRegex)
protected abstract javafx.scene.Parent	getRootNode()
static javafx.stage.Window	getWindowByIndex(int index)
static List<javafx.stage.Window>	getWindows()
GuiTest	move(double x, double y) Moves the mouse cursor to the given coordinates.
GuiTest	move(Object target)
GuiTest	moveBy(double x, double y) Moves the mouse cursor relatively to its current position.
static Callable<Integer>	numberOf(String nodeQuery) Returns a Callable that calculates the number of nodes that matches the given query.
static org.loadui.testfx.GuiTest.OffsetTarget	offset(Object target, double offsetX, double offsetY)
javafx.geometry.Point2D	pointFor(Object target)
GuiTest	pos(javafx.geometry.Pos pos)
GuiTest	press(javafx.scene.input.KeyCode... keys) Presses and holds a given key, until explicitly released.
GuiTest	press(javafx.scene.input.MouseButton... buttons) Presses and holds a mouse button, until explicitly released.
GuiTest	push(char character) Alias for type().
GuiTest	push(javafx.scene.input.KeyCode... keys) Alias for type( ).
GuiTest	release(javafx.scene.input.KeyCode... keys) Releases a given key.
GuiTest	release(javafx.scene.input.MouseButton... buttons) Releases a pressed mouse button.
GuiTest	rightClick()
GuiTest	rightClick(javafx.geometry.Bounds bounds)
GuiTest	rightClick(org.loadui.testfx.GuiTest.OffsetTarget target)
GuiTest	rightClick(Iterable<?> iterable)
GuiTest	rightClick(org.hamcrest.Matcher<javafx.scene.Node> matcher)
GuiTest	rightClick(javafx.scene.Node node)
GuiTest	rightClick(javafx.geometry.Point2D point)
<T extends javafx.scene.Node> GuiTest	rightClick(com.google.common.base.Predicate<T> predicate)
GuiTest	rightClick(javafx.scene.Scene scene)
GuiTest	rightClick(String query) Right-clicks a given target.
GuiTest	rightClick(javafx.stage.Window window)
GuiTest	scroll(int amount) Deprecated.
GuiTest	scroll(int amount, javafx.geometry.VerticalDirection direction) Scrolls the mouse-wheel a given number of notches in a direction.
GuiTest	scroll(javafx.geometry.VerticalDirection direction) Scrolls the mouse-wheel one notch in the given direction.
void	setupStage()
GuiTest	sleep(long ms) Same as Thread.sleep(), but without checked exceptions.
GuiTest	sleep(long value, TimeUnit unit)
GuiTest	target(Object window)
static <T extends javafx.stage.Window> T	targetWindow(T window)
GuiTest	type(char character)
GuiTest	type(javafx.scene.input.KeyCode... keys)
GuiTest	type(String text) Types the given text on the keyboard.
static <T> void	waitUntil(Callable<T> callable, org.hamcrest.Matcher<? super T> condition)
static void	waitUntil(javafx.scene.Node node, org.hamcrest.Matcher<Object> condition) Waits until the provided node fulfills the given condition.
static void	waitUntil(javafx.scene.Node node, org.hamcrest.Matcher<Object> condition, int timeoutInSeconds)
static <T> void	waitUntil(T value, org.hamcrest.Matcher<? super T> condition)
static <T> void	waitUntil(T value, org.hamcrest.Matcher<? super T> condition, int timeoutInSeconds)
static <T extends javafx.scene.Node> void	waitUntil(T node, com.google.common.base.Predicate<T> condition)
static <T extends javafx.scene.Node> void	waitUntil(T node, com.google.common.base.Predicate<T> condition, int timeoutInSeconds)

Methods inherited from class java.lang.Object

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

Field Detail

stage

protected static javafx.stage.Stage stage

Constructor Detail

GuiTest

public GuiTest()

Method Detail

setupStage

public void setupStage()
                throws Throwable

Throws:

Throwable

getRootNode

protected abstract javafx.scene.Parent getRootNode()

targetWindow

public static <T extends javafx.stage.Window> T targetWindow(T window)

offset

public static org.loadui.testfx.GuiTest.OffsetTarget offset(Object target,
                                            double offsetX,
                                            double offsetY)

getWindows

public static List<javafx.stage.Window> getWindows()

getWindowByIndex

public static javafx.stage.Window getWindowByIndex(int index)

findStageByTitle

public static javafx.stage.Stage findStageByTitle(String titleRegex)

findAll

public static Set<javafx.scene.Node> findAll(String query)

find

public static <T extends javafx.scene.Node> T find(String selector,
                                   Object parent)

find

public static <T extends javafx.scene.Node> T find(String query)

exists

public static boolean exists(String query)

numberOf

public static Callable<Integer> numberOf(String nodeQuery)

Returns a Callable that calculates the number of nodes that matches the given query.

Parameters:

nodeQuery - a CSS query or the label of a node.

Returns:

captureScreenshot

public static File captureScreenshot()

waitUntil

public static void waitUntil(javafx.scene.Node node,
             org.hamcrest.Matcher<Object> condition,
             int timeoutInSeconds)

waitUntil

public static void waitUntil(javafx.scene.Node node,
             org.hamcrest.Matcher<Object> condition)

Waits until the provided node fulfills the given condition.

Parameters:

node -

condition -

waitUntil

public static <T> void waitUntil(T value,
                 org.hamcrest.Matcher<? super T> condition)

waitUntil

public static <T> void waitUntil(Callable<T> callable,
                 org.hamcrest.Matcher<? super T> condition)

waitUntil

public static <T> void waitUntil(T value,
                 org.hamcrest.Matcher<? super T> condition,
                 int timeoutInSeconds)

waitUntil

public static <T extends javafx.scene.Node> void waitUntil(T node,
                                           com.google.common.base.Predicate<T> condition)

waitUntil

public static <T extends javafx.scene.Node> void waitUntil(T node,
                                           com.google.common.base.Predicate<T> condition,
                                           int timeoutInSeconds)

find

public static <T extends javafx.scene.Node> T find(org.hamcrest.Matcher<Object> matcher)

find

public static <T extends javafx.scene.Node> T find(com.google.common.base.Predicate<T> predicate)

findAll

public static Set<javafx.scene.Node> findAll(org.hamcrest.Matcher<Object> matcher,
                             javafx.scene.Node parent)

Returns all child nodes of parent, that matches the given matcher.

Parameters:

matcher -

parent -

Returns:

found nodes

findAll

public static <T extends javafx.scene.Node> Set<T> findAll(com.google.common.base.Predicate<T> predicate,
                                           javafx.scene.Node parent)

sleep

public GuiTest sleep(long ms)

Same as Thread.sleep(), but without checked exceptions.

Parameters:

ms - time in milliseconds

sleep

public GuiTest sleep(long value,
            TimeUnit unit)

target

public GuiTest target(Object window)

click

public GuiTest click(javafx.scene.input.MouseButton... buttons)

click

public GuiTest click(String query,
            javafx.scene.input.MouseButton... buttons)

Clicks the first Node matching the given query.

Parameters:

query - either CSS selector, label of node or class name.

buttons -

click

public GuiTest click(javafx.scene.Node node,
            javafx.scene.input.MouseButton... buttons)

click

public <T extends javafx.scene.Node> GuiTest click(com.google.common.base.Predicate<T> p,
                                          javafx.scene.input.MouseButton... buttons)

click

public GuiTest click(javafx.geometry.Point2D point,
            javafx.scene.input.MouseButton... buttons)

click

public GuiTest click(javafx.geometry.Bounds bounds,
            javafx.scene.input.MouseButton... buttons)

click

public GuiTest click(javafx.scene.Scene scene,
            javafx.scene.input.MouseButton... buttons)

click

public GuiTest click(javafx.stage.Window window,
            javafx.scene.input.MouseButton... buttons)

click

public GuiTest click(org.hamcrest.Matcher<javafx.scene.Node> matcher,
            javafx.scene.input.MouseButton... buttons)

click

public GuiTest click(Iterable<?> iterable,
            javafx.scene.input.MouseButton... buttons)

click

public GuiTest click(org.loadui.testfx.GuiTest.OffsetTarget target,
            javafx.scene.input.MouseButton... buttons)

rightClick

public GuiTest rightClick()

rightClick

public GuiTest rightClick(String query)

Right-clicks a given target.

rightClick

public GuiTest rightClick(javafx.scene.Node node)

rightClick

public GuiTest rightClick(org.hamcrest.Matcher<javafx.scene.Node> matcher)

rightClick

public <T extends javafx.scene.Node> GuiTest rightClick(com.google.common.base.Predicate<T> predicate)

rightClick

public GuiTest rightClick(javafx.scene.Scene scene)

rightClick

public GuiTest rightClick(javafx.stage.Window window)

rightClick

public GuiTest rightClick(javafx.geometry.Point2D point)

rightClick

public GuiTest rightClick(javafx.geometry.Bounds bounds)

rightClick

public GuiTest rightClick(org.loadui.testfx.GuiTest.OffsetTarget target)

rightClick

public GuiTest rightClick(Iterable<?> iterable)

doubleClick

public GuiTest doubleClick()

doubleClick

public GuiTest doubleClick(String query)

Double-clicks a given target.

Parameters:

query -

doubleClick

public GuiTest doubleClick(javafx.scene.Node node)

doubleClick

public GuiTest doubleClick(org.hamcrest.Matcher<javafx.scene.Node> matcher)

doubleClick

public <T extends javafx.scene.Node> GuiTest doubleClick(com.google.common.base.Predicate<T> predicate)

doubleClick

public GuiTest doubleClick(javafx.scene.Scene scene)

doubleClick

public GuiTest doubleClick(javafx.stage.Window window)

doubleClick

public GuiTest doubleClick(javafx.geometry.Point2D point)

doubleClick

public GuiTest doubleClick(javafx.geometry.Bounds bounds)

doubleClick

public GuiTest doubleClick(org.loadui.testfx.GuiTest.OffsetTarget target)

doubleClick

public GuiTest doubleClick(Iterable<?> iterable)

doubleClick

public GuiTest doubleClick(javafx.scene.input.MouseButton button)

eraseCharacters

public GuiTest eraseCharacters(int characters)

drag

public MouseMotion drag(Object source,
               javafx.scene.input.MouseButton... buttons)

move

public GuiTest move(double x,
           double y)

Moves the mouse cursor to the given coordinates.

Parameters:

x -

y -

move

public GuiTest move(Object target)

moveBy

public GuiTest moveBy(double x,
             double y)

Moves the mouse cursor relatively to its current position.

Parameters:

x -

y -

press

public GuiTest press(javafx.scene.input.MouseButton... buttons)

Presses and holds a mouse button, until explicitly released.

Parameters:

buttons - defaults to the primary mouse button.

release

public GuiTest release(javafx.scene.input.MouseButton... buttons)

Releases a pressed mouse button.

Parameters:

buttons - defaults to the primary mouse button.

scroll

@Deprecated
public GuiTest scroll(int amount)

Deprecated.

scroll

public GuiTest scroll(int amount,
             javafx.geometry.VerticalDirection direction)

Scrolls the mouse-wheel a given number of notches in a direction.

Parameters:

amount - the number of notches to scroll

direction -

Returns:

scroll

public GuiTest scroll(javafx.geometry.VerticalDirection direction)

Scrolls the mouse-wheel one notch in the given direction.

Parameters:

direction -

Returns:

type

public GuiTest type(String text)

Types the given text on the keyboard. Note: Typing depends on the operating system keyboard layout!

Parameters:

text -

type

public GuiTest type(char character)

push

public GuiTest push(javafx.scene.input.KeyCode... keys)

Alias for type( ).

Parameters:

keys -

push

public GuiTest push(char character)

Alias for type().

Parameters:

character -

type

public GuiTest type(javafx.scene.input.KeyCode... keys)

press

public GuiTest press(javafx.scene.input.KeyCode... keys)

Presses and holds a given key, until explicitly released.

Parameters:

keys -

release

public GuiTest release(javafx.scene.input.KeyCode... keys)

Releases a given key.

Parameters:

keys -

pos

public GuiTest pos(javafx.geometry.Pos pos)

closeCurrentWindow

public GuiTest closeCurrentWindow()

Closes the front-most window using the Alt+F4 keyboard shortcut.

Returns:

pointFor

public javafx.geometry.Point2D pointFor(Object target)