org.safs.selenium.webdriver.lib

Class WDLibrary.RBT

java.lang.Object

org.safs.selenium.webdriver.lib.WDLibrary.RBT

Enclosing class:

WDLibrary

public static class WDLibrary.RBT
extends java.lang.Object

This class represents a Robot, which can do work locally (thru local org.safs.robot.Robot) or remotely (thru a RMI agent).

Author:

Lei Wang

Constructor Summary

Constructors

Constructor and Description
RBT()

Method Summary

Modifier and Type	Method and Description
static void	click(java.awt.Point location, org.openqa.selenium.Keys specialKey, int mouseButtonNumber, int nclicks) Use Robot to click locally or remotely (through RMI).
static void	click(RemoteDriver rd, java.awt.Point location, org.openqa.selenium.Keys specialKey, int mouseButtonNumber, int nclicks) Use Robot to click locally or remotely (through RMI).
static java.lang.Object	inputChars(RemoteDriver rd, java.lang.String chars) Type keyboard input characters unmodified.
static java.lang.Object	inputChars(java.lang.String chars) Type keyboard input characters unmodified.
static java.lang.Object	inputKeys(RemoteDriver rd, java.lang.String keys) Type keyboard input.
static java.lang.Object	inputKeys(java.lang.String keys) Type keyboard input.
static boolean	keyPress(int keycode) Press down a Key locally if the current RemoteDriver is null or is local; otherwise if the current RemoteDriver is remote, then press down a key remotely.
static boolean	keyPress(RemoteDriver rd, int keycode) Press down a Key locally if the RemoteDriver 'rd' is null or is local; otherwise if the RemoteDriver 'rd' is remote, then press down a key remotely.
static boolean	keyRelease(int keycode) Release a Key locally if the current RemoteDriver is null or is local; otherwise if the current RemoteDriver is remote, then release a key remotely.
static boolean	keyRelease(RemoteDriver rd, int keycode) Release a Key locally if the RemoteDriver 'rd' is null or is local; otherwise if the RemoteDriver 'rd' is remote, then release a key remotely.
static boolean	mouseWheel(int wheelAmt) Scroll the mouse wheel by Java Robot. The scroll happens locally if the current RemoteDriver is null or is local; otherwise if the current RemoteDriver is remote, then it happens remotely.
static boolean	mouseWheel(RemoteDriver rd, int wheelAmt) Scroll the mouse wheel by Java Robot. The scroll happens locally if the RemoteDriver 'rd' is null or is local; otherwise if the RemoteDriver 'rd' is remote, then it happens remotely.

Methods inherited from class java.lang.Object

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

Constructor Detail

RBT

public RBT()

Method Detail

click

public static void click(java.awt.Point location,
                         org.openqa.selenium.Keys specialKey,
                         int mouseButtonNumber,
                         int nclicks)
                  throws java.lang.Exception

Use Robot to click locally or remotely (through RMI). Use the current WebDriver as a RemoteDriver to provide an RMI agent.

Parameters:

location - Point, The screen location to click at.

specialKey - Keys, The selenium Keys value, representing the key (such as Ctrl, Alt) pressed during mouse click.

mouseButtonNumber - int, Representing the mouse button to click, such as WDLibrary.MOUSE_BUTTON_LEFT.

nclicks - int, How many times to click mouse.

Throws:

java.lang.Exception

click

public static void click(RemoteDriver rd,
                         java.awt.Point location,
                         org.openqa.selenium.Keys specialKey,
                         int mouseButtonNumber,
                         int nclicks)
                  throws java.lang.Exception

Use Robot to click locally or remotely (through RMI).

Parameters:

rd - RemoteDriver, The Remote Driver with an RMI agent.

location - Point, The screen location to click at.

specialKey - Keys, The selenium Keys value, representing the key (such as Ctrl, Alt) pressed during mouse click.

mouseButtonNumber - int, Representing the mouse button to click, such as WDLibrary.MOUSE_BUTTON_LEFT.

nclicks - int, How many times to click mouse.

Throws:

java.lang.Exception

keyPress

public static boolean keyPress(int keycode)
                        throws SeleniumPlusException

Press down a Key locally if the current RemoteDriver is null or is local; otherwise if the current RemoteDriver is remote, then press down a key remotely.

Parameters:

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

Returns:

boolean, true if success

Throws:

SeleniumPlusException

keyPress

public static boolean keyPress(RemoteDriver rd,
                               int keycode)
                        throws SeleniumPlusException

Press down a Key locally if the RemoteDriver 'rd' is null or is local; otherwise if the RemoteDriver 'rd' is remote, then press down a key remotely.

Parameters:

rd - RemoteDriver, The Remote Driver with an RMI agent.

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

Returns:

boolean, true if success

Throws:

SeleniumPlusException

keyRelease

public static boolean keyRelease(int keycode)
                          throws SeleniumPlusException

Release a Key locally if the current RemoteDriver is null or is local; otherwise if the current RemoteDriver is remote, then release a key remotely.

Parameters:

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

Returns:

boolean, true if success

Throws:

SeleniumPlusException

keyRelease

public static boolean keyRelease(RemoteDriver rd,
                                 int keycode)
                          throws SeleniumPlusException

Release a Key locally if the RemoteDriver 'rd' is null or is local; otherwise if the RemoteDriver 'rd' is remote, then release a key remotely.

Parameters:

rd - RemoteDriver, The Remote Driver with an RMI agent.

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

Returns:

boolean, true if success

Throws:

SeleniumPlusException

inputKeys

public static java.lang.Object inputKeys(java.lang.String keys)
                                  throws SeleniumPlusException

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 CreateUnicodeMap class.
The input happens locally if the current RemoteDriver is null or is local; otherwise if the current RemoteDriver is remote, then it happens remotely.

Parameters:

keys - String, the keys to enter.

Returns:

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

Throws:

SeleniumPlusException - if the "bypass robot" is set to true.

inputKeys

public static java.lang.Object inputKeys(RemoteDriver rd,
                                         java.lang.String keys)
                                  throws SeleniumPlusException

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 CreateUnicodeMap class.
The input happens locally if the RemoteDriver 'rd' is null or is local; otherwise if the RemoteDriver 'rd' is remote, then it happens remotely.

Parameters:

rd - RemoteDriver, The Remote Driver with an RMI agent.

keys - String, the keys to enter.

Returns:

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

Throws:

SeleniumPlusException - if the "bypass robot" is set to true.

inputChars

public static java.lang.Object inputChars(java.lang.String chars)
                                   throws SeleniumPlusException

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.
The input happens locally if the current RemoteDriver is null or is local; otherwise if the current RemoteDriver is remote, then it happens remotely.

Parameters:

chars - String, the characters to enter.

Returns:

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

Throws:

SeleniumPlusException

inputChars

public static java.lang.Object inputChars(RemoteDriver rd,
                                          java.lang.String chars)
                                   throws SeleniumPlusException

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.
The input happens locally if the RemoteDriver 'rd' is null or is local; otherwise if the RemoteDriver 'rd' is remote, then it happens remotely.

Parameters:

rd - RemoteDriver, The Remote Driver with an RMI agent.

chars - String, the characters to enter.

Returns:

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

Throws:

SeleniumPlusException

mouseWheel

public static boolean mouseWheel(int wheelAmt)
                          throws SeleniumPlusException

Scroll the mouse wheel by Java Robot.
The scroll happens locally if the current RemoteDriver is null or is local; otherwise if the current RemoteDriver is remote, then it happens remotely.

Parameters:

wheelAmt - int, the wheel amount to scroll.

Returns:

boolean true, if the scroll succeeds.

Throws:

SeleniumPlusException - if the "bypass robot" is set to true.

mouseWheel

public static boolean mouseWheel(RemoteDriver rd,
                                 int wheelAmt)
                          throws SeleniumPlusException

Scroll the mouse wheel by Java Robot.
The scroll happens locally if the RemoteDriver 'rd' is null or is local; otherwise if the RemoteDriver 'rd' is remote, then it happens remotely.

Parameters:

rd - RemoteDriver, The Remote Driver with an RMI agent.

wheelAmt - int, the wheel amount to scroll.

Returns:

boolean true, if the scroll succeeds.

Throws:

SeleniumPlusException - if the "bypass robot" is set to true.