Package io.karatelabs.driver

Class BaseElement

java.lang.Object

io.karatelabs.driver.BaseElement

All Implemented Interfaces:

Element, io.karatelabs.js.ObjectLike, io.karatelabs.js.SimpleObject

Direct Known Subclasses:

MissingElement, W3cElement

public class BaseElement
extends Object
implements Element

Locator-based Element implementation that delegates all operations to a Driver. This is the default implementation used by all backends (CDP, W3C WebDriver, etc.). Operations are performed by passing the locator to the Driver, which handles backend-specific execution (JS eval for CDP, HTTP calls for W3C, etc.).

See Also:

• Element
• Driver

Field Summary

Fields

Modifier and Type	Field	Description
protected final Driver	driver
protected final boolean	exists
protected final String	locator

Fields inherited from interface io.karatelabs.js.SimpleObject

logger, TO_STRING

Constructor Summary

Constructors

Constructor	Description
BaseElement(Driver driver, String locator, boolean exists)

Method Summary

Modifier and Type	Method	Description
protected void	assertExists()	Guard run before every operation that needs the element in the page.
String	attribute(String name)
Element	clear()
Element	click()
Element	closest(String selector)	The closest ancestor (or self) matching the given CSS selector.
boolean	enabled()
static BaseElement	existing(Driver driver, String locator)	Construct an Element whose existence has already been verified by the caller.
boolean	exists()
Element	focus()
String	getLocator()
Element	highlight()
String	html()
String	innerHtml()
Element	input(String value)
Element	inputFile(String... files)
boolean	isPresent()
protected static boolean	isPureJsLocator(String locator)	A pure-JS locator is a JS expression that evaluates to an element at runtime — produced by closest(String) and anything else routing through Locators.wrapInFunctionInvoke(java.lang.String).
Object	jsGet(String name)	JS members follow the Java API: every operation is a method (exists(), text(), click()).
Element	locate(String childLocator)
List<Element>	locateAll(String childLocator)
boolean	matches(String selector)	Whether this element matches the given CSS selector.
static BaseElement	of(Driver driver, String locator)
static BaseElement	optional(Driver driver, String locator)
Map<String,Object>	position()
Map<String,Object>	position(boolean relative)
Object	property(String name)
Element	retry()
Element	retry(int count)
Element	retry(int count, int interval)
Object	script(String expression)
Element	scroll()
Element	select(int index)
Element	select(String text)
Element	submit()
String	text()
String	toString()
String	value()
Element	value(String value)
Element	waitFor()
Element	waitForEnabled()
Element	waitForText(String expected)
Element	waitUntil(String expression)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.karatelabs.js.ObjectLike

getMember, getPrototype, isExtensible, isFrozen, isOwnProperty, isSealed, putMember, removeMember, setExtensible, setFrozen, setSealed

Methods inherited from interface io.karatelabs.js.SimpleObject

getMember, jsKeys, jsToString, putMember, removeMember, toMap

Field Details

driver

protected final Driver driver

locator

protected final String locator

exists

protected final boolean exists

Constructor Details

BaseElement

public BaseElement(Driver driver,
 String locator,
 boolean exists)

Method Details

of

public static BaseElement of(Driver driver,
 String locator)

optional

public static BaseElement optional(Driver driver,
 String locator)

existing

public static BaseElement existing(Driver driver,
 String locator)

Construct an Element whose existence has already been verified by the caller. Skips the exists() round-trip, which also avoids re-entering the driver at a moment when it may be unable to evaluate JS — e.g. after click() opened a blocking alert/confirm/prompt dialog.

exists

public boolean exists()

Specified by:

exists in interface Element

isPresent

public boolean isPresent()

Specified by:

isPresent in interface Element

getLocator

public String getLocator()

Specified by:

getLocator in interface Element

text

public String text()

Specified by:

text in interface Element

html

public String html()

Specified by:

html in interface Element

innerHtml

public String innerHtml()

Specified by:

innerHtml in interface Element

value

public String value()

Specified by:

value in interface Element

attribute

public String attribute(String name)

Specified by:

attribute in interface Element

property

public Object property(String name)

Specified by:

property in interface Element

enabled

public boolean enabled()

Specified by:

enabled in interface Element

position

public Map<String,Object> position()

Specified by:

position in interface Element

position

public Map<String,Object> position(boolean relative)

Specified by:

position in interface Element

click

public Element click()

Specified by:

click in interface Element

focus

public Element focus()

Specified by:

focus in interface Element

clear

public Element clear()

Specified by:

clear in interface Element

input

public Element input(String value)

Specified by:

input in interface Element

inputFile

public Element inputFile(String... files)

Specified by:

inputFile in interface Element

value

public Element value(String value)

Specified by:

value in interface Element

select

public Element select(String text)

Specified by:

select in interface Element

select

public Element select(int index)

Specified by:

select in interface Element

scroll

public Element scroll()

Specified by:

scroll in interface Element

highlight

public Element highlight()

Specified by:

highlight in interface Element

submit

public Element submit()

Specified by:

submit in interface Element

locate

public Element locate(String childLocator)

Specified by:

locate in interface Element

locateAll

public List<Element> locateAll(String childLocator)

Specified by:

locateAll in interface Element

isPureJsLocator

protected static boolean isPureJsLocator(String locator)

A pure-JS locator is a JS expression that evaluates to an element at runtime — produced by closest(String) and anything else routing through Locators.wrapInFunctionInvoke(java.lang.String). Distinguished from XPath (which starts with (//) and from wildcard/CSS.

closest

public Element closest(String selector)

Description copied from interface: Element

The closest ancestor (or self) matching the given CSS selector. Mirrors the native Element.closest() DOM API — robust to markup shuffling, preferred over counting parent hops.

Specified by:

closest in interface Element

matches

public boolean matches(String selector)

Description copied from interface: Element

Whether this element matches the given CSS selector. Mirrors the native Element.matches() DOM API.

Specified by:

matches in interface Element

script

public Object script(String expression)

Specified by:

script in interface Element

waitFor

public Element waitFor()

Specified by:

waitFor in interface Element

waitForText

public Element waitForText(String expected)

Specified by:

waitForText in interface Element

waitForEnabled

public Element waitForEnabled()

Specified by:

waitForEnabled in interface Element

waitUntil

public Element waitUntil(String expression)

Specified by:

waitUntil in interface Element

retry

public Element retry()

Specified by:

retry in interface Element

retry

public Element retry(int count)

Specified by:

retry in interface Element

retry

public Element retry(int count,
 int interval)

Specified by:

retry in interface Element

jsGet

public Object jsGet(String name)

JS members follow the Java API: every operation is a method (exists(), text(), click()). The one property is present, the v1 idiom for optional(locator).present — as a callable it would be truthy even for a missing element.

Specified by:

jsGet in interface io.karatelabs.js.SimpleObject

assertExists

protected void assertExists()

Guard run before every operation that needs the element in the page. The snapshot taken at lookup decides; BaseElement.RetryElement waits instead.

toString

public String toString()

Overrides:

toString in class Object