Package com.microsoft.playwright

Class Frame.HoverOptions

java.lang.Object

com.microsoft.playwright.Frame.HoverOptions

Enclosing interface:

Frame

public static class Frame.HoverOptions
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	force	Whether to bypass the actionability checks.
List<KeyboardModifier>	modifiers	Modifier keys to press.
Boolean	noWaitAfter	Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading.
Position	position	A point to use relative to the top-left corner of element padding box.
Boolean	strict	When true, the call requires selector to resolve to a single element.
Double	timeout	Maximum time in milliseconds.
Boolean	trial	When set, this method only performs the actionability checks and skips the action.

Constructor Summary

Constructors

Constructor	Description
HoverOptions()

Method Summary

Modifier and Type	Method	Description
Frame.HoverOptions	setForce(boolean force)	Whether to bypass the actionability checks.
Frame.HoverOptions	setModifiers(List<KeyboardModifier> modifiers)	Modifier keys to press.
Frame.HoverOptions	setNoWaitAfter(boolean noWaitAfter)	Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading.
Frame.HoverOptions	setPosition(double x, double y)	A point to use relative to the top-left corner of element padding box.
Frame.HoverOptions	setPosition(Position position)	A point to use relative to the top-left corner of element padding box.
Frame.HoverOptions	setStrict(boolean strict)	When true, the call requires selector to resolve to a single element.
Frame.HoverOptions	setTimeout(double timeout)	Maximum time in milliseconds.
Frame.HoverOptions	setTrial(boolean trial)	When set, this method only performs the actionability checks and skips the action.

Methods inherited from class java.lang.Object

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

Field Detail

force

public Boolean force

Whether to bypass the actionability checks. Defaults to false.

modifiers

public List<KeyboardModifier> modifiers

Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

noWaitAfter

public Boolean noWaitAfter

Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

position

public Position position

A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

strict

public Boolean strict

When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

timeout

public Double timeout

Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

trial

public Boolean trial

When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

Constructor Detail

HoverOptions

public HoverOptions()

Method Detail

setForce

public Frame.HoverOptions setForce(boolean force)

Whether to bypass the actionability checks. Defaults to false.

setModifiers

public Frame.HoverOptions setModifiers(List<KeyboardModifier> modifiers)

Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

setNoWaitAfter

public Frame.HoverOptions setNoWaitAfter(boolean noWaitAfter)

Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

setPosition

public Frame.HoverOptions setPosition(double x,
                                      double y)

A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

setPosition

public Frame.HoverOptions setPosition(Position position)

A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

setStrict

public Frame.HoverOptions setStrict(boolean strict)

When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

setTimeout

public Frame.HoverOptions setTimeout(double timeout)

Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

setTrial

public Frame.HoverOptions setTrial(boolean trial)

When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.