Package allurium.inputs

Class Select

java.lang.Object

allurium.primitives.UIElement

allurium.inputs.Select

All Implemented Interfaces:

AlluriumElement, ListComponent, Selectable, WebElementMeta

Direct Known Subclasses:

DropdownSelect

public class Select
extends UIElement
implements Selectable

Encapsulates interactions with a select menu (`` element) in a web application.

This class provides methods for selecting options, asserting the presence of options, and performing various selection-related operations. It integrates with Selenide for fluent, chainable interactions and supports Allure reporting for step-level visibility.

Features:

• Select options by visible text, index, or navigation (e.g., keyboard arrows).
• Supports additional selection behaviors using SelectOptions.
• Assert the presence or absence of specific options within the selectOptionsList.
• Support for selecting options while excluding specific values.
• Convenient factory methods for instantiating the class.

Purpose:

• Encapsulates and simplifies interactions with `

` elements in web pages.

Enhances readability and maintainability of tests through a unified interface.

Standardizes select menu interactions across different test cases.

Integrates seamlessly with Allure for comprehensive test reporting.

Usage Example:

 Select selectOptionsList = $select("#dropdown-list-class");
 selectOptionsList.select("Option 1");
 selectOptionsList.assertCurrentValue("Option 1");
 selectOptionsList.selectAnyBesides("Option 2");
 selectOptionsList.assertHasItem("Option 3");
 

Class Integration:

• Inherits from UIElement for shared behavior across web elements.
• Implements Selectable for standard select operations.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.codeborne.selenide.ElementsCollection	options	Collection of options within the options list.

Fields inherited from class allurium.primitives.UIElement

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Select()	Default constructor.
	Select(com.codeborne.selenide.SelenideElement selenideElement)	Constructor that initializes the select using a Selenide element.
	Select(String selenideLocator)	Constructor that initializes the select using a Selenide locator string.
	Select(org.openqa.selenium.By rootLocator)	Constructor that initializes the select using a Selenium By locator.

Method Summary

Modifier and Type	Method	Description
static Select	_$select(String xpath)
static Select	$select(com.codeborne.selenide.SelenideElement selenideElement)
static Select	$select(String selenideLocator)
static Select	$select(org.openqa.selenium.By locator)
void	assertCurrentValue(String value)	Asserts that the currently selected value in the select or dropdown list matches the expected value.
void	assertCurrentValueIsNot(String value)	Asserts that the currently selected value in the select or dropdown list does not match the given value.
void	assertHasItem(String item)	Asserts that the select or dropdown list contains a specific option by its visible text.
void	assertHasItems(List<String> items)	method is overridable
protected void	refreshOptions()	Refreshes the list of options within the options list.
void	select(int index)	Selects an option by its index.
void	select(int index, SelectOptions selectOptions)	Selects an option by its index with additional selection behavior.
void	select(String option)	Selects an option by its visible text.
void	select(String option, SelectOptions selectOptions)	Selects an option by its visible text with additional selection behavior.
void	selectAny()	Selects a random option from the selectOptionsList.
void	selectAnyBesides(String value)	Selects any option from the select or dropdown list except the one specified by its value.
void	selectByArrowsLeftAndRight(String text)	Selects an option by navigating using keyboard arrows.
void	selectFirst()	Selects the first available option.
void	selectLast()	Selects the last available option.

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, getId, 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, getUiElementName, setAssignNameMethod, setDescription, setParent, setUiElementName

Field Details

options

protected com.codeborne.selenide.ElementsCollection options

Collection of options within the options list.

Constructor Details

Select

protected Select()

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

Select

public Select(org.openqa.selenium.By rootLocator)

Constructor that initializes the select using a Selenium By locator.

Parameters:

rootLocator - the Selenium locator for the dropdown

Select

public Select(String selenideLocator)

Constructor that initializes the select using a Selenide locator string.

Parameters:

selenideLocator - the Selenide locator as a string

Select

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

Constructor that initializes the select using a Selenide element.

Parameters:

selenideElement - the Selenide element representing the dropdown

Method Details

$select

public static Select $select(org.openqa.selenium.By locator)

$select

public static Select $select(String selenideLocator)

$select

public static Select $select(com.codeborne.selenide.SelenideElement selenideElement)

_$select

public static Select _$select(String xpath)

refreshOptions

protected void refreshOptions()

Refreshes the list of options within the options list.

select

public void select(String option)

Selects an option by its visible text.

Step: Processed by Aspect

Specified by:

select in interface Selectable

Parameters:

option - the text of the option to select

select

public void select(String option,
 SelectOptions selectOptions)

Selects an option by its visible text with additional selection behavior.

Parameters:

option - the text of the option to select

selectOptions - additional selection behavior

select

public void select(int index)

Selects an option by its index.

Step: Processed by Aspect

Parameters:

index - the index of the option to select

select

public void select(int index,
 SelectOptions selectOptions)

Selects an option by its index with additional selection behavior.

Parameters:

index - the index of the option to select

selectOptions - additional selection behavior

selectByArrowsLeftAndRight

public void selectByArrowsLeftAndRight(String text)

Selects an option by navigating using keyboard arrows.

Step: Processed by Aspect

Parameters:

text - the text of the option to select

selectFirst

public void selectFirst()

Selects the first available option.

Step: Processed by Aspect

Specified by:

selectFirst in interface Selectable

selectLast

public void selectLast()

Selects the last available option.

Step: Processed by Aspect

Specified by:

selectLast in interface Selectable

selectAny

public void selectAny()

Selects a random option from the selectOptionsList.

Step: Processed by Aspect

Specified by:

selectAny in interface Selectable

selectAnyBesides

public void selectAnyBesides(String value)

Selects any option from the select or dropdown list except the one specified by its value.

This method filters the dropdown options to exclude the specified value and then selects the first available option that does not match.

Step: Processed by Aspect

Specified by:

selectAnyBesides in interface Selectable

Parameters:

value - the text of the option to exclude

Throws:

IllegalArgumentException - if no option besides the specified value exists

assertCurrentValue

public void assertCurrentValue(String value)

Asserts that the currently selected value in the select or dropdown list matches the expected value.

This method verifies the `value` attribute of the select element and ensures it matches the provided input.

Step: Processed by Aspect

Example Usage:

 Select selectOptionsList = new Select("select");
 selectOptionsList.assertSelectedValue("Expected Option");
 

Behavior:

• Throws an AssertionError if the selected value does not match the provided value.

Parameters:

value - the expected value to match

assertCurrentValueIsNot

public void assertCurrentValueIsNot(String value)

Asserts that the currently selected value in the select or dropdown list does not match the given value.

This method verifies the `value` attribute of the select element and ensures it is not equal to the provided input.

Step: Processed by Aspect

Example Usage:

 Select selectOptionsList = new Select("select");
 selectOptionsList.assertSelectedValueIsNot("Excluded Option");
 

Behavior:

• Throws an AssertionError if the selected value matches the provided value.

Parameters:

value - the value to ensure is not selected

assertHasItem

public void assertHasItem(String item)

Asserts that the select or dropdown list contains a specific option by its visible text.

This method checks the list of available options within the dropdown and verifies that the specified item exists.

Step: Processed by Aspect

Example Usage:

 Select selectOptionsList = new Select("select");
 selectOptionsList.assertHasItem("Option 1");
 

Behavior:

• Throws an AssertionError if the specified item is not found in the selectOptionsList.

Parameters:

item - the visible text of the option to verify

assertHasItems

public void assertHasItems(List<String> items)
                    throws Throwable

method is overridable

Step: Processed by Aspect

Parameters:

items -

Throws:

Throwable