org.jemmy.input

Class RobotDriver

java.lang.Object

org.jemmy.input.RobotDriver

public class RobotDriver
extends Object

Author:

shura, mrkam

Constructor Summary

Constructors

Constructor and Description
RobotDriver(Environment env) Constructs a RobotDriver object.
RobotDriver(Timeout autoDelay) Constructs a RobotDriver object.

Method Summary

Modifier and Type	Method and Description
void	clickMouse(Point point, int clickCount, Mouse.MouseButton mouseButton, Timeout mouseClick, Modifier... modifiers) Clicks the mouse button specified by mouseButton at the specified point specified number of times preceding it by pressing the modifiers key or buttons and ending by releasing them.
static Image	createScreenCapture(Rectangle screenRect) Capture an image of specified rectangular area of screen
void	dragMouse(Point point, int mouseButton, int modifiers) Deprecated. Implementation doesn't seem to be correct as it ignores mouseButton and modifiers
void	dragNDrop(Point startPoint, Point endPoint, Mouse.MouseButton mouseButton, Modifier[] modifiers, Timeout before, Timeout after) Performs drag and drop from startPoint to endPoint using specified mouseButton and modifiers to perform it.
static void	exit() If java.awt.Robot is running in other JVM, it shutdowns that JVM
static int	getMouseSmoothness() Gets mouse smoothness
void	makeAnOperation(String method, Object[] params, Class[] paramClasses) Performs a single operation.
void	moveMouse(Point point) Moves mouse to the specified mouse.
void	pressKey(Keyboard.KeyboardButton kbdButton, Modifier... modifiers) Presses a key.
protected void	pressModifiers(Modifier... modifiers) Presses modifiers keys by robot.
void	pressMouse(Mouse.MouseButton mouseButton, Modifier... modifiers) Presses mouse button specified by mouseButton preceding pressing of modifier keys or buttons specified by modifiers
void	releaseKey(Keyboard.KeyboardButton kbdButton, Modifier... modifiers) Releases a key.
protected void	releaseModifiers(Modifier... modifiers) Releases modifiers keys by robot.
void	releaseMouse(Mouse.MouseButton mouseButton, Modifier... modifiers) Releases mouse button specified by mouseButton then releasing modifier keys or buttons specified by modifiers
static void	setMouseSmoothness(int mouseSmoothness) Sets mouse smoothness
void	turnWheel(Point p, int amount, Modifier... modifiers) Turns the wheel.

Methods inherited from class java.lang.Object

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

Constructor Detail

RobotDriver

public RobotDriver(Timeout autoDelay)

Constructs a RobotDriver object.

Parameters:

autoDelay - Time for Robot.setAutoDelay(long) method.

RobotDriver

public RobotDriver(Environment env)

Constructs a RobotDriver object.

Parameters:

env - Environment with ROBOT_DELAY_TIMEOUT_NAME timeout

See Also:

AWTRobotInputFactory.ROBOT_DELAY_TIMEOUT_NAME

Method Detail

setMouseSmoothness

public static void setMouseSmoothness(int mouseSmoothness)

Sets mouse smoothness

Parameters:

mouseSmoothness - the maximum distance in pixels between mouse positions during movement

See Also:

moveMouse(Point)

getMouseSmoothness

public static int getMouseSmoothness()

Gets mouse smoothness

Returns:

the maximum distance in pixels between mouse positions during movement

See Also:

setMouseSmoothness(int), moveMouse(Point)

createScreenCapture

public static Image createScreenCapture(Rectangle screenRect)

Capture an image of specified rectangular area of screen

Parameters:

screenRect - area on screen that will be captured

Returns:

image of specified rectangular area of screen

pressMouse

public void pressMouse(Mouse.MouseButton mouseButton,
                       Modifier... modifiers)

Presses mouse button specified by mouseButton preceding pressing of modifier keys or buttons specified by modifiers

Parameters:

mouseButton - One of MouseEvent.BUTTON*_MASK

modifiers - Combination of InputEvent.*_DOWN_MASK

See Also:

InputEvent, MouseEvent

releaseMouse

public void releaseMouse(Mouse.MouseButton mouseButton,
                         Modifier... modifiers)

Releases mouse button specified by mouseButton then releasing modifier keys or buttons specified by modifiers

Parameters:

mouseButton - One of MouseEvent.BUTTON*_MASK

modifiers - Combination of InputEvent.*_DOWN_MASK

See Also:

InputEvent, MouseEvent

moveMouse

public void moveMouse(Point point)

Moves mouse to the specified mouse. When previous mouse location is remembered mouse moved smoothly between the points according to mouse smoothness parameter. Otherwise it jumps to the specified point

Parameters:

point - Position on the screen where to move mouse

See Also:

setMouseSmoothness(int), getMouseSmoothness()

clickMouse

public void clickMouse(Point point,
                       int clickCount,
                       Mouse.MouseButton mouseButton,
                       Timeout mouseClick,
                       Modifier... modifiers)

Clicks the mouse button specified by mouseButton at the specified point specified number of times preceding it by pressing the modifiers key or buttons and ending by releasing them. The last click is as long as mouseClick timeout

Parameters:

point - Screen location where to click mouse

clickCount - Number of clicks

mouseButton - One of MouseEvent.BUTTON*_MASK

modifiers - Combination of InputEvent.*_DOWN_MASK

mouseClick - Timeout of the last click

See Also:

InputEvent, MouseEvent

dragMouse

public void dragMouse(Point point,
                      int mouseButton,
                      int modifiers)

Deprecated. Implementation doesn't seem to be correct as it ignores mouseButton and modifiers

Parameters:

point - todo document

mouseButton - One of MouseEvent.BUTTON*_MASK

modifiers - todo document

dragNDrop

public void dragNDrop(Point startPoint,
                      Point endPoint,
                      Mouse.MouseButton mouseButton,
                      Modifier[] modifiers,
                      Timeout before,
                      Timeout after)

Performs drag and drop from startPoint to endPoint using specified mouseButton and modifiers to perform it.

Parameters:

startPoint - Screen coordinates of drag start point

endPoint - Screen coordinates of drag end point

mouseButton - One of MouseEvent.BUTTON*_MASK

modifiers - Combination of InputEvent.*_DOWN_MASK

before - Timeout between pressing mouse at the startPoint and mouse move

after - Timeout between mouse move to the endPoint and mouse release

pressKey

public void pressKey(Keyboard.KeyboardButton kbdButton,
                     Modifier... modifiers)

Presses a key.

Parameters:

kbdButton - Key code (KeyEventVK_* field.

modifiers - a combination of InputEvent.*_MASK fields.

releaseKey

public void releaseKey(Keyboard.KeyboardButton kbdButton,
                       Modifier... modifiers)

Releases a key.

Parameters:

kbdButton - Key code (KeyEventVK_* field.

modifiers - a combination of InputEvent.*_MASK fields.

turnWheel

public void turnWheel(Point p,
                      int amount,
                      Modifier... modifiers)

Turns the wheel.

Parameters:

p - todo document

amount - Either positive or negative

modifiers - a combination of InputEvent.*_MASK fields.

makeAnOperation

public void makeAnOperation(String method,
                            Object[] params,
                            Class[] paramClasses)

Performs a single operation.

Parameters:

method - a name of java.awt.Robot method.

params - method parameters

paramClasses - method parameters classes

pressModifiers

protected void pressModifiers(Modifier... modifiers)

Presses modifiers keys by robot.

Parameters:

modifiers - a combination of InputEvent.*_MASK fields.

releaseModifiers

protected void releaseModifiers(Modifier... modifiers)

Releases modifiers keys by robot.

Parameters:

modifiers - a combination of InputEvent.*_MASK fields.

exit

public static void exit()

If java.awt.Robot is running in other JVM, it shutdowns that JVM

See Also:

AWTRobotInputFactory.runInOtherJVM(boolean)