Package allurium.primitives

Class Text

java.lang.Object

allurium.primitives.UIElement

allurium.primitives.Text

All Implemented Interfaces:

AlluriumElement, ListComponent, WebElementMeta

public class Text
extends UIElement

Represents a `Text` element in the UI, extending UIElement.

This class encapsulates the behavior and attributes of a text-based UI component, such as paragraphs, labels, or any element containing textual content.

Features:

• Encapsulates behavior and attributes of a `Text` element.
• Provides multiple constructors for flexible initialization using:
  • Selenide locators as strings
  • Selenium By locators
  • SelenideElement instances
• Includes static factory methods for convenient creation of `Text` instances.
• Overrides `toString` and `getId` methods to return the element's name.

Purpose:

• Standardizes interaction with text elements in the UI.
• Simplifies the creation and validation of text-based elements in tests.

Constructors:

• Text() - Default constructor.
• Text(String) - Creates a `Text` using a Selenide locator string.
• Text(String, String) - Creates a `Text` using a Selenide locator string and a name.
• Text(By) - Creates a `Text` using a Selenium By locator.
• Text(By, String) - Creates a `Text` using a Selenium By locator and a name.
• Text(SelenideElement) - Creates a `Text` using a SelenideElement.
• Text(SelenideElement, String) - Creates a `Text` using a SelenideElement and a name.

Static Factory Methods:

• $text(By) - Creates a `Text` using a Selenium By locator.
• $text(By, String) - Creates a `Text` using a Selenium By locator and a name.
• $text(SelenideElement) - Creates a `Text` using a SelenideElement.
• $text(SelenideElement, String) - Creates a `Text` using a SelenideElement and a name.
• $text(String) - Creates a `Text` using a Selenide locator string.
• $text(String, String) - Creates a `Text` using a Selenide locator string and a name.
• _$text(String) - Creates a `Text` using an XPath expression.

Usage Example:

 
 // Creating a text element using a Selenide locator
 Text textElement = $text(".text-class");

 // Creating a text element with a custom name
 Text namedText = $text(By.cssSelector(".text-class"), "Description");

 // Getting the text element's name or ID
 String textName = namedText.getId();
 
 

Field Summary

Fields inherited from class allurium.primitives.UIElement

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static Text	_$text(String xpath)
static Text	$text(com.codeborne.selenide.SelenideElement selenideElement)
static Text	$text(com.codeborne.selenide.SelenideElement selenideElement, String name)
static Text	$text(String selenideLocator)
static Text	$text(String selenideLocator, String name)
static Text	$text(org.openqa.selenium.By locator)
static Text	$text(org.openqa.selenium.By locator, String name)
String	getId()	Retrieves the unique identifier of the element.
String	toString()

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, 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

Text

public Text()

Default constructor. Initializes the element type as "text".

Text

public Text(String selenideLocator)

Constructor that initializes a `Text` element using a Selenide locator string.

Parameters:

selenideLocator - the Selenide locator as a string

Text

public Text(String selenideLocator,
 String name)

Constructor that initializes a `Text` element using a Selenide locator string and a name.

Parameters:

selenideLocator - the Selenide locator as a string

name - the name of the text element

Text

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

Constructor that initializes a `Text` element using a Selenium By locator.

Parameters:

locator - the Selenium locator for the text element

Text

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

Constructor that initializes a `Text` element using a Selenium By locator and a name.

Parameters:

locator - the Selenium locator for the text element

name - the name of the text element

Text

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

Constructor that initializes a `Text` element using a SelenideElement.

Parameters:

selenideElement - the Selenide element representing the text element

Text

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

Constructor that initializes a `Text` element using a SelenideElement and a name.

Parameters:

selenideElement - the Selenide element representing the text element

name - the name of the text element

Method Details

$text

public static Text $text(org.openqa.selenium.By locator)

$text

public static Text $text(org.openqa.selenium.By locator,
 String name)

$text

public static Text $text(com.codeborne.selenide.SelenideElement selenideElement)

$text

public static Text $text(com.codeborne.selenide.SelenideElement selenideElement,
 String name)

$text

public static Text $text(String selenideLocator)

$text

public static Text $text(String selenideLocator,
 String name)

_$text

public static Text _$text(String xpath)

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

Description copied from class: UIElement

Retrieves the unique identifier of the element.

Specified by:

getId in interface ListComponent

Overrides:

getId in class UIElement

Returns:

the ID if explicitly set; otherwise, the text content of the root element