com.github.loyada.jdollarx.singlebrowser.highlevelapi.Inputs Maven / Gradle / Ivy

Go to download
package com.github.loyada.jdollarx.singlebrowser.highlevelapi;

import com.github.loyada.jdollarx.ElementProperty;
import com.github.loyada.jdollarx.InBrowser;
import com.github.loyada.jdollarx.Operations;
import com.github.loyada.jdollarx.Path;
import com.github.loyada.jdollarx.singlebrowser.InBrowserSinglton;

import java.util.concurrent.TimeUnit;

import static com.github.loyada.jdollarx.BasicPath.input;
import static com.github.loyada.jdollarx.BasicPath.textNode;
import static com.github.loyada.jdollarx.singlebrowser.InBrowserSinglton.driver;

/**
 * High-level API to define and interact with various input elements.
 * High level API's are not optimized. A definition of an element may interact with the browser
 * to understand the structure of the DOM.
 */
public final class Inputs {
    private Inputs() {}

    /**
     * A lazy way to find an input based on the label. Mote that unlike
     * It looks for a label element that has an ID. If it finds one, it returns
     * a Path to an input with that ID. Otherwise it returns a Path to an  input
     * inside the label element.
     * @param labelText the label to look for
     * @return a Path to the input, on a best effort basis
     */
    public static Path inputForLabel(String labelText) {
        return com.github.loyada.jdollarx.highlevelapi.Inputs.inputForLabel(new InBrowser(driver), labelText);
    }

    /**
     * A lazy way to find an input based on the label. Mote that unlike
     * It looks for a label element that has an ID. If it finds one, it returns
     * a Path to an input with that ID. Otherwise it returns a Path to an  input
     * inside the label element.
     * @param labelText the label to look for
     * @param properties additional properties of the input
     * @return a Path to the input, on a best effort basis
     */
    public static Path inputForLabel(String labelText, ElementProperty... properties) {
        return com.github.loyada.jdollarx.highlevelapi.Inputs.inputForLabel(new InBrowser(driver), labelText, properties);
    }

    /**
     * Input followed by text that does not have its on label element.
     * @param text the text following the input
     * @return a Path to the input element
     */
    public static Path inputFollowedByUnlabeledText(String text) {
        return input.immediatelyBeforeSibling(textNode(text));
    }

    /**
     * Clear operation on an input element
     * @param field the input element
     */
    public static void clearInput(Path field) throws Operations.OperationFailedException {
        com.github.loyada.jdollarx.highlevelapi.Inputs.clearInput(new InBrowser(driver), field);
    }

    /**
     * Perform a selection of an option in a select element.
     * It expects to find the label element with the given text before the select element
     * @param labelText The text of the select label
     * @param option The option text
     */
    public static void selectInFieldWithLabel(String labelText, String option) {
        com.github.loyada.jdollarx.highlevelapi.Inputs.selectInFieldWithLabel(
                new InBrowser(driver), labelText, option);
    }

    /**
     * Change input value: clear it and then enter another text in it
     * @param field Path to the input field
     * @param text the text to enter in the input field
     * @throws Operations.OperationFailedException failed to perform the operation
     */
    public static void changeInputValue(Path field, String text) throws Operations.OperationFailedException {
        com.github.loyada.jdollarx.highlevelapi.Inputs.changeInputValue(
                new InBrowser(driver), field, text);
    }

    /**
     * Change input value: clear it and then enter another text in it
     * @param field Path to the input field
     * @param text the text to enter in the input field
     * @throws Operations.OperationFailedException failed to perform the operation
     */
    public static void changeInputValueAssumingElementIsNotReplaced(Path field, String text) throws Operations.OperationFailedException {
        com.github.loyada.jdollarx.highlevelapi.Inputs.changeInputValueAssumingElementIsNotReplaced(
                new InBrowser(driver), field, text);
    }

    /**
     * Change input value: clear it and then enter another text in it. Prefers speed over guaranteed clearing.
     * @param field Path to the input field
     * @param text the text to enter in the input field
     * @throws Operations.OperationFailedException failed to perform the operation
     */
    public static void changeInputValueWithApproximateDeletion(Path field, String text) throws Operations.OperationFailedException {
        com.github.loyada.jdollarx.highlevelapi.Inputs.changeInputValueWithQuickApproximateDeletion(
                new InBrowser(driver), field, text);
    }

    /**
     * Change input value: try to clear as much as it can, and then enter another text in it
     * @param field Path to the input field
     * @param text the text to enter in the input field
     * @throws Operations.OperationFailedException failed to perform the operation
     */
    public static void changeInputValueNonStrictClearing(Path field, String text) throws Operations.OperationFailedException {
        com.github.loyada.jdollarx.highlevelapi.Inputs.changeInputValueNonStrictClearing(
                new InBrowser(driver), field, text);
    }

    /**
     * Similar to changeInputValue, but adds an ENTER after setting the value of the input
     * @param field Path to the input field
     * @param text the text to enter in the input field
     * @throws Operations.OperationFailedException failed to perform the operation
     */
    public static void changeInputValueWithEnter(Path field, String text) throws Operations.OperationFailedException {
        com.github.loyada.jdollarx.highlevelapi.Inputs.changeInputValueWithEnter(
                new InBrowser(driver), field, text);
    }

    /**
     * Similar to changeInputValueWithEnter, but deletion of previous value is approximate and prefers speed over
     * accuracy.
     * @param field Path to the input field
     * @param text the text to enter in the input field
     * @throws Operations.OperationFailedException failed to perform the operation
     */
    public static void changeInputValueWithEnterApproximateDeletion(Path field, String text) throws Operations.OperationFailedException {
        com.github.loyada.jdollarx.highlevelapi.Inputs.changeInputValueWithApproximateDeletionWithEnter(
                new InBrowser(driver), field, text);
    }


    /**
     * A generic, reasonable guess of an input field in a form.
     * @param fieldName - the field before the input
     * @return a Path for the input field
     */
    public static Path genericFormInputAfterField(String fieldName) {
        return com.github.loyada.jdollarx.highlevelapi.Inputs.genericFormInputAfterField(fieldName);
    }

    /**
     * A generic, reasonable guess of an input field in a form.
     * @param fieldName - the field before the input
     * @return a Path for the input field
     */
    public static Path genericFormInputBeforeField(String fieldName) {
        return com.github.loyada.jdollarx.highlevelapi.Inputs.genericFormInputBeforeField(fieldName);
    }

    /**
     * A generic, reasonable guess of an input field in a form.
     * @param fieldName - the field before the input
     * @param container - an element that contains the field input. Typically a form, a region, section or just body
     * @return a Path for the input field
     */
    public static Path genericFormInputAfterField(String fieldName, Path container) {
        return com.github.loyada.jdollarx.highlevelapi.Inputs.genericFormInputAfterField(fieldName, container);
    }

    /**
     * A generic, reasonable guess of an input field in a form.
     * @param fieldName - the field before the input
     * @param container - an element that contains the field input. Typically a form, a region, section or just body
     * @return a Path for the input field
     */
    public static Path genericFormInputBeforeField(String fieldName, Path container) {
        return com.github.loyada.jdollarx.highlevelapi.Inputs.genericFormInputBeforeField(fieldName, container);
    }

    public static void selectDropdownOption(Path dropdownContent, Path myOption) {
        InBrowser browser = new InBrowser(driver);
        browser.setImplicitTimeout((int)InBrowserSinglton.getImplicitTimeoutInMillisec(), TimeUnit.MILLISECONDS);
        com.github.loyada.jdollarx.highlevelapi.Inputs.selectDropdownOption(
                browser, dropdownContent, myOption);
    }

}