/*

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

 */

/*

  @test

  @bug       6463545

  @summary   Tests javax.swing.LayoutFocusTraversalPolicy functionality.

  @author    anton.tarasov, oleg.sukhodolsky: area=awt.focus

  @library   ../../regtesthelpers

  @build     AbstractPolicyTest

  @run       main LayoutFTPTest

*/

import java.awt.*;

import javax.swing.*;

import java.awt.event.*;

import java.util.*;

import test.java.awt.regtesthelpers.AbstractPolicyTest;

/*

Below are some notes about changes in SortingFocusTraversalPolicy behaviour.

container(root) [...]           - focus traversal cycle with the <container> as the root.

container(provider) [...]       - focus traversal cycle with the <container> as the provider.

container(..)(focusable) [...]  - <container> is implicitly set focusable.

comp[unfocusable]               - <comp> is set unfocusable.

1. frame [ container(root)(focusable) [...] ]

- getComponentAfter(<frame>, <container>) returns <container>.

  If <container> is the default component to focus in its own cycle.  * NO CHANGE *

3. frame [ comp1 container(root)(focusable) [ comp2 ] comp3 ]

- getComponentBefore(<frame>, <comp3>) returns <comp2>.                                 ** BEHAVIOUR CHANGE **

  Previously <container> would be returned. This was a bug as it

  wasn't according to the spec.

- getComponentBefore(<container>, <comp2>) returns <container>.     * NO CHANGE *

- getComponentBefore(<frame>, <container>) returns <comp1>.         * NO CHANGE *

- getComponentBefore(<container>, <container>) returns <comp2>.     * NO CHANGE *

4. frame [ container(provider) [...] comp ]

- getComponentAfter(<frame>, <container>) returns <container>'s default.                ** BEHAVIOUR CHANGE. SPEC ADDITION **

  Previously <comp> would be returned. Not specified in the spec.

- getComponentBefore(<frame>, <comp>) returns <container>'s last.                       ** SPEC CHANGE **

  The spec says (incorrectly) that default should be returned.

5. frame [ container(provider)(focusable) [...] comp2 ]

- getComponentBefore(<frame>, <comp2>) returns <container>'s last.                      ** BEHAVIOUR CHANGE. SPEC ADDITION **

  Previously <container> would be returned. Not specified in the spec.

6. frame [ comp1 container(root) [...] comp2 ]

- getComponentAfter(<frame>, <comp1>) returns <container>'s default.                    ** BEHAVIOUR CHANGE. SPEC ADDITION **

  Previously <comp2> would be returned. It's just the fix for 6240842.

  Not specified in the spec.

7. frame [ comp1 container(root) [...] comp2(unfocusable) comp3 ]

- getComponentBefore(<frame>, <comp3>) returns <container>'s default.                   ** BEHAVIOUR CHANGE **

  Previously <comp1> would be returned. This was a bug, because

  in case if <comp2> is focusable getComponentBefore(<frame>, <comp2>) would

  return <container>'s default.

*/

public class LayoutFTPTest {

    final int TESTS_NUMBER = 11;

    public static void main(String[] args) {

        LayoutFTPTest app = new LayoutFTPTest();

        app.start();

    }

    public void start() {

        try {

            Class clazz = null;

            AbstractPolicyTest test = null;

            for (int i = 1; i <= TESTS_NUMBER; i++) {

                clazz = Class.forName("PolicyTest" + i);

                if (clazz != null) {

                    test = (AbstractPolicyTest)clazz.newInstance();

                    System.out.print("Test " + i + " is in progress...");

                    test.testIt();

                    System.out.println(" passed.");

                }

            }

        } catch (RuntimeException rte) {

            throw rte;

        } catch (Exception e) {

            throw new RuntimeException("Error: unexpected exception cought!", e);

        }

    }

}

/*

 * frame [ container1 [...] container2 [...] container3 [...] ]

 * - verifies simple configuration.

 */

class PolicyTest1 extends AbstractPolicyTest {

    protected Frame createFrame() {

        JFrame jframe = (JFrame) registerComponent("jframe", new JFrame("Test Frame"));

        jframe.setLayout(new GridLayout(3, 1));

        for (int i = 0; i < 3; i++) {

            Container cont = (Container) registerComponent("jpanel" + i, new JPanel());

            for (int j = 0; j < 3; j++) {

                cont.add(registerComponent("btn " + (j + i*100), new JButton("jbutton")));

            }

            jframe.add(cont);

        }

        return jframe;

    }

    protected void customizeHierarchy() {

        ((Container)getComponent("jframe")).setFocusTraversalPolicy(new LayoutFocusTraversalPolicy());

    }

    protected Map<String, String> getForwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("btn 0", "btn 1");

        order.put("btn 1", "btn 2");

        order.put("btn 2", "btn 100");

        order.put("btn 100", "btn 101");

        order.put("btn 101", "btn 102");

        order.put("btn 102", "btn 200");

        order.put("btn 200", "btn 201");

        order.put("btn 201", "btn 202");

        order.put("btn 202", "btn 0");

        order.put("jpanel0", "btn 0");

        order.put("jpanel1", "btn 100");

        order.put("jpanel2", "btn 200");

        order.put("jframe", "btn 0");

        return order;

    }

    protected Map<String, String> getBackwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("btn 0", "btn 202");

        order.put("btn 1", "btn 0");

        order.put("btn 2", "btn 1");

        order.put("btn 100", "btn 2");

        order.put("btn 101", "btn 100");

        order.put("btn 102", "btn 101");

        order.put("btn 200", "btn 102");

        order.put("btn 201", "btn 200");

        order.put("btn 202", "btn 201");

        order.put("jpanel0", "btn 202");

        order.put("jpanel1", "btn 2");

        order.put("jpanel2", "btn 102");

        order.put("jframe", "btn 202");

        return order;

    }

    protected String[] getContainersToTest() {

        return new String[] {"jframe"};

    }

    protected String getDefaultComp(String focusCycleRoot_id) {

        return "btn 0";

    }

    protected String getFirstComp(String focusCycleRoot_id) {

        return "btn 0";

    }

    protected String getLastComp(String focusCycleRoot_id) {

        return "btn 202";

    }

}

/*

 * frame [ comp container(provider) [...] comp ]

 * - transfering focus through a provider.

 */

class PolicyTest2 extends AbstractPolicyTest {

    protected Frame createFrame() {

        JFrame jframe = (JFrame) registerComponent("jframe", new JFrame("Test Frame"));

        jframe.setLayout(new FlowLayout());

        jframe.add(registerComponent("btn 1", new JButton("jbutton")));

        Container cont = (Container)registerComponent("jpanel", new JPanel());

        cont.add(registerComponent("btn 2", new JButton("jbutton")));

        cont.add(registerComponent("btn 3", new JButton("jbutton")));

        jframe.add(cont);

        jframe.add(registerComponent("btn 4", new JButton("jbutton")));

        return jframe;

    }

    protected void customizeHierarchy() {

        ((Container)getComponent("jframe")).setFocusTraversalPolicy(new LayoutFocusTraversalPolicy());

        ((Container)getComponent("jpanel")).setFocusTraversalPolicyProvider(true);

    }

    protected Map<String, String> getForwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("jframe", "btn 1");

        order.put("btn 1", "btn 2");

        order.put("btn 2", "btn 3");

        order.put("btn 3", "btn 4");

        order.put("btn 4", "btn 1");

        order.put("jpanel", "btn 2");

        return order;

    }

    protected Map<String, String> getBackwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("btn 4", "btn 3");

        order.put("btn 3", "btn 2");

        order.put("btn 2", "btn 1");

        order.put("btn 1", "btn 4");

        return order;

    }

    protected String[] getContainersToTest() {

        return new String[] {"jframe", "jpanel"};

    }

    protected String getDefaultComp(String focusCycleRoot_id) {

        if ("jframe".equals(focusCycleRoot_id)) {

            return "btn 1";

        } else if ("jpanel".equals(focusCycleRoot_id)) {

            return "btn 2";

        }

        return null;

    }

    protected String getFirstComp(String focusCycleRoot_id) {

        return getDefaultComp(focusCycleRoot_id);

    }

    protected String getLastComp(String focusCycleRoot_id) {

        if ("jframe".equals(focusCycleRoot_id)) {

            return "btn 4";

        } else if ("jpanel".equals(focusCycleRoot_id)) {

            return "btn 3";

        }

        return null;

    }

}

/*

 * frame [ comp container(root) [...] comp ]

 * - transfering focus through a root (includes the case reported in the CR 6240842).

 */

class PolicyTest3 extends AbstractPolicyTest {

    protected Frame createFrame() {

        JFrame jframe = (JFrame) registerComponent("jframe", new JFrame("Test Frame"));

        jframe.setLayout(new FlowLayout());

        jframe.add(registerComponent("btn 1", new JButton("jbutton")));

        Container cont = (Container)registerComponent("jpanel", new JPanel());

        cont.add(registerComponent("btn 2", new JButton("jbutton")));

        cont.add(registerComponent("btn 3", new JButton("jbutton")));

        jframe.add(cont);

        jframe.add(registerComponent("btn 4", new JButton("jbutton")));

        return jframe;

    }

    protected void customizeHierarchy() {

        ((Container)getComponent("jframe")).setFocusTraversalPolicy(new LayoutFocusTraversalPolicy());

        ((Container)getComponent("jpanel")).setFocusCycleRoot(true);

    }

    protected Map<String, String> getForwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("jframe", "btn 1");

        order.put("btn 1", "btn 2");

        order.put("btn 2", "btn 3");

        order.put("btn 3", "btn 2");

        order.put("btn 4", "btn 1");

        order.put("jpanel", "btn 2");

        return order;

    }

    protected Map<String, String> getBackwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("btn 4", "btn 2");

        order.put("btn 3", "btn 2");

        order.put("btn 2", "btn 3");

        order.put("btn 1", "btn 4");

        return order;

    }

    protected String[] getContainersToTest() {

        return new String[] {"jframe", "jpanel"};

    }

    protected String getDefaultComp(String focusCycleRoot_id) {

        if ("jframe".equals(focusCycleRoot_id)) {

            return "btn 1";

        } else if ("jpanel".equals(focusCycleRoot_id)) {

            return "btn 2";

        }

        return null;

    }

    protected String getFirstComp(String focusCycleRoot_id) {

        return getDefaultComp(focusCycleRoot_id);

    }

    protected String getLastComp(String focusCycleRoot_id) {

        if ("jframe".equals(focusCycleRoot_id)) {

            return "btn 4";

        } else if ("jpanel".equals(focusCycleRoot_id)) {

            return "btn 3";

        }

        return null;

    }

}

/*

 * frame [ container(provider) [...] comp1(unfocusable) comp2 ]

 * - getComponentBefore(<frame>, <comp2>) should return <container>'s last.

 */

class PolicyTest4 extends AbstractPolicyTest {

    protected Frame createFrame() {

        JFrame jframe = (JFrame) registerComponent("jframe", new JFrame("Test Frame"));

        jframe.setLayout(new FlowLayout());

        Container cont = (Container)registerComponent("jpanel", new JPanel());

        cont.add(registerComponent("btn 1", new JButton("jbutton")));

        cont.add(registerComponent("btn 2", new JButton("jbutton")));

        jframe.add(cont);

        jframe.add(registerComponent("btn 3", new JButton("jbutton")));

        jframe.add(registerComponent("btn 4", new JButton("jbutton")));

        return jframe;

    }

    protected void customizeHierarchy() {

        ((Container)getComponent("jframe")).setFocusTraversalPolicy(new LayoutFocusTraversalPolicy());

        ((Container)getComponent("jpanel")).setFocusTraversalPolicyProvider(true);

        ((JButton)getComponent("btn 3")).setFocusable(false);

    }

    protected Map<String, String> getBackwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("btn 4", "btn 2");

        order.put("btn 2", "btn 1");

        order.put("btn 1", "btn 4");

        return order;

    }

    // no testing

    protected Map<String, String> getForwardOrder() {

        return null;

    }

    protected String[] getContainersToTest() {

        return null;

    }

    protected String getDefaultComp(String focusCycleRoot_id) {

        return null;

    }

    protected String getFirstComp(String focusCycleRoot_id) {

        return null;

    }

    protected String getLastComp(String focusCycleRoot_id) {

        return null;

    }

}

/*

 * frame [ container(root) [...] comp1(unfocusable) comp2 ]

 * - getComponentBefore(<frame>, <comp2>) should return <container>'s default.

 */

class PolicyTest5 extends AbstractPolicyTest {

    protected Frame createFrame() {

        JFrame jframe = (JFrame) registerComponent("jframe", new JFrame("Test Frame"));

        jframe.setLayout(new FlowLayout());

        Container cont = (Container)registerComponent("jpanel", new JPanel());

        cont.add(registerComponent("btn 1", new JButton("jbutton")));

        cont.add(registerComponent("btn 2", new JButton("jbutton")));

        jframe.add(cont);

        jframe.add(registerComponent("btn 3", new JButton("jbutton")));

        jframe.add(registerComponent("btn 4", new JButton("jbutton")));

        return jframe;

    }

    protected void customizeHierarchy() {

        ((Container)getComponent("jframe")).setFocusTraversalPolicy(new LayoutFocusTraversalPolicy());

        ((Container)getComponent("jpanel")).setFocusCycleRoot(true);

        ((JButton)getComponent("btn 3")).setFocusable(false);

    }

    protected Map<String, String> getBackwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("btn 4", "btn 1");

        order.put("btn 2", "btn 1");

        order.put("btn 1", "btn 2");

        return order;

    }

    // no testing

    protected Map<String, String> getForwardOrder() {

        return null;

    }

    protected String[] getContainersToTest() {

        return null;

    }

    protected String getDefaultComp(String focusCycleRoot_id) {

        return null;

    }

    protected String getFirstComp(String focusCycleRoot_id) {

        return null;

    }

    protected String getLastComp(String focusCycleRoot_id) {

        return null;

    }

}

/*

 * frame [ comp container(provider)(focusable) [...] comp ]

 * - transfering focus through a focusable provider.

 */

class PolicyTest6 extends AbstractPolicyTest {

    protected Frame createFrame() {

        JFrame jframe = (JFrame) registerComponent("jframe", new JFrame("Test Frame"));

        jframe.setLayout(new FlowLayout());

        jframe.add(registerComponent("btn 1", new JButton("jbutton")));

        Container cont = (Container)registerComponent("jpanel", new JPanel());

        cont.add(registerComponent("btn 2", new JButton("jbutton")));

        cont.add(registerComponent("btn 3", new JButton("jbutton")));

        jframe.add(cont);

        jframe.add(registerComponent("btn 4", new JButton("jbutton")));

        return jframe;

    }

    protected void customizeHierarchy() {

        ((Container)getComponent("jframe")).setFocusTraversalPolicy(new LayoutFocusTraversalPolicy());

        ((Container)getComponent("jpanel")).setFocusTraversalPolicy(new LayoutFocusTraversalPolicy() {

                public Component getDefaultComponent(Container aContainer) {

                    return getComponent("btn 2");

                }

            });

        ((Container)getComponent("jpanel")).setFocusTraversalPolicyProvider(true);

        ((Container)getComponent("jpanel")).setFocusable(true);

    }

    protected Map<String, String> getForwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("jframe", "btn 1");

        order.put("btn 1", "jpanel");

        order.put("btn 2", "btn 3");

        order.put("btn 3", "btn 4");

        order.put("btn 4", "btn 1");

        order.put("jpanel", "btn 2");

        return order;

    }

    protected Map<String, String> getBackwardOrder() {

        Map<String, String> order = new HashMap<String, String>();

        order.put("btn 4", "btn 3");

        order.put("btn 3", "btn 2");

        order.put("btn 2", "jpanel");

        order.put("btn 1", "btn 4");

        order.put("jpanel", "btn 1");

        return order;

    }

    protected String[] getContainersToTest() {

        return new String[] {"jpanel"};

    }

    protected String getDefaultComp(String focusCycleRoot_id) {

        return "btn 2";

    }