com.sun.javafx.robot.impl

Class BaseFXRobot

java.lang.Object

com.sun.javafx.robot.FXRobot

com.sun.javafx.robot.impl.BaseFXRobot

public class BaseFXRobot
extends FXRobot

An implementation of FXRobot which injects the events into the FX event queue

Field Summary

Fields inherited from class com.sun.javafx.robot.FXRobot

autoWait

Constructor Summary

Constructors

Constructor and Description
BaseFXRobot(Scene target)

Method Summary

Modifier and Type	Method and Description
int	getPixelColor(int x, int y) Returns pixel color at specified scene coordinates in IntARGB format, 0 if the passed coordinates are outside of the scene's bounds or if pixel grabbing isn't supported.
FXRobotImage	getSceneCapture(int x, int y, int w, int h) Returns a FXRobotImage object representing in image with contents of the scene at specified coordinates, or null if scene pixel capturing isn't supported.
void	keyPress(KeyCode keyCode) Generate a key pressed event.
void	keyRelease(KeyCode keyCode) Generate a key released event.
void	keyType(KeyCode keyCode, String keyChar) Generate a key typed event.
void	mouseClick(MouseButton button, int clickCount) Generate a mouse clicked event with specified click count.
void	mouseDrag(MouseButton button) Generate a mouse dragged event.
void	mouseMove(int x, int y) Generate a mouse moved event.
void	mousePress(MouseButton button, int clickCount) Generate a mouse press event with specified click count.
void	mouseRelease(MouseButton button, int clickCount) Generate a mouse release event with specified click count.
void	mouseWheel(int wheelAmt) Generate a mouse wheel event.
void	waitForIdle() Block until events in the queue are processed.

Methods inherited from class com.sun.javafx.robot.FXRobot

mouseClick, mousePress, mouseRelease, setAutoWaitForIdle

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseFXRobot

public BaseFXRobot(Scene target)

Method Detail

waitForIdle

public void waitForIdle()

Description copied from class: FXRobot

Block until events in the queue are processed.

Specified by:

waitForIdle in class FXRobot

keyPress

public void keyPress(KeyCode keyCode)

Description copied from class: FXRobot

Generate a key pressed event.

Specified by:

keyPress in class FXRobot

Parameters:

keyCode - key code for this event

keyRelease

public void keyRelease(KeyCode keyCode)

Description copied from class: FXRobot

Generate a key released event. Note that KeyTyped event will not be generated automatically on key released, FXRobot.keyType(javafx.scene.input.KeyCode, java.lang.String) will need to be called explicitly.

Specified by:

keyRelease in class FXRobot

Parameters:

keyCode - key code for this event

keyType

public void keyType(KeyCode keyCode,
                    String keyChar)

Description copied from class: FXRobot

Generate a key typed event. The keyChar argument will need to depend on what character is generated by this event. That is, the user will need to take into account different modifiers currently applied and so forth. If shift is presumed to be pressed, the char will be "A", otherwise it will be "a".

Specified by:

keyType in class FXRobot

Parameters:

keyCode - key code for this event

keyChar - char for this event

mouseMove

public void mouseMove(int x,
                      int y)

Description copied from class: FXRobot

Generate a mouse moved event.

Specified by:

mouseMove in class FXRobot

Parameters:

x - scene coordinate x

y - scene coordinate y

mousePress

public void mousePress(MouseButton button,
                       int clickCount)

Description copied from class: FXRobot

Generate a mouse press event with specified click count. Note that a multi-click gesture consists of multiple sets of MousePressed/MouseReleased/MouseClicked events, with second and following sets having appropriate click count set.
For example, a double click is emulated with: press/release/click followed by press(2)/release(2)/click(2)

Specified by:

mousePress in class FXRobot

Parameters:

button - button to have generated the event

clickCount - number of clicks for this event

mouseRelease

public void mouseRelease(MouseButton button,
                         int clickCount)

Description copied from class: FXRobot

Generate a mouse release event with specified click count. Note that this method will not generate a MouseClicked event, use FXRobot.mouseClick(javafx.scene.input.MouseButton) for that. Note that a multi-click gesture consists of multiple sets of MousePressed/MouseReleased/MouseClicked events, with second and following sets having appropriate click count set.
For example, a double click is emulated with: press/release/click followed by press(2)/release(2)/click(2)

Specified by:

mouseRelease in class FXRobot

Parameters:

button - button to have generated the event

clickCount - number of clicks for this event

mouseClick

public void mouseClick(MouseButton button,
                       int clickCount)

Description copied from class: FXRobot

Generate a mouse clicked event with specified click count. Note that a multi-click gesture consists of multiple sets of MousePressed/MouseReleased/MouseClicked events, with second and following sets having appropriate click count set.
For example, a double click is emulated with: press/release/click followed by press(2)/release(2)/click(2)

Specified by:

mouseClick in class FXRobot

Parameters:

button - button to have generated the event

clickCount - number of clicks for this event

mouseDrag

public void mouseDrag(MouseButton button)

Description copied from class: FXRobot

Generate a mouse dragged event.

Specified by:

mouseDrag in class FXRobot

Parameters:

button - button to have generated the event

mouseWheel

public void mouseWheel(int wheelAmt)

Description copied from class: FXRobot

Generate a mouse wheel event.

Specified by:

mouseWheel in class FXRobot

Parameters:

wheelAmt - amount the wheel has turned of wheel turning

getPixelColor

public int getPixelColor(int x,
                         int y)

Description copied from class: FXRobot

Returns pixel color at specified scene coordinates in IntARGB format, 0 if the passed coordinates are outside of the scene's bounds or if pixel grabbing isn't supported.

Specified by:

getPixelColor in class FXRobot

Parameters:

x - scene coordinate

y - scene coordinate

Returns:

pixel color in IntARGB format or 0 if outside of scene bounds or if pixel grabbing isn't supported

getSceneCapture

public FXRobotImage getSceneCapture(int x,
                                    int y,
                                    int w,
                                    int h)

Description copied from class: FXRobot

Returns a FXRobotImage object representing in image with contents of the scene at specified coordinates, or null if scene pixel capturing isn't supported. Implementation note: current implementation ignores passed parameters and always captures complete scene.

Specified by:

getSceneCapture in class FXRobot

Parameters:

x - scene coordinate

y - scene coordinate

w - of the area to capture

h - of the area to capture

Returns:

FXRobotImage containing captured pixels or null if pixel capturing isn't supproted