com.redhat.darcy.web.api.WebSelection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of darcy-web Show documentation
Extension to darcy that expands the DSL to support interaction with browsers and web applications.
The newest version!
/*
 Copyright 2014 Red Hat, Inc. and/or its affiliates.

 This file is part of darcy-web.

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see .
 */

package com.redhat.darcy.web.api;

import com.redhat.darcy.ui.api.ContextSelection;
import com.redhat.darcy.ui.api.ElementSelection;
import com.redhat.darcy.ui.api.Locator;
import com.redhat.darcy.web.api.elements.HtmlButton;
import com.redhat.darcy.web.api.elements.HtmlCheckbox;
import com.redhat.darcy.web.api.elements.HtmlDateInput;
import com.redhat.darcy.web.api.elements.HtmlElement;
import com.redhat.darcy.web.api.elements.HtmlFileSelect;
import com.redhat.darcy.web.api.elements.HtmlLabel;
import com.redhat.darcy.web.api.elements.HtmlLink;
import com.redhat.darcy.web.api.elements.HtmlMultiSelect;
import com.redhat.darcy.web.api.elements.HtmlRadio;
import com.redhat.darcy.web.api.elements.HtmlSelect;
import com.redhat.darcy.web.api.elements.HtmlText;
import com.redhat.darcy.web.api.elements.HtmlTextInput;

import java.util.List;

/**
 * Extends the default {@link ContextSelection} interface with some web-specific defaults.
 */
public interface WebSelection extends ContextSelection, ElementSelection {
    default Browser browser(Locator locator) {
        return contextOfType(Browser.class, locator);
    }

    default Frame frame(Locator locator) {
        return contextOfType(Frame.class, locator);
    }

    /**
     * Returns a reference to a Javascript alert window. Will not throw an exception immediately if
     * one is not open, but attempting to interact with one where none is present will
     * throw an exception. Because there can only be one alert within one window at a time,
     * providing a {@link com.redhat.darcy.ui.api.Locator} is unnecessary.
     *
     * @see Alert
     * @see Alert#isPresent()
     */
    Alert alert();

    default HtmlElement htmlElement(Locator locator) {
        return elementOfType(HtmlElement.class, locator);
    }

    default List htmlElements(Locator locator) {
        return elementsOfType(HtmlElement.class, locator);
    }

    default HtmlTextInput htmlTextInput(Locator locator) {
        return elementOfType(HtmlTextInput.class, locator);
    }

    default List htmlTextInputs(Locator locator) {
        return elementsOfType(HtmlTextInput.class, locator);
    }

    default HtmlButton htmlButton(Locator locator) {
        return elementOfType(HtmlButton.class, locator);
    }

    default List htmlButtons(Locator locator) {
        return elementsOfType(HtmlButton.class, locator);
    }

    default HtmlFileSelect htmlFileSelect(Locator locator) {
        return elementOfType(HtmlFileSelect.class, locator);
    }

    default List htmlFileSelects(Locator locator) {
        return elementsOfType(HtmlFileSelect.class, locator);
    }

    default HtmlLabel htmlLabel(Locator locator) {
        return elementOfType(HtmlLabel.class, locator);
    }

    default List htmlLabels(Locator locator) {
        return elementsOfType(HtmlLabel.class, locator);
    }

    default HtmlLink htmlLink(Locator locator) {
        return elementOfType(HtmlLink.class, locator);
    }

    default List htmlLinks(Locator locator) {
        return elementsOfType(HtmlLink.class, locator);
    }

    default HtmlSelect htmlSelect(Locator locator) {
        return elementOfType(HtmlSelect.class, locator);
    }

    default List htmlSelects(Locator locator) {
        return elementsOfType(HtmlSelect.class, locator);
    }

    default HtmlText htmlText(Locator locator) {
        return elementOfType(HtmlText.class, locator);
    }

    default List htmlTexts(Locator locator) {
        return elementsOfType(HtmlText.class, locator);
    }

    default HtmlCheckbox htmlCheckbox(Locator locator) {
        return elementOfType(HtmlCheckbox.class, locator);
    }

    default List htmlCheckboxes(Locator locator) {
        return elementsOfType(HtmlCheckbox.class, locator);
    }

    default HtmlRadio htmlRadio(Locator locator) {
        return elementOfType(HtmlRadio.class, locator);
    }

    default List htmlRadios(Locator locator) {
        return elementsOfType(HtmlRadio.class, locator);
    }

    default HtmlMultiSelect htmlMultiSelect(Locator locator) {
        return elementOfType(HtmlMultiSelect.class, locator);
    }

    default List htmlMultiSelects(Locator locator) {
        return elementsOfType(HtmlMultiSelect.class, locator);
    }

    default HtmlDateInput htmlDateInput(Locator locator) {
        return elementOfType(HtmlDateInput.class, locator);
    }

    default List htmlDateInputs(Locator locator) {
        return elementsOfType(HtmlDateInput.class, locator);
    }
}