Package allurium.primitives

Class Image

java.lang.Object
allurium.primitives.UIElement
allurium.primitives.Image
All Implemented Interfaces:
AlluriumElement, ListComponent, WebElementMeta
public class Image extends UIElement
Represents an `Image` element in the UI, extending UIElement.

This class provides constructors and methods to initialize and interact with image elements, identified by locators or SelenideElement. It also supports dynamically setting and retrieving a custom ID or falling back to the `url` attribute.

Features:

  • Encapsulates behavior and attributes of an image element.
  • Provides multiple constructors for initialization using:
    • Selenide locators as strings
    • Selenium By locators
    • SelenideElement instances
  • Offers static factory methods for convenient creation of `Image` objects.
  • Supports setting and retrieving a custom ID for the image.
  • Falls back to the `url` attribute if no custom ID is set.

Purpose:

  • Standardizes the interaction with image elements in the UI.
  • Simplifies the creation of `Image` objects using various initialization methods.

Constructors:

Static Factory Methods:

Usage Example:

 
 // Creating an image using a Selenide locator
 Image image = $image("img.icon-class");

 // Creating an image using a Selenium locator and a custom name
 Image namedImage = $image(By.cssSelector(".image-class"), "Custom Image");

 // Asserting the image's source URL
  namedImage.assertSrcUrl("https://example.com/image.png");

  • Constructor Details

    • Image

      public Image()
      Default constructor. Initializes the element type as "image".

    • Image

      public Image(String selenideLocator)
      Constructor that initializes an `Image` using a Selenide locator string.
      Parameters:
      selenideLocator - the Selenide locator as a string

    • Image

      public Image(String selenideLocator, String name)
      Constructor that initializes an `Image` using a Selenide locator string and a name.
      Parameters:
      selenideLocator - the Selenide locator as a string
      name - the name of the image

    • Image

      public Image(org.openqa.selenium.By locator)
      Constructor that initializes an `Image` using a Selenium By locator.
      Parameters:
      locator - the Selenium locator for the image

    • Image

      public Image(org.openqa.selenium.By locator, String name)
      Constructor that initializes an `Image` using a Selenium By locator and a name.
      Parameters:
      locator - the Selenium locator for the image
      name - the name of the image

    • Image

      public Image(com.codeborne.selenide.SelenideElement selenideElement)
      Constructor that initializes an `Image` using a Selenide element.
      Parameters:
      selenideElement - the Selenide element representing the image

    • Image

      public Image(com.codeborne.selenide.SelenideElement selenideElement, String name)
      Constructor that initializes an `Image` using a Selenide element and a name.
      Parameters:
      selenideElement - the Selenide element representing the image
      name - the name of the image

  • Method Details

    • $image

      public static Image $image(org.openqa.selenium.By locator)

    • $image

      public static Image $image(org.openqa.selenium.By locator, String name)

    • $image

      public static Image $image(com.codeborne.selenide.SelenideElement selenideElement)

    • $image

      public static Image $image(com.codeborne.selenide.SelenideElement selenideElement, String name)

    • $image

      public static Image $image(String selenideLocator)

    • $image

      public static Image $image(String selenideLocator, String name)

    • _$image

      public static Image _$image(String xpath)

    • setId

      public void setId(Supplier<String> howToMakeId)
      Sets a custom ID for the image using a Supplier.

      This method allows you to dynamically generate and assign an ID to the image.

      Parameters:
      howToMakeId - a supplier function that provides the custom ID

    • getId

      public String getId()
      Retrieves the ID of the image.

      If a custom ID has been set using setId(Supplier), it will be returned. If no custom ID is set, the method falls back to the `url` attribute of the image element.

      Specified by:
      getId in interface ListComponent
      Overrides:
      getId in class UIElement
      Returns:
      the custom ID if set, otherwise the `url` attribute of the image

    • getSrcUrl

      public String getSrcUrl()
      Retrieves the source URL of the image.
      Returns:
      the `src` attribute of the image

    • assertSrcUrl

      public void assertSrcUrl(String srcUrl)
      Asserts that the image's source URL matches the expected value.
      Parameters:
      srcUrl - the expected source URL