Package allurium

Class AbstractWidget

java.lang.Object

allurium.primitives.UIElement

allurium.AbstractWidget

All Implemented Interfaces:

AlluriumElement, ListComponent, WebElementMeta

Direct Known Subclasses:

AbstractCarousel, AbstractForm, AbstractTabs, FakeParent, Iframe

public abstract class AbstractWidget
extends UIElement

Base class for creating composite UI components (widgets) by aggregating multiple UIElement elements or elements extended of UIElement elements.

The `AbstractWidget` class provides a foundation for defining complex UI components, such as forms, panels, or custom widgets, that are made up of multiple elements. It extends UIElement to inherit base element behavior while adding widget-specific functionalities.

Features:

• Provides a base for composite UI entities.
• Encapsulates the behavior of widgets with multiple sub-elements.
• Overrides element size methods to handle cases where a root element may not be initialized.

Purpose:

• Encapsulates the structure and behavior of composite UI components.
• Standardizes interaction with widgets in UI tests.

Usage Example:

 
 public class CustomWidget extends AbstractWidget {
     private final Button submitButton;
     private final TextField inputField;

     public CustomWidget(SelenideElement rootElement) {
         super(rootElement);
         submitButton = new Button(rootElement.$(".submit-button"));
         inputField = new TextField(rootElement.$(".input-field"));
     }

     public void submit(String input) {
         inputField.write(input);
         submitButton.click();
     }
 }
 
 

Constructors:

• AbstractWidget() - Default constructor.
• AbstractWidget(SelenideElement) - Initializes the widget with a SelenideElement root element.
• AbstractWidget(String) - Initializes the widget using a Selenide locator string.
• AbstractWidget(By) - Initializes the widget using a Selenium By locator.

Field Summary

Fields inherited from class allurium.primitives.UIElement

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

Constructor Summary

Constructors

Constructor	Description
AbstractWidget()	Default constructor.
AbstractWidget(com.codeborne.selenide.SelenideElement rootElement)	Constructor that initializes the widget using a SelenideElement.
AbstractWidget(String selenideLocator)	Constructor that initializes the widget using a Selenide locator string.
AbstractWidget(org.openqa.selenium.By locator)	Constructor that initializes the widget using a Selenium By locator.

Method Summary

Modifier and Type	Method	Description
int	getHeight()	Retrieves the height of the widget.
com.codeborne.selenide.SelenideElement	getRoot()	Retrieves the root element of the widget.
int	getWidth()	Retrieves the width of the widget.
void	setRoot(com.codeborne.selenide.SelenideElement root)	Sets the root element of the widget.

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, getId, getStepText, getUiElementName, hover, hover, hover, isDisplayed, logStep, logStepToReport, logStepToReport, scrollTo, scrollTo, scrollTo, 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.WebElementMeta

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

Constructor Details

AbstractWidget

public AbstractWidget()

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

AbstractWidget

public AbstractWidget(com.codeborne.selenide.SelenideElement rootElement)

Constructor that initializes the widget using a SelenideElement.

Parameters:

rootElement - the Selenide element representing the root of the widget

AbstractWidget

public AbstractWidget(String selenideLocator)

Constructor that initializes the widget using a Selenide locator string.

Parameters:

selenideLocator - the Selenide locator string for the root element

AbstractWidget

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

Constructor that initializes the widget using a Selenium By locator.

Parameters:

locator - the Selenium locator for the root element

Method Details

getWidth

public int getWidth()

Retrieves the width of the widget.

If the root element is not initialized, logs a warning and returns 0.

Overrides:

getWidth in class UIElement

Returns:

the width of the widget or 0 if the root element is not set

getHeight

public int getHeight()

Retrieves the height of the widget.

If the root element is not initialized, logs a warning and returns 0.

Overrides:

getHeight in class UIElement

Returns:

the height of the widget or 0 if the root element is not set

getRoot

public com.codeborne.selenide.SelenideElement getRoot()

Retrieves the root element of the widget.

If the root is not initialized, returns the `` element as a fallback.

Returns:

the root element of the widget or the `` element if the root is not set

setRoot

public void setRoot(com.codeborne.selenide.SelenideElement root)

Sets the root element of the widget.

Overrides:

setRoot in class UIElement

Parameters:

root - the Selenide element to set as the root of the widget