FocusManager.java

/*
 * Copyright (c) 1997, 2024, 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. Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * 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.
 */
packagejavax.swing;

importjava.awt.*;


/**
 * This class has been obsoleted by the 1.4 focus APIs. While client code may
 * still use this class, developers are strongly encouraged to use
 * <code>java.awt.KeyboardFocusManager</code> and
 * <code>java.awt.DefaultKeyboardFocusManager</code> instead.
 * <p>
 * Please see
 * <a href="https://docs.oracle.com/javase/tutorial/uiswing/misc/focus.html">
 * How to Use the Focus Subsystem</a>,
 * a section in <em>The Java Tutorial</em>, and the
 * <a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
 * for more information.
 *
 * @see <a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
 *
 * @author Arnaud Weber
 * @author David Mendenhall
 * @since 1.2
 */
publicabstractclassFocusManagerextendsDefaultKeyboardFocusManager {

/**
 * This field is obsolete, and its use is discouraged since its
 * specification is incompatible with the 1.4 focus APIs.
 * The current FocusManager is no longer a property of the UI.
 * Client code must query for the current FocusManager using
 * <code>KeyboardFocusManager.getCurrentKeyboardFocusManager()</code>.
 * See the Focus Specification for more information.
 *
 * @see java.awt.KeyboardFocusManager#getCurrentKeyboardFocusManager
 * @see <a href="../../java/awt/doc-files/FocusSpec.html">Focus Specification</a>
 */
publicstaticfinalStringFOCUS_MANAGER_CLASS_PROPERTY =
"FocusManagerClassName";

privatestaticbooleanenabled = true;

/**
 * Constructor for subclasses to call.
 */
protectedFocusManager() {}

/**
 * Returns the current <code>KeyboardFocusManager</code> instance
 * for the calling thread's context.
 *
 * @return this thread's context's <code>KeyboardFocusManager</code>
 * @see #setCurrentManager
 */
publicstaticFocusManagergetCurrentManager() {
KeyboardFocusManagermanager =
KeyboardFocusManager.getCurrentKeyboardFocusManager();
if (managerinstanceofFocusManager) {
return (FocusManager)manager;
 } else {
returnnewDelegatingDefaultFocusManager(manager);
 }
 }

/**
 * Sets the current <code>KeyboardFocusManager</code> instance
 * for the calling thread's context. If <code>null</code> is
 * specified, then the current <code>KeyboardFocusManager</code>
 * is replaced with a new instance of
 * <code>DefaultKeyboardFocusManager</code>.
 *
 * @param aFocusManager the new <code>KeyboardFocusManager</code>
 * for this thread's context
 * @see #getCurrentManager
 * @see java.awt.DefaultKeyboardFocusManager
 */
publicstaticvoidsetCurrentManager(FocusManageraFocusManager) {
KeyboardFocusManagertoSet =
 (aFocusManagerinstanceofDelegatingDefaultFocusManager)
 ? ((DelegatingDefaultFocusManager)aFocusManager).getDelegate()
 : aFocusManager;
KeyboardFocusManager.setCurrentKeyboardFocusManager(toSet);
 }

/**
 * Changes the current <code>KeyboardFocusManager</code>'s default
 * <code>FocusTraversalPolicy</code> to
 * <code>DefaultFocusTraversalPolicy</code>.
 *
 * @see java.awt.DefaultFocusTraversalPolicy
 * @see java.awt.KeyboardFocusManager#setDefaultFocusTraversalPolicy
 * @deprecated as of 1.4, replaced by
 * <code>KeyboardFocusManager.setDefaultFocusTraversalPolicy(FocusTraversalPolicy)</code>
 */
@Deprecated
publicstaticvoiddisableSwingFocusManager() {
if (enabled) {
enabled = false;
KeyboardFocusManager.getCurrentKeyboardFocusManager().
setDefaultFocusTraversalPolicy(
newDefaultFocusTraversalPolicy());
 }
 }

/**
 * Returns whether the application has invoked
 * <code>disableSwingFocusManager()</code>.
 *
 * @return {@code true} if focus manager is enabled.
 * @see #disableSwingFocusManager
 * @deprecated As of 1.4, replaced by
 * <code>KeyboardFocusManager.getDefaultFocusTraversalPolicy()</code>
 */
@Deprecated
publicstaticbooleanisFocusManagerEnabled() {
returnenabled;
 }
}