org.pageobject.core.api

Element

abstract class Element extends AnyRef

Wrapper class for a Selenium WebElement. This class provides all possibilities on a WebElement which are also provided by Selenium. That contains information about the WebElement like its size, location or css style but also all user interactions like clicking, filling, submitting etc.

Apart from that there is a special WebElement class for a lot of different types of elements (the most common ones). If you are sure about the element type you want to access, you could use the approtiate case class like DateTimeField or TextField. Using these the locator of the element not only identifies it but also checks if the element's type is as expected. If you're unsure or your web site changes regularly, you could also use UntypedElement. In that case the check if the element found matches the expected type is left out.

This class provides idiomatic Scala access to the services of an underlying WebElement. You can access the wrapped WebElement via the underlying method.

Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractSel, Button, Checkbox, ColorField, DateField, DateTimeField, DateTimeLocalField, EmailField, HtmlElement, MonthField, MultiSel, NumberField, PasswordField, RadioButton, RangeField, SearchField, SingleSel, TelField, TextArea, TextField, TimeField, UntypedElement, UrlField, WeekField
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Element
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Element(typeDescription: String, checker: (WebElement) ⇒ Boolean)

Abstract Value Members

  1. abstract val factory: ElementFactory

    The factory returning the underlying WebElement wrapped by this Element

    The factory returning the underlying WebElement wrapped by this Element

    Attributes
    protected[org.pageobject]

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def attribute(name: String): Option[String]

    The attribute value of the given attribute name of this element, wrapped in a Some, or None if no such attribute exists on this Element.

    The attribute value of the given attribute name of this element, wrapped in a Some, or None if no such attribute exists on this Element.

    This method invokes getAttribute on the underlying WebElement, passing in the specified name.

    returns

    the attribute with the given name, wrapped in a Some, else None

  8. def clear(): Unit

    Clears this element.

  9. def click(): Unit

    Clicks this element.

  10. def clickAfterAnimation(duration: FiniteDuration, count: Int): Unit

    Clicks this element after animation has finished.

    Clicks this element after animation has finished.

    Detects the location of the Element to click and waits duration. After this the location is checked again. The click is only processed if the location and size was not modified. AssertionError is thrown otherwise.

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def css(name: String): Option[String]

    The value for the given css attribute of this element, wrapped in a Some, or None if no such css attribute exists on this Element.

    The value for the given css attribute of this element, wrapped in a Some, or None if no such css attribute exists on this Element.

    This method invokes getCssValue on the underlying WebElement, passing in the specified name.

    returns

    the attribute with the given name, wrapped in a Some, else None

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. def equals(other: Any): Boolean

    Returns the result of invoking equals on the underlying Element, passing in the specified other object.

    Returns the result of invoking equals on the underlying Element, passing in the specified other object.

    other

    the object with which to compare for equality

    returns

    true if the passed object is equal to this one

    Definition Classes
    Element → AnyRef → Any

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def hasFocus: Boolean

  18. def hashCode(): Int

    Returns the result of invoking hashCode on the underlying Element.

    Returns the result of invoking hashCode on the underlying Element.

    returns

    a hash code for this object

    Definition Classes
    Element → AnyRef → Any

  19. def isDisplayed: Boolean

    Indicates whether this Element is displayed.

    Indicates whether this Element is displayed.

    This invokes isDisplayed on the underlying WebElement.

    returns

    true if the element is currently displayed

  20. def isEnabled: Boolean

    Indicates whether this Element is enabled.

    Indicates whether this Element is enabled.

    This invokes isEnabled on the underlying WebElement, which will generally return true for everything but disabled input elements.

    returns

    true if the element is currently enabled

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. def isSelected: Boolean

    Indicates whether this Element is selected.

    Indicates whether this Element is selected.

    This method, which invokes isSelected on the underlying WebElement, is relevant only for input elements such as checkboxes, options in a single- or multiple-selection list box, and radio buttons. For any other element it will simply return false.

    returns

    true if the element is currently selected or checked

  23. def location: Point

    The XY location of the top-left corner of this Element.

    The XY location of the top-left corner of this Element.

    This invokes getLocation on the underlying WebElement.

    returns

    the location of the top-left corner of this element on the page

  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  27. def rect: Rect

    The XY location and width/height of this Element.

    The XY location and width/height of this Element.

    This invokes getRect on the underlying WebElement.

    returns

    the location and size of this element on the page

  28. def retry[T](retryOn: (Throwable) ⇒ Boolean*)(what: ⇒ T): T

    Attributes
    protected

  29. def sendKeys(value: String): Unit

    Send keys to the Element.

    Send keys to the Element.

    value

    the keys to send

  30. def size: Dimension

    The width/height size of this Element.

    The width/height size of this Element.

    This invokes getSize on the underlying WebElement.

    returns

    the size of the element on the page

  31. def submit(): Unit

    Submits the current form.

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  33. def tagName: String

    The tag name of this element.

    The tag name of this element.

    This method invokes getTagName on the underlying WebElement. Note it returns the name of the tag, not the value of the of the name attribute. For example, it will return will return "input" for the element <input name="city" />, not "city".

    returns

    the tag name of this element

  34. def text: String

    Returns the visible (i.e., not hidden by CSS) text of this element, including sub-elements, without any leading or trailing whitespace.

    Returns the visible (i.e., not hidden by CSS) text of this element, including sub-elements, without any leading or trailing whitespace.

    returns

    the visible text enclosed by this element, or an empty string, if the element encloses no visible text

  35. def toString(): String

    Returns the result of invoking toString on the underlying Element.

    Returns the result of invoking toString on the underlying Element.

    returns

    a string representation of this object

    Definition Classes
    Element → AnyRef → Any

  36. def underlying: WebElement

    Attributes
    protected[org.pageobject]

  37. def value: String

    Gets this field's value.

    Gets this field's value.

    This method invokes getAttribute("value") on the underlying WebElement.

    returns

    the field's value

  38. def value_=(value: String): Unit

    Sets this field's value.

    Sets this field's value.

    value

    the new value

  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. def webElement: WebElement

    webElement can be used to access the underlying selenium WebElement.

    webElement can be used to access the underlying selenium WebElement.

    returns

    the underlying WebElement

Inherited from AnyRef

Inherited from Any

Ungrouped