public class FocusEvent extends ComponentEvent
A low-level event which indicates that a Component has gained or lost the input focus. This low-level event is generated by a Component (such as a TextField). The event is passed to every FocusListener or FocusAdapter object which registered to receive such events using the Component's addFocusListener method. (
FocusAdapter objects implement the FocusListener interface.) Each such listener object gets this FocusEvent when the event occurs.
There are two levels of focus events: permanent and temporary. Permanent focus change events occur when focus is directly moved from one Component to another, such as through a call to requestFocus() or as the user uses the TAB key to traverse Components. Temporary focus change events occur when focus is temporarily lost for a Component as the indirect result of another operation, such as Window deactivation or a Scrollbar drag. In this case, the original focus state will automatically be restored once that operation is finished, or, for the case of Window deactivation, when the Window is reactivated. Both permanent and temporary focus events are delivered using the FOCUS_GAINED and FOCUS_LOST event ids; the level may be distinguished in the event using the isTemporary() method.
An unspecified behavior will be caused if the id parameter of any particular FocusEvent instance is not in the range from FOCUS_FIRST to FOCUS_LAST.
FocusAdapter, FocusListener, Tutorial: Writing a Focus Listener, Serialized Formpublic static final int FOCUS_FIRST
The first number in the range of ids used for focus events.
public static final int FOCUS_LAST
The last number in the range of ids used for focus events.
public static final int FOCUS_GAINED
This event indicates that the Component is now the focus owner.
public static final int FOCUS_LOST
This event indicates that the Component is no longer the focus owner.
public FocusEvent(Component source,
int id,
boolean temporary,
Component opposite) Constructs a FocusEvent object with the specified temporary state and opposite Component. The opposite Component is the other Component involved in this focus change. For a FOCUS_GAINED event, this is the Component that lost focus. For a FOCUS_LOST event, this is the Component that gained focus. If this focus change occurs with a native application, with a Java application in a different VM, or with no other Component, then the opposite Component is null.
This method throws an IllegalArgumentException if source is null.
source - The Component that originated the eventid - An integer indicating the type of event. For information on allowable values, see the class description for FocusEvent
temporary - Equals true if the focus change is temporary; false otherwiseopposite - The other Component involved in the focus change, or null
IllegalArgumentException - if source equals null
EventObject.getSource(), AWTEvent.getID(), isTemporary(), getOppositeComponent()
public FocusEvent(Component source,
int id,
boolean temporary) Constructs a FocusEvent object and identifies whether or not the change is temporary.
This method throws an IllegalArgumentException if source is null.
source - The Component that originated the eventid - An integer indicating the type of event. For information on allowable values, see the class description for FocusEvent
temporary - Equals true if the focus change is temporary; false otherwiseIllegalArgumentException - if source equals null
EventObject.getSource(), AWTEvent.getID(), isTemporary()
public FocusEvent(Component source,
int id) Constructs a FocusEvent object and identifies it as a permanent change in focus.
This method throws an IllegalArgumentException if source is null.
source - The Component that originated the eventid - An integer indicating the type of event. For information on allowable values, see the class description for FocusEvent
IllegalArgumentException - if source equals null
EventObject.getSource(), AWTEvent.getID()
public boolean isTemporary()
Identifies the focus change event as temporary or permanent.
true if the focus change is temporary; false otherwisepublic Component getOppositeComponent()
Returns the other Component involved in this focus change. For a FOCUS_GAINED event, this is the Component that lost focus. For a FOCUS_LOST event, this is the Component that gained focus. If this focus change occurs with a native application, with a Java application in a different VM or context, or with no other Component, then null is returned.
public String paramString()
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.
paramString in class ComponentEvent
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.