/*

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

import java.awt.Component;

import java.awt.Container;

import java.awt.Dimension;

import java.awt.Point;

import java.awt.Rectangle;

import java.util.EventObject;

import java.util.Hashtable;

import javax.swing.JPopupMenu;

import javax.swing.JScrollPane;

import javax.swing.JTable;

import javax.swing.ListSelectionModel;

import javax.swing.event.ChangeEvent;

import javax.swing.event.ListSelectionEvent;

import javax.swing.event.TableColumnModelEvent;

import javax.swing.event.TableModelEvent;

import javax.swing.plaf.TableUI;

import javax.swing.table.JTableHeader;

import javax.swing.table.TableCellEditor;

import javax.swing.table.TableCellRenderer;

import javax.swing.table.TableColumn;

import javax.swing.table.TableColumnModel;

import javax.swing.table.TableModel;

import org.netbeans.jemmy.ComponentChooser;

import org.netbeans.jemmy.ComponentSearcher;

import org.netbeans.jemmy.JemmyException;

import org.netbeans.jemmy.Outputable;

import org.netbeans.jemmy.QueueTool;

import org.netbeans.jemmy.TestOut;

import org.netbeans.jemmy.TimeoutExpiredException;

import org.netbeans.jemmy.Timeoutable;

import org.netbeans.jemmy.Timeouts;

import org.netbeans.jemmy.Waiter;

import org.netbeans.jemmy.drivers.DriverManager;

import org.netbeans.jemmy.drivers.TableDriver;

import org.netbeans.jemmy.util.EmptyVisualizer;

/**

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

 * JTableOperator.WaitEditingTimeout - time to wait cell editing<BR>

 * ComponentOperator.WaitComponentTimeout - time to wait component displayed

 * <BR>

 * ComponentOperator.WaitStateTimeout - time to wait for cell contents <BR>

 * JTextComponentOperator.ChangeCaretPositionTimeout - maximum time to chenge

 * caret position <BR>

 * JTextComponentOperator.TypeTextTimeout - maximum time to type text <BR>

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

 *

 * @see Timeouts

 *

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

 *

 */

public class JTableOperator extends JComponentOperator

        implements Outputable, Timeoutable {

    /**

     * Identifier for a "cell" property.

     *

     * @see #getDump

     */

    public static final String CELL_PREFIX_DPROP = "Cell";

    /**

     * Identifier for a "column" property.

     *

     * @see #getDump

     */

    public static final String COLUMN_PREFIX_DPROP = "Column";

    /**

     * Identifier for a "selected column" property.

     *

     * @see #getDump

     */

    public static final String SELECTED_COLUMN_PREFIX_DPROP = "SelectedColumn";

    /**

     * Identifier for a "selected row" property.

     *

     * @see #getDump

     */

    public static final String SELECTED_ROW_PREFIX_DPROP = "SelectedRow";

    /**

     * Identifier for a "column count" property.

     *

     * @see #getDump

     */

    public static final String COLUMN_COUNT_DPROP = "Column count";

    /**

     * Identifier for a "row count" property.

     *

     * @see #getDump

     */

    public static final String ROW_COUNT_DPROP = "Row count";

    private final static long WAIT_EDITING_TIMEOUT = 60000;

    private TestOut output;

    private Timeouts timeouts;

    TableDriver driver;

    /**

     * Constructor.

     *

     * @param b a component

     */

    public JTableOperator(JTable b) {

        super(b);

        driver = DriverManager.getTableDriver(getClass());

    }

    /**

     * Constructs a JTableOperator object.

     *

     * @param cont a container

     * @param chooser a component chooser specifying searching criteria.

     * @param index an index between appropriate ones.

     */

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

        this((JTable) cont.

                waitSubComponent(new JTableFinder(chooser),

                        index));

        copyEnvironment(cont);

    }

    /**

     * Constructs a JTableOperator object.

     *

     * @param cont a container

     * @param chooser a component chooser specifying searching criteria.

     */

    public JTableOperator(ContainerOperator<?> cont, ComponentChooser chooser) {

        this(cont, chooser, 0);

    }

    /**

     * Constructor. Waits by cell text first. Uses cont's timeout and output for

     * waiting and to init operator.

     *

     * @param cont a container

     * @param text Text of a cell which is currently selected.

     * @param row a cell row to check.

     * @param column a cell row to check.

     * @param index Ordinal component index.

     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)

     * @throws TimeoutExpiredException

     */

    public JTableOperator(ContainerOperator<?> cont, String text, int row, int column, int index) {

        this((JTable) waitComponent(cont,

                new JTableByCellFinder(text, row, column,

                        cont.getComparator()),

                index));

        copyEnvironment(cont);

    }

    /**

     * Constructor. Waits by cell text first. Uses cont's timeout and output for

     * waiting and to init operator.

     *

     * @param cont a container

     * @param text Text of a cell which is currently selected.

     * @param row a cell row to check.

     * @param column a cell row to check.

     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)

     * @throws TimeoutExpiredException

     */

    public JTableOperator(ContainerOperator<?> cont, String text, int row, int column) {

        this(cont, text, row, column, 0);

    }

    /**

     * Constructor. Waits by text in selected cell first. Uses cont's timeout

     * and output for waiting and to init operator.

     *

     * @param cont a container

     * @param text Text of a cell which is currently selected.

     * @param index Ordinal component index.

     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)

     * @throws TimeoutExpiredException

     */

    public JTableOperator(ContainerOperator<?> cont, String text, int index) {

        this(cont, text, -1, -1, index);

    }

    /**

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

     * output for waiting and to init operator.

     *

     * @param cont a container

     * @param text Text of a cell which is currently selected.

     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)

     * @throws TimeoutExpiredException

     */

    public JTableOperator(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 a container

     * @param index Ordinal component index.

     * @throws TimeoutExpiredException

     */

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

        this((JTable) waitComponent(cont,

                new JTableFinder(),

                index));

        copyEnvironment(cont);

    }

    /**

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

     * output for waiting and to init operator.

     *

     * @param cont a container

     * @throws TimeoutExpiredException

     */

    public JTableOperator(ContainerOperator<?> cont) {

        this(cont, 0);

    }

    ////////////////////////////////////////////////////////

    //Static finds                                        //

    ////////////////////////////////////////////////////////

    /**

     * Searches JTable in container.

     *

     * @param cont Container to search component in.

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

     * @param index Ordinal component index.

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

     */

    public static JTable findJTable(Container cont, ComponentChooser chooser, int index) {

        return (JTable) findComponent(cont, new JTableFinder(chooser), index);

    }

    /**

     * Searches 0'th JTable in container.

     *

     * @param cont Container to search component in.

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

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

     */

    public static JTable findJTable(Container cont, ComponentChooser chooser) {

        return findJTable(cont, chooser, 0);

    }

    /**

     * Searches JTable by cell.

     *

     * @param cont Container to search component in.

     * @param text Item text. If null, contents is not checked.

     * @param ce Compare text exactly.

     * @param ccs Compare text case sensitively.

     * @param row Index of row to compare text. If -1, selected row is checked.

     * @param column Index of column to compare text. If -1, selected column is

     * checked.

     * @param index Ordinal component index.

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

     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)

     */

    public static JTable findJTable(Container cont, String text, boolean ce, boolean ccs, int row, int column, int index) {

        return findJTable(cont, new JTableByCellFinder(text, row, column, new DefaultStringComparator(ce, ccs)), index);

    }

    /**

     * Searches JTable by cell.

     *

     * @param cont Container to search component in.

     * @param text Item text. If null, contents is not checked.

     * @param ce Compare text exactly.

     * @param ccs Compare text case sensitively.

     * @param row Index of row to compare text. If -1, selected row is checked.

     * @param column Index of column to compare text. If -1, selected column is

     * checked.

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

     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)

     */

    public static JTable findJTable(Container cont, String text, boolean ce, boolean ccs, int row, int column) {

        return findJTable(cont, text, ce, ccs, row, column, 0);

    }

    /**

     * Waits JTable in container.

     *

     * @param cont Container to search component in.

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

     * @param index Ordinal component index.

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

     * @throws TimeoutExpiredException

     */

    public static JTable waitJTable(Container cont, ComponentChooser chooser, int index) {

        return (JTable) waitComponent(cont, new JTableFinder(chooser), index);

    }

    /**

     * Waits 0'th JTable in container.

     *

     * @param cont Container to search component in.

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

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

     * @throws TimeoutExpiredException

     */

    public static JTable waitJTable(Container cont, ComponentChooser chooser) {

        return waitJTable(cont, chooser, 0);

    }

    /**

     * Waits JTable by cell.

     *

     * @param cont Container to search component in.

     * @param text Item text. If null, contents is not checked.

     * @param ce Compare text exactly.

     * @param ccs Compare text case sensitively.

     * @param row Index of row to compare text. If -1, selected row is checked.

     * @param column Index of column to compare text. If -1, selected column is

     * checked.

     * @param index Ordinal component index.

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

     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)

     * @throws TimeoutExpiredException

     */

    public static JTable waitJTable(Container cont, String text, boolean ce, boolean ccs, int row, int column, int index) {

        return waitJTable(cont, new JTableByCellFinder(text, row, column, new DefaultStringComparator(ce, ccs)), index);

    }

    /**

     * Waits JTable by cell.

     *

     * @param cont Container to search component in.

     * @param text Item text. If null, contents is not checked.

     * @param ce Compare text exactly.

     * @param ccs Compare text case sensitively.

     * @param row Index of row to compare text. If -1, selected row is checked.

     * @param column Index of column to compare text. If -1, selected column is

     * checked.

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

     * @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)

     * @throws TimeoutExpiredException

     */

    public static JTable waitJTable(Container cont, String text, boolean ce, boolean ccs, int row, int column) {

        return waitJTable(cont, text, ce, ccs, row, column, 0);

    }

    static {

        Timeouts.initDefault("JTableOperator.WaitEditingTimeout", WAIT_EDITING_TIMEOUT);

    }

    ////////////////////////////////////////////////////////

    //Environment                                         //

    ////////////////////////////////////////////////////////

    @Override

    public void setTimeouts(Timeouts times) {

        this.timeouts = times;

        super.setTimeouts(timeouts);

    }

    @Override

    public Timeouts getTimeouts() {

        return timeouts;

    }

    @Override

    public void setOutput(TestOut out) {

        output = out;

        super.setOutput(output);

    }

    @Override

    public TestOut getOutput() {

        return output;

    }

    @Override

    public void copyEnvironment(Operator anotherOperator) {

        super.copyEnvironment(anotherOperator);

        driver

                = (TableDriver) DriverManager.

                getDriver(DriverManager.TABLE_DRIVER_ID,

                        getClass(),

                        anotherOperator.getProperties());

    }

    ////////////////////////////////////////////////////////

    //Find methods                                        //

    ////////////////////////////////////////////////////////

    //text, comparator and index

    /**

     * Searches cell coordinates.

     *

     * @param text a text pattern

     * @param comparator a string comparision algorithm

     * @param index an ordinal cell index

     * @return Point indicating coordinates (x - column, y - row)

     */

    public Point findCell(String text, StringComparator comparator, int index) {

        return (findCell(new BySubStringTableCellChooser(text,

                comparator),

                index));

    }

    /**

     * Searches cell coordinates in the specified rows and columns.

     *

     * @param text a text pattern

     * @param comparator a string comparision algorithm

     * @param rows rows to search in

     * @param columns columns to search in

     * @param index an ordinal cell index

     * @return Point indicating coordinates (x - column, y - row)

     */

    public Point findCell(String text, StringComparator comparator, int[] rows, int[] columns, int index) {

        return findCell(new BySubStringTableCellChooser(text, comparator), rows, columns, index);

    }

    /**

     * Searches cell row index.

     *

     * @param text a text pattern

     * @param comparator a string comparision algorithm

     * @param index an ordinal cell index

     * @return a row index.

     */

    public int findCellRow(String text, StringComparator comparator, int index) {

        return findCell(text, comparator, index).y;

    }

    /**

     * Searches cell row index. Searching is performed between cells in one

     * column.

     *

     * @param text a text pattern

     * @param comparator a string comparision algorithm

     * @param column a column index to search in

     * @param index an ordinal cell index

     * @return a row index.

     */

    public int findCellRow(String text, StringComparator comparator, int column, int index) {

        return findCell(text, comparator, null, new int[]{column}, index).y;

    }

    /**

     * Searches cell column visible index.

     *

     * @param text a text pattern

     * @param comparator a string comparision algorithm

     * @param index an ordinal cell index

     * @return a column index.

     */

    public int findCellColumn(String text, StringComparator comparator, int index) {

        return findCell(text, comparator, index).x;

    }

    /**

     * Searches cell column index. Searching is performed between cells in one

     * row.

     *

     * @param text a text pattern

     * @param comparator a string comparision algorithm

     * @param row a row index to search in

     * @param index an ordinal cell index

     * @return a column index.

     */

    public int findCellColumn(String text, StringComparator comparator, int row, int index) {

        return findCell(text, comparator, new int[]{row}, null, index).x;

    }

    //booleans - deprecated

    /**

     * Searches cell row by cell text.

     *

     * @param text Text to search by.

     * @param ce Compare exactly.

     * @param ccs Compare case sensitively.

     * @param index Ordinal index in suitable cells.

     * @return a row index.

     * @see #findCellRow(String, int)

     * @deprecated Use findCellRow(String, int) or findCellRow(String,

     * StringComparator, int)

     */

    @Deprecated

    public int findCellRow(String text, boolean ce, boolean ccs, int index) {

        return findCell(text, ce, ccs, index).y;

    }

    /**

     * Searches cell column by cell text.

     *

     * @param text Text to search by.

     * @param ce Compare exactly.

     * @param ccs Compare case sensitively.

     * @param index Ordinal index in suitable cells.

     * @return a column index.

     * @see #findCellColumn(String, int)

     * @deprecated Use findCellColumn(String, int) or findCellColumn(String,

     * StringComparator, int)

     */