Package allurium.inputs

Class TextField

java.lang.Object
allurium.primitives.UIElement
allurium.inputs.AbstractInputElement
allurium.inputs.TextField
All Implemented Interfaces:
AlluriumElement, InputElement, ListComponent, TextInputAsserts, WebElementMeta, Writable
Direct Known Subclasses:
AbstractRequiredTextField, TextArea
public class TextField extends AbstractInputElement implements Writable, TextInputAsserts
Represents a text input field in the UI, extending AbstractInputElement.

This class provides wrapper functionality for managing text input fields and logging each action as a step in Allure reports.

Features:

  • Typing, clearing, and retrieving text from input fields.
  • Assertions for input values, including checks for emptiness or specific values.
  • All actions are logged as Allure steps for enhanced reporting.

Example Usage:


 <html>
     <input type="text">
 </html>
 

 TextField textField = new TextField("input");
 textField.write("Hello World");
 textField.clear();

Purpose:

  • Encapsulates text input field behavior.
  • Standardizes interactions with input fields for consistency in tests.

  • Constructor Details

    • TextField

      public TextField()
      Default constructor. Initializes the element type as "input".

    • TextField

      public TextField(String selenideLocator)
      Constructor that initializes a text field using a Selenide locator string.
      Parameters:
      selenideLocator - the Selenide locator as a string

    • TextField

      public TextField(String selenideLocator, String name)
      Constructor that initializes a text field using a Selenide locator string and a name.
      Parameters:
      selenideLocator - the Selenide locator as a string
      name - the name of the text field

    • TextField

      public TextField(org.openqa.selenium.By locator)
      Constructor that initializes a text field using a Selenium By locator.
      Parameters:
      locator - the Selenium locator for the text field

    • TextField

      public TextField(org.openqa.selenium.By locator, String name)
      Constructor that initializes a text field using a Selenium By locator and a name.
      Parameters:
      locator - the Selenium locator for the text field
      name - the name of the text field

    • TextField

      public TextField(com.codeborne.selenide.SelenideElement selenideElement)
      Constructor that initializes a text field using a Selenide element.
      Parameters:
      selenideElement - the Selenide element representing the text field

    • TextField

      public TextField(com.codeborne.selenide.SelenideElement selenideElement, String name)
      Constructor that initializes a text field using a Selenide element and a name.
      Parameters:
      selenideElement - the Selenide element representing the text field
      name - the name of the text field

  • Method Details

    • $textField

      public static TextField $textField(org.openqa.selenium.By locator)
      Creates a text field instance using a Selenium By locator.
      Parameters:
      locator - the Selenium locator for the text field
      Returns:
      a new TextField instance

    • $textField

      public static TextField $textField(org.openqa.selenium.By locator, String name)
      Creates a text field instance using a Selenium By locator and a name.
      Parameters:
      locator - the Selenium locator for the text field
      name - the name of the text field
      Returns:
      a new TextField instance

    • $textField

      public static TextField $textField(com.codeborne.selenide.SelenideElement selenideElement)
      Creates a text field instance using a Selenide element.
      Parameters:
      selenideElement - the Selenide element representing the text field
      Returns:
      a new TextField instance

    • $textField

      public static TextField $textField(com.codeborne.selenide.SelenideElement selenideElement, String name)
      Creates a text field instance using a Selenide element and a name.
      Parameters:
      selenideElement - the Selenide element representing the text field
      name - the name of the text field
      Returns:
      a new TextField instance

    • $textField

      public static TextField $textField(String selenideLocator)
      Creates a text field instance using a Selenide locator string.
      Parameters:
      selenideLocator - the Selenide locator as a string
      Returns:
      a new TextField instance

    • $textField

      public static TextField $textField(String selenideLocator, String name)
      Creates a text field instance using a Selenide locator string and a name.
      Parameters:
      selenideLocator - the Selenide locator as a string
      name - the name of the text field
      Returns:
      a new TextField instance

    • _$textField

      public static TextField _$textField(String xpath)
      Creates a text field instance using an XPath string.
      Parameters:
      xpath - the XPath string for the text field
      Returns:
      a new TextField instance

    • write

      public void write(String text)
      Writes the specified text into the text field.

      Step: Processed by Aspect

      Specified by:
      write in interface Writable
      Parameters:
      text - the text to be typed into the text field

    • clearAndWrite

      public void clearAndWrite(String text)
      Clears the text field and writes the specified text.
      Parameters:
      text - the text to be typed after clearing the field

    • clear

      public void clear()
      Clears the text field.

      Step: Processed by Aspect

      Specified by:
      clear in interface Writable

    • value

      public String value()
      Retrieves the current value of the text field.
      Returns:
      the current value of the text field

    • pressEnter

      public void pressEnter()
      Simulates pressing the Enter key in the text field.

    • assertEmpty

      public void assertEmpty()
      Asserts that the text field is empty. = Step: Processed by Aspect =
      Specified by:
      assertEmpty in interface TextInputAsserts
      Overrides:
      assertEmpty in class UIElement

    • assertNotEmpty

      public void assertNotEmpty()
      Asserts that the text field is not empty.

      Step: Processed by Aspect

      Specified by:
      assertNotEmpty in interface TextInputAsserts

    • getId

      public String getId()
      Retrieves the unique identifier for the text field.
      Specified by:
      getId in interface ListComponent
      Overrides:
      getId in class UIElement
      Returns:
      the ID or name of the text field

    • assertCurrentValue

      public void assertCurrentValue(String value)
      Asserts that the current value of the text field matches the specified value.

      Step: Processed by Aspect

      Specified by:
      assertCurrentValue in interface TextInputAsserts
      Specified by:
      assertCurrentValue in interface Writable
      Parameters:
      value - the expected value

    • assertCurrentValueContains

      public void assertCurrentValueContains(String value)
      Asserts that the current value of the text field contains the specified substring.

      Step: Processed by Aspect

      Specified by:
      assertCurrentValueContains in interface TextInputAsserts
      Specified by:
      assertCurrentValueContains in interface Writable
      Parameters:
      value - the substring to check for