jdk/src/share/classes/javax/swing/DefaultFocusManager.java
author rriggs
Tue, 03 Jun 2014 11:18:03 -0400
changeset 25122 1ecc464c69d2
parent 23697 e556a715949f
child 25201 4adc75e0c4e5
permissions -rw-r--r--
8044460: Cleanup new Boolean and single character strings Reviewed-by: pchelko, serb, rriggs Contributed-by: otaviopolianasantana@gmail.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
23697
e556a715949f 8034169: Fix serial lint warnings in javax.swing
darcy
parents: 23010
diff changeset
     2
 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1639
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1639
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1639
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1639
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1639
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
package javax.swing;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
import java.awt.Component;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.awt.Container;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.awt.FocusTraversalPolicy;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.util.Comparator;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * This class has been obsoleted by the 1.4 focus APIs. While client code may
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * still use this class, developers are strongly encouraged to use
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * <code>java.awt.KeyboardFocusManager</code> and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * <code>java.awt.DefaultKeyboardFocusManager</code> instead.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * Please see
20455
f6f9a0c2796b 8020688: Broken links in documentation at http://docs.oracle.com/javase/6/docs/api/index.
mcherkas
parents: 5506
diff changeset
    40
 * <a href="http://docs.oracle.com/javase/tutorial/uiswing/misc/focus.html">
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * How to Use the Focus Subsystem</a>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * a section in <em>The Java Tutorial</em>, and the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * <a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * for more information.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * @author Arnaud Weber
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * @author David Mendenhall
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 */
23697
e556a715949f 8034169: Fix serial lint warnings in javax.swing
darcy
parents: 23010
diff changeset
    49
@SuppressWarnings("serial") // Obsolete class
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
public class DefaultFocusManager extends FocusManager {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    final FocusTraversalPolicy gluePolicy =
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
        new LegacyGlueFocusTraversalPolicy(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    private final FocusTraversalPolicy layoutPolicy =
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
        new LegacyLayoutFocusTraversalPolicy(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    private final LayoutComparator comparator =
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
        new LayoutComparator();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    public DefaultFocusManager() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        setDefaultFocusTraversalPolicy(gluePolicy);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    public Component getComponentAfter(Container aContainer,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
                                       Component aComponent)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
        Container root = (aContainer.isFocusCycleRoot())
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
            ? aContainer
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
            : aContainer.getFocusCycleRootAncestor();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
        // Support for mixed 1.4/pre-1.4 focus APIs. If a particular root's
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
        // traversal policy is non-legacy, then honor it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
        if (root != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
            FocusTraversalPolicy policy = root.getFocusTraversalPolicy();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
            if (policy != gluePolicy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
                return policy.getComponentAfter(root, aComponent);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
            comparator.setComponentOrientation(root.getComponentOrientation());
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
            return layoutPolicy.getComponentAfter(root, aComponent);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
        return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    public Component getComponentBefore(Container aContainer,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
                                        Component aComponent)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
        Container root = (aContainer.isFocusCycleRoot())
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
            ? aContainer
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
            : aContainer.getFocusCycleRootAncestor();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
        // Support for mixed 1.4/pre-1.4 focus APIs. If a particular root's
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
        // traversal policy is non-legacy, then honor it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
        if (root != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
            FocusTraversalPolicy policy = root.getFocusTraversalPolicy();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
            if (policy != gluePolicy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
                return policy.getComponentBefore(root, aComponent);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
            comparator.setComponentOrientation(root.getComponentOrientation());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
            return layoutPolicy.getComponentBefore(root, aComponent);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
        return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
    public Component getFirstComponent(Container aContainer) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
        Container root = (aContainer.isFocusCycleRoot())
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
            ? aContainer
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
            : aContainer.getFocusCycleRootAncestor();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
        // Support for mixed 1.4/pre-1.4 focus APIs. If a particular root's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
        // traversal policy is non-legacy, then honor it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
        if (root != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
            FocusTraversalPolicy policy = root.getFocusTraversalPolicy();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
            if (policy != gluePolicy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
                return policy.getFirstComponent(root);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
            comparator.setComponentOrientation(root.getComponentOrientation());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
            return layoutPolicy.getFirstComponent(root);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
        return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
    public Component getLastComponent(Container aContainer) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
        Container root = (aContainer.isFocusCycleRoot())
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
            ? aContainer
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
            : aContainer.getFocusCycleRootAncestor();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
        // Support for mixed 1.4/pre-1.4 focus APIs. If a particular root's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
        // traversal policy is non-legacy, then honor it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
        if (root != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
            FocusTraversalPolicy policy = root.getFocusTraversalPolicy();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
            if (policy != gluePolicy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
                return policy.getLastComponent(root);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
            comparator.setComponentOrientation(root.getComponentOrientation());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
            return layoutPolicy.getLastComponent(root);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
        return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
    public boolean compareTabOrder(Component a, Component b) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
        return (comparator.compare(a, b) < 0);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
23697
e556a715949f 8034169: Fix serial lint warnings in javax.swing
darcy
parents: 23010
diff changeset
   152
@SuppressWarnings("serial") // JDK-implementation class
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
final class LegacyLayoutFocusTraversalPolicy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
    extends LayoutFocusTraversalPolicy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
{
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
    LegacyLayoutFocusTraversalPolicy(DefaultFocusManager defaultFocusManager) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
        super(new CompareTabOrderComparator(defaultFocusManager));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
1301
15e81207e1f2 6727662: Code improvement and warnings removing from swing packages
rupashka
parents: 2
diff changeset
   161
final class CompareTabOrderComparator implements Comparator<Component> {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
    private final DefaultFocusManager defaultFocusManager;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   163
90ce3da70b43 Initial load
duke
parents:
diff changeset
   164
    CompareTabOrderComparator(DefaultFocusManager defaultFocusManager) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
        this.defaultFocusManager = defaultFocusManager;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   166
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   167
1301
15e81207e1f2 6727662: Code improvement and warnings removing from swing packages
rupashka
parents: 2
diff changeset
   168
    public int compare(Component o1, Component o2) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   169
        if (o1 == o2) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   170
            return 0;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   171
        }
1301
15e81207e1f2 6727662: Code improvement and warnings removing from swing packages
rupashka
parents: 2
diff changeset
   172
        return (defaultFocusManager.compareTabOrder(o1, o2)) ? -1 : 1;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   173
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   174
}