/*

 * 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.Container;

import java.awt.Point;

import java.awt.Rectangle;

import javax.swing.JScrollBar;

import javax.swing.JScrollPane;

import javax.swing.JViewport;

import javax.swing.SwingUtilities;

import javax.swing.border.Border;

import javax.swing.plaf.ScrollPaneUI;

import org.netbeans.jemmy.ComponentChooser;

import org.netbeans.jemmy.ComponentSearcher;

import org.netbeans.jemmy.Outputable;

import org.netbeans.jemmy.TestOut;

import org.netbeans.jemmy.TimeoutExpiredException;

import org.netbeans.jemmy.Timeoutable;

import org.netbeans.jemmy.Timeouts;

import org.netbeans.jemmy.drivers.scrolling.ScrollAdjuster;

import org.netbeans.jemmy.util.EmptyVisualizer;

/**

 * <BR><BR>Timeouts used: <BR>

 * JScrollBarOperator.OneScrollClickTimeout - time for one scroll click <BR>

 * JScrollBarOperator.WholeScrollTimeout - time for the whole scrolling <BR>

 * ComponentOperator.WaitComponentTimeout - time to wait component displayed

 * <BR>.

 *

 * @see org.netbeans.jemmy.Timeouts

 *

 * @author Alexandre Iline (alexandre.iline@oracle.com)

 *

 */

public class JScrollPaneOperator extends JComponentOperator

        implements Timeoutable, Outputable {

    private static int X_POINT_RECT_SIZE = 6;

    private static int Y_POINT_RECT_SIZE = 4;

    private Timeouts timeouts;

    private TestOut output;

    private JScrollBarOperator hScrollBarOper = null;

    private JScrollBarOperator vScrollBarOper = null;

    /**

     * Constructor.

     *

     * @param b JScrollPane component.

     */

    public JScrollPaneOperator(JScrollPane b) {

        super(b);

    }

    /**

     * Constructs a JScrollPaneOperator object.

     *

     * @param cont a container

     * @param chooser a component chooser specifying searching criteria.

     * @param index an index between appropriate ones.

     */

    public JScrollPaneOperator(ContainerOperator<?> cont, ComponentChooser chooser, int index) {

        this((JScrollPane) cont.

                waitSubComponent(new JScrollPaneFinder(chooser),

                        index));

        copyEnvironment(cont);

    }

    /**

     * Constructs a JScrollPaneOperator object.

     *

     * @param cont a container

     * @param chooser a component chooser specifying searching criteria.

     */

    public JScrollPaneOperator(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 Operator pointing a container to search component in.

     * @param index Ordinal component index.

     * @throws TimeoutExpiredException

     */

    public JScrollPaneOperator(ContainerOperator<?> cont, int index) {

        this((JScrollPane) waitComponent(cont,

                new JScrollPaneFinder(),

                index));

        copyEnvironment(cont);

    }

    /**

     * Constructor. Waits component in container first. Uses cont's timeout and

     * output for waiting and to init operator.

     *

     * @param cont Operator pointing a container to search component in.

     * @throws TimeoutExpiredException

     */

    public JScrollPaneOperator(ContainerOperator<?> cont) {

        this(cont, 0);

    }

    /**

     * Searches JScrollPane in container.

     *

     * @param cont Container to search component in.

     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.

     * @param index Ordinal component index.

     * @return JScrollPane instance or null if component was not found.

     */

    public static JScrollPane findJScrollPane(Container cont, ComponentChooser chooser, int index) {

        return (JScrollPane) findComponent(cont, new JScrollPaneFinder(chooser), index);

    }

    /**

     * Searches 0'th JScrollPane in container.

     *

     * @param cont Container to search component in.

     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.

     * @return JScrollPane instance or null if component was not found.

     */

    public static JScrollPane findJScrollPane(Container cont, ComponentChooser chooser) {

        return findJScrollPane(cont, chooser, 0);

    }

    /**

     * Searches JScrollPane in container.

     *

     * @param cont Container to search component in.

     * @param index Ordinal component index.

     * @return JScrollPane instance or null if component was not found.

     */

    public static JScrollPane findJScrollPane(Container cont, int index) {

        return findJScrollPane(cont, ComponentSearcher.getTrueChooser(Integer.toString(index) + "'th JScrollPane instance"), index);

    }

    /**

     * Searches 0'th JScrollPane in container.

     *

     * @param cont Container to search component in.

     * @return JScrollPane instance or null if component was not found.

     */

    public static JScrollPane findJScrollPane(Container cont) {

        return findJScrollPane(cont, 0);

    }

    /**

     * Searches JScrollPane object which component lies on.

     *

     * @param comp Component to find JScrollPane under.

     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.

     * @return JScrollPane instance or null if component was not found.

     */

    public static JScrollPane findJScrollPaneUnder(Component comp, ComponentChooser chooser) {

        return (JScrollPane) findContainerUnder(comp, new JScrollPaneFinder(chooser));

    }

    /**

     * Searches JScrollPane object which component lies on.

     *

     * @param comp Component to find JScrollPane under.

     * @return JScrollPane instance or null if component was not found.

     */

    public static JScrollPane findJScrollPaneUnder(Component comp) {

        return findJScrollPaneUnder(comp, new JScrollPaneFinder());

    }

    /**

     * Waits JScrollPane in container.

     *

     * @param cont Container to search component in.

     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.

     * @param index Ordinal component index.

     * @return JScrollPane instance or null if component was not displayed.

     * @throws TimeoutExpiredException

     */

    public static JScrollPane waitJScrollPane(Container cont, ComponentChooser chooser, int index) {

        return (JScrollPane) waitComponent(cont, new JScrollPaneFinder(chooser), index);

    }

    /**

     * Waits 0'th JScrollPane in container.

     *

     * @param cont Container to search component in.

     * @param chooser org.netbeans.jemmy.ComponentChooser implementation.

     * @return JScrollPane instance or null if component was not displayed.

     * @throws TimeoutExpiredException

     */

    public static JScrollPane waitJScrollPane(Container cont, ComponentChooser chooser) {

        return waitJScrollPane(cont, chooser, 0);

    }

    /**

     * Waits JScrollPane in container.

     *

     * @param cont Container to search component in.

     * @param index Ordinal component index.

     * @return JScrollPane instance or null if component was not displayed.

     * @throws TimeoutExpiredException

     */

    public static JScrollPane waitJScrollPane(Container cont, int index) {

        return waitJScrollPane(cont, ComponentSearcher.getTrueChooser(Integer.toString(index) + "'th JScrollPane instance"), index);

    }

    /**

     * Waits 0'th JScrollPane in container.

     *

     * @param cont Container to search component in.

     * @return JScrollPane instance or null if component was not displayed.

     * @throws TimeoutExpiredException

     */

    public static JScrollPane waitJScrollPane(Container cont) {

        return waitJScrollPane(cont, 0);

    }

    /**

     * Sets values for both JScrollBars.

     *

     * @param hValue a value for the horizontal scrollbar.

     * @param vValue a value for the vertical scrollbar.

     */

    public void setValues(int hValue, int vValue) {

        initOperators();

        hScrollBarOper.setValue(hValue);

        vScrollBarOper.setValue(vValue);

    }

    @Override

    public void setTimeouts(Timeouts timeouts) {

        super.setTimeouts(timeouts);

        this.timeouts = timeouts;

    }

    @Override

    public Timeouts getTimeouts() {

        return timeouts;

    }

    @Override

    public void setOutput(TestOut out) {

        output = out;

        super.setOutput(output.createErrorOutput());

    }

    @Override

    public TestOut getOutput() {

        return output;

    }

    /**

     * Scrolls horizontal scroll bar.

     *

     * @param value Value to scroll horizontal scroll bar to.

     * @throws TimeoutExpiredException

     */

    public void scrollToHorizontalValue(int value) {

        output.printTrace("Scroll JScrollPane to " + Integer.toString(value) + " horizontal value \n"

                + toStringSource());

        output.printGolden("Scroll JScrollPane to " + Integer.toString(value) + " horizontal value");

        initOperators();

        makeComponentVisible();

        if (hScrollBarOper != null && hScrollBarOper.getSource().isVisible()) {

            hScrollBarOper.scrollToValue(value);

        }

    }

    /**

     * Scrolls horizontal scroll bar.

     *

     * @param proportionalValue Proportional value to scroll horizontal scroll

     * bar to.

     * @throws TimeoutExpiredException

     */

    public void scrollToHorizontalValue(double proportionalValue) {

        output.printTrace("Scroll JScrollPane to " + Double.toString(proportionalValue) + " proportional horizontal value \n"

                + toStringSource());

        output.printGolden("Scroll JScrollPane to " + Double.toString(proportionalValue) + " proportional horizontal value");

        initOperators();

        makeComponentVisible();

        if (hScrollBarOper != null && hScrollBarOper.getSource().isVisible()) {

            hScrollBarOper.scrollToValue(proportionalValue);

        }

    }

    /**

     * Scrolls vertical scroll bar.

     *

     * @param value Value to scroll vertical scroll bar to.

     * @throws TimeoutExpiredException

     */

    public void scrollToVerticalValue(int value) {

        output.printTrace("Scroll JScrollPane to " + Integer.toString(value) + " vertical value \n"

                + toStringSource());

        output.printGolden("Scroll JScrollPane to " + Integer.toString(value) + " vertical value");

        initOperators();

        makeComponentVisible();

        if (vScrollBarOper != null && vScrollBarOper.getSource().isVisible()) {

            vScrollBarOper.scrollToValue(value);

        }

    }

    /**

     * Scrolls vertical scroll bar.

     *

     * @param proportionalValue Value to scroll vertical scroll bar to.

     * @throws TimeoutExpiredException

     */

    public void scrollToVerticalValue(double proportionalValue) {

        output.printTrace("Scroll JScrollPane to " + Double.toString(proportionalValue) + " proportional vertical value \n"

                + toStringSource());

        output.printGolden("Scroll JScrollPane to " + Double.toString(proportionalValue) + " proportional vertical value");

        initOperators();

        makeComponentVisible();

        if (vScrollBarOper != null && vScrollBarOper.getSource().isVisible()) {

            vScrollBarOper.scrollToValue(proportionalValue);

        }

    }

    /**

     * Scrolls both scroll bars.

     *

     * @param valueX Value to scroll horizontal scroll bar to.

     * @param valueY Value to scroll vertical scroll bar to.

     * @throws TimeoutExpiredException

     */

    public void scrollToValues(int valueX, int valueY) {

        scrollToVerticalValue(valueX);

        scrollToHorizontalValue(valueX);

    }

    /**

     * Scrolls both scroll bars.

     *

     * @param proportionalValueX Value to scroll horizontal scroll bar to.

     * @param proportionalValueY Value to scroll vertical scroll bar to.

     * @throws TimeoutExpiredException

     */

    public void scrollToValues(double proportionalValueX, double proportionalValueY) {

        scrollToVerticalValue(proportionalValueX);

        scrollToHorizontalValue(proportionalValueY);

    }

    /**

     * Scrolls pane to top.

     *

     * @throws TimeoutExpiredException

     */

    public void scrollToTop() {

        output.printTrace("Scroll JScrollPane to top\n"

                + toStringSource());

        output.printGolden("Scroll JScrollPane to top");

        initOperators();

        makeComponentVisible();

        if (vScrollBarOper != null && vScrollBarOper.getSource().isVisible()) {

            vScrollBarOper.scrollToMinimum();

        }

    }

    /**

     * Scrolls pane to bottom.

     *

     * @throws TimeoutExpiredException

     */

    public void scrollToBottom() {

        output.printTrace("Scroll JScrollPane to bottom\n"

                + toStringSource());

        output.printGolden("Scroll JScrollPane to bottom");

        initOperators();

        makeComponentVisible();

        if (vScrollBarOper != null && vScrollBarOper.getSource().isVisible()) {

            vScrollBarOper.scrollToMaximum();

        }

    }

    /**

     * Scrolls pane to left.

     *

     * @throws TimeoutExpiredException

     */

    public void scrollToLeft() {

        output.printTrace("Scroll JScrollPane to left\n"

                + toStringSource());

        output.printGolden("Scroll JScrollPane to left");

        initOperators();

        makeComponentVisible();

        if (hScrollBarOper != null && hScrollBarOper.getSource().isVisible()) {

            hScrollBarOper.scrollToMinimum();

        }

    }

    /**

     * Scrolls pane to right.

     *

     * @throws TimeoutExpiredException

     */

    public void scrollToRight() {

        output.printTrace("Scroll JScrollPane to right\n"

                + toStringSource());

        output.printGolden("Scroll JScrollPane to right");

        initOperators();

        makeComponentVisible();

        if (hScrollBarOper != null && hScrollBarOper.getSource().isVisible()) {

            hScrollBarOper.scrollToMaximum();

        }

    }

    /**

     * Scrolls pane to rectangle of a component.

     *

     * @param comp a subcomponent defining coordinate system.

     * @param x coordinate

     * @param y coordinate

     * @param width rectangle width

     * @param height rectangle height

     * @throws TimeoutExpiredException

     */

    public void scrollToComponentRectangle(Component comp, int x, int y, int width, int height) {

        initOperators();

        makeComponentVisible();

        if (hScrollBarOper != null && hScrollBarOper.getSource().isVisible()) {

            hScrollBarOper.scrollTo(new ComponentRectChecker(comp, x, y, width, height, JScrollBar.HORIZONTAL));

        }

        if (vScrollBarOper != null && vScrollBarOper.getSource().isVisible()) {

            vScrollBarOper.scrollTo(new ComponentRectChecker(comp, x, y, width, height, JScrollBar.VERTICAL));

        }

    }

    /**

     * Scrolls pane to point.

     *

     * @param comp a subcomponent defining coordinate system.

     * @param x coordinate

     * @param y coordinate

     * @throws TimeoutExpiredException

     */

    public void scrollToComponentPoint(Component comp, int x, int y) {

        scrollToComponentRectangle(comp,

                x - X_POINT_RECT_SIZE,

                y - Y_POINT_RECT_SIZE,

                2 * X_POINT_RECT_SIZE,

                2 * Y_POINT_RECT_SIZE);

    }

    /**

     * Scrolls pane to component on this pane. Component should lay on the

     * JScrollPane view.

     *

     * @param comp Component to scroll to.

     * @throws TimeoutExpiredException

     */

    public void scrollToComponent(final Component comp) {

        String componentToString = runMapping(

                new Operator.MapAction<String>("comp.toString()") {

            @Override

            public String map() {

                return comp.toString();

            }

        }

        );

        output.printTrace("Scroll JScrollPane " + toStringSource()

                + "\nto component " + componentToString);

        output.printGolden("Scroll JScrollPane to " + comp.getClass().getName() + " component.");

        scrollToComponentRectangle(comp, 0, 0, comp.getWidth(), comp.getHeight());

    }

    /**

     * Returns operator used for horizontal scrollbar.

     *

     * @return an operator for the horizontal scrollbar.

     */

    public JScrollBarOperator getHScrollBarOperator() {

        initOperators();

        return hScrollBarOper;

    }

    /**

     * Returns operator used for vertical scrollbar.

     *

     * @return an operator for the vertical scrollbar.

     */

    public JScrollBarOperator getVScrollBarOperator() {

        initOperators();

        return vScrollBarOper;

    }

    /**

     * Checks if component's rectangle is inside view port (no scrolling

     * necessary).

     *

     * @param comp a subcomponent defining coordinate system.

     * @param x coordinate

     * @param y coordinate

     * @param width rectangle width

     * @param height rectangle height

     * @return true if pointed subcomponent rectangle is inside the scrolling

     * area.

     */

    public boolean checkInside(Component comp, int x, int y, int width, int height) {

        Component view = getViewport().getView();

        Point toPoint = SwingUtilities.

                convertPoint(comp, x, y, getViewport().getView());

        initOperators();

        if (hScrollBarOper != null && hScrollBarOper.getSource().isVisible()) {