Locator.ClickOptions (Playwright - Main Library 1.21.0 API)

java.lang.Object
- com.microsoft.playwright.Locator.ClickOptions

Enclosing interface:: Locator

public static class Locator.ClickOptions
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`MouseButton`	`button` Defaults to `left`.
`Integer`	`clickCount` defaults to 1.
`Double`	`delay` Time to wait between `mousedown` and `mouseup` in milliseconds.
`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.
`Double`	`timeout` Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout.
`Boolean`	`trial` When set, this method only performs the actionability checks and skips the action.

Constructor Summary

Constructors
Constructor and Description

ClickOptions()

Constructors
Constructor and Description
`ClickOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Locator.ClickOptions`	`setButton(MouseButton button)` Defaults to `left`.
`Locator.ClickOptions`	`setClickCount(int clickCount)` defaults to 1.
`Locator.ClickOptions`	`setDelay(double delay)` Time to wait between `mousedown` and `mouseup` in milliseconds.
`Locator.ClickOptions`	`setForce(boolean force)` Whether to bypass the actionability checks.
`Locator.ClickOptions`	`setModifiers(List<KeyboardModifier> modifiers)` Modifier keys to press.
`Locator.ClickOptions`	`setNoWaitAfter(boolean noWaitAfter)` Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading.
`Locator.ClickOptions`	`setPosition(double x, double y)` A point to use relative to the top-left corner of element padding box.
`Locator.ClickOptions`	`setPosition(Position position)` A point to use relative to the top-left corner of element padding box.
`Locator.ClickOptions`	`setTimeout(double timeout)` Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout.
`Locator.ClickOptions`	`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
  - button
```
public MouseButton button
```
    Defaults to left.
  - clickCount
```
public Integer clickCount
```
    defaults to 1. See [UIEvent.detail].
  - delay
```
public Double delay
```
    Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
  - 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.
  - 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 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
  - ClickOptions
```
public ClickOptions()
```
- Method Detail
  - setButton
```
public Locator.ClickOptions setButton(MouseButton button)
```
    Defaults to left.
  - setClickCount
```
public Locator.ClickOptions setClickCount(int clickCount)
```
    defaults to 1. See [UIEvent.detail].
  - setDelay
```
public Locator.ClickOptions setDelay(double delay)
```
    Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
  - setForce
```
public Locator.ClickOptions setForce(boolean force)
```
    Whether to bypass the actionability checks. Defaults to false.
  - setModifiers
```
public Locator.ClickOptions 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.
  - setNoWaitAfter
```
public Locator.ClickOptions 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.ClickOptions 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.ClickOptions 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.ClickOptions setTimeout(double timeout)
```
    Maximum time in milliseconds, defaults to 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.ClickOptions 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.

Class Locator.ClickOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

button

clickCount

delay

force

modifiers

noWaitAfter

position

timeout

trial

Constructor Detail

ClickOptions

Method Detail

setButton

setClickCount

setDelay

setForce

setModifiers

setNoWaitAfter

setPosition

setPosition

setTimeout

setTrial