Package allurium.carousels

Class Carousel

java.lang.Object

allurium.primitives.UIElement

allurium.AbstractWidget

allurium.carousels.AbstractCarousel

allurium.carousels.Carousel

All Implemented Interfaces:

AlluriumElement, ListComponent, WebElementMeta

public class Carousel
extends AbstractCarousel

Represents a concrete implementation of the AbstractCarousel class for image sliders or carousels.

The `Carousel` class encapsulates the behavior and structure of a carousel component with forward and backward navigation buttons. It extends the functionality provided by the base AbstractCarousel.

Features:

• Encapsulates the forward and backward navigation buttons as Button components.
• Implements the scrollForward() and scrollBackward() methods for navigation.
• Supports initialization with various locator and element types for flexibility.

Purpose:

• Provides a standardized implementation of a carousel component with dynamic navigation.
• Enhances testability and reusability of carousel components in UI automation.

Usage Example:

 Carousel imageCarousel = new Carousel(
     By.cssSelector(".carousel"),
     By.cssSelector(".next-button"),
     By.cssSelector(".back-button")
 );

 imageCarousel.scrollForward();  // Navigate to the next set of images.
 imageCarousel.scrollBackward(); // Navigate to the previous set of images.
 

Integration:

• Extends AbstractCarousel to inherit common carousel behaviors.
• Encapsulates navigation buttons as Button elements, annotated with Name for identification.
• Supports interaction through Selenium locators or SelenideElement instances.

See Also:

• AbstractCarousel
• Button

Field Summary

Fields

Modifier and Type	Field	Description
protected Button	buttonBack	The button used to scroll the carousel backward.
protected Button	buttonNext	The button used to scroll the carousel forward.

Fields inherited from class allurium.primitives.UIElement

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

Constructor Summary

Constructors

Constructor	Description
Carousel(com.codeborne.selenide.SelenideElement selenideRootElement, com.codeborne.selenide.SelenideElement buttonNextElement, com.codeborne.selenide.SelenideElement buttonBackLocator)	Constructor to initialize the carousel with SelenideElement instances for the root and navigation buttons.
Carousel(String selenideRootLocator, String buttonNextSelenideLocator, String buttonBackSelenideLocator)	Constructor to initialize the carousel with Selenide locator strings for the root and navigation buttons.
Carousel(org.openqa.selenium.By buttonNextLocator, org.openqa.selenium.By buttonBackLocator)	Constructor to initialize the carousel with Selenium By locators for navigation buttons.
Carousel(org.openqa.selenium.By rootLocator, org.openqa.selenium.By buttonNextLocator, org.openqa.selenium.By buttonBackLocator)	Constructor to initialize the carousel with Selenium By locators for the root and navigation buttons.

Method Summary

Modifier and Type	Method	Description
void	scrollBackward()	Scrolls the carousel backward by clicking the "Back" button.
void	scrollForward()	Scrolls the carousel forward by clicking the "Next" button.

Methods inherited from class allurium.AbstractWidget

getHeight, getRoot, getWidth, setRoot

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

Field Details

buttonNext

protected Button buttonNext

The button used to scroll the carousel forward.

buttonBack

protected Button buttonBack

The button used to scroll the carousel backward.

Constructor Details

Carousel

public Carousel(org.openqa.selenium.By buttonNextLocator,
 org.openqa.selenium.By buttonBackLocator)

Constructor to initialize the carousel with Selenium By locators for navigation buttons.

Parameters:

buttonNextLocator - the locator for the "Next" button

buttonBackLocator - the locator for the "Back" button

Carousel

public Carousel(org.openqa.selenium.By rootLocator,
 org.openqa.selenium.By buttonNextLocator,
 org.openqa.selenium.By buttonBackLocator)

Constructor to initialize the carousel with Selenium By locators for the root and navigation buttons.

Parameters:

rootLocator - the locator for the carousel's root element

buttonNextLocator - the locator for the "Next" button

buttonBackLocator - the locator for the "Back" button

Carousel

public Carousel(String selenideRootLocator,
 String buttonNextSelenideLocator,
 String buttonBackSelenideLocator)

Constructor to initialize the carousel with Selenide locator strings for the root and navigation buttons.

Parameters:

selenideRootLocator - the Selenide locator string for the carousel's root element

buttonNextSelenideLocator - the Selenide locator string for the "Next" button

buttonBackSelenideLocator - the Selenide locator string for the "Back" button

Carousel

public Carousel(com.codeborne.selenide.SelenideElement selenideRootElement,
 com.codeborne.selenide.SelenideElement buttonNextElement,
 com.codeborne.selenide.SelenideElement buttonBackLocator)

Constructor to initialize the carousel with SelenideElement instances for the root and navigation buttons.

Parameters:

selenideRootElement - the SelenideElement representing the carousel's root element

buttonNextElement - the SelenideElement representing the "Next" button

buttonBackLocator - the SelenideElement representing the "Back" button

Method Details

scrollForward

public void scrollForward()

Scrolls the carousel forward by clicking the "Next" button.

Specified by:

scrollForward in class AbstractCarousel

scrollBackward

public void scrollBackward()

Scrolls the carousel backward by clicking the "Back" button.

Specified by:

scrollBackward in class AbstractCarousel