org.fluentlenium.core.action

Class KeyboardActions

java.lang.Object

org.fluentlenium.core.action.KeyboardActions

public class KeyboardActions
extends Object

Execute actions with the keyboard.

Constructor Summary

Constructors

Constructor and Description
KeyboardActions(org.openqa.selenium.interactions.Keyboard keyboard, org.openqa.selenium.interactions.Mouse mouse) Creates a new object to execute actions with the keyboard, using given selenium Keyboard and Mouse interfaces.
KeyboardActions(org.openqa.selenium.WebDriver driver) Creates a new object to execute actions with the keyboard, using given selenium driver.

Method Summary

Modifier and Type	Method and Description
protected org.openqa.selenium.interactions.Actions	actions() Get selenium interactions actions.
org.openqa.selenium.interactions.Keyboard	basic() Basic keyboard operations
KeyboardActions	keyDown(org.openqa.selenium.Keys theKey) Performs a modifier key press.
KeyboardActions	keyUp(org.openqa.selenium.Keys theKey) Performs a modifier key release.
KeyboardActions	sendKeys(CharSequence... keysToSend) Sends keys to the active element.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyboardActions

public KeyboardActions(org.openqa.selenium.WebDriver driver)

Creates a new object to execute actions with the keyboard, using given selenium driver.

Parameters:

driver - selenium driver

KeyboardActions

public KeyboardActions(org.openqa.selenium.interactions.Keyboard keyboard,
                       org.openqa.selenium.interactions.Mouse mouse)

Creates a new object to execute actions with the keyboard, using given selenium Keyboard and Mouse interfaces.

Parameters:

keyboard - keyboard interface

mouse - mouse interface

Method Detail

actions

protected org.openqa.selenium.interactions.Actions actions()

Get selenium interactions actions.

Returns:

selenium actions

basic

public org.openqa.selenium.interactions.Keyboard basic()

Basic keyboard operations

Returns:

low level interface to control the keyboard

keyDown

public KeyboardActions keyDown(org.openqa.selenium.Keys theKey)

Performs a modifier key press. Does not release the modifier key - subsequent interactions may assume it's kept pressed. Note that the modifier key is never released implicitly - either keyUp(theKey) or sendKeys(Keys.NULL) must be called to release the modifier.

Parameters:

theKey - Either Keys.SHIFT, Keys.ALT or Keys.CONTROL. If the provided key is none of those, IllegalArgumentException is thrown.

Returns:

this object reference to chain calls

See Also:

Actions.keyDown(Keys)

keyUp

public KeyboardActions keyUp(org.openqa.selenium.Keys theKey)

Performs a modifier key release. Releasing a non-depressed modifier key will yield undefined behaviour.

Parameters:

theKey - Either Keys.SHIFT, Keys.ALT or Keys.CONTROL.

Returns:

this object reference to chain calls

See Also:

Actions.keyUp(Keys)

sendKeys

public KeyboardActions sendKeys(CharSequence... keysToSend)

Sends keys to the active element. This differs from calling WebElement.sendKeys(CharSequence...) on the active element in two ways:

• The modifier keys included in this call are not released.
• There is no attempt to re-focus the element - so sendKeys(Keys.TAB) for switching elements should work.

Parameters:

keysToSend - The keys.

Returns:

A self reference.

See Also:

Actions.sendKeys(CharSequence...)