com.vaadin.flow.component.dialog.testbench.DialogElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vaadin-dialog-testbench Show documentation

There is a newer version: 24.5.5

Show newest version

/*
 * Copyright 2000-2024 Vaadin Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.vaadin.flow.component.dialog.testbench;

import org.openqa.selenium.SearchContext;
import org.openqa.selenium.StaleElementReferenceException;

import com.vaadin.testbench.TestBenchElement;
import com.vaadin.testbench.elementsbase.Element;

/**
 * A TestBench element representing a <vaadin-dialog>
 * element.
 */
@Element("vaadin-dialog")
public class DialogElement extends TestBenchElement {

    /**
     * Checks whether the dialog is shown.
     *
     * @return true if the dialog is shown, false
     *         otherwise
     */
    public boolean isOpen() {
        try {
            return getPropertyBoolean("opened");
        } catch (StaleElementReferenceException e) {
            // The element is no longer even attached to the DOM
            // -> it's not open
            return false;
        }
    }

    @Override
    public SearchContext getContext() {
        // Find child elements inside the overlay, not the dialog element
        return getOverlay();
    }

    /**
     * Gets the overlay element connected to the dialog.
     * 
     * The overlay contains the content of the dialog but is not a child element
     * of the dialog element.
     *
     * @return the overlay element
     */
    private TestBenchElement getOverlay() {
        return getPropertyElement("$", "overlay");
    }

}