Package allurium.primitives

Class Button

java.lang.Object

allurium.primitives.UIElement

allurium.inputs.AbstractInputElement

allurium.primitives.Button

All Implemented Interfaces:

AlluriumElement, InputElement, ListComponent, WebElementMeta

public class Button
extends AbstractInputElement

Represents a Button element in the UI, extending AbstractInputElement.

This class provides additional functionality specific to button elements, such as setting the element type to "button" and offering utility methods for creating button instances. It also includes helper methods to simplify interaction and assertions for button elements in tests.

Features:

• Sets the UI element type as "button" for easier identification.
• Supports convenient factory methods for instantiating button objects.
• Integrates with the AbstractInputElement functionality for input-related behavior.

Purpose:

• Encapsulates button-specific behavior for improved test readability and maintainability.
• Standardizes the creation and management of button elements in UI tests.

Usage Example:

 Button button = new Button("button.submit");
 button.click();
 button.assertEnabled();
 

Field Summary

Fields inherited from class allurium.primitives.UIElement

assignNameMethod, description, id, parent, root, stepsConsoleLoggingEnabled, stepsReportLoggingEnabled, uiElementName, uiElementType

Constructor Summary

Constructors

Constructor	Description
Button()	Default constructor.
Button(com.codeborne.selenide.SelenideElement selenideElement)	Constructor that initializes a button using a Selenide element.
Button(com.codeborne.selenide.SelenideElement selenideElement, String name)	Constructor that initializes a button using a Selenide element and a name.
Button(String selenideLocator)	Constructor that initializes a button using a Selenide locator string.
Button(String selenideLocator, String name)	Constructor that initializes a button using a Selenide locator string and a name.
Button(org.openqa.selenium.By locator)	Constructor that initializes a button using a Selenium By locator.
Button(org.openqa.selenium.By locator, String name)	Constructor that initializes a button using a Selenium By locator and a name.

Method Summary

Modifier and Type	Method	Description
static Button	_$button(String xpath)	Creates a button using an XPath string.
static Button	$button(com.codeborne.selenide.SelenideElement selenideElement)	Creates a button using a Selenide element.
static Button	$button(com.codeborne.selenide.SelenideElement selenideElement, String name)	Creates a button using a Selenide element and a name.
static Button	$button(String selenideLocator)	Creates a button using a Selenide locator string.
static Button	$button(String selenideLocator, String name)	Creates a button using a Selenide locator string and a name.
static Button	$button(org.openqa.selenium.By locator, String name)	Creates a button using a Selenium By locator and a name.
String	getId()	Retrieves the unique identifier for this button, which is its text.

Methods inherited from class allurium.inputs.AbstractInputElement

assertDisabled, assertEnabled, isDisabled

Methods inherited from class allurium.primitives.UIElement

_$uiElement, $uiElement, $uiElement, $uiElement, $uiElement, $uiElement, $uiElement, applyName, applyName, as, assertEmpty, assertEquals, assertExists, assertExists, assertHasCssClass, assertHasCssClass, assertHasNotCssClass, assertHasNotCssClass, assertHasNotCssClass, assertHasText, assertIsNotEmpty, assertNotExist, assertNotExist, assertNotVisible, assertNotVisible, assertNotVisible, assertText, assertVisible, assertVisible, assertVisible, assertVisible, assertVisibleInViewport, click, click, click, click, click, clickAndHold, clickAndHold, clickAndHold, contextClick, contextClick, contextClick, doubleClick, doubleClick, doubleClick, get, getAllureCompiledStep, getAttribute, getHeight, getStepText, getUiElementName, getWidth, hover, hover, hover, isDisplayed, logStep, logStepToReport, logStepToReport, scrollTo, scrollTo, scrollTo, setRoot, setRoot, text, verifyEmpty, verifyIsNotEmpty, wrappedName

Methods inherited from class java.lang.Object

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

Methods inherited from interface allurium.interfaces.AlluriumElement

getRoot

Methods inherited from interface allurium.interfaces.WebElementMeta

getDescription, getMetaKeys, getParent, setAssignNameMethod, setDescription, setParent, setUiElementName

Constructor Details

Button

public Button()

Default constructor. Initializes the button element type.

Button

public Button(String selenideLocator)

Constructor that initializes a button using a Selenide locator string.

Parameters:

selenideLocator - the Selenide locator as a string

Button

public Button(com.codeborne.selenide.SelenideElement selenideElement)

Constructor that initializes a button using a Selenide element.

Parameters:

selenideElement - the Selenide element representing the button

Button

public Button(org.openqa.selenium.By locator)

Constructor that initializes a button using a Selenium By locator.

Parameters:

locator - the Selenium locator for the button

Button

public Button(org.openqa.selenium.By locator,
 String name)

Constructor that initializes a button using a Selenium By locator and a name.

Parameters:

locator - the Selenium locator for the button

name - the name of the button

Button

public Button(com.codeborne.selenide.SelenideElement selenideElement,
 String name)

Constructor that initializes a button using a Selenide element and a name.

Parameters:

selenideElement - the Selenide element representing the button

name - the name of the button

Button

public Button(String selenideLocator,
 String name)

Constructor that initializes a button using a Selenide locator string and a name.

Parameters:

selenideLocator - the Selenide locator as a string

name - the name of the button

Method Details

$button

public static Button $button(org.openqa.selenium.By locator,
 String name)

Creates a button using a Selenium By locator and a name.

Parameters:

locator - the Selenium locator for the button

name - the name of the button

Returns:

a new Button instance

$button

public static Button $button(com.codeborne.selenide.SelenideElement selenideElement)

Creates a button using a Selenide element.

Parameters:

selenideElement - the Selenide element representing the button

Returns:

a new Button instance

$button

public static Button $button(com.codeborne.selenide.SelenideElement selenideElement,
 String name)

Creates a button using a Selenide element and a name.

Parameters:

selenideElement - the Selenide element representing the button

name - the name of the button

Returns:

a new Button instance

$button

public static Button $button(String selenideLocator)

Creates a button using a Selenide locator string.

Parameters:

selenideLocator - the Selenide locator as a string

Returns:

a new Button instance

$button

public static Button $button(String selenideLocator,
 String name)

Creates a button using a Selenide locator string and a name.

Parameters:

selenideLocator - the Selenide locator as a string

name - the name of the button

Returns:

a new Button instance

_$button

public static Button _$button(String xpath)

Creates a button using an XPath string.

Parameters:

xpath - the XPath string for the button

Returns:

a new Button instance

getId

public String getId()

Retrieves the unique identifier for this button, which is its text.

Specified by:

getId in interface ListComponent

Overrides:

getId in class UIElement

Returns:

the button's text as its unique identifier