com.codeborne.selenide

Class Condition

java.lang.Object

com.codeborne.selenide.Condition

All Implemented Interfaces:

com.google.common.base.Predicate<org.openqa.selenium.WebElement>

public abstract class Condition
extends java.lang.Object
implements com.google.common.base.Predicate<org.openqa.selenium.WebElement>

Conditions to match web elements: checks for visibility, text etc.

Field Summary

Fields

Modifier and Type	Field and Description
static Condition	appear Synonym for visible - may be used for better readability
static Condition	appears Synonym for visible - may be used for better readability
static Condition	disabled Checks that element is disabled
static Condition	disappear Synonym for hidden - may be used for better readability:
static Condition	disappears Synonym for hidden - may be used for better readability:
static Condition	empty 1) For input element, check that value is missing or empty
static Condition	enabled Checks that element is not disabled
static Condition	exist Check if element exist.
static Condition	focused Check if browser focus is currently in given element.
static Condition	hidden Checks that element is not visible or does not exists.
protected java.lang.String	name
static Condition	notPresent Deprecated. Use method $.shouldNot(exist) or $.shouldNotBe(present).
protected boolean	nullIsAllowed
static Condition	options Deprecated. Not needed anymore. Use methods $.selectOption() or $.selectOptionByValue().
static Condition	present Check that element is present on the page.
static Condition	readonly Check if element has "readonly" attribute (with any value)
static Condition	selected Checks that element is selected
static Condition	visible Sample: $("input").shouldBe(visible);

Constructor Summary

Constructors

Constructor and Description
Condition(java.lang.String name)
Condition(java.lang.String name, boolean absentElementMatchesCondition)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	actualValue(org.openqa.selenium.WebElement element) If element didn't match the condition, returns the actual value of element.
static Condition	and(java.lang.String name, Condition... condition) Check if element matches ALL given conditions.
abstract boolean	apply(org.openqa.selenium.WebElement element) Check if given element matches this condition.
boolean	applyNull()
static Condition	attribute(java.lang.String attributeName) Check if element has given attribute (with any value)
static Condition	attribute(java.lang.String attributeName, java.lang.String expectedAttributeValue) Sample: $("#mydiv").shouldHave(attribute("fileId", "12345"));
static Condition	cssClass(java.lang.String cssClass) Sample: $("input").shouldHave(cssClass("active"));
static Condition	exactText(java.lang.String text) Sample: $("h1").shouldHave(exactText("Hello"))
static Condition	exactTextCaseSensitive(java.lang.String text) Sample: $("h1").shouldHave(exactTextCaseSensitive("Hello"))
static Condition	hasAttribute(java.lang.String attributeName, java.lang.String attributeValue) Sample: $("#mydiv").waitUntil(hasAttribute("fileId", "12345"), 7000);
static Condition	hasClass(java.lang.String cssClass) Sample: $("input").waitUntil(hasClass("blocked"), 7000);
static boolean	hasClass(org.openqa.selenium.WebElement element, java.lang.String cssClass)
static Condition	hasNotClass(java.lang.String cssClass) Deprecated. Use method $.shouldNotHave(cssClass("abc"))
static Condition	hasOptions() Deprecated.
static Condition	hasText(java.lang.String text) Sample: $("h1").waitUntil(hasText("Hello"), 10000)
static Condition	hasValue(java.lang.String value) Sample: $("#myInput").waitUntil(hasValue("John"), 5000)
static Condition	id(java.lang.String id) Sample: $("#input").shouldHave(id("myForm"))
static Condition	matchesText(java.lang.String text) Sample: $(".error_message").waitWhile(matchesText("Exception"), 12000)
static Condition	matchText(java.lang.String regex) Assert that given element's text matches given regular expression
static Condition	name(java.lang.String name) Sample: $("#input").shouldHave(name("username"))
static Condition	not(Condition condition) Negate given condition.
static Condition	or(java.lang.String name, Condition... condition) Check if element matches ANY of given conditions.
static Condition	text(java.lang.String text) Sample: $("h1").shouldHave(text("Hello\s*John"))
static Condition	textCaseSensitive(java.lang.String text) Sample: $("h1").shouldHave(textCaseSensitive("Hello\s*John"))
java.lang.String	toString()
static Condition	type(java.lang.String type) Sample: $("#input").shouldHave(type("checkbox"))
static Condition	value(java.lang.String value) Sample: $("#input").shouldHave(value("John"));

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.base.Predicate

equals

Field Detail

visible

public static final Condition visible

Sample: $("input").shouldBe(visible);

exist

public static final Condition exist

Check if element exist. It can be visible or hidden.

Sample: $("input").should(exist);

present

public static final Condition present

Check that element is present on the page. Synonym for exist.

Sample: $("input").shouldBe(present);

notPresent

@Deprecated
public static final Condition notPresent

Deprecated. Use method $.shouldNot(exist) or $.shouldNotBe(present).

Sample: $("input").should(notPresent);

hidden

public static final Condition hidden

Checks that element is not visible or does not exists. Opposite to appear

Sample: $("input").shouldBe(hidden);

appear

public static final Condition appear

Synonym for visible - may be used for better readability

Sample: $("#logoutLink").should(appear);

appears

public static final Condition appears

Synonym for visible - may be used for better readability

$("#logoutLink").waitUntil(appears, 10000);

Though the same can be done in a shorter way:

waitFor(By.id("logoutLink");

disappears

public static final Condition disappears

Synonym for hidden - may be used for better readability:

Sample: $("#loginLink").waitUntil(disappears, 9000);

disappear

public static final Condition disappear

Synonym for hidden - may be used for better readability:

$("#loginLink").should(disappear);

readonly

public static final Condition readonly

Check if element has "readonly" attribute (with any value)

Sample: $("input").shouldBe(readonly);

empty

public static final Condition empty

1) For input element, check that value is missing or empty

Sample: $("#input").shouldBe(empty)

2) For other elements, check that text is empty

Sample: $("h2").shouldBe(empty)

options

@Deprecated
public static final Condition options

Deprecated. Not needed anymore. Use methods $.selectOption() or $.selectOptionByValue().

Sample: $("input").shouldHave(options);

focused

public static final Condition focused

Check if browser focus is currently in given element.

enabled

public static final Condition enabled

Checks that element is not disabled

See Also:

WebElement.isEnabled()

disabled

public static final Condition disabled

Checks that element is disabled

See Also:

WebElement.isEnabled()

selected

public static final Condition selected

Checks that element is selected

See Also:

WebElement.isSelected()

name

protected final java.lang.String name

nullIsAllowed

protected final boolean nullIsAllowed

Constructor Detail

Condition

public Condition(java.lang.String name)

Condition

public Condition(java.lang.String name,
         boolean absentElementMatchesCondition)

Method Detail

hasAttribute

public static Condition hasAttribute(java.lang.String attributeName,
                     java.lang.String attributeValue)

Sample: $("#mydiv").waitUntil(hasAttribute("fileId", "12345"), 7000);

Parameters:

attributeName - name of attribute

attributeValue - expected value of attribute

attribute

public static Condition attribute(java.lang.String attributeName)

Check if element has given attribute (with any value)

Sample: $("#mydiv").shouldHave(attribute("fileId"));

Parameters:

attributeName - name of attribute, not null

Returns:

true iff attribute exists

attribute

public static Condition attribute(java.lang.String attributeName,
                  java.lang.String expectedAttributeValue)

Sample: $("#mydiv").shouldHave(attribute("fileId", "12345"));

Parameters:

attributeName - name of attribute

expectedAttributeValue - expected value of attribute

value

public static Condition value(java.lang.String value)

Sample: $("#input").shouldHave(value("John"));

Parameters:

value - expected value of input field

hasValue

public static Condition hasValue(java.lang.String value)

Sample: $("#myInput").waitUntil(hasValue("John"), 5000)

Parameters:

value - expected value of input field

name

public static Condition name(java.lang.String name)

Sample: $("#input").shouldHave(name("username"))

Parameters:

name - expected name of input field

type

public static Condition type(java.lang.String type)

Sample: $("#input").shouldHave(type("checkbox"))

Parameters:

type - expected type of input field

id

public static Condition id(java.lang.String id)

Sample: $("#input").shouldHave(id("myForm"))

Parameters:

id - expected id of input field

matchesText

public static Condition matchesText(java.lang.String text)

Sample: $(".error_message").waitWhile(matchesText("Exception"), 12000)

See Also:

matchText(String)

matchText

public static Condition matchText(java.lang.String regex)

Assert that given element's text matches given regular expression

Sample: $("h1").should(matchText("Hello\s*John"))

Parameters:

regex - e.g. Kicked.*Chuck Norris - in this case ".*" can contain any characters including spaces, tabs, CR etc.

hasText

public static Condition hasText(java.lang.String text)

Sample: $("h1").waitUntil(hasText("Hello"), 10000)

Case insensitive

NB! Ignores multiple whitespaces between words

Parameters:

text - expected text of HTML element

text

public static Condition text(java.lang.String text)

Sample: $("h1").shouldHave(text("Hello\s*John"))

NB! Case insensitive

NB! Ignores multiple whitespaces between words

Parameters:

text - expected text of HTML element

textCaseSensitive

public static Condition textCaseSensitive(java.lang.String text)

Sample: $("h1").shouldHave(textCaseSensitive("Hello\s*John"))

NB! Ignores multiple whitespaces between words

Parameters:

text - expected text of HTML element

exactText

public static Condition exactText(java.lang.String text)

Sample: $("h1").shouldHave(exactText("Hello"))

Case insensitive

NB! Ignores multiple whitespaces between words

Parameters:

text - expected text of HTML element

exactTextCaseSensitive

public static Condition exactTextCaseSensitive(java.lang.String text)

Sample: $("h1").shouldHave(exactTextCaseSensitive("Hello"))

NB! Ignores multiple whitespaces between words

Parameters:

text - expected text of HTML element

hasOptions

@Deprecated
public static Condition hasOptions()

Deprecated.

Sample: $("#my-select-box").waitUntil(hasOptions(), 7000);

See Also:

options

hasClass

public static boolean hasClass(org.openqa.selenium.WebElement element,
               java.lang.String cssClass)

cssClass

public static Condition cssClass(java.lang.String cssClass)

Sample: $("input").shouldHave(cssClass("active"));

hasClass

public static Condition hasClass(java.lang.String cssClass)

Sample: $("input").waitUntil(hasClass("blocked"), 7000);

hasNotClass

@Deprecated
public static Condition hasNotClass(java.lang.String cssClass)

Deprecated. Use method $.shouldNotHave(cssClass("abc"))

not

public static Condition not(Condition condition)

Negate given condition. Used for methods like $.shouldNot(exist), $.shouldNotBe(visible) Typically you don't need to use it.

and

public static Condition and(java.lang.String name,
            Condition... condition)

Check if element matches ALL given conditions.

Parameters:

name - Name of this condition, like "empty" (meaning e.g. empty text AND empty value).

condition - Conditions to match.

Returns:

logical AND for given conditions.

or

public static Condition or(java.lang.String name,
           Condition... condition)

Check if element matches ANY of given conditions.

Parameters:

name - Name of this condition, like "error" (meaning e.g. "error" OR "failed").

condition - Conditions to match.

Returns:

logical OR for given conditions.

apply

public abstract boolean apply(org.openqa.selenium.WebElement element)

Check if given element matches this condition.

Specified by:

apply in interface com.google.common.base.Predicate<org.openqa.selenium.WebElement>

Parameters:

element - given WebElement

Returns:

true if element matches condition

applyNull

public final boolean applyNull()

actualValue

public java.lang.String actualValue(org.openqa.selenium.WebElement element)

If element didn't match the condition, returns the actual value of element. Used in error reporting. Optional. Makes sense only if you need to add some additional important info to error message.

Parameters:

element - given WebElement

Returns:

any string that needs to be appended to error message.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object