Package com.microsoft.playwright

Class Locator.CheckOptions

java.lang.Object

com.microsoft.playwright.Locator.CheckOptions

Enclosing interface:

Locator

public static class Locator.CheckOptions
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	force	Whether to bypass the actionability checks.
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.
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
CheckOptions()

Method Summary

Modifier and Type	Method	Description
Locator.CheckOptions	setForce(boolean force)	Whether to bypass the actionability checks.
Locator.CheckOptions	setNoWaitAfter(boolean noWaitAfter)	Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading.
Locator.CheckOptions	setPosition(double x, double y)	A point to use relative to the top-left corner of element padding box.
Locator.CheckOptions	setPosition(Position position)	A point to use relative to the top-left corner of element padding box.
Locator.CheckOptions	setTimeout(double timeout)	Maximum time in milliseconds.
Locator.CheckOptions	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.

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.

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

CheckOptions

public CheckOptions()

Method Detail

setForce

public Locator.CheckOptions setForce(boolean force)

Whether to bypass the actionability checks. Defaults to false.

setNoWaitAfter

public Locator.CheckOptions 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 Locator.CheckOptions 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 Locator.CheckOptions 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.

setTimeout

public Locator.CheckOptions 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 Locator.CheckOptions 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.