org.safs.robot

Class Robot

java.lang.Object

org.safs.robot.Robot

Direct Known Subclasses:

SAFSRobot

public class Robot
extends java.lang.Object

Utility functions for common user interactions on the system.

Author:

Carl Nagle Sept 09, 2008
SEP 30, 2015 Carl Nagle Add configurable delay between mouse down and mouse up.

See Also:

Robot, CreateUnicodeMap, InputKeysParser

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.datatransfer.Clipboard	clipboard The system clip-board, it is a singleton, we keep it in a static field.
static int	DEFAULT_MILLIS_BETWEEN_KEYSTROKES 1
static int	DEFAULT_MILLIS_BETWEEN_MOUSE_RELEASE 800
static boolean	DEFAULT_WAIT_REACTION
static java.awt.Dimension	SCREENSZIE

Constructor Summary

Constructors

Constructor and Description
Robot()

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	altLeftDrag(java.awt.Point start, java.awt.Point end) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.
static java.lang.Object	centerDrag(java.awt.Point start, java.awt.Point end) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button2) and drag\move then Release the mouse button at the end point.
static java.lang.Object	centerDrag(java.awt.Point start, java.awt.Point end, int dndReleaseDelay) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button2) and drag\move then Release the mouse button at the end point.
static void	clearClipboard() Clear the system clip-board.
static java.lang.Object	click(int x, int y) Move the mouse cursor to the specified x,y coordinates then perform a single mousePress and Release to execute a Click.
static java.lang.Object	click(int x, int y, int dndReleaseDelay) Move the mouse cursor to the specified x,y coordinates then perform a single mousePress and Release to execute a Click.
static java.lang.Object	click(int x, int y, int buttonmask, int nclicks) Workhorse Click routine.
static java.lang.Object	click(int x, int y, int buttonmask, int nclicks, int dndReleaseDelay) Workhorse Click routine.
static java.lang.Object	click(java.awt.Point p) Move the mouse cursor to the specified Point coordinates then perform a single mousePress and Release to execute a Click.
static java.lang.Object	clickWithKeyPress(int x, int y, int buttonmask, int keycode, int nclicks) Workhorse Click with Keypress routine.
static java.lang.Object	clickWithKeyPress(int x, int y, int buttonmask, int keycode, int nclicks, int dndReleaseDelay) Workhorse Click with Keypress routine.
static void	closeFocusedWindow() Pre-condition: The window should be focused Minimize window by mnemonic key 'C' of window-system-menu. This works only for windows system.
static java.lang.Object	ctrlAltLeftDrag(java.awt.Point start, java.awt.Point end) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.
static java.lang.Object	ctrlLeftDrag(java.awt.Point start, java.awt.Point end) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.
static java.lang.Object	ctrlShiftLeftDrag(java.awt.Point start, java.awt.Point end) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.
static java.lang.Object	doubleClick(int x, int y) Move the mouse cursor to the specified x,y coordinates then perform a double mousePress and Release to execute a Click.
static java.lang.Object	doubleClick(java.awt.Point p) Move the mouse cursor to the specified Point coordinates then perform a single mousePress and Release to execute a Click.
static java.lang.Object	getClipboard(java.awt.datatransfer.DataFlavor flavor) Get content from system clip-board.
static int	getDndReleaseDelay()
static InputKeysParser	getInputKeysParser() Retrieve the active InputKeysParser.
static int	getMillisBetweenKeystrokes() Get the current delay in milliseconds between Robot key events.
static java.awt.Point	getMouseLocation() get mouse screen location.
static boolean	getNumLock()
protected static java.net.URL	getResourceURL(java.lang.Class clazz, java.lang.String aresource)
static java.awt.Robot	getRobot() Retrieve the active java.awt.Robot from the JVM.
static void	getWindowSystemMenu() Pre-condition: The window should be focused Get the window system menu by short-cut 'Alt+Space' This works only for windows system.
static java.lang.Object	inputChars(java.lang.String input) Type keyboard input characters unmodified.
static java.lang.Object	inputKeys(java.lang.String input) Type keyboard input.
static boolean	keyPress(int keycode) Press down a Key.
static boolean	keyRelease(int keycode) Release a Key.
static java.lang.Object	leftDrag(java.awt.Point start, java.awt.Point end) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.
static java.lang.Object	leftDrag(java.awt.Point start, java.awt.Point end, int dndReleaseDelay) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.
static void	main(java.lang.String[] args)
static void	maximizeFocusedWindow() Pre-condition: The window should be focused Minimize window by mnemonic key 'x' of window-system-menu. This works only for windows system.
static void	minimizeAllWindows() Minimize all windows by the short cut 'Windows+M' This works only for windows system.
static void	minimizeFocusedWindow() Pre-condition: The window should be focused Minimize window by mnemonic key 'n' of window-system-menu. This works only for windows system.
static java.lang.Object	mouseDrag(java.awt.Point start, java.awt.Point end, int buttonMasks) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress using buttonMasks and drag\move then Release the mouse button at the end point.
static java.lang.Object	mouseDrag(java.awt.Point start, java.awt.Point end, int buttonMasks, int dndReleaseDelay) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress using buttonMasks and drag\move then Release the mouse button at the end point.
static void	mouseHover(java.awt.Point point, int millisStay) Move the mouse cursor to the specified Point, stay for a period and move out
static boolean	mouseWheel(int wheelAmt) Scroll the mouse wheel on the object which has focus.
static void	restoreFocusedWindow() Pre-condition: The window should be focused Minimize window by mnemonic key 'R' of window-system-menu. This works only for windows system.
static java.lang.Object	rightClick(int x, int y) Move the mouse cursor to the specified x,y coordinates then perform a single mousePress and Release to execute a RightClick.
static java.lang.Object	rightClick(int x, int y, int dndReleaseDelay) Move the mouse cursor to the specified x,y coordinates then perform a single mousePress and Release to execute a RightClick.
static java.lang.Object	rightClick(java.awt.Point p) Move the mouse cursor to the specified Point coordinates then perform a single mousePress and Release to execute a Click.
static java.lang.Object	rightDrag(java.awt.Point start, java.awt.Point end) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button3) and drag\move then Release the mouse button at the end point.
static java.lang.Object	rightDrag(java.awt.Point start, java.awt.Point end, int dndReleaseDelay) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button3) and drag\move then Release the mouse button at the end point.
static void	setClipboard(java.lang.String content) Set a string value to the clip-board.
static void	setDndReleaseDelay(int dndReleaseDelay)
static void	setDragEndPointOffset(int offsetx, int offsety) Set the offset from the end point for dragging.
static void	setDragStartPointOffset(int offsetx, int offsety) Set the offset from the start point for dragging.
static void	setMillisBetweenKeystrokes(int msBetween) Set the delay in milliseconds between Robot key events.
static void	setNumLock(boolean onOff)
static void	setWaitReaction(boolean wait) Set if wait for reaction to "input keys/chars".
static void	setWaitReaction(boolean wait, int tokenLength, int dealyForToken, int dealy) Set if wait for reaction to "input keys/chars".
static java.lang.Object	shiftLeftDrag(java.awt.Point start, java.awt.Point end) Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.
protected static void	waitReaction(java.lang.String text) After Robot input keys/chars into a browser or an application, the browser/application may need time to react.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MILLIS_BETWEEN_KEYSTROKES

public static final int DEFAULT_MILLIS_BETWEEN_KEYSTROKES

1

See Also:

Constant Field Values

DEFAULT_MILLIS_BETWEEN_MOUSE_RELEASE

public static final int DEFAULT_MILLIS_BETWEEN_MOUSE_RELEASE

800

See Also:

Constant Field Values

SCREENSZIE

public static final java.awt.Dimension SCREENSZIE

DEFAULT_WAIT_REACTION

public static final boolean DEFAULT_WAIT_REACTION

See Also:

Constant Field Values

clipboard

public static final java.awt.datatransfer.Clipboard clipboard

The system clip-board, it is a singleton, we keep it in a static field.

Constructor Detail

Robot

public Robot()

Method Detail

setWaitReaction

public static void setWaitReaction(boolean wait)

Set if wait for reaction to "input keys/chars".

Parameters:

wait - boolean, if wait or not.

setWaitReaction

public static void setWaitReaction(boolean wait,
                                   int tokenLength,
                                   int dealyForToken,
                                   int dealy)

Set if wait for reaction to "input keys/chars".

Parameters:

wait - boolean, if wait or not.

tokenLength - int, the length of a token. Only if the string is longer than this then we wait the reaction after input-keys a certain time indicated by the parameter dealyForToken.

dealyForToken - int, The delay in millisecond to wait the reaction after input-keys for the string as long as a token.

dealy - int, The constant delay in millisecond to wait the reaction after input-keys.

See Also:

waitReactionDelayInMillisecond, waitReactionDelayInMillisecondForToken, waitReactionTokenLength

setMillisBetweenKeystrokes

public static void setMillisBetweenKeystrokes(int msBetween)

Set the delay in milliseconds between Robot key events.

Parameters:

msBetween - >= 0

See Also:

inputKeys(String), inputChars(String), doEvents(java.awt.Robot, Vector, int)

getMillisBetweenKeystrokes

public static int getMillisBetweenKeystrokes()

Get the current delay in milliseconds between Robot key events.

See Also:

inputKeys(String), inputChars(String), doEvents(java.awt.Robot, Vector, int)

getDndReleaseDelay

public static int getDndReleaseDelay()

Returns:

int, The delay in millisecond before releasing mouse button when 'drag and drop'

setDndReleaseDelay

public static void setDndReleaseDelay(int dndReleaseDelay)

Parameters:

dndReleaseDelay - int, The delay in millisecond before releasing mouse button when 'drag and drop'

setDragStartPointOffset

public static void setDragStartPointOffset(int offsetx,
                                           int offsety)

Set the offset from the start point for dragging. The object will be firstly dragged to the position (startPoint+dragStartPointOffset)

Parameters:

offsetx - int, offset in x-axis

offsety - int, offset in y-axis

See Also:

mouseDrag(Point, Point, int)

setDragEndPointOffset

public static void setDragEndPointOffset(int offsetx,
                                         int offsety)

Set the offset from the end point for dragging. The object will be firstly dragged to the position (endPoint+dragEndPointOffset)

Parameters:

offsetx - int, offset in x-axis

offsety - int, offset in y-axis

See Also:

mouseDrag(Point, Point, int)

getRobot

public static java.awt.Robot getRobot()
                               throws java.awt.AWTException

Retrieve the active java.awt.Robot from the JVM. If one does not yet exist the routine will attempt to instantiate it.

Returns:

java.awt.Robot or a thrown java.awt.AWTException

Throws:

java.awt.AWTException

getInputKeysParser

public static InputKeysParser getInputKeysParser()

Retrieve the active InputKeysParser. If one does not yet exist the routine will attempt to instantiate it.

Returns:

InputKeysParser or null

See Also:

InputKeysParser

getResourceURL

protected static java.net.URL getResourceURL(java.lang.Class clazz,
                                             java.lang.String aresource)

inputKeys

public static java.lang.Object inputKeys(java.lang.String input)
                                  throws java.awt.AWTException

Type keyboard input. The input goes to the current keyboard focus target. The String input can include all special characters and processing as documented in the InputKeysParser class.

Parameters:

input - -- the String of characters to enter.

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - -- if there is a problem instantiating or using the java.awt.Robot

See Also:

InputKeysParser, Robot, setMillisBetweenKeystrokes(int), doEvents(java.awt.Robot, Vector, int)

inputChars

public static java.lang.Object inputChars(java.lang.String input)
                                   throws java.awt.AWTException

Type keyboard input characters unmodified. No special key processing. The input goes to the current keyboard focus target. The String input will be treated simply as literal text and typed as-is.

Parameters:

input - -- the String of characters to enter.

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - -- if there is a problem instantiating or using the java.awt.Robot

See Also:

InputKeysParser, Robot, setMillisBetweenKeystrokes(int), doEvents(java.awt.Robot, Vector, int)

waitReaction

protected static void waitReaction(java.lang.String text)

After Robot input keys/chars into a browser or an application, the browser/application may need time to react. Before that reaction, the EditBox may contain incomplete text. And the next test action may fail and the verification will fail too.

click

public static java.lang.Object click(int x,
                                     int y,
                                     int buttonmask,
                                     int nclicks,
                                     int dndReleaseDelay)
                              throws java.awt.AWTException

Workhorse Click routine. Allows us to Click--Press & Release--any combination of InputEvent.BUTTONn_MASK any number of times.

Parameters:

x - screen X coordinate

y - screen Y coordinate

buttonmask - -- specific InputEvent.BUTTONn_MASK(s)

nclicks - -- number of times to click (press and release)

dndReleaseDelay - -- number of millis to wait before final Release.

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException

See Also:

Robot.mousePress(int), InputEvent.BUTTON1_MASK

click

public static java.lang.Object click(int x,
                                     int y,
                                     int buttonmask,
                                     int nclicks)
                              throws java.awt.AWTException

Workhorse Click routine. Allows us to Click--Press & Release--any combination of InputEvent.BUTTONn_MASK any number of times.

Parameters:

x - screen X coordinate

y - screen Y coordinate

buttonmask - -- specific InputEvent.BUTTONn_MASK(s)

nclicks - -- number of times to click (press and release)

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException

See Also:

Robot.mousePress(int), InputEvent.BUTTON1_MASK

clickWithKeyPress

public static java.lang.Object clickWithKeyPress(int x,
                                                 int y,
                                                 int buttonmask,
                                                 int keycode,
                                                 int nclicks,
                                                 int dndReleaseDelay)
                                          throws java.awt.AWTException

Workhorse Click with Keypress routine. Allows us to Click--Press & Release--any combination of InputEvent.BUTTONn_MASK any number of times with a single Key Press & Release.

Parameters:

x - screen X coordinate

y - screen Y coordinate

buttonmask - -- specific InputEvent.BUTTONn_MASK(s)

keycode - -- specific keycode to press & release. Ex: KeyEvent.VK_SHIFT

nclicks - -- number of times to click (press and release)

dndReleaseDelay - -- number of millis to wait before final Release.

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException

See Also:

Robot.mousePress(int), InputEvent.BUTTON1_MASK

clickWithKeyPress

public static java.lang.Object clickWithKeyPress(int x,
                                                 int y,
                                                 int buttonmask,
                                                 int keycode,
                                                 int nclicks)
                                          throws java.awt.AWTException

Workhorse Click with Keypress routine. Allows us to Click--Press & Release--any combination of InputEvent.BUTTONn_MASK any number of times with a single Key Press & Release.

Parameters:

x - screen X coordinate

y - screen Y coordinate

buttonmask - -- specific InputEvent.BUTTONn_MASK(s)

keycode - -- specific keycode to press & release. Ex: KeyEvent.VK_SHIFT

nclicks - -- number of times to click (press and release)

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException

See Also:

Robot.mousePress(int), InputEvent.BUTTON1_MASK

click

public static java.lang.Object click(int x,
                                     int y,
                                     int dndReleaseDelay)
                              throws java.awt.AWTException

Move the mouse cursor to the specified x,y coordinates then perform a single mousePress and Release to execute a Click.

Parameters:

x -

y -

dndReleaseDelay - -- number of millis to wait before final Release.

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot

click

public static java.lang.Object click(int x,
                                     int y)
                              throws java.awt.AWTException

Move the mouse cursor to the specified x,y coordinates then perform a single mousePress and Release to execute a Click.

Parameters:

x -

y -

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot

doubleClick

public static java.lang.Object doubleClick(int x,
                                           int y)
                                    throws java.awt.AWTException

Move the mouse cursor to the specified x,y coordinates then perform a double mousePress and Release to execute a Click.

Parameters:

x -

y -

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot

rightClick

public static java.lang.Object rightClick(int x,
                                          int y)
                                   throws java.awt.AWTException

Move the mouse cursor to the specified x,y coordinates then perform a single mousePress and Release to execute a RightClick.

Parameters:

x -

y -

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot

rightClick

public static java.lang.Object rightClick(int x,
                                          int y,
                                          int dndReleaseDelay)
                                   throws java.awt.AWTException

Move the mouse cursor to the specified x,y coordinates then perform a single mousePress and Release to execute a RightClick.

Parameters:

x -

y -

dndReleaseDelay - millis between final release.

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot

click

public static java.lang.Object click(java.awt.Point p)
                              throws java.awt.AWTException

Move the mouse cursor to the specified Point coordinates then perform a single mousePress and Release to execute a Click. This routine simply calls click with the x,y coordinates in the Point.

Parameters:

Point -

Returns:

Object returned from click above.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot, click(int, int)

rightClick

public static java.lang.Object rightClick(java.awt.Point p)
                                   throws java.awt.AWTException

Move the mouse cursor to the specified Point coordinates then perform a single mousePress and Release to execute a Click. This routine simply calls click with the x,y coordinates in the Point.

Parameters:

Point -

Returns:

Object returned from click above.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot, click(int, int)

doubleClick

public static java.lang.Object doubleClick(java.awt.Point p)
                                    throws java.awt.AWTException

Move the mouse cursor to the specified Point coordinates then perform a single mousePress and Release to execute a Click. This routine simply calls click with the x,y coordinates in the Point.

Parameters:

Point -

Returns:

Object returned from click above.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot, click(int, int)

mouseDrag

public static java.lang.Object mouseDrag(java.awt.Point start,
                                         java.awt.Point end,
                                         int buttonMasks,
                                         int dndReleaseDelay)
                                  throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress using buttonMasks and drag\move then Release the mouse button at the end point.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

int - button masks to use during drag

dndReleaseDelay - millis before final release.

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot

mouseDrag

public static java.lang.Object mouseDrag(java.awt.Point start,
                                         java.awt.Point end,
                                         int buttonMasks)
                                  throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress using buttonMasks and drag\move then Release the mouse button at the end point.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

int - button masks to use during drag

Returns:

Object Currently we return a Boolean(true) object, but this may be subject to change.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot

altLeftDrag

public static java.lang.Object altLeftDrag(java.awt.Point start,
                                           java.awt.Point end)
                                    throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point. During the drag, the key "ALT" is kept pressed.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot, mouseDrag(Point, Point, int, int[])

ctrlAltLeftDrag

public static java.lang.Object ctrlAltLeftDrag(java.awt.Point start,
                                               java.awt.Point end)
                                        throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point. During the drag, the key "CONTROL" and "ALT" are kept pressed.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot, mouseDrag(Point, Point, int, int[])

ctrlLeftDrag

public static java.lang.Object ctrlLeftDrag(java.awt.Point start,
                                            java.awt.Point end)
                                     throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point. During the drag, the key "CONTROL" is kept pressed.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot, mouseDrag(Point, Point, int, int[])

ctrlShiftLeftDrag

public static java.lang.Object ctrlShiftLeftDrag(java.awt.Point start,
                                                 java.awt.Point end)
                                          throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point. During the drag, the key "CONTROL" and "SHIFT" are kept pressed.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot, mouseDrag(Point, Point, int, int[])

shiftLeftDrag

public static java.lang.Object shiftLeftDrag(java.awt.Point start,
                                             java.awt.Point end)
                                      throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point. During the drag, the key "SHIFT" is kept pressed.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

Robot, mouseDrag(Point, Point, int, int[])

mouseWheel

public static boolean mouseWheel(int wheelAmt)

Scroll the mouse wheel on the object which has focus.

Parameters:

wheelAmt - int, the wheel amount to scroll.

Returns:

boolean, true if success

keyPress

public static boolean keyPress(int keycode)

Press down a Key.

Parameters:

keycode - int, keycode Key to press (e.g. KeyEvent.VK_A)

Returns:

boolean, true if success

keyRelease

public static boolean keyRelease(int keycode)

Release a Key.

Parameters:

keycode - int, keycode Key to release (e.g. KeyEvent.VK_A)

Returns:

boolean, true if success

mouseHover

public static void mouseHover(java.awt.Point point,
                              int millisStay)
                       throws SAFSException

Move the mouse cursor to the specified Point, stay for a period and move out

Parameters:

point - Point, the screen point to hover the mouse

millisStay - int, in milliseconds, the period to hover the mouse; the mouse will be moved out of screen if it expires.
if it equals Constants.TIMEOUT_HOVERMOUSE_STAY_FOREVER, then the mouse will always stay there forever.

Throws:

SAFSException - if some error happens

leftDrag

public static java.lang.Object leftDrag(java.awt.Point start,
                                        java.awt.Point end)
                                 throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

mouseDrag(Point,Point,int)

rightDrag

public static java.lang.Object rightDrag(java.awt.Point start,
                                         java.awt.Point end)
                                  throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button3) and drag\move then Release the mouse button at the end point.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

mouseDrag(Point,Point,int)

centerDrag

public static java.lang.Object centerDrag(java.awt.Point start,
                                          java.awt.Point end)
                                   throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button2) and drag\move then Release the mouse button at the end point.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

mouseDrag(Point,Point,int)

leftDrag

public static java.lang.Object leftDrag(java.awt.Point start,
                                        java.awt.Point end,
                                        int dndReleaseDelay)
                                 throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button1) and drag\move then Release the mouse button at the end point.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

dndReleaseDelay - millisecond before final release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

mouseDrag(Point, Point, int, int)

rightDrag

public static java.lang.Object rightDrag(java.awt.Point start,
                                         java.awt.Point end,
                                         int dndReleaseDelay)
                                  throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button3) and drag\move then Release the mouse button at the end point.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

dndReleaseDelay - millisecond before final release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

mouseDrag(Point, Point, int, int)

centerDrag

public static java.lang.Object centerDrag(java.awt.Point start,
                                          java.awt.Point end,
                                          int dndReleaseDelay)
                                   throws java.awt.AWTException

Move the mouse cursor to the specified start Point coordinates then perform a single mousePress (Button2) and drag\move then Release the mouse button at the end point.

Parameters:

Point - screen coordinates to start of mouse press and drag.

Point - screen coordinates to end mouse drag and mouse release.

dndReleaseDelay - millisecond before final release.

Returns:

Object returned from generic mouseDrag.

Throws:

java.awt.AWTException - if instantiating java.awt.Robot throws it.

See Also:

mouseDrag(Point, Point, int, int)

minimizeAllWindows

public static void minimizeAllWindows()
                               throws java.awt.AWTException

Minimize all windows by the short cut 'Windows+M'
This works only for windows system.

Throws:

java.awt.AWTException

getMouseLocation

public static java.awt.Point getMouseLocation()
                                       throws SAFSException

get mouse screen location.

Returns:

Point, the mouse screen location.

Throws:

SAFSException

getWindowSystemMenu

public static void getWindowSystemMenu()
                                throws java.awt.AWTException

Pre-condition: The window should be focused Get the window system menu by short-cut 'Alt+Space'
This works only for windows system.

Throws:

java.awt.AWTException

minimizeFocusedWindow

public static void minimizeFocusedWindow()
                                  throws java.awt.AWTException

Pre-condition: The window should be focused Minimize window by mnemonic key 'n' of window-system-menu.
This works only for windows system.

Throws:

java.awt.AWTException

maximizeFocusedWindow

public static void maximizeFocusedWindow()
                                  throws java.awt.AWTException

Pre-condition: The window should be focused Minimize window by mnemonic key 'x' of window-system-menu.
This works only for windows system.

Throws:

java.awt.AWTException

restoreFocusedWindow

public static void restoreFocusedWindow()
                                 throws java.awt.AWTException

Pre-condition: The window should be focused Minimize window by mnemonic key 'R' of window-system-menu.
This works only for windows system.

Throws:

java.awt.AWTException

closeFocusedWindow

public static void closeFocusedWindow()
                               throws java.awt.AWTException

Pre-condition: The window should be focused Minimize window by mnemonic key 'C' of window-system-menu.
This works only for windows system.

Throws:

java.awt.AWTException

clearClipboard

public static void clearClipboard()

Clear the system clip-board.

setClipboard

public static void setClipboard(java.lang.String content)

Set a string value to the clip-board.

Parameters:

content - String, the content to set.

getClipboard

public static java.lang.Object getClipboard(java.awt.datatransfer.DataFlavor flavor)
                                     throws SAFSException

Get content from system clip-board.

Parameters:

flavor - DataFlavor, provides meta information about data.

Returns:

Object

Throws:

SAFSException - if there is something wrong.

setNumLock

public static void setNumLock(boolean onOff)

Parameters:

onOff - boolean, Set keyboard's 'NumLock' on or off.

getNumLock

public static boolean getNumLock()

Returns:

boolean, the current keyboard's 'NumLock' status.

main

public static void main(java.lang.String[] args)