WebElementActionBuilder (Ibello API 1.21.1 API)

```
public interface WebElementActionBuilder
```
Interface for building an action with an element. It contains fluent methods to build and execute interactive operations on an element.
During an action, the ibello tries to interact with an element on the page. If the interaction fails, it will try it again and again, until it successes or the time runs out. By default, an action uses the ibello default timeout, but it can be changed with the TimeoutRelated.withTimeout(Enum) or TimeoutRelated.withTimeout(String) method.

In some cases it is useful to wait a few seconds after an interaction occurred on the page. The action may change the page structure dynamically, or can navigate to another page. With the withPageRefreshWait() method, this wait can be performed right after the action finishes.

During test execution, every action is logged with it's additional information. If an action fails, then the test will be marked with "error" flag, and not with "failed". This is a difference between actions and expectations - see hu.ibello.expect.

WebElementActionBuilder instance can be obtained on page objects, with PageObject.doWith(WebElement) method.

Examples:
```
 WebElement button = ...;
 WebElement inputField = ...;
 
 doWith(button).withPageRefreshWait().click();
 doWith(inputField).sendKeys(keys().CONTROL(), "a");
 
```
Author:

Kornél Simon

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`click()` Click the current element.
`void`	`contextClick()` Right (context-) click on the current element.
`void`	`doubleClick()` Double click on the current element.
`void`	`dragAndDropTo(WebElement target)` Drags the current element and drops to the given target.
`default void`	`fireEvent(Events event)` Fires an event on the element.
`void`	`fireEvent(String eventName)` Fires an event on the element.
`void`	`moveTo()` Move the cursor to the center of the current element.
`void`	`scrollTo(WebElement target)` Scrolls the current element (if it is scrollable) to the given target element.
`void`	`selectOption(int index)` Select an option from the dropdown list, with the given index.
`void`	`selectOption(String text)` Select an option from the dropdown list, with the given text.
`void`	`sendKeys(CharSequence... keys)` Send the given character sequences (strings) to the current element.
`void`	`sendKeys(KeyModifier modifier, CharSequence... keys)` Send the given character sequences (strings) to the current element, with the given `KeyModifier`.
`default void`	`setFile(File file)` Set the value of the current element, which should be a file input.
`void`	`setFile(String filePath)` Set the value of the current element, which should be a file input.
`void`	`setSelected(boolean selected)` This method works for checkboxes and radio buttons.
`void`	`setValue(String value)` Set the value of the current element, which should be a text input field or a textarea.
`void`	`submit()` Submit the current element, which should be a `form`.
`B`	`withPageRefreshWait()` If this method is called on the action builder instance, and then an action is executed successfully, the program will wait until the page is refreshed and all dynamic changes in the DOM performed.

Methods inherited from interface hu.ibello.core.TimeoutRelated
withTimeout, withTimeout

- Method Detail
  - click
```
void click()
```
    Click the current element.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
  - dragAndDropTo
```
void dragAndDropTo(WebElement target)
```
    Drags the current element and drops to the given target.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    target - drop target
  - contextClick
```
void contextClick()
```
    Right (context-) click on the current element.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
  - doubleClick
```
void doubleClick()
```
    Double click on the current element.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
  - selectOption
```
void selectOption(String text)
```
    Select an option from the dropdown list, with the given text.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    text - the text of the option we want to select
  - selectOption
```
void selectOption(int index)
```
    Select an option from the dropdown list, with the given index. The index is 0-based, so the first option has index 0.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    index - the index of the option we want to select
  - moveTo
```
void moveTo()
```
    Move the cursor to the center of the current element.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
  - scrollTo
```
void scrollTo(WebElement target)
```
    Scrolls the current element (if it is scrollable) to the given target element. The target should be a child of the current element. After the scrolling the target element will be visible inside of the current element.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    target - the target element to which we want to scroll
  - sendKeys
```
void sendKeys(CharSequence... keys)
```
    Send the given character sequences (strings) to the current element.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    keys - character sequences to send
  - sendKeys
```
void sendKeys(KeyModifier modifier,
              CharSequence... keys)
```
    Send the given character sequences (strings) to the current element, with the given KeyModifier.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    modifier - key modifier which should be activated
    
    keys - character sequences to send
    
    See Also:
    
    KeyModifier
  - submit
```
void submit()
```
    Submit the current element, which should be a form.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
  - setValue
```
void setValue(String value)
```
    Set the value of the current element, which should be a text input field or a textarea.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    value - the new value
  - setFile
```
void setFile(String filePath)
```
    Set the value of the current element, which should be a file input.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    filePath - path of the file to set
  - setFile
```
default void setFile(File file)
```
    Set the value of the current element, which should be a file input.
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    file - the file to set
  - fireEvent
```
void fireEvent(String eventName)
```
    Fires an event on the element. Event names can be obtained from an Events instance.
    
    Parameters:
    
    eventName - the name of the event
  - fireEvent
```
default void fireEvent(Events event)
```
    Fires an event on the element. Event names can be obtained from an Events instance.
    
    Parameters:
    
    event - the type of the event
  - setSelected
```
void setSelected(boolean selected)
```
    This method works for checkboxes and radio buttons. It sets the element's selection to the given value.
    For radio buttons, the only acceptable parameter of this method is true. There is no quick solution to unselect a radio button.
    
    During the timeout, this method tries to execute the action until it is successfully performed. If the time runs out and the action was not performed, an exception will be thrown, the error will be logged and the current test will be interrupted and marked as "error".
    
    Parameters:
    
    selected - should be the checkbox selected
  - withPageRefreshWait
```
B withPageRefreshWait()
```
    If this method is called on the action builder instance, and then an action is executed successfully, the program will wait until the page is refreshed and all dynamic changes in the DOM performed.
    
    Returns:
    
    the current action builder instance

Interface WebElementActionBuilder

Method Summary

Methods inherited from interface hu.ibello.core.TimeoutRelated

Method Detail

click

dragAndDropTo

contextClick

doubleClick

selectOption

selectOption

moveTo

scrollTo

sendKeys

sendKeys

submit

setValue

setFile

setFile

fireEvent

fireEvent

setSelected

withPageRefreshWait