Package allurium.interfaces

Interface WebElementMeta

All Known Subinterfaces:
AlluriumElement, Dropdown, ListComponent, Selectable, SwitcherItem
All Known Implementing Classes:
AbstractCarousel, AbstractForm, AbstractInputElement, AbstractRequiredTextArea, AbstractRequiredTextField, AbstractSwitcher, AbstractTabs, AbstractWidget, Button, Carousel, Cell, CheckBox, DropdownSelect, FakeParent, Header, Icon, Iframe, Image, Label, Line, Link, ListItem, ListWC, MenuItem, Partition, RadioButton, Row, Select, Symbol, Tab, Text, TextArea, TextField, TextLine, Title, UIElement, UploadField, Value
public interface WebElementMeta
Interface defining metadata and hierarchical relationships for UI elements.

This interface allows setting and retrieving metadata about a UI element, such as its name, description, and hierarchical parent widget. It is typically implemented by UI elements to enable richer reporting and debugging.

Purpose:

  • Provides metadata about UI elements, including name, description, and parent relationships.
  • Enables structured and organized reporting for test automation frameworks.

Features:

  • Defines methods to set and get metadata like element name and description.
  • Supports hierarchical relationships between UI elements and their parent widgets.
  • Stores metadata keys for additional context or debugging information.

  • Method Details

    • setUiElementName

      void setUiElementName(String uiElementName)
      Sets the name of the UI element.
      Parameters:
      uiElementName - the name of the UI element

    • getUiElementName

      String getUiElementName()
      Gets the name of the UI element.
      Returns:
      the name of the UI element

    • setDescription

      void setDescription(String description)
      Sets the description of the UI element.
      Parameters:
      description - the description of the UI element

    • getDescription

      String getDescription()
      Gets the description of the UI element.
      Returns:
      the description of the UI element

    • setParent

      void setParent(Optional<AbstractWidget> parent)
      Sets the parent widget of the UI element.
      Parameters:
      parent - the parent widget wrapped in an Optional

    • getParent

      Optional<AbstractWidget> getParent()
      Gets the parent widget of the UI element.
      Returns:
      the parent widget wrapped in an Optional

    • setAssignNameMethod

      void setAssignNameMethod(String method)
      Sets the method used for assigning the element's name.
      Parameters:
      method - the method name

    • getMetaKeys

      StringBuffer getMetaKeys()
      Gets the metadata keys associated with the UI element.
      Returns:
      a StringBuffer containing the metadata keys