Waiting (Robot Framework :: Selenium2Library 1.4.0.0 API)

java.lang.Object
- com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter
- - com.github.markusbernhardt.selenium2library.keywords.Waiting

All Implemented Interfaces:: RunOnFailureKeywords

public class Waiting
extends RunOnFailureKeywordsAdapter

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static interface Waiting.WaitUntilFunction

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`Waiting.WaitUntilFunction`

Field Summary

Fields
Modifier and Type	Field and Description
`protected BrowserManagement`	`browserManagement` Instantiated BrowserManagement keyword bean
`protected Element`	`element` Instantiated Element keyword bean

Constructor Summary

Constructors
Constructor and Description

Waiting()

Constructors
Constructor and Description
`Waiting()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`waitForCondition(String condition)`
`void`	`waitForCondition(String condition, String timeout)`
`void`	`waitForCondition(String condition, String timeout, String message)` Waits until the given JavaScript condition is true.
`protected void`	`waitUntil(String timestr, String message, Waiting.WaitUntilFunction function)`
`void`	`waitUntilElementIsClickable(String locator)`
`void`	`waitUntilElementIsClickable(String locator, String timeout)`
`void`	`waitUntilElementIsClickable(String locator, String timeout, String message)` Waits until the element identified by locator is clickable.
`void`	`waitUntilElementIsNotClickable(String locator)`
`void`	`waitUntilElementIsNotClickable(String locator, String timeout)`
`void`	`waitUntilElementIsNotClickable(String locator, String timeout, String message)` Waits until the element identified by locator is not clickable.
`void`	`waitUntilElementIsNotSelected(String locator)`
`void`	`waitUntilElementIsNotSelected(String locator, String timeout)`
`void`	`waitUntilElementIsNotSelected(String locator, String timeout, String message)` Waits until the element identified by locator is not selected.
`void`	`waitUntilElementIsNotVisible(String locator)`
`void`	`waitUntilElementIsNotVisible(String locator, String timeout)`
`void`	`waitUntilElementIsNotVisible(String locator, String timeout, String message)` Waits until the element identified by locator is not visible.
`void`	`waitUntilElementIsSelected(String locator)`
`void`	`waitUntilElementIsSelected(String locator, String timeout)`
`void`	`waitUntilElementIsSelected(String locator, String timeout, String message)` Waits until the element identified by locator is selected.
`void`	`waitUntilElementIsSuccessfullyClicked(String locator)`
`void`	`waitUntilElementIsSuccessfullyClicked(String locator, String timeout)`
`void`	`waitUntilElementIsSuccessfullyClicked(String locator, String timeout, String message)` Waits until the element identified by locator is sucessfully clicked on.
`void`	`waitUntilElementIsVisible(String locator)`
`void`	`waitUntilElementIsVisible(String locator, String timeout)`
`void`	`waitUntilElementIsVisible(String locator, String timeout, String message)` Waits until the element identified by locator is visible.
`void`	`waitUntilPageContains(String condition)`
`void`	`waitUntilPageContains(String condition, String timeout)`
`void`	`waitUntilPageContains(String text, String timeout, String message)` Waits until the current page contains text.
`void`	`waitUntilPageContainsElement(String condition)`
`void`	`waitUntilPageContainsElement(String condition, String timeout)`
`void`	`waitUntilPageContainsElement(String locator, String timeout, String message)` Waits until the element identified by locator is found on the current page.
`void`	`waitUntilPageNotContains(String condition)`
`void`	`waitUntilPageNotContains(String condition, String timeout)`
`void`	`waitUntilPageNotContains(String text, String timeout, String message)` Waits until the current page does not contain text.
`void`	`waitUntilPageNotContainsElement(String locator)`
`void`	`waitUntilPageNotContainsElement(String locator, String timeout)`
`void`	`waitUntilPageNotContainsElement(String locator, String timeout, String message)` Waits until the element identified by locator is not found on the current page.
`void`	`waitUntilTitleContains(String title)`
`void`	`waitUntilTitleContains(String title, String timeout)`
`void`	`waitUntilTitleContains(String title, String timeout, String message)` Waits until the current page title contains title.
`void`	`waitUntilTitleIs(String title)`
`void`	`waitUntilTitleIs(String title, String timeout)`
`void`	`waitUntilTitleIs(String title, String timeout, String message)` Waits until the current page title is exactly title.
`void`	`waitUntilTitleIsNot(String title)`
`void`	`waitUntilTitleIsNot(String title, String timeout)`
`void`	`waitUntilTitleIsNot(String title, String timeout, String message)` Waits until the current page title is not exactly title.
`void`	`waitUntilTitleNotContains(String title)`
`void`	`waitUntilTitleNotContains(String title, String timeout)`
`void`	`waitUntilTitleNotContains(String title, String timeout, String message)` Waits until the current page title does not contain title.

Methods inherited from class com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter
runOnFailureByAspectJ

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - browserManagement
```
protected BrowserManagement browserManagement
```
    Instantiated BrowserManagement keyword bean
  - element
```
protected Element element
```
    Instantiated Element keyword bean
- Constructor Detail
  - Waiting
```
public Waiting()
```
- Method Detail
  - waitForCondition
```
public void waitForCondition(String condition)
```
  - waitForCondition
```
public void waitForCondition(String condition,
                    String timeout)
```
  - waitForCondition
```
public void waitForCondition(String condition,
                    String timeout,
                    String message)
```
    Waits until the given JavaScript condition is true.
    
    Fails, if the timeout expires, before the condition gets true.
    
    The condition may contain multiple JavaScript statements, but the last statement must return a boolean. Otherwise this keyword will always hit the timeout.
    
    Note that by default the code will be executed in the context of the Selenium object itself, so this will refer to the Selenium object. Use window to refer to the window of your application, e.g. window.document.getElementById('foo').
    
    See `Introduction` for details about timeouts.
    
    Parameters:
    condition - The JavaScript condition returning a boolean.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilPageContains
```
public void waitUntilPageContains(String condition)
```
  - waitUntilPageContains
```
public void waitUntilPageContains(String condition,
                         String timeout)
```
  - waitUntilPageContains
```
public void waitUntilPageContains(String text,
                         String timeout,
                         String message)
```
    Waits until the current page contains text.
    
    Fails, if the timeout expires, before the text appears.
    
    See `Introduction` for details about timeouts.
    
    Parameters:
    text - The text to verify.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilPageNotContains
```
public void waitUntilPageNotContains(String condition,
                            String timeout)
```
  - waitUntilPageNotContains
```
public void waitUntilPageNotContains(String condition)
```
  - waitUntilPageNotContains
```
public void waitUntilPageNotContains(String text,
                            String timeout,
                            String message)
```
    Waits until the current page does not contain text.
    
    Fails, if the timeout expires, before the text disappears.
    
    See `Introduction` for details about timeouts.
    
    Parameters:
    text - The text to verify.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilPageContainsElement
```
public void waitUntilPageContainsElement(String condition)
```
  - waitUntilPageContainsElement
```
public void waitUntilPageContainsElement(String condition,
                                String timeout)
```
  - waitUntilPageContainsElement
```
public void waitUntilPageContainsElement(String locator,
                                String timeout,
                                String message)
```
    Waits until the element identified by locator is found on the current page.
    
    Fails, if the timeout expires, before the element appears.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilPageNotContainsElement
```
public void waitUntilPageNotContainsElement(String locator)
```
  - waitUntilPageNotContainsElement
```
public void waitUntilPageNotContainsElement(String locator,
                                   String timeout)
```
  - waitUntilPageNotContainsElement
```
public void waitUntilPageNotContainsElement(String locator,
                                   String timeout,
                                   String message)
```
    Waits until the element identified by locator is not found on the current page.
    
    Fails, if the timeout expires, before the element disappears.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilElementIsVisible
```
public void waitUntilElementIsVisible(String locator,
                             String timeout)
```
  - waitUntilElementIsVisible
```
public void waitUntilElementIsVisible(String locator)
```
  - waitUntilElementIsVisible
```
public void waitUntilElementIsVisible(String locator,
                             String timeout,
                             String message)
```
    Waits until the element identified by locator is visible.
    
    Fails, if the timeout expires, before the element gets visible.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilElementIsNotVisible
```
public void waitUntilElementIsNotVisible(String locator,
                                String timeout)
```
  - waitUntilElementIsNotVisible
```
public void waitUntilElementIsNotVisible(String locator)
```
  - waitUntilElementIsNotVisible
```
public void waitUntilElementIsNotVisible(String locator,
                                String timeout,
                                String message)
```
    Waits until the element identified by locator is not visible.
    
    Fails, if the timeout expires, before the element gets invisible.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilElementIsClickable
```
public void waitUntilElementIsClickable(String locator)
```
  - waitUntilElementIsClickable
```
public void waitUntilElementIsClickable(String locator,
                               String timeout)
```
  - waitUntilElementIsClickable
```
public void waitUntilElementIsClickable(String locator,
                               String timeout,
                               String message)
```
    Waits until the element identified by locator is clickable.
    
    Fails, if the timeout expires, before the element gets clickable.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilElementIsNotClickable
```
public void waitUntilElementIsNotClickable(String locator,
                                  String timeout)
```
  - waitUntilElementIsNotClickable
```
public void waitUntilElementIsNotClickable(String locator)
```
  - waitUntilElementIsNotClickable
```
public void waitUntilElementIsNotClickable(String locator,
                                  String timeout,
                                  String message)
```
    Waits until the element identified by locator is not clickable.
    
    Fails, if the timeout expires, before the element gets unclickable.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilElementIsSuccessfullyClicked
```
public void waitUntilElementIsSuccessfullyClicked(String locator,
                                         String timeout)
```
  - waitUntilElementIsSuccessfullyClicked
```
public void waitUntilElementIsSuccessfullyClicked(String locator)
```
  - waitUntilElementIsSuccessfullyClicked
```
public void waitUntilElementIsSuccessfullyClicked(String locator,
                                         String timeout,
                                         String message)
```
    Waits until the element identified by locator is sucessfully clicked on.
    
    Fails, if the timeout expires, before the element gets clicked on.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilElementIsSelected
```
public void waitUntilElementIsSelected(String locator,
                              String timeout)
```
  - waitUntilElementIsSelected
```
public void waitUntilElementIsSelected(String locator)
```
  - waitUntilElementIsSelected
```
public void waitUntilElementIsSelected(String locator,
                              String timeout,
                              String message)
```
    Waits until the element identified by locator is selected.
    
    Fails, if the timeout expires, before the element gets selected.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilElementIsNotSelected
```
public void waitUntilElementIsNotSelected(String locator,
                                 String timeout)
```
  - waitUntilElementIsNotSelected
```
public void waitUntilElementIsNotSelected(String locator)
```
  - waitUntilElementIsNotSelected
```
public void waitUntilElementIsNotSelected(String locator,
                                 String timeout,
                                 String message)
```
    Waits until the element identified by locator is not selected.
    
    Fails, if the timeout expires, before the element gets unselected.
    
    See `Introduction` for details about locators and timeouts.
    
    Parameters:
    locator - The locator to locate the element.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilTitleContains
```
public void waitUntilTitleContains(String title,
                          String timeout)
```
  - waitUntilTitleContains
```
public void waitUntilTitleContains(String title)
```
  - waitUntilTitleContains
```
public void waitUntilTitleContains(String title,
                          String timeout,
                          String message)
```
    Waits until the current page title contains title.
    
    Fails, if the timeout expires, before the page title contains the given title.
    
    Parameters:
    title - The title to verify.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilTitleNotContains
```
public void waitUntilTitleNotContains(String title,
                             String timeout)
```
  - waitUntilTitleNotContains
```
public void waitUntilTitleNotContains(String title)
```
  - waitUntilTitleNotContains
```
public void waitUntilTitleNotContains(String title,
                             String timeout,
                             String message)
```
    Waits until the current page title does not contain title.
    
    Fails, if the timeout expires, before the page title does not contain the given title.
    
    Parameters:
    title - The title to verify.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilTitleIs
```
public void waitUntilTitleIs(String title,
                    String timeout)
```
  - waitUntilTitleIs
```
public void waitUntilTitleIs(String title)
```
  - waitUntilTitleIs
```
public void waitUntilTitleIs(String title,
                    String timeout,
                    String message)
```
    Waits until the current page title is exactly title.
    
    Fails, if the timeout expires, before the page title matches the given title.
    
    Parameters:
    title - The title to verify.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntilTitleIsNot
```
public void waitUntilTitleIsNot(String title,
                       String timeout)
```
  - waitUntilTitleIsNot
```
public void waitUntilTitleIsNot(String title)
```
  - waitUntilTitleIsNot
```
public void waitUntilTitleIsNot(String title,
                       String timeout,
                       String message)
```
    Waits until the current page title is not exactly title.
    
    Fails, if the timeout expires, before the page title does not match the given title.
    
    Parameters:
    title - The title to verify.
    timeout - Default=NONE. Optional timeout interval.
    message - Default=NONE. Optional custom error message.
  - waitUntil
```
protected void waitUntil(String timestr,
             String message,
             Waiting.WaitUntilFunction function)
```

Class Waiting

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

Methods inherited from class java.lang.Object

Field Detail

browserManagement

element

Constructor Detail

Waiting

Method Detail

waitForCondition

waitForCondition

waitForCondition

waitUntilPageContains

waitUntilPageContains

waitUntilPageContains

waitUntilPageNotContains

waitUntilPageNotContains

waitUntilPageNotContains

waitUntilPageContainsElement

waitUntilPageContainsElement

waitUntilPageContainsElement

waitUntilPageNotContainsElement

waitUntilPageNotContainsElement

waitUntilPageNotContainsElement

waitUntilElementIsVisible

waitUntilElementIsVisible

waitUntilElementIsVisible

waitUntilElementIsNotVisible

waitUntilElementIsNotVisible

waitUntilElementIsNotVisible

waitUntilElementIsClickable

waitUntilElementIsClickable

waitUntilElementIsClickable

waitUntilElementIsNotClickable

waitUntilElementIsNotClickable

waitUntilElementIsNotClickable

waitUntilElementIsSuccessfullyClicked

waitUntilElementIsSuccessfullyClicked

waitUntilElementIsSuccessfullyClicked

waitUntilElementIsSelected

waitUntilElementIsSelected

waitUntilElementIsSelected

waitUntilElementIsNotSelected

waitUntilElementIsNotSelected

waitUntilElementIsNotSelected

waitUntilTitleContains

waitUntilTitleContains

waitUntilTitleContains

waitUntilTitleNotContains

waitUntilTitleNotContains

waitUntilTitleNotContains

waitUntilTitleIs

waitUntilTitleIs

waitUntilTitleIs

waitUntilTitleIsNot

waitUntilTitleIsNot

waitUntilTitleIsNot

waitUntil