org.fluentlenium.core.domain.FluentWebElement Maven / Gradle / Ivy
package org.fluentlenium.core.domain;
import io.appium.java_client.AppiumDriver;
import org.fluentlenium.core.FluentControl;
import org.fluentlenium.core.FluentPage;
import org.fluentlenium.core.SeleniumDriverControl;
import org.fluentlenium.core.action.*;
import org.fluentlenium.core.alert.Alert;
import org.fluentlenium.core.alert.AlertControl;
import org.fluentlenium.core.capabilities.CapabilitiesControl;
import org.fluentlenium.core.components.ComponentInstantiator;
import org.fluentlenium.core.conditions.FluentConditions;
import org.fluentlenium.core.conditions.WebElementConditions;
import org.fluentlenium.core.css.CssControl;
import org.fluentlenium.core.css.CssSupport;
import org.fluentlenium.core.dom.Dom;
import org.fluentlenium.core.events.EventsControl;
import org.fluentlenium.core.events.EventsRegistry;
import org.fluentlenium.core.hook.FluentHook;
import org.fluentlenium.core.hook.HookControl;
import org.fluentlenium.core.hook.HookControlImpl;
import org.fluentlenium.core.hook.HookDefinition;
import org.fluentlenium.core.inject.ContainerContext;
import org.fluentlenium.core.inject.FluentInjectControl;
import org.fluentlenium.core.label.FluentLabel;
import org.fluentlenium.core.label.FluentLabelImpl;
import org.fluentlenium.core.navigation.NavigationControl;
import org.fluentlenium.core.proxy.FluentProxyState;
import org.fluentlenium.core.proxy.LocatorHandler;
import org.fluentlenium.core.proxy.LocatorProxies;
import org.fluentlenium.core.script.FluentJavascript;
import org.fluentlenium.core.script.JavascriptControl;
import org.fluentlenium.core.search.Search;
import org.fluentlenium.core.search.SearchControl;
import org.fluentlenium.core.search.SearchFilter;
import org.fluentlenium.core.snapshot.SnapshotControl;
import org.fluentlenium.core.wait.FluentWaitElement;
import org.fluentlenium.utils.SupplierOfInstance;
import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.*;
import org.openqa.selenium.support.pagefactory.ElementLocator;
import org.openqa.selenium.support.ui.ExpectedConditions;
import java.time.Duration;
import java.util.*;
import java.util.function.Function;
/**
* Wraps a Selenium {@link WebElement}. It provides an enhanced API to control selenium element.
*/
@SuppressWarnings({"PMD.GodClass", "PMD.ExcessivePublicCount"})
public class FluentWebElement extends Component
implements WrapsElement, FluentActions, FluentProxyState,
SearchControl, HookControl, FluentLabel,
NavigationControl, JavascriptControl, AlertControl, SnapshotControl, EventsControl, SeleniumDriverControl,
CssControl, FluentInjectControl, CapabilitiesControl, ComponentInstantiator {
private final Search search;
private final Dom dom;
private final MouseElementActions mouseActions;
private final KeyboardElementActions keyboardActions;
private final WebElementConditions conditions;
private final HookControlImpl hookControl;
private final FluentLabel label;
private final FluentJavascriptActionsImpl javascriptActions;
/**
* Creates a new fluent web element.
*
* @param element underlying element
* @param control control interface
* @param instantiator component instantiator
*/
public FluentWebElement(WebElement element, FluentControl control, ComponentInstantiator instantiator) {
super(element, control, instantiator);
hookControl = new HookControlImpl<>(this, webElement, this.control, this.instantiator,
/*do not change it to lambda - change will affect w/ PMD warning
Overridable method 'getElement' called during object construction*/
() -> {
LocatorHandler locatorHandler = LocatorProxies.getLocatorHandler(getElement());
ElementLocator locator = locatorHandler.getLocator();
WebElement noHookElement = LocatorProxies.createWebElement(locator);
return control.newComponent(this.getClass(), noHookElement);
});
search = new Search(element, this, this.instantiator, this.control);
dom = new Dom(element, this.instantiator);
mouseActions = new MouseElementActions(this.control.getDriver(), element);
keyboardActions = new KeyboardElementActions(this.control.getDriver(), element);
conditions = new WebElementConditions(this);
label = new FluentLabelImpl<>(this, () -> getElement().toString());
javascriptActions = new FluentJavascriptActionsImpl<>(this, this.control, new SupplierOfInstance<>(this));
}
private HookControl getHookControl() { // NOPMD UnusedPrivateMethod
return hookControl;
}
private FluentJavascriptActionsImpl getJavascriptActions() { //NOPMD UnusedPrivateMethod
return javascriptActions;
}
public FluentLabel getLabel() {
return label;
}
@Override
public FluentJavascript executeScript(String script, Object... args) {
return control.executeScript(script, args);
}
@Override
public FluentJavascript executeAsyncScript(String script, Object... args) {
return control.executeAsyncScript(script, args);
}
@Override
public Alert alert() {
return control.alert();
}
@Override
public void takeHtmlDump() {
control.takeHtmlDump();
}
@Override
public void takeHtmlDump(String fileName) {
control.takeHtmlDump(fileName);
}
@Override
public boolean canTakeScreenShot() {
return control.canTakeScreenShot();
}
@Override
public void takeScreenshot() {
control.takeScreenshot();
}
@Override
public void takeScreenshot(String fileName) {
control.takeScreenshot(fileName);
}
@Override
public EventsRegistry events() {
return control.events();
}
@Override
public P goTo(P page) {
return control.goTo(page);
}
@Override
public void goTo(String url) {
control.goTo(url);
}
@Override
public void goToInNewTab(String url) {
control.goToInNewTab(url);
}
@Override
public void switchTo(FluentList elements) {
control.switchTo(elements);
}
@Override
public void switchTo(FluentWebElement element) {
control.switchTo(element);
}
@Override
public void switchTo() {
control.switchTo();
}
@Override
public void switchToDefault() {
control.switchToDefault();
}
@Override
public String pageSource() {
return control.pageSource();
}
@Override
public WindowAction window() {
return control.window();
}
@Override
public Set getCookies() {
return control.getCookies();
}
@Override
public Cookie getCookie(String name) {
return control.getCookie(name);
}
@Override
public String url() {
return control.url();
}
@Override
public WebDriver getDriver() {
return control.getDriver();
}
@Override
public AppiumDriver getAppiumDriver() {
return control.getAppiumDriver();
}
@Override
public CssSupport css() {
return control.css();
}
@Override
public ContainerContext inject(Object container) {
return control.inject(container);
}
@Override
public ContainerContext injectComponent(Object componentContainer, Object parentContainer, SearchContext context) {
return control.injectComponent(componentContainer, parentContainer, context);
}
@Override
public T newInstance(Class cls) {
return control.newInstance(cls);
}
@Override
public FluentWebElement newFluent(WebElement element) {
return control.newFluent(element);
}
@Override
public T newComponent(Class componentClass, WebElement element) {
return control.newComponent(componentClass, element);
}
@Override
public FluentList newFluentList() {
return control.newFluentList();
}
@Override
public FluentList newFluentList(FluentWebElement... elements) {
return control.newFluentList(elements);
}
@Override
public FluentList newFluentList(List elements) {
return control.newFluentList(elements);
}
@Override
public FluentList asFluentList(WebElement... elements) {
return control.asFluentList(elements);
}
@Override
public FluentList asFluentList(Iterable elements) {
return control.asFluentList(elements);
}
@Override
public FluentList asFluentList(List elements) {
return control.asFluentList(elements);
}
@Override
public FluentList newFluentList(Class componentClass) {
return control.newFluentList(componentClass);
}
@Override
public FluentList newFluentList(Class componentClass, T... elements) {
return control.newFluentList(componentClass, elements);
}
@Override
public FluentList newFluentList(Class componentClass, List elements) {
return control.newFluentList(componentClass, elements);
}
@Override
public FluentList asFluentList(Class componentClass, WebElement... elements) {
return control.asFluentList(componentClass, elements);
}
@Override
public FluentList asFluentList(Class componentClass, Iterable elements) {
return control.asFluentList(componentClass, elements);
}
@Override
public FluentList asFluentList(Class componentClass, List elements) {
return control.asFluentList(componentClass, elements);
}
@Override
public ComponentList newComponentList(Class componentClass) {
return control.newComponentList(componentClass);
}
@Override
public ComponentList asComponentList(Class componentClass, WebElement... elements) {
return control.asComponentList(componentClass, elements);
}
@Override
public ComponentList asComponentList(Class componentClass, Iterable elements) {
return control.asComponentList(componentClass, elements);
}
@Override
public ComponentList asComponentList(Class componentClass, List elements) {
return control.asComponentList(componentClass, elements);
}
@Override
public ComponentList newComponentList(Class componentClass, T... componentsList) {
return control.newComponentList(componentClass, componentsList);
}
@Override
public ComponentList newComponentList(Class componentClass, List componentsList) {
return control.newComponentList(componentClass, componentsList);
}
@Override
public , T> L newComponentList(Class listClass, Class componentClass) {
return control.newComponentList(listClass, componentClass);
}
@Override
public , T> L asComponentList(Class listClass, Class componentClass, WebElement... elements) {
return control.asComponentList(listClass, componentClass, elements);
}
@Override
public , T> L asComponentList(Class listClass, Class componentClass, Iterable elements) {
return control.asComponentList(listClass, componentClass, elements);
}
@Override
public , T> L asComponentList(Class listClass, Class componentClass, List elements) {
return control.asComponentList(listClass, componentClass, elements);
}
@Override
public , T> L newComponentList(Class listClass, Class componentClass, T... componentsList) {
return control.newComponentList(listClass, componentClass, componentsList);
}
@Override
public , T> L newComponentList(Class listClass, Class componentClass, List componentsList) {
return control.newComponentList(listClass, componentClass, componentsList);
}
@Override
public boolean isComponentClass(Class componentClass) {
return control.isComponentClass(componentClass);
}
@Override
public boolean isComponentListClass(Class> componentListClass) {
return false;
}
@Override
public Capabilities capabilities() {
return control.capabilities();
}
@Override
public FluentWebElement click() {
webElement.click();
return this;
}
@Override
public FluentWebElement doubleClick() {
mouse().doubleClick();
return this;
}
@Override
public FluentWebElement contextClick() {
mouse().contextClick();
return this;
}
@Override
public FluentWebElement waitAndClick() {
return waitAndClick(Duration.ofSeconds(5));
}
@Override
public FluentWebElement waitAndClick(Duration duration) {
await().atMost(duration).until(this).clickable();
this.scrollToCenter();
this.click();
return this;
}
@Override
public FluentWebElement hoverOver() {
mouse().moveToElement();
return this;
}
@Override
public boolean present() {
return LocatorProxies.present(webElement);
}
@Override
public FluentWebElement now() {
LocatorProxies.now(webElement);
return this;
}
@Override
public FluentWebElement now(boolean force) {
if (force) {
reset();
}
return now();
}
@Override
public FluentWebElement reset() {
LocatorProxies.reset(webElement);
return this;
}
@Override
public boolean loaded() {
return LocatorProxies.loaded(webElement);
}
/**
* XPath Axes accessor (parent, ancestors, preceding, following, ...).
*
* @return object to perform XPath Axes transformations.
* @deprecated Use {@link #dom()} instead.
*/
@Deprecated
public Dom axes() {
return dom;
}
/**
* XPath Axes accessor (parent, ancestors, preceding, following, ...).
*
* @return object to perform XPath Axes transformations.
*/
public Dom dom() {
return dom;
}
/**
* Get a conditions object used to verify condition on this element.
*
* @return conditions object
*/
public FluentConditions conditions() {
return conditions;
}
/**
* Build a wait object to wait for a condition of this element.
*
* @return a wait object
*/
public FluentWaitElement await() {
return new FluentWaitElement(control.await(), this);
}
/**
* Execute mouse actions on the element
*
* @return mouse actions object
*/
public MouseElementActions mouse() {
return mouseActions;
}
/**
* Execute keyboard actions on the element
*
* @return keyboard actions object
*/
public KeyboardElementActions keyboard() {
return keyboardActions;
}
/**
* Wrap all underlying elements in a component.
*
* @param componentClass component class
* @param type of component
* @return element as component.
*/
public T as(Class componentClass) {
T component = instantiator.newComponent(componentClass, getElement());
control.injectComponent(component, this, getElement());
return component;
}
/**
* Clear the element
*
* @return fluent web element
*/
public FluentWebElement clear() {
if (!isInputOfTypeFile()) {
webElement.clear();
}
return this;
}
/**
* Clear React input using Backspace only
*
* @return fluent web element
*/
public FluentWebElement clearReactInput() {
if (this.attribute("value").length() != 0) {
javascriptActions.modifyAttribute("value", "");
}
return this;
}
/**
* Submit the element
*
* @return fluent web element
*/
public FluentWebElement submit() {
webElement.submit();
return this;
}
/**
* Set the text element
*
* @param text value to set
* @return fluent web element
*/
public FluentWebElement write(String... text) {
clear();
if (text.length != 0) {
webElement.sendKeys(text[0]);
}
return this;
}
/**
* return the name of the element
*
* @return name of the element
*/
public String name() {
return webElement.getAttribute("name");
}
/**
* return any value of custom attribute (generated=true will return "true" if attribute("generated") is called.
*
* @param name custom attribute name
* @return name value
* @see WebElement#getAttribute(String)
*/
public String attribute(String name) {
return webElement.getAttribute(name);
}
/**
* Get the value of a given CSS property.
*
* @param propertyName the css property name of the element
* @return The current, computed value of the property.
* @see WebElement#getCssValue(String)
*/
public String cssValue(String propertyName) {
return webElement.getCssValue(propertyName);
}
/**
* return the id of the elements
*
* @return id of element
*/
public String id() {
return webElement.getAttribute("id");
}
/**
* return the visible text of the element
*
* @return text of element
* @see WebElement#getText()
*/
public String text() {
return webElement.getText();
}
/**
* return the text content of the element (even invisible through textContent attribute)
*
* @return text content of element
*/
public String textContent() {
return webElement.getAttribute("textContent");
}
/**
* return the value of the elements
*
* @return value of attribute
*/
public String value() {
return webElement.getAttribute("value");
}
/**
* return true if the element is displayed, other way return false
*
* @return boolean value of displayed check
* @see WebElement#isDisplayed()
*/
public boolean displayed() {
boolean displayed;
try {
displayed = webElement.isDisplayed();
} catch (NoSuchElementException | StaleElementReferenceException e) {
displayed = false;
}
return displayed;
}
/**
* return true if the element is enabled, other way return false
*
* @return boolean value of enabled check
* @see WebElement#isEnabled()
*/
public boolean enabled() {
boolean enabled;
try {
enabled = webElement.isEnabled();
} catch (NoSuchElementException | StaleElementReferenceException ex) {
enabled = false;
}
return enabled;
}
/**
* return true if the element is selected, other way false
*
* @return boolean value of selected check
* @see WebElement#isSelected()
*/
public boolean selected() {
boolean selected;
try {
selected = webElement.isSelected();
} catch (NoSuchElementException | StaleElementReferenceException e) {
selected = false;
}
return selected;
}
/**
* Check that this element is visible and enabled such that you can click it.
*
* @return true if the element can be clicked, false otherwise.
*/
public boolean clickable() {
boolean clickable;
try {
clickable = ExpectedConditions.elementToBeClickable(getElement())
.apply(control.getDriver()) != null;
} catch (NoSuchElementException | StaleElementReferenceException
| ElementNotVisibleException | ElementClickInterceptedException e) {
clickable = false;
}
return clickable;
}
/**
* Check that this element is no longer attached to the DOM.
*
* @return false is the element is still attached to the DOM, true otherwise.
*/
public boolean stale() {
return ExpectedConditions.stalenessOf(getElement()).apply(control.getDriver());
}
/**
* return the tag name
*
* @return string value of tag name
* @see WebElement#getTagName()
*/
public String tagName() {
return webElement.getTagName();
}
/**
* return the webElement
*
* @return web element
*/
public WebElement getElement() {
return webElement;
}
@Override
public WebElement getWrappedElement() {
return getElement();
}
/**
* return the size of the element
*
* @return dimension/size of element
* @see WebElement#getSize()
*/
public Dimension size() {
return webElement.getSize();
}
/**
* Converts this element as a single element list.
*
* @return list of element
*/
public FluentList asList() {
return instantiator.asComponentList(FluentListImpl.class, FluentWebElement.class, Arrays.asList(webElement));
}
@Override
public FluentList find(By locator, SearchFilter... filters) {
return search.find(locator, filters);
}
@Override
public FluentList find(String selector, SearchFilter... filters) {
return search.find(selector, filters);
}
@Override
public FluentList find(SearchFilter... filters) {
return search.find(filters);
}
@Override
public FluentList find(List rawElements) {
return search.find(rawElements);
}
@Override
public FluentWebElement el(WebElement rawElement) {
return search.el(rawElement);
}
/**
* Get the HTML of a the element
*
* @return the underlying html content
*/
public String html() {
return webElement.getAttribute("innerHTML");
}
@Override
public Fill fill() {
return new Fill<>(this);
}
@Override
public FillSelect fillSelect() {
return new FillSelect<>(this);
}
@Override
public FluentWebElement frame() {
control.window().switchTo().frame(this);
return this;
}
@Override
public Optional optional() {
if (present()) {
return Optional.of(this);
} else {
return Optional.empty();
}
}
/**
* This method return true if the current FluentWebElement is an input of type file
*
* @return boolean value for is input file type
*/
private boolean isInputOfTypeFile() {
return "input".equalsIgnoreCase(tagName()) && "file".equalsIgnoreCase(attribute("type"));
}
/**
* Save actual hook definitions to backup.
*
* @param hookRestoreStack restore stack
*/
/* default */ void setHookRestoreStack(Stack>> hookRestoreStack) {
hookControl.setHookRestoreStack(hookRestoreStack);
}
@Override
public String toString() {
return label.toString();
}
@Override
public R noHook(Class hook, Function function) {
return getHookControl().noHook(hook, function);
}
@Override
public > FluentWebElement withHook(Class hook, O options) {
return getHookControl().withHook(hook, options);
}
@Override
public > FluentWebElement withHook(Class hook) {
return getHookControl().withHook(hook);
}
@Override
public FluentWebElement noHook(Class... hooks) {
return getHookControl().noHook(hooks);
}
@Override
public R noHook(Function function) {
return getHookControl().noHook(function);
}
@Override
public FluentWebElement noHookInstance(Class... hooks) {
return getHookControl().noHookInstance(hooks);
}
@Override
public FluentWebElement restoreHooks() {
return getHookControl().restoreHooks();
}
@Override
public FluentWebElement noHookInstance() {
return getHookControl().noHookInstance();
}
@Override
public FluentWebElement noHook() {
return getHookControl().noHook();
}
@Override
public FluentWebElement scrollToCenter() {
return getJavascriptActions().scrollToCenter();
}
@Override
public FluentWebElement scrollIntoView() {
return getJavascriptActions().scrollIntoView();
}
@Override
public FluentWebElement scrollIntoView(boolean alignWithTop) {
return getJavascriptActions().scrollIntoView(alignWithTop);
}
@Override
public FluentWebElement modifyAttribute(String attributeName, String attributeValue) {
return getJavascriptActions().modifyAttribute(attributeName, attributeValue);
}
@Override
public FluentWebElement withLabelHint(String... labelHint) {
return getLabel().withLabelHint(labelHint);
}
@Override
public FluentWebElement withLabel(String label) {
return getLabel().withLabel(label);
}
}