PageObjectTool (Ibello API 1.21.1 API)

```
public interface PageObjectTool
```
Helper interface for page objects.
There is no need to use this interface directly. The ibello dependency injection system automatically instantiates and injects an instance into page objects.

Author:

Kornél Simon

See Also:

PageObject

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Browser`	`browser(String windowId)` Returns a `Browser` instance which can be used for different browser-specific actions, including element search and opening URL.
`WebElementChecker`	`checkThat(WebElement element)` Returns a `WebElementChecker` instance which can be used to inspect a `WebElement`'s state and have some boolean result about it.
`BrowserActionBuilder`	`doWith(Browser browser)` Returns an `BrowserActionBuilder` instance which can be used to manager browser window related actions.
`WebElementActionBuilder`	`doWith(WebElement element)` Returns an `WebElementActionBuilder` instance which can be used to perform an action on the web element.
`ExpectationBuilder`	`expectations(String windowId)` Returns an `ExpectationBuilder` instance which can be used to build and execute an expectation.
`SearchTool`	`find(String windowId)` Returns a `SearchTool` instance which is used to search elements on the page.
`WebElementGetter`	`get(WebElement element)` Returns a `WebElementGetter` instance which can be used to get some property of the given `WebElement`.
`Value`	`getConfigurationValue(String name)` Returns a configuration property as a `Value`.
`String`	`getMergedURL(String url)` Returns an URL which is merged with the `ibello.url.base` configuration property.
`KeyHelper`	`keys()` Returns a `KeyHelper` instance, which offers special keys and key modifiers.
`TaskRepeater`	`repeat(Task task)` Returns a `TaskRepeater` instance which will run the given task multiple times.
`TestDataBuilder`	`testData()` Starts a new test data loading.
`BrowserActionBuilder`	`tryWith(Browser browser)` Returns an `BrowserActionBuilder` instance which can be used to manager browser window related actions.
`WebElementActionBuilder`	`tryWith(WebElement element)` Returns an `WebElementActionBuilder` instance which can be used to perform an action on the web element.

- Method Detail
  - find
```
SearchTool find(String windowId)
```
    Returns a SearchTool instance which is used to search elements on the page.
    
    The returned instance offers a fluent interface for element search. Example:
```
 WebElement image = ...;
 WebElement child = find().using(By.TAG_NAME, "span").leftFrom(image).first();
 
```
    Parameters:
    
    windowId - identifier of the browser window
    
    Returns:
    
    an object used for element search on the page
  - getConfigurationValue
```
Value getConfigurationValue(String name)
```
    Returns a configuration property as a Value. The returned value offers some public methods to transform the configuration property into different java types. This method always has a non-null result, even if the configuration value does not exist - in this case, the wrapped value will be null.
    
    Parameters:
    
    name - name of the configuration parameter
    
    Returns:
    
    value of the configuration parameter wrapped into a Value instance
  - getMergedURL
```
String getMergedURL(String url)
```
    Returns an URL which is merged with the ibello.url.base configuration property.
    If the given URL is an absolute one with protocol, then it will be returned (without any changes).
    
    If the URL is relative, then it will be concatenated to the configuration property, and the result will be returned.
    
    Parameters:
    
    url - the absolute or relative URL
    
    Returns:
    
    the merged URL
  - browser
```
Browser browser(String windowId)
```
    Returns a Browser instance which can be used for different browser-specific actions, including element search and opening URL.
    
    Parameters:
    
    windowId - identifier of the browser window
    
    Returns:
    
    an interface which offers browser-specific actions
  - doWith
```
WebElementActionBuilder doWith(WebElement element)
```
    Returns an WebElementActionBuilder instance which can be used to perform an action on the web element. If the action fails then the test execution stops.
    
    Parameters:
    
    element - we want to perform an action with this elements
    
    Returns:
    
    an interface configured for doing actions with the element
  - tryWith
```
WebElementActionBuilder tryWith(WebElement element)
```
    Returns an WebElementActionBuilder instance which can be used to perform an action on the web element. If the action fails then the test execution continues.
    
    Parameters:
    
    element - we want to perform an action with this elements
    
    Returns:
    
    an interface configured for doing actions with the element
  - doWith
```
BrowserActionBuilder doWith(Browser browser)
```
    Returns an BrowserActionBuilder instance which can be used to manager browser window related actions. If the action fails then test execution stops.
    
    Parameters:
    
    browser - the browser instance, can be obtained with the PageObject.browser() method
    
    Returns:
    
    an interface configured for doing actions with the browser
  - tryWith
```
BrowserActionBuilder tryWith(Browser browser)
```
    Returns an BrowserActionBuilder instance which can be used to manager browser window related actions. If the action fails then test execution continues.
    
    Parameters:
    
    browser - the browser instance, can be obtained with the PageObject.browser() method
    
    Returns:
    
    an interface configured for doing actions with the browser
  - repeat
```
TaskRepeater repeat(Task task)
```
    Returns a TaskRepeater instance which will run the given task multiple times. The methods of this instance are customizing the exit condition of this repeat process.
    
    Parameters:
    
    task - the task we want to repeat
    
    Returns:
    
    an interface configured for repeating the task
  - checkThat
```
WebElementChecker checkThat(WebElement element)
```
    Returns a WebElementChecker instance which can be used to inspect a WebElement's state and have some boolean result about it. The investigation holds until the element is accessible (or the time runs out).
    
    Parameters:
    
    element - the element we need to investigate
    
    Returns:
    
    an interface configured for running investigation on the element
  - get
```
WebElementGetter get(WebElement element)
```
    Returns a WebElementGetter instance which can be used to get some property of the given WebElement. The operation waits until the element is accessible (or the time runs out).
    
    Parameters:
    
    element - the element
    
    Returns:
    
    an interface configured for querying properties of the element
  - expectations
```
ExpectationBuilder expectations(String windowId)
```
    Returns an ExpectationBuilder instance which can be used to build and execute an expectation.
    
    The returned instance offers a fluent interface for element search. Example:
```
 WebElement okButton = ...;
 WebElements buttons = ...;
 expectations().expect(okButton).toBe().visible();
 expectations().expect(buttons).toHave().size(5);
 expectations().expect(browser()).toHave().url("http://localhost/page");
 
```
    Parameters:
    
    windowId - identifier of the browser window
    
    Returns:
    
    an ExpectationBuilder instance which is configured to run expectations
  - keys
```
KeyHelper keys()
```
    Returns a KeyHelper instance, which offers special keys and key modifiers. Those can be used in WebElementActionBuilder.sendKeys(CharSequence...) and WebElementActionBuilder.sendKeys(hu.ibello.actions.KeyModifier, CharSequence...) methods.
    
    Returns:
    
    a KeyHelper instance
  - testData
```
TestDataBuilder testData()
```
    Starts a new test data loading. The result is a TestDataBuilder instance which can be used to configure and perform the test loading operation.
    
    Returns:
    
    a test data loader instance
    
    See Also:
    
    TestDataBuilder

Interface PageObjectTool

Method Summary

Method Detail

find

getConfigurationValue

getMergedURL

browser

doWith

tryWith

doWith

tryWith

repeat

checkThat

get

expectations

keys

testData