jdk/test/sanity/client/lib/jemmy/src/org/netbeans/jemmy/operators/FrameOperator.java

/*
 * Copyright (c) 1997, 2016, 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.
 */
package org.netbeans.jemmy.operators;

import java.awt.Component;
import java.awt.Frame;
import java.awt.Image;
import java.awt.MenuBar;
import java.util.Hashtable;

import org.netbeans.jemmy.ComponentChooser;
import org.netbeans.jemmy.FrameWaiter;
import org.netbeans.jemmy.JemmyProperties;
import org.netbeans.jemmy.Outputable;
import org.netbeans.jemmy.TestOut;
import org.netbeans.jemmy.TimeoutExpiredException;
import org.netbeans.jemmy.Timeouts;
import org.netbeans.jemmy.drivers.DriverManager;
import org.netbeans.jemmy.drivers.FrameDriver;

/**
 * <BR><BR>Timeouts used: <BR>
 * FrameWaiter.WaitFrameTimeout - time to wait frame displayed <BR>
 * FrameWaiter.AfterFrameTimeout - time to sleep after frame has been dispayed
 * <BR>
 * ComponentOperator.WaitStateTimeout - time to wait for text <BR>.
 *
 * @see org.netbeans.jemmy.Timeouts
 *
 * @author Alexandre Iline (alexandre.iline@oracle.com)
 *
 */
public class FrameOperator extends WindowOperator implements Outputable {

    /**
     * Identifier for a title property.
     *
     * @see #getDump
     */
    public static final String TITLE_DPROP = "Title";

    /**
     * Identifier for a state property.
     *
     * @see #getDump
     */
    public static final String STATE_DPROP = "State";

    /**
     * Identifier for a "normal state" state property value.
     *
     * @see #getDump
     */
    public static final String STATE_NORMAL_DPROP_VALUE = "NORMAL";

    /**
     * Identifier for a "iconified state" state property value.
     *
     * @see #getDump
     */
    public static final String STATE_ICONIFIED_DPROP_VALUE = "ICONIFIED";

    /**
     * Identifier for a resizable property.
     *
     * @see #getDump
     */
    public static final String IS_RESIZABLE_DPROP = "Resizable";

    TestOut output;
    FrameDriver driver;

    /**
     * Constructs a FrameOperator object.
     *
     * @param w window
     */
    public FrameOperator(Frame w) {
        super(w);
        driver = DriverManager.getFrameDriver(getClass());
    }

    /**
     * Constructs a FrameOperator object.
     *
     * @param chooser a component chooser specifying searching criteria.
     * @param index an index between appropriate ones.
     * @param env an operator to copy environment from.
     */
    public FrameOperator(ComponentChooser chooser, int index, Operator env) {
        this(waitFrame(new FrameFinder(chooser),
                index,
                env.getTimeouts(),
                env.getOutput()));
        copyEnvironment(env);
    }

    /**
     * Constructs a FrameOperator object.
     *
     * @param chooser a component chooser specifying searching criteria.
     * @param index an index between appropriate ones.
     */
    public FrameOperator(ComponentChooser chooser, int index) {
        this(chooser, index, Operator.getEnvironmentOperator());
    }

    /**
     * Constructs a FrameOperator object.
     *
     * @param chooser a component chooser specifying searching criteria.
     */
    public FrameOperator(ComponentChooser chooser) {
        this(chooser, 0);
    }

    /**
     * Constructor. Waits for the frame with "title" subtitle. Constructor can
     * be used in complicated cases when output or timeouts should differ from
     * default.
     *
     * @param title a window title
     * @param index Ordinal component index.
     * @param env an operator to copy environment from.
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     * @throws TimeoutExpiredException
     */
    public FrameOperator(String title, int index, Operator env) {
        this(waitFrame(new FrameByTitleFinder(title,
                env.getComparator()),
                index,
                env.getTimeouts(),
                env.getOutput()));
        copyEnvironment(env);
    }

    /**
     * Constructor. Waits for the frame with "title" subtitle. Uses current
     * timeouts and output values.
     *
     * @param title a window title
     * @param index Ordinal component index.
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     * @see JemmyProperties#getCurrentTimeouts()
     * @see JemmyProperties#getCurrentOutput()
     * @throws TimeoutExpiredException
     */
    public FrameOperator(String title, int index) {
        this(title, index,
                ComponentOperator.getEnvironmentOperator());
    }

    /**
     * Constructor. Waits for the frame with "title" subtitle. Uses current
     * timeouts and output values.
     *
     * @param title a window title
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     * @see JemmyProperties#getCurrentTimeouts()
     * @see JemmyProperties#getCurrentOutput()
     * @throws TimeoutExpiredException
     */
    public FrameOperator(String title) {
        this(title, 0);
    }

    /**
     * Constructor. Waits for the index'th frame. Uses current timeout and
     * output for waiting and to init operator.
     *
     * @param index Ordinal component index.
     * @throws TimeoutExpiredException
     */
    public FrameOperator(int index) {
        this(waitFrame(new FrameFinder(),
                index,
                ComponentOperator.getEnvironmentOperator().getTimeouts(),
                ComponentOperator.getEnvironmentOperator().getOutput()));
        copyEnvironment(ComponentOperator.getEnvironmentOperator());
    }

    /**
     * Constructor. Waits for the first frame. Uses current timeout and output
     * for waiting and to init operator.
     *
     * @throws TimeoutExpiredException
     */
    public FrameOperator() {
        this(0);
    }

    @Override
    public void setOutput(TestOut out) {
        super.setOutput(out);
        output = out;
    }

    @Override
    public TestOut getOutput() {
        return output;
    }

    @Override
    public void copyEnvironment(Operator anotherOperator) {
        super.copyEnvironment(anotherOperator);
        driver
                = (FrameDriver) DriverManager.
                getDriver(DriverManager.FRAME_DRIVER_ID,
                        getClass(),
                        anotherOperator.getProperties());
    }

    /**
     * Waits for title. Uses getComparator() comparator.
     *
     * @param title Title to wait for.
     */
    public void waitTitle(final String title) {
        getOutput().printLine("Wait \"" + title + "\" title of frame \n    : "
                + toStringSource());
        getOutput().printGolden("Wait \"" + title + "\" title");
        waitState(new FrameByTitleFinder(title, getComparator()));
    }

    /**
     * Iconifies the frame.
     */
    public void iconify() {
        output.printLine("Iconifying frame\n    " + toStringSource());
        output.printGolden("Iconifying frame");
        driver.iconify(this);
        if (getVerification()) {
            waitState(Frame.ICONIFIED);
        }
    }

    /**
     * Deiconifies the frame.
     */
    public void deiconify() {
        output.printLine("Deiconifying frame\n    " + toStringSource());
        output.printGolden("Deiconifying frame");
        driver.deiconify(this);
        if (getVerification()) {
            waitState(Frame.NORMAL);
        }
    }

    /**
     * Maximizes the frame.
     */
    public void maximize() {
        output.printLine("Maximizing frame\n    " + toStringSource());
        output.printGolden("Maximizing frame");
        driver.maximize(this);
        if (getVerification()) {
            waitState(Frame.MAXIMIZED_BOTH);
        }
    }

    /**
     * Demaximizes the frame.
     */
    public void demaximize() {
        output.printLine("Demaximizing frame\n    " + toStringSource());
        output.printGolden("Demaximizing frame");
        driver.demaximize(this);
        if (getVerification()) {
            waitState(Frame.NORMAL);
        }
    }

    /**
     * Waits for the frame to have a specified state.
     *
     * @param state a state for the frame to have.
     */
    public void waitState(final int state) {
        getOutput().printLine("Wait frame to have "
                + Integer.toString(state)
                + " state \n    : "
                + toStringSource());
        getOutput().printGolden("Wait frame to have "
                + Integer.toString(state)
                + " state");
        waitState(new ComponentChooser() {
            @Override
            public boolean checkComponent(Component comp) {
                return ((Frame) comp).getExtendedState() == state;
            }

            @Override
            public String getDescription() {
                return Integer.toString(state) + " state";
            }

            @Override
            public String toString() {
                return "FrameOperator.waitState.ComponentChooser{description = " + getDescription() + '}';
            }
        });
    }

    /**
     * Returns information about component.
     */
    @Override
    public Hashtable<String, Object> getDump() {
        Hashtable<String, Object> result = super.getDump();
        if (((Frame) getSource()).getTitle() != null) {
            result.put(TITLE_DPROP, ((Frame) getSource()).getTitle());
        }
        result.put(STATE_DPROP,
                (((Frame) getSource()).getState() == Frame.ICONIFIED)
                        ? STATE_ICONIFIED_DPROP_VALUE : STATE_NORMAL_DPROP_VALUE);
        result.put(IS_RESIZABLE_DPROP, ((Frame) getSource()).isResizable() ? "true" : "false");
        return result;
    }

    ////////////////////////////////////////////////////////
    //Mapping                                             //
    /**
     * Maps {@code Frame.getIconImage()} through queue
     */
    public Image getIconImage() {
        return (runMapping(new MapAction<Image>("getIconImage") {
            @Override
            public Image map() {
                return ((Frame) getSource()).getIconImage();
            }
        }));
    }

    /**
     * Maps {@code Frame.getMenuBar()} through queue
     */
    public MenuBar getMenuBar() {
        return (runMapping(new MapAction<MenuBar>("getMenuBar") {
            @Override
            public MenuBar map() {
                return ((Frame) getSource()).getMenuBar();
            }
        }));
    }

    /**
     * Maps {@code Frame.getState()} through queue
     */
    public int getState() {
        return (runMapping(new MapIntegerAction("getState") {
            @Override
            public int map() {
                return ((Frame) getSource()).getState();
            }
        }));
    }

    /**
     * Maps {@code Frame.getExtendedState()} through queue
     * @return the state of the frame
     */
    public int getExtendedState() {
        return (runMapping(new MapAction<Integer>("getExtendedState") {
            @Override
            public Integer map() {
                return ((Frame) getSource()).getExtendedState();
            }
        }));
    }

    /**
     * Maps {@code Frame.getTitle()} through queue
     */
    public String getTitle() {
        return (runMapping(new MapAction<String>("getTitle") {
            @Override
            public String map() {
                return ((Frame) getSource()).getTitle();
            }
        }));
    }

    /**
     * Maps {@code Frame.isResizable()} through queue
     */
    public boolean isResizable() {
        return (runMapping(new MapBooleanAction("isResizable") {
            @Override
            public boolean map() {
                return ((Frame) getSource()).isResizable();
            }
        }));
    }

    /**
     * Maps {@code Frame.setIconImage(Image)} through queue
     */
    public void setIconImage(final Image image) {
        runMapping(new MapVoidAction("setIconImage") {
            @Override
            public void map() {
                ((Frame) getSource()).setIconImage(image);
            }
        });
    }

    /**
     * Maps {@code Frame.setMenuBar(MenuBar)} through queue
     */
    public void setMenuBar(final MenuBar menuBar) {
        runMapping(new MapVoidAction("setMenuBar") {
            @Override
            public void map() {
                ((Frame) getSource()).setMenuBar(menuBar);
            }
        });
    }

    /**
     * Maps {@code Frame.setResizable(boolean)} through queue
     */
    public void setResizable(final boolean b) {
        runMapping(new MapVoidAction("setResizable") {
            @Override
            public void map() {
                ((Frame) getSource()).setResizable(b);
            }
        });
    }

    /**
     * Maps {@code Frame.setState(int)} through queue
     */
    public void setState(final int i) {
        runMapping(new MapVoidAction("setState") {
            @Override
            public void map() {
                ((Frame) getSource()).setState(i);
            }
        });
    }

    /**
     * Maps {@code Frame.setExtendedState(int)} through queue
     * @param state of the frame
     */
    public void setExtendedState(final int state) {
        runMapping(new MapAction<Void>("setExtendedState") {
            @Override
            public Void map() {
                ((Frame) getSource()).setExtendedState(state);
                return null;
            }
        });

    }

    /**
     * Maps {@code Frame.setTitle(String)} through queue
     */
    public void setTitle(final String string) {
        runMapping(new MapVoidAction("setTitle") {
            @Override
            public void map() {
                ((Frame) getSource()).setTitle(string);
            }
        });
    }

    //End of mapping                                      //
    ////////////////////////////////////////////////////////
    /**
     * A method to be used from subclasses. Uses timeouts and output passed as
     * parameters during the waiting.
     *
     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.
     * @param index Ordinal component index.
     * @param timeouts timeouts to be used during the waiting.
     * @param output an output to be used during the waiting.
     * @return Component instance or null if component was not found.
     * @throws TimeoutExpiredException
     */
    protected static Frame waitFrame(ComponentChooser chooser, int index,
            Timeouts timeouts, TestOut output) {
        try {
            FrameWaiter waiter = new FrameWaiter();
            waiter.setTimeouts(timeouts);
            waiter.setOutput(output);
            return waiter.waitFrame(new FrameFinder(chooser), index);
        } catch (InterruptedException e) {
            output.printStackTrace(e);
            return null;
        }
    }

    /**
     * Checks component type.
     */
    public static class FrameFinder extends Finder {

        /**
         * Constructs FrameFinder.
         *
         * @param sf other searching criteria.
         */
        public FrameFinder(ComponentChooser sf) {
            super(Frame.class, sf);
        }

        /**
         * Constructs FrameFinder.
         */
        public FrameFinder() {
            super(Frame.class);
        }
    }

    /**
     * Allows to find component by title.
     */
    public static class FrameByTitleFinder implements ComponentChooser {

        String title;
        StringComparator comparator;

        /**
         * Constructs FrameByTitleFinder.
         *
         * @param t a text pattern
         * @param comparator specifies string comparision algorithm.
         */
        public FrameByTitleFinder(String t, StringComparator comparator) {
            title = t;
            this.comparator = comparator;
        }

        /**
         * Constructs FrameByTitleFinder.
         *
         * @param t a text pattern
         */
        public FrameByTitleFinder(String t) {
            this(t, Operator.getDefaultStringComparator());
        }

        @Override
        public boolean checkComponent(Component comp) {
            if (comp instanceof Frame) {
                if (comp.isShowing() && ((Frame) comp).getTitle() != null) {
                    return comparator.equals(((Frame) comp).getTitle(), title);
                }
            }
            return false;
        }

        @Override
        public String getDescription() {
            return "Frame with title \"" + title + "\"";
        }

        @Override
        public String toString() {
            return "FrameByTitleFinder{" + "title=" + title + ", comparator=" + comparator + '}';
        }
    }
}