jemmy/operators/CheckboxOperator.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.Checkbox;
import java.awt.CheckboxGroup;
import java.awt.Component;
import java.awt.Container;
import java.awt.event.ItemListener;
import java.util.Hashtable;

import org.netbeans.jemmy.ComponentChooser;
import org.netbeans.jemmy.JemmyException;
import org.netbeans.jemmy.Outputable;
import org.netbeans.jemmy.TestOut;
import org.netbeans.jemmy.TimeoutExpiredException;
import org.netbeans.jemmy.drivers.ButtonDriver;
import org.netbeans.jemmy.drivers.DriverManager;

/**
 *
 * <BR><BR>Timeouts used: <BR>
 * ButtonOperator.PushButtonTimeout - time between checkbox pressing and
 * releasing<BR>
 * ComponentOperator.WaitComponentTimeout - time to wait checkbox displayed <BR>
 * ComponentOperator.WaitComponentEnabledTimeout - time to wait checkbox enabled
 * <BR>.
 *
 * @see org.netbeans.jemmy.Timeouts
 *
 * @author Alexandre Iline (alexandre.iline@oracle.com)
 *
 */
public class CheckboxOperator extends ComponentOperator implements Outputable {

    /**
     * Identifier for a label property.
     *
     * @see #getDump
     */
    public static final String TEXT_DPROP = "Label";

    private TestOut output;
    ButtonDriver driver;

    /**
     * Constructor.
     *
     * @param b a component
     */
    public CheckboxOperator(Checkbox b) {
        super(b);
        driver = DriverManager.getButtonDriver(getClass());
    }

    /**
     * Constructs an CheckboxOperator object.
     *
     * @param cont container
     * @param chooser a component chooser specifying searching criteria.
     * @param index an index between appropriate ones.
     */
    public CheckboxOperator(ContainerOperator<?> cont, ComponentChooser chooser, int index) {
        this((Checkbox) cont.
                waitSubComponent(new CheckboxFinder(chooser),
                        index));
        copyEnvironment(cont);
    }

    /**
     * Constructs an CheckboxOperator object.
     *
     * @param cont container
     * @param chooser a component chooser specifying searching criteria.
     */
    public CheckboxOperator(ContainerOperator<?> cont, ComponentChooser chooser) {
        this(cont, chooser, 0);
    }

    /**
     * Constructor. Waits component in container first. Uses cont's timeout and
     * output for waiting and to init operator.
     *
     * @param cont container
     * @param text Checkbox text.
     * @param index Ordinal component index.
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     * @throws TimeoutExpiredException
     */
    public CheckboxOperator(ContainerOperator<?> cont, String text, int index) {
        this((Checkbox) waitComponent(cont,
                new CheckboxByLabelFinder(text,
                        cont.getComparator()),
                index));
        copyEnvironment(cont);
    }

    /**
     * Constructor. Waits component in container first. Uses cont's timeout and
     * output for waiting and to init operator.
     *
     * @param cont container
     * @param text Checkbox text.
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     * @throws TimeoutExpiredException
     */
    public CheckboxOperator(ContainerOperator<?> cont, String text) {
        this(cont, text, 0);
    }

    /**
     * Constructor. Waits component in container first. Uses cont's timeout and
     * output for waiting and to init operator.
     *
     * @param cont container
     * @param index Ordinal component index.
     * @throws TimeoutExpiredException
     */
    public CheckboxOperator(ContainerOperator<?> cont, int index) {
        this((Checkbox) waitComponent(cont,
                new CheckboxFinder(),
                index));
        copyEnvironment(cont);
    }

    /**
     * Constructor. Waits component in container first. Uses cont's timeout and
     * output for waiting and to init operator.
     *
     * @param cont container
     * @throws TimeoutExpiredException
     */
    public CheckboxOperator(ContainerOperator<?> cont) {
        this(cont, 0);
    }

    /**
     * Searches Checkbox in container.
     *
     * @param cont Container to search component in.
     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.
     * @param index Ordinal component index.
     * @return Checkbox instance or null if component was not found.
     */
    public static Checkbox findCheckbox(Container cont, ComponentChooser chooser, int index) {
        return (Checkbox) findComponent(cont, new CheckboxFinder(chooser), index);
    }

    /**
     * Searches 0'th Checkbox in container.
     *
     * @param cont Container to search component in.
     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.
     * @return Checkbox instance or null if component was not found.
     */
    public static Checkbox findCheckbox(Container cont, ComponentChooser chooser) {
        return findCheckbox(cont, chooser, 0);
    }

    /**
     * Searches Checkbox by text.
     *
     * @param cont Container to search component in.
     * @param text Checkbox text. If null, contents is not checked.
     * @param ce Compare text exactly.
     * @param ccs Compare text case sensitively.
     * @param index Ordinal component index.
     * @return Checkbox instance or null if component was not found.
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     */
    public static Checkbox findCheckbox(Container cont, String text, boolean ce, boolean ccs, int index) {
        return (findCheckbox(cont,
                new CheckboxByLabelFinder(text,
                        new DefaultStringComparator(ce, ccs)),
                index));
    }

    /**
     * Searches Checkbox by text.
     *
     * @param cont Container to search component in.
     * @param text Checkbox text. If null, contents is not checked.
     * @param ce Compare text exactly.
     * @param ccs Compare text case sensitively.
     * @return Checkbox instance or null if component was not found.
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     */
    public static Checkbox findCheckbox(Container cont, String text, boolean ce, boolean ccs) {
        return findCheckbox(cont, text, ce, ccs, 0);
    }

    /**
     * Waits Checkbox in container.
     *
     * @param cont Container to search component in.
     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.
     * @param index Ordinal component index.
     * @return Checkbox instance.
     * @throws TimeoutExpiredException
     */
    public static Checkbox waitCheckbox(Container cont, ComponentChooser chooser, int index) {
        return (Checkbox) waitComponent(cont, new CheckboxFinder(chooser), index);
    }

    /**
     * Waits 0'th Checkbox in container.
     *
     * @param cont Container to search component in.
     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.
     * @return Checkbox instance.
     * @throws TimeoutExpiredException
     */
    public static Checkbox waitCheckbox(Container cont, ComponentChooser chooser) {
        return waitCheckbox(cont, chooser, 0);
    }

    /**
     * Waits Checkbox by text.
     *
     * @param cont Container to search component in.
     * @param text Checkbox text. If null, contents is not checked.
     * @param ce Compare text exactly.
     * @param ccs Compare text case sensitively.
     * @param index Ordinal component index.
     * @return Checkbox instance.
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     * @throws TimeoutExpiredException
     */
    public static Checkbox waitCheckbox(Container cont, String text, boolean ce, boolean ccs, int index) {
        return (waitCheckbox(cont,
                new CheckboxByLabelFinder(text,
                        new DefaultStringComparator(ce, ccs)),
                index));
    }

    /**
     * Waits Checkbox by text.
     *
     * @param cont Container to search component in.
     * @param text Checkbox text. If null, contents is not checked.
     * @param ce Compare text exactly.
     * @param ccs Compare text case sensitively.
     * @return Checkbox instance.
     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
     * @throws TimeoutExpiredException
     */
    public static Checkbox waitCheckbox(Container cont, String text, boolean ce, boolean ccs) {
        return waitCheckbox(cont, text, ce, ccs, 0);
    }

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

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

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

    /**
     * Changes selection if necessary. Uses a ButtonDriver registered for this
     * operator.
     *
     * @param newValue a button selection.
     */
    public void changeSelection(boolean newValue) {
        makeComponentVisible();
        if (getState() != newValue) {
            try {
                waitComponentEnabled();
            } catch (InterruptedException e) {
                throw (new JemmyException("Interrupted!", e));
            }
            output.printLine("Change checkbox selection to " + (newValue ? "true" : "false")
                    + "\n    :" + toStringSource());
            output.printGolden("Change checkbox selection to " + (newValue ? "true" : "false"));
            driver.push(this);
            if (getVerification()) {
                waitSelected(newValue);
            }
        }
    }

    /**
     * Runs {@code changeSelection(boolean)} method in a separate thread.
     *
     * @param selected a button selection.
     */
    public void changeSelectionNoBlock(boolean selected) {
        produceNoBlocking(new NoBlockingAction<Void, Boolean>("Button selection changing") {
            @Override
            public Void doAction(Boolean param) {
                changeSelection(param);
                return null;
            }
        }, selected ? Boolean.TRUE : Boolean.FALSE);
    }

    /**
     * Waits for button to be selected.
     *
     * @param selected selection.
     */
    public void waitSelected(final boolean selected) {
        getOutput().printLine("Wait button to be selected \n    : "
                + toStringSource());
        getOutput().printGolden("Wait button to be selected");
        waitState(new ComponentChooser() {
            @Override
            public boolean checkComponent(Component comp) {
                return getState() == selected;
            }

            @Override
            public String getDescription() {
                return ("Items has been "
                        + (selected ? "" : "un") + "selected");
            }

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

    /**
     * Returns information about component.
     */
    @Override
    public Hashtable<String, Object> getDump() {
        Hashtable<String, Object> result = super.getDump();
        result.put(TEXT_DPROP, ((Checkbox) getSource()).getLabel());
        return result;
    }

    ////////////////////////////////////////////////////////
    //Mapping                                             //
    /**
     * Maps {@code Checkbox.addItemListener(ItemListener)} through queue
     */
    public void addItemListener(final ItemListener itemListener) {
        runMapping(new MapVoidAction("addItemListener") {
            @Override
            public void map() {
                ((Checkbox) getSource()).addItemListener(itemListener);
            }
        });
    }

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

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

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

    /**
     * Maps {@code Checkbox.removeItemListener(ItemListener)} through queue
     */
    public void removeItemListener(final ItemListener itemListener) {
        runMapping(new MapVoidAction("removeItemListener") {
            @Override
            public void map() {
                ((Checkbox) getSource()).removeItemListener(itemListener);
            }
        });
    }

    /**
     * Maps {@code Checkbox.setCheckboxGroup(CheckboxGroup)} through queue
     */
    public void setCheckboxGroup(final CheckboxGroup grp) {
        runMapping(new MapVoidAction("setCheckboxGroup") {
            @Override
            public void map() {
                ((Checkbox) getSource()).setCheckboxGroup(grp);
            }
        });
    }

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

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

    //End of mapping                                      //
    ////////////////////////////////////////////////////////
    /**
     * Allows to find component by label.
     */
    public static class CheckboxByLabelFinder implements ComponentChooser {

        String label;
        StringComparator comparator;

        /**
         * Constructs CheckboxByLabelFinder.
         *
         * @param lb a label pattern
         * @param comparator specifies string comparision algorithm.
         */
        public CheckboxByLabelFinder(String lb, StringComparator comparator) {
            label = lb;
            this.comparator = comparator;
        }

        /**
         * Constructs CheckboxByLabelFinder.
         *
         * @param lb a label pattern
         */
        public CheckboxByLabelFinder(String lb) {
            this(lb, Operator.getDefaultStringComparator());
        }

        @Override
        public boolean checkComponent(Component comp) {
            if (comp instanceof Checkbox) {
                if (((Checkbox) comp).getLabel() != null) {
                    return (comparator.equals(((Checkbox) comp).getLabel(),
                            label));
                }
            }
            return false;
        }

        @Override
        public String getDescription() {
            return "Checkbox with label \"" + label + "\"";
        }

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

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

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

        /**
         * Constructs CheckboxFinder.
         */
        public CheckboxFinder() {
            super(Checkbox.class);
        }
    }
}