Element

Instance Constructors

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

Type Members

type Duration = scala.concurrent.duration.Duration

Definition Classes
DurationDsl
type FiniteDuration = scala.concurrent.duration.FiniteDuration

Definition Classes
DurationDsl
type TimeUnit = java.util.concurrent.TimeUnit

Attributes
protected
Definition Classes
DurationDsl

Abstract Value Members

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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final val DAYS: java.util.concurrent.TimeUnit(DAYS)

Attributes
protected
Definition Classes
DurationDsl
final val HOURS: java.util.concurrent.TimeUnit(HOURS)

Attributes
protected
Definition Classes
DurationDsl
final val MICROSECONDS: java.util.concurrent.TimeUnit(MICROSECONDS)

Attributes
protected
Definition Classes
DurationDsl
final val MILLISECONDS: java.util.concurrent.TimeUnit(MILLISECONDS)

Attributes
protected
Definition Classes
DurationDsl
final val MINUTES: java.util.concurrent.TimeUnit(MINUTES)

Attributes
protected
Definition Classes
DurationDsl
final val NANOSECONDS: java.util.concurrent.TimeUnit(NANOSECONDS)

Attributes
protected
Definition Classes
DurationDsl
final val SECONDS: java.util.concurrent.TimeUnit(SECONDS)

Attributes
protected
Definition Classes
DurationDsl
final def asInstanceOf[T0]: T0

Definition Classes
Any
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
def clear(): Unit

Clears this element.
def click(): Unit

Clicks this element.
def clickAfterAnimation(patienceConfig: PatienceConfig): 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.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
def debug(msg: ⇒ String, throwable: ⇒ Throwable): Unit

Definition Classes
Logging
def debug(msg: ⇒ String): Unit

Definition Classes
Logging
implicit def doubleMult(d: Double): DoubleMult

Attributes
protected
Definition Classes
DurationDsl
implicit def durationDouble(n: Double): DurationConversions

Attributes
protected
Definition Classes
DurationDsl
implicit def durationInt(n: Int): DurationConversions

Attributes
protected
Definition Classes
DurationDsl
implicit def durationLong(n: Long): DurationConversions

Attributes
protected
Definition Classes
DurationDsl
implicit def durationToPair(d: Duration): (Long, TimeUnit)

Attributes
protected
Definition Classes
DurationDsl
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
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
def error(msg: ⇒ String, throwable: ⇒ Throwable): Unit

Definition Classes
Logging
def error(msg: ⇒ String): Unit

Definition Classes
Logging
def executeAsyncScript(script: String, args: AnyRef*)(implicit driver: WebDriver): Any

Executes an asynchronous piece of JavaScript in the context of the currently selected frame or window.
Executes an asynchronous piece of JavaScript in the context of the currently selected frame or window.
Unlike executing synchronous JavaScript, scripts executed with this method must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.
The first argument passed to the callback function will be used as the script's result. This value will be handled as follows:
- For an HTML element, this method returns a WebElement
- For a number, a Long is returned
- For a boolean, a Boolean is returned
- For all other cases, a String is returned
- For an array, return a List<Object> with each object following the rules above. We support nested lists
- Unless the value is null or there is no return value, in which null is returned
Script arguments must be a number, boolean, String, WebElement, or a List of any combination of these. An exception will be thrown if the arguments do not meet these criteria. The arguments will be made available to the JavaScript via the "arguments" variable. (Note that although this behavior is specified by Selenium's JavascriptExecutor Javadoc, it may still be possible for the underlying JavascriptExecutor implementation to return an objects of other types. For example, HtmlUnit has been observed to return a java.util.Map for a Javascript object.)
script
the JavaScript to execute
args
the arguments to the script, may be empty
returns
One of Boolean, Long, String, List, WebElement, or null (following Selenium's JavascriptExecutor Javadoc)

Attributes
protected
Definition Classes
ScriptDsl
def executeScript[T](script: String, args: AnyRef*)(implicit driver: WebDriver): Any

Executes JavaScript in the context of the currently selected frame or window.
Executes JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.
Within the script, you can use document to refer to the current document. Local variables will not be available once the script has finished executing, but global variables will.
To return a value (e.g. if the script contains a return statement), then the following steps will be taken:
- For an HTML element, this method returns a WebElement
- For a decimal, a Double is returned
- For a non-decimal number, a Long is returned
- For a boolean, a Boolean is returned
- For all other cases, a String is returned
- For an array, return a List<Object> with each object following the rules above. We support nested lists
- Unless the value is null or there is no return value, in which null is returned
Script arguments must be a number, boolean, String, WebElement, or a List of any combination of these. An exception will be thrown if the arguments do not meet these criteria. The arguments will be made available to the JavaScript via the "arguments" variable. (Note that although this behavior is specified by Selenium's JavascriptExecutor Javadoc, it may still be possible for the underlying JavascriptExecutor implementation to return an objects of other types. For example, HtmlUnit has been observed to return a java.util.Map for a Javascript object.)
script
the JavaScript to execute
args
the arguments to the script, may be empty
returns
One of Boolean, Long, String, List or WebElement. Or null (following Selenium's JavascriptExecutor Javadoc)

Attributes
protected
Definition Classes
ScriptDsl
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final val fromNow: scala.concurrent.duration.fromNow.type

Attributes
protected
Definition Classes
DurationDsl
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasFocus: Boolean
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
def info(msg: ⇒ String, throwable: ⇒ Throwable): Unit

Definition Classes
Logging
def info(msg: ⇒ String): Unit

Definition Classes
Logging
implicit def intMult(i: Int): IntMult

Attributes
protected
Definition Classes
DurationDsl
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
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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
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
def log(level: LogLevel, msg: ⇒ String, throwable: ⇒ Throwable): Unit

Definition Classes
Logging
def log(level: LogLevel, msg: ⇒ String): Unit

Definition Classes
Logging
implicit def longMult(l: Long): LongMult

Attributes
protected
Definition Classes
DurationDsl
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit def pairIntToDuration(p: (Int, TimeUnit)): Duration

Attributes
protected
Definition Classes
DurationDsl
implicit def pairLongToDuration(p: (Long, TimeUnit)): FiniteDuration

Attributes
protected
Definition Classes
DurationDsl
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
def retry[T](description: String, retryOn: (Throwable) ⇒ Boolean*)(what: ⇒ T): T

Attributes
protected
def scrollIntoView(offset: Int = 0): Unit

scroll the element into the view
def sendKeys(value: String): Unit

Send keys to the Element.
Send keys to the Element.
value
the keys to send
def setScriptTimeout(timeout: scala.concurrent.duration.FiniteDuration)(implicit driver: WebDriver): Unit

Sets the amount of time to wait for an asynchronous script to finish execution before throwing an exception.
Sets the amount of time to wait for an asynchronous script to finish execution before throwing an exception.
timeout
the amount of time to wait for an asynchronous script to finish execution before throwing exception

Attributes
protected
Definition Classes
ScriptDsl
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
final val span: scala.concurrent.duration.span.type

Attributes
protected
Definition Classes
DurationDsl
def submit(): Unit

Submits the current form.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
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
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
def trace(msg: ⇒ String, throwable: ⇒ Throwable): Unit

Definition Classes
Logging
def trace(msg: ⇒ String): Unit

Definition Classes
Logging
def underlying: WebElement

Attributes
protected[org.pageobject]
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
def value_=(value: String): Unit

Sets this field's value.
Sets this field's value.
value
the new value
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def waitFor[T](description: String, config: PatienceConfig)(fun: ⇒ T): T

Attributes
protected
Definition Classes
WaitFor
def waitFor[T](description: String, timeout: FiniteDuration, interval: FiniteDuration)(fun: ⇒ T): T

Attributes
protected
Definition Classes
WaitFor
def warn(msg: ⇒ String, throwable: ⇒ Throwable): Unit

Definition Classes
Logging
def warn(msg: ⇒ String): Unit

Definition Classes
Logging
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
def withPatience[T](map: PatienceMap)(fun: ⇒ T): T

Attributes
protected
Definition Classes
WaitFor
def withPatience[T](config: (PatienceConfig, PatienceConfig)*)(fun: ⇒ T): T

Attributes
protected
Definition Classes
WaitFor

Related Doc: package api

abstract class Element extends Logging with WaitFor with ScriptDsl

Instance Constructors

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

Type Members

type Duration = scala.concurrent.duration.Duration

type FiniteDuration = scala.concurrent.duration.FiniteDuration

type TimeUnit = java.util.concurrent.TimeUnit

Abstract Value Members

abstract val factory: ElementFactory

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final val DAYS: java.util.concurrent.TimeUnit(DAYS)

final val HOURS: java.util.concurrent.TimeUnit(HOURS)

final val MICROSECONDS: java.util.concurrent.TimeUnit(MICROSECONDS)

final val MILLISECONDS: java.util.concurrent.TimeUnit(MILLISECONDS)

final val MINUTES: java.util.concurrent.TimeUnit(MINUTES)

final val NANOSECONDS: java.util.concurrent.TimeUnit(NANOSECONDS)

final val SECONDS: java.util.concurrent.TimeUnit(SECONDS)

final def asInstanceOf[T0]: T0

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

def clear(): Unit

def click(): Unit

def clickAfterAnimation(patienceConfig: PatienceConfig): Unit

def clone(): AnyRef

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

def debug(msg: ⇒ String, throwable: ⇒ Throwable): Unit

def debug(msg: ⇒ String): Unit

implicit def doubleMult(d: Double): DoubleMult

implicit def durationDouble(n: Double): DurationConversions

implicit def durationInt(n: Int): DurationConversions

implicit def durationLong(n: Long): DurationConversions

implicit def durationToPair(d: Duration): (Long, TimeUnit)

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def error(msg: ⇒ String, throwable: ⇒ Throwable): Unit

def error(msg: ⇒ String): Unit

def executeAsyncScript(script: String, args: AnyRef*)(implicit driver: WebDriver): Any

def executeScript[T](script: String, args: AnyRef*)(implicit driver: WebDriver): Any

def finalize(): Unit

final val fromNow: scala.concurrent.duration.fromNow.type

final def getClass(): Class[_]

def hasFocus: Boolean

def hashCode(): Int

def info(msg: ⇒ String, throwable: ⇒ Throwable): Unit

def info(msg: ⇒ String): Unit

implicit def intMult(i: Int): IntMult

def isDisplayed: Boolean

def isEnabled: Boolean

final def isInstanceOf[T0]: Boolean

def isSelected: Boolean

def location: Point

def log(level: LogLevel, msg: ⇒ String, throwable: ⇒ Throwable): Unit

def log(level: LogLevel, msg: ⇒ String): Unit

implicit def longMult(l: Long): LongMult

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def pairIntToDuration(p: (Int, TimeUnit)): Duration

implicit def pairLongToDuration(p: (Long, TimeUnit)): FiniteDuration

def rect: Rect

def retry[T](description: String, retryOn: (Throwable) ⇒ Boolean*)(what: ⇒ T): T

def scrollIntoView(offset: Int = 0): Unit

def sendKeys(value: String): Unit

def setScriptTimeout(timeout: scala.concurrent.duration.FiniteDuration)(implicit driver: WebDriver): Unit

def size: Dimension

final val span: scala.concurrent.duration.span.type

def submit(): Unit

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

def tagName: String

def text: String

def toString(): String

def trace(msg: ⇒ String, throwable: ⇒ Throwable): Unit

def trace(msg: ⇒ String): Unit

def underlying: WebElement

def value: String

def value_=(value: String): Unit