test/jdk/java/awt/Modal/FileDialog/FileDialogFWDTest.java

/*
 * Copyright (c) 2007, 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

import java.awt.*;



// FWD: Frame, Window, Dialog

public class FileDialogFWDTest {

    private volatile FileDialog fileDialog;
    private volatile CustomDialog dialog;
    private volatile TestFrame frame;
    private volatile TestWindow window;

    private static final int delay = 500;
    private final ExtendedRobot robot;

    private volatile Dialog hiddenDialog;
    private volatile Frame  hiddenFrame;

    public enum DialogOwner {
        HIDDEN_DIALOG, NULL_DIALOG, HIDDEN_FRAME, NULL_FRAME, FRAME};

    private DialogOwner owner;
    boolean setModal;

    Dialog.ModalityType modalityType;

    private FileDialogFWDTest(Dialog.ModalityType modType,
                              boolean             modal,
                              DialogOwner         o) throws Exception {
        modalityType = modType;
        setModal = modal;
        owner = o;

        robot = new ExtendedRobot();
        EventQueue.invokeLater(this::createGUI);
    }

    public FileDialogFWDTest(Dialog.ModalityType modalityType,
                             DialogOwner         o) throws Exception {
        this(modalityType, false, o);
    }

    public FileDialogFWDTest(DialogOwner o) throws Exception {
        this(null, true, o);
    }

    private void createGUI() {

        frame = new CustomFrame();

        switch (owner) {
            case HIDDEN_DIALOG:
                hiddenDialog = new Dialog((Frame) null);
                dialog = new CustomDialog(hiddenDialog);
                break;
            case NULL_DIALOG:
                dialog = new CustomDialog((Dialog) null);
                break;
            case HIDDEN_FRAME:
                hiddenFrame = new Frame();
                dialog = new CustomDialog(hiddenFrame);
                break;
            case NULL_FRAME:
                dialog = new CustomDialog((Frame) null);
                break;
            case FRAME:
                dialog = new CustomDialog(frame);
                break;
        }

        if (setModal) {
            dialog.setModal(true);
            modalityType = dialog.getModalityType();
        } else if (modalityType != null) {
            dialog.setModalityType(modalityType);
        }

        window = new CustomWindow(frame);

        int x = Toolkit.getDefaultToolkit().getScreenSize().width -
            frame.getWidth() - 50;
        int y = 50;
        frame.setLocation(x, y);
        y += (frame.getHeight() + 50);
        window.setLocation(x, y);
        y += (window.getHeight() + 50);
        dialog.setLocation(x, y);

        frame.setVisible(true);
    }

    private void openAll() throws Exception {
        robot.waitForIdle(delay);
        frame.clickOpenButton(robot);
        robot.waitForIdle(delay);
        window.clickOpenButton(robot);
        robot.waitForIdle(delay);
        dialog.clickOpenButton(robot);
        robot.waitForIdle(delay);
    }

    private void checkBlockedWindows() throws Exception {

        String msg = "FileDialog should block this ";
        frame.checkBlockedFrame(robot, msg + "Frame.");
        robot.waitForIdle(delay);
        window.checkBlockedWindow(robot, msg + "Window.");
        robot.waitForIdle(delay);
        dialog.checkBlockedDialog(robot, msg + "Dialog.");
        robot.waitForIdle(delay);
    }

    private void checkUnblockedWindows() throws Exception {

        String msg = "Blocking dialogs were closed.";
        frame.checkUnblockedFrame(robot, msg + "Frame.");
        robot.waitForIdle(delay);
        window.checkUnblockedWindow(robot, msg + "Window.");
        robot.waitForIdle(delay);
    }

    private void modalTest(String type) throws Exception {

        checkBlockedWindows();

        EventQueue.invokeAndWait(() -> { fileDialog.dispose(); });
        robot.waitForIdle(delay);

        String msg = "FileDialog was closed, " +
            "but the " + type + " modal dialog should block this ";

        frame.checkBlockedFrame(robot, msg + "Frame.");
        robot.waitForIdle(delay);

        window.checkBlockedWindow(robot, msg + "Window.");
        robot.waitForIdle(delay);

        dialog.checkUnblockedDialog(robot, "FileDialog was closed.");
        robot.waitForIdle(delay);

        dialog.clickCloseButton(robot);
        robot.waitForIdle(delay);

        checkUnblockedWindows();
    }

    private void docModalTest() throws Exception {

        if (owner == DialogOwner.FRAME) {

            checkBlockedWindows();

            EventQueue.invokeAndWait(() -> { fileDialog.dispose(); });
            robot.waitForIdle(delay);

            String msg = "FileDialog was closed.";

            dialog.checkUnblockedDialog(robot, msg);
            robot.waitForIdle(delay);

            msg += " But the blocking document modal dialog is still open.";

            frame.checkBlockedFrame(robot, msg);
            robot.waitForIdle(delay);

            window.checkBlockedWindow(robot, msg);
            robot.waitForIdle(delay);

            dialog.clickCloseButton(robot);
            robot.waitForIdle(delay);

            checkUnblockedWindows();

        } else {
            nonModalTest();
        }
    }

    private void nonModalTest() throws Exception {

        checkBlockedWindows();

        EventQueue.invokeAndWait(() -> { fileDialog.dispose(); });
        robot.waitForIdle(delay);

        dialog.checkUnblockedDialog(robot, "FileDialog was closed.");
        robot.waitForIdle(delay);

        checkUnblockedWindows();
    }

    public void doTest() throws Exception {

        try {
            openAll();

            if (modalityType == null) {
                nonModalTest();
                return;
            }

            switch (modalityType) {
                case APPLICATION_MODAL:
                    modalTest("application");
                    break;
                case DOCUMENT_MODAL:
                    docModalTest();
                    break;
                case TOOLKIT_MODAL:
                    modalTest("toolkit");
                    break;
                case MODELESS:
                    nonModalTest();
                    break;
            }

        } finally {
            EventQueue.invokeAndWait(this::closeAll);
        }
    }

    private void closeAll() {
        if (dialog != null) { dialog.dispose(); }
        if (frame  != null) {  frame.dispose(); }
        if (window != null) { window.dispose(); }
        if (fileDialog != null) { fileDialog.dispose(); }
        if (hiddenDialog != null) { hiddenDialog.dispose(); }
        if (hiddenFrame  != null) {  hiddenFrame.dispose(); }
    }


    class CustomDialog extends TestDialog {

        public CustomDialog(Dialog d) { super(d); }
        public CustomDialog(Frame  f) { super(f); }

        @Override
        public void doOpenAction() {
            fileDialog = new FileDialog((Frame) null);
            fileDialog.setLocation(50, 50);
            fileDialog.setVisible(true);
        }

        @Override
        public void doCloseAction() {
            this.dispose();
        }
    }

    class CustomFrame extends TestFrame {

        @Override
        public void doOpenAction() {
            if (window != null) { window.setVisible(true); }
        }
    }

    class CustomWindow extends TestWindow {

        public CustomWindow(Frame f) { super(f); }

        @Override
        public void doOpenAction() {
            if (dialog != null) { dialog.setVisible(true); }
        }
    }
}