Module com.serenitybdd.serenityscreenplaywebdriver

Package net.serenitybdd.screenplay.ui

Class Button

java.lang.Object

net.serenitybdd.screenplay.ui.Button

public class Button
extends Object

An HTML element representing a button. This element will match an HTML button element containing the specified text, or a button-styled input field with a matching value, id or data-test attribute.

Constructor Summary

Constructors

Constructor	Description
Button()

Method Summary

Modifier and Type	Method	Description
static SearchableTarget	containingText(String text)	Locate an element that contains a specified text value in its body.
static SearchableTarget	located(org.openqa.selenium.By selector)
static SearchableTarget	locatedBy(String selector)	Locate a button using an arbitrary CSS or XPath expression
static SearchableTarget	withAriaLabel(String name)	Locate a button using the ARIA label value
static SearchableTarget	withCSSClass(String className)	Look for an element with a given CSS class
static SearchableTarget	withIcon(String icon)	A button containing an icon
static SearchableTarget	withLabel(String labelText)	Locate a button using an HTML Label value
static SearchableTarget	withLocalisedLabelFor(String name)	Locate a button using an internationalised element.
static SearchableTarget	withNameOrId(String nameOrId)	Locate a button element with a given id, name or aria-label.
static SearchableTarget	withText(String name)	Locate a button element with a given text.

Methods inherited from class java.lang.Object

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

Constructor Details

Button

public Button()

Method Details

withText

public static SearchableTarget withText(String name)

Locate a button element with a given text.

withNameOrId

public static SearchableTarget withNameOrId(String nameOrId)

Locate a button element with a given id, name or aria-label.

withLocalisedLabelFor

public static SearchableTarget withLocalisedLabelFor(String name)

Locate a button using an internationalised element. Internationalised elements are defined in the serenity.conf file in the i8n section, e.g.

locale = fr i8n { "Search" { en: "Search" fr: "Recherche" } "Sign Up" { en: "Sign Up" fr: "Se connecter" } }

withLabel

public static SearchableTarget withLabel(String labelText)

Locate a button using an HTML Label value

withAriaLabel

public static SearchableTarget withAriaLabel(String name)

Locate a button using the ARIA label value

withIcon

public static SearchableTarget withIcon(String icon)

A button containing an icon

withCSSClass

public static SearchableTarget withCSSClass(String className)

Look for an element with a given CSS class

containingText

public static SearchableTarget containingText(String text)

Locate an element that contains a specified text value in its body. This will not include text that is contained in nested elements.

locatedBy

public static SearchableTarget locatedBy(String selector)

Locate a button using an arbitrary CSS or XPath expression

located

public static SearchableTarget located(org.openqa.selenium.By selector)