Package org.fluentlenium.core.action

Class MouseElementActions

java.lang.Object

org.fluentlenium.core.action.MouseElementActions

public class MouseElementActions
extends java.lang.Object

Element specific mouse control interface.

Constructor Summary

Constructors

Constructor	Description
MouseElementActions(org.openqa.selenium.WebDriver driver, FluentWebElement fluentWebElement)	Creates a new mouse element actions.
MouseElementActions(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element)	Creates a new mouse element actions.

Method Summary

Modifier and Type	Method	Description
org.openqa.selenium.interactions.Mouse	basic()	Deprecated. Use the following mapping for updating your code:
MouseElementActions	click()	Clicks in the middle of the given element.
MouseElementActions	clickAndHold()	Clicks (without releasing) in the middle of the given element.
MouseElementActions	contextClick()	Performs a context-click at middle of the given element.
MouseElementActions	doubleClick()	Performs a double-click at middle of the given element.
MouseElementActions	dragAndDropBy(int xOffset, int yOffset)	A convenience method that performs click-and-hold at the location of this element, moves by a given offset, then releases the mouse.
MouseElementActions	dragAndDropByWithTargetOffset(org.openqa.selenium.WebElement target, int xOffset, int yOffset)	A convenience method that performs click-and-hold at the location of this element, moves by a given offset of target element, then releases the mouse.
MouseElementActions	dragAndDropFrom(org.openqa.selenium.WebElement source)	A convenience method that performs click-and-hold at the location of the source element, moves to the location of this element (target), then releases the mouse.
MouseElementActions	dragAndDropTo(org.openqa.selenium.WebElement target)	A convenience method that performs click-and-hold at the location of this element (source), moves to the location of the target element, then releases the mouse.
MouseElementActions	moveToElement()	Moves the mouse to the middle of the element.
MouseElementActions	moveToElement(int xOffset, int yOffset)	Moves the mouse to an offset from the top-left corner of the element.
MouseElementActions	moveToElement(org.openqa.selenium.WebElement target)	Moves the mouse to the middle of the target element.
MouseElementActions	moveToElement(org.openqa.selenium.WebElement target, int xOffset, int yOffset)	Moves the mouse to an offset from the top-left corner of the target element.
MouseElementActions	release()	Releases the depressed left mouse button, in the middle of the given element.

Methods inherited from class java.lang.Object

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

Constructor Detail

MouseElementActions

public MouseElementActions(org.openqa.selenium.WebDriver driver,
                           org.openqa.selenium.WebElement element)

Creates a new mouse element actions.

Parameters:

driver - selenium driver

element - selenium element

MouseElementActions

public MouseElementActions(org.openqa.selenium.WebDriver driver,
                           FluentWebElement fluentWebElement)

Creates a new mouse element actions.

Parameters:

driver - selenium driver

fluentWebElement - FluentWebElement

Method Detail

basic

@Deprecated
public org.openqa.selenium.interactions.Mouse basic()

Deprecated.

Use the following mapping for updating your code:

Mouse.click(Coordinates) to click()

Mouse.doubleClick(Coordinates) to doubleClick()

Mouse.mouseDown(Coordinates) to moveToElement() then clickAndHold()

Mouse.mouseUp(Coordinates) to release()

Mouse.mouseMove(Coordinates) to moveToElement()

Mouse.mouseMove(Coordinates, long, long) to moveToElement(int, int)

Mouse.contextClick(Coordinates) to contextClick()

Basic mouse operations

Returns:

low level interface to control the mouse

clickAndHold

public MouseElementActions clickAndHold()

Clicks (without releasing) in the middle of the given element. This is equivalent to: Actions.moveToElement(onElement).clickAndHold()

Returns:

this object reference to chain calls

See Also:

Actions.clickAndHold(WebElement)

release

public MouseElementActions release()

Releases the depressed left mouse button, in the middle of the given element. This is equivalent to: Actions.moveToElement(onElement).release()

Invoking this action without invoking clickAndHold() first will result in undefined behaviour.

Returns:

this object reference to chain calls

See Also:

Actions.release(WebElement)

click

public MouseElementActions click()

Clicks in the middle of the given element. Equivalent to: Actions.moveToElement(onElement).click()

Returns:

this object reference to chain calls

See Also:

Actions.click(WebElement)

doubleClick

public MouseElementActions doubleClick()

Performs a double-click at middle of the given element. Equivalent to: Actions.moveToElement(element).doubleClick()

Returns:

this object reference to chain calls

See Also:

Actions.doubleClick(WebElement)

moveToElement

public MouseElementActions moveToElement()

Moves the mouse to the middle of the element. The element is scrolled into view and its location is calculated using getBoundingClientRect.

Returns:

this object reference to chain calls

See Also:

Actions.moveToElement(WebElement)

moveToElement

public MouseElementActions moveToElement(org.openqa.selenium.WebElement target)

Moves the mouse to the middle of the target element. The element is scrolled into view and its location is calculated using getBoundingClientRect.

Parameters:

target - element to move to and release the mouse at.

Returns:

this object reference to chain calls

See Also:

Actions.moveToElement(WebElement)

moveToElement

public MouseElementActions moveToElement(int xOffset,
                                         int yOffset)

Moves the mouse to an offset from the top-left corner of the element. The element is scrolled into view and its location is calculated using getBoundingClientRect.

Parameters:

xOffset - Offset from the top-left corner. A negative value means coordinates left from the element

yOffset - Offset from the top-left corner. A negative value means coordinates above the element

Returns:

this object reference to chain calls

See Also:

Actions.moveToElement(WebElement, int, int)

moveToElement

public MouseElementActions moveToElement(org.openqa.selenium.WebElement target,
                                         int xOffset,
                                         int yOffset)

Moves the mouse to an offset from the top-left corner of the target element. The element is scrolled into view and its location is calculated using getBoundingClientRect.

Parameters:

target - element to move to and release the mouse at.

xOffset - Offset from the top-left corner. A negative value means coordinates left from the element

yOffset - Offset from the top-left corner. A negative value means coordinates above the element

Returns:

this object reference to chain calls

See Also:

Actions.moveToElement(WebElement, int, int)

contextClick

public MouseElementActions contextClick()

Performs a context-click at middle of the given element. First performs a mouseMove to the location of the element.

Returns:

this object reference to chain calls

See Also:

Actions.contextClick(WebElement)

dragAndDropFrom

public MouseElementActions dragAndDropFrom(org.openqa.selenium.WebElement source)

A convenience method that performs click-and-hold at the location of the source element, moves to the location of this element (target), then releases the mouse.

Parameters:

source - element to emulate button down at

Returns:

this object reference to chain calls

See Also:

Actions.dragAndDrop(WebElement, WebElement)

dragAndDropTo

public MouseElementActions dragAndDropTo(org.openqa.selenium.WebElement target)

A convenience method that performs click-and-hold at the location of this element (source), moves to the location of the target element, then releases the mouse.

Parameters:

target - element to move to and release the mouse at.

Returns:

this object reference to chain calls

See Also:

Actions.dragAndDrop(WebElement, WebElement)

dragAndDropBy

public MouseElementActions dragAndDropBy(int xOffset,
                                         int yOffset)

A convenience method that performs click-and-hold at the location of this element, moves by a given offset, then releases the mouse.

Parameters:

xOffset - horizontal move offset.

yOffset - vertical move offset.

Returns:

this object reference to chain calls

See Also:

Actions.dragAndDropBy(WebElement, int, int)

dragAndDropByWithTargetOffset

public MouseElementActions dragAndDropByWithTargetOffset(org.openqa.selenium.WebElement target,
                                                         int xOffset,
                                                         int yOffset)

A convenience method that performs click-and-hold at the location of this element, moves by a given offset of target element, then releases the mouse. This Method is not available in pure Selenium

Parameters:

target - element to move to and release the mouse at.

xOffset - horizontal move offset.

yOffset - vertical move offset.

Returns:

this object reference to chain calls

See Also:

Actions.dragAndDropBy(WebElement, int, int)