WebElementState (Serenity Core 3.1.0 API)

All Known Subinterfaces:

WebElementFacade, WebElementFacade, WebElementState, WidgetObject

All Known Implementing Classes:

WebElementFacadeImpl, WebElementFacadeImpl, WebElementFacadeStub, WidgetObjectImpl, WrappedWebElementFacadeImpl
```
public interface WebElementState
```
This interface is a way of presenting state information about a web element without exposing (too much) of the WebDriver API.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`containsOnlyText(String value)` Does this element exactly match given text?
`boolean`	`containsSelectOption(String value)` Does this dropdown contain the specified value.
`boolean`	`containsText(String value)` Does this element contain a given text?
`boolean`	`containsValue(String value)` Does this element contain a given value attribute?
`WebElementState`	`expect(String errorMessage)`
`String`	`getAttribute(String name)`
`String`	`getSelectedValue()`
`List<String>`	`getSelectedValues()`
`List<String>`	`getSelectedVisibleTexts()`
`String`	`getSelectedVisibleTextValue()`
`List<String>`	`getSelectOptions()`
`String`	`getText()`
`String`	`getTextValue()`
`String`	`getValue()`
`boolean`	`hasFocus()` Does this element currently have the focus.
`boolean`	`isClickable()`
`boolean`	`isCurrentlyEnabled()`
`boolean`	`isCurrentlyVisible()` Is this web element present and visible on the screen This method will not throw an exception if the element is not on the screen at all.
`boolean`	`isDisabled()`
`boolean`	`isEnabled()`
`boolean`	`isPresent()`
`boolean`	`isSelected()`
`boolean`	`isVisible()` Is this web element present and visible on the screen This method will not throw an exception if the element is not on the screen at all.
`WebElementState`	`shouldBeCurrentlyVisible()` Checks whether a web element is visible.
`WebElementState`	`shouldBeEnabled()`
`WebElementState`	`shouldBePresent()`
`WebElementState`	`shouldBeVisible()` Checks whether a web element is visible.
`WebElementState`	`shouldContainOnlyText(String textValue)` Check that an element exactly matches a text value
`WebElementState`	`shouldContainSelectedOption(String textValue)`
`WebElementState`	`shouldContainText(String textValue)` Check that an element contains a text value
`WebElementState`	`shouldNotBeCurrentlyVisible()` Checks whether a web element is not visible straight away.
`WebElementState`	`shouldNotBeEnabled()`
`WebElementState`	`shouldNotBePresent()`
`WebElementState`	`shouldNotBeVisible()` Checks whether a web element is not visible.
`WebElementState`	`shouldNotContainText(String textValue)` Check that an element does not contain a text value

- Method Detail
  - isVisible
```
boolean isVisible()
```
    Is this web element present and visible on the screen This method will not throw an exception if the element is not on the screen at all. If the element is not visible, the method will wait a bit to see if it appears later on.
  - isCurrentlyVisible
```
boolean isCurrentlyVisible()
```
    Is this web element present and visible on the screen This method will not throw an exception if the element is not on the screen at all. The method will fail immediately if the element is not visible on the screen. There is a little black magic going on here - the web element class will detect if it is being called by a method called "isCurrently*" and, if so, fail immediately without waiting as it would normally do.
  - isCurrentlyEnabled
```
boolean isCurrentlyEnabled()
```
  - shouldBeVisible
```
WebElementState shouldBeVisible()
```
    Checks whether a web element is visible. Throws an AssertionError if the element is not rendered.
  - shouldBeCurrentlyVisible
```
WebElementState shouldBeCurrentlyVisible()
```
    Checks whether a web element is visible. Throws an AssertionError if the element is not rendered.
  - shouldNotBeVisible
```
WebElementState shouldNotBeVisible()
```
    Checks whether a web element is not visible. Throws an AssertionError if the element is not rendered.
  - shouldNotBeCurrentlyVisible
```
WebElementState shouldNotBeCurrentlyVisible()
```
    Checks whether a web element is not visible straight away. Throws an AssertionError if the element is not rendered.
  - hasFocus
```
boolean hasFocus()
```
    Does this element currently have the focus.
  - containsText
```
boolean containsText(String value)
```
    Does this element contain a given text?
  - containsValue
```
boolean containsValue(String value)
```
    Does this element contain a given value attribute?
  - containsOnlyText
```
boolean containsOnlyText(String value)
```
    Does this element exactly match given text?
  - containsSelectOption
```
boolean containsSelectOption(String value)
```
    Does this dropdown contain the specified value.
  - shouldContainText
```
WebElementState shouldContainText(String textValue)
```
    Check that an element contains a text value
    
    Parameters:
    
    textValue -
  - shouldContainOnlyText
```
WebElementState shouldContainOnlyText(String textValue)
```
    Check that an element exactly matches a text value
    
    Parameters:
    
    textValue -
  - shouldContainSelectedOption
```
WebElementState shouldContainSelectedOption(String textValue)
```
  - shouldNotContainText
```
WebElementState shouldNotContainText(String textValue)
```
    Check that an element does not contain a text value
    
    Parameters:
    
    textValue -
  - shouldBeEnabled
```
WebElementState shouldBeEnabled()
```
  - isEnabled
```
boolean isEnabled()
```
  - isDisabled
```
boolean isDisabled()
```
  - shouldNotBeEnabled
```
WebElementState shouldNotBeEnabled()
```
  - getSelectedVisibleTextValue
```
String getSelectedVisibleTextValue()
```
  - getSelectedVisibleTexts
```
List<String> getSelectedVisibleTexts()
```
  - getSelectedValue
```
String getSelectedValue()
```
  - getSelectedValues
```
List<String> getSelectedValues()
```
  - getSelectOptions
```
List<String> getSelectOptions()
```
  - isPresent
```
boolean isPresent()
```
  - shouldBePresent
```
WebElementState shouldBePresent()
```
  - shouldNotBePresent
```
WebElementState shouldNotBePresent()
```
  - isSelected
```
boolean isSelected()
```
  - getTextValue
```
String getTextValue()
```
  - getValue
```
String getValue()
```
  - getText
```
String getText()
```
  - getAttribute
```
String getAttribute(String name)
```
  - expect
```
WebElementState expect(String errorMessage)
```
  - isClickable
```
boolean isClickable()
```

Interface WebElementState

Method Summary

Method Detail

isVisible

isCurrentlyVisible

isCurrentlyEnabled

shouldBeVisible

shouldBeCurrentlyVisible

shouldNotBeVisible

shouldNotBeCurrentlyVisible

hasFocus

containsText

containsValue

containsOnlyText

containsSelectOption

shouldContainText

shouldContainOnlyText

shouldContainSelectedOption

shouldNotContainText

shouldBeEnabled

isEnabled

isDisabled

shouldNotBeEnabled

getSelectedVisibleTextValue

getSelectedVisibleTexts

getSelectedValue

getSelectedValues

getSelectOptions

isPresent

shouldBePresent

shouldNotBePresent

isSelected

getTextValue

getValue

getText

getAttribute

expect

isClickable