APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt.event

public Class WindowEvent

extends ComponentEvent
Class Inheritance
Known Direct Subclasses
sun.awt.TimedWindowEvent
Imports
java.awt.Window, java.io.Serial, java.lang.annotation.Native, sun.awt.SunToolkit
A low-level event that indicates that a window has changed its status. This low-level event is generated by a Window object when it is opened, closed, activated, deactivated, iconified, or deiconified, or when focus is transferred into or out of the Window.

The event is passed to every WindowListener or WindowAdapter object which registered to receive such events using the window's addWindowListener method. (WindowAdapter objects implement the WindowListener interface.) Each such listener object gets this WindowEvent when the event occurs.

An unspecified behavior will be caused if the id parameter of any particular WindowEvent instance is not in the range from WINDOW_FIRST to WINDOW_LAST.

Authors
Carl Quinn, Amy Fowler
Since
1.1
See Also
WindowAdapter, WindowListener, Tutorial: Writing a Window Listener

Field Summary

Modifier and TypeField and Description
pack-priv int
newState

pack-priv int
oldState

pack-priv transient Window
opposite

The other Window involved in this focus or activation change.

private static final long
serialVersionUID

Hides java.awt.event.ComponentEvent.serialVersionUID.

Use serialVersionUID from JDK 1.1 for interoperability.
public static final int
WINDOW_ACTIVATED

The window-activated event type.

public static final int
WINDOW_CLOSED

The window closed event.

public static final int
WINDOW_CLOSING

The "window is closing" event.

public static final int
WINDOW_DEACTIVATED

The window-deactivated event type.

public static final int
WINDOW_DEICONIFIED

The window deiconified event type.

public static final int
WINDOW_FIRST

The first number in the range of ids used for window events.

public static final int
WINDOW_GAINED_FOCUS

The window-gained-focus event type.

public static final int
WINDOW_ICONIFIED

The window iconified event.

public static final int
WINDOW_LAST

The last number in the range of ids used for window events.

public static final int
WINDOW_LOST_FOCUS

The window-lost-focus event type.

public static final int
WINDOW_OPENED

The window opened event.

public static final int
WINDOW_STATE_CHANGED

The window-state-changed event type.

Inherited from java.awt.event.ComponentEvent:
COMPONENT_FIRSTCOMPONENT_HIDDENCOMPONENT_LASTCOMPONENT_MOVEDCOMPONENT_RESIZEDCOMPONENT_SHOWN

Constructor Summary

AccessConstructor and Description
public
WindowEvent(Window
The Window object that originated the event
source, int
An integer indicating the type of event. For information on allowable values, see the class description for WindowEvent
id, Window
The other window involved in the focus or activation change, or null
opposite, int
Previous state of the window for window state change event. See #getOldState() for allowable values
oldState, int
New state of the window for window state change event. See #getNewState() for allowable values
newState)

Constructs a WindowEvent object.

public
WindowEvent(Window
The Window object that originated the event
source, int
An integer indicating the type of event. For information on allowable values, see the class description for WindowEvent. It is expected that this constructor will not be used for other then WINDOW_ACTIVATED,WINDOW_DEACTIVATED, WINDOW_GAINED_FOCUS, or WINDOW_LOST_FOCUS. WindowEvent types, because the opposite Window of other event types will always be null.
id, Window
The other Window involved in the focus or activation change, or null
opposite)

Constructs a WindowEvent object with the specified opposite Window.

public
WindowEvent(Window
The Window object that originated the event
source, int
An integer indicating the type of event. For information on allowable values, see the class description for WindowEvent. It is expected that this constructor will not be used for other then WINDOW_STATE_CHANGED WindowEvent types, because the previous and new window states are meaningless for other event types.
id, int
An integer representing the previous window state. See #getOldState() for allowable values
oldState, int
An integer representing the new window state. See #getNewState() for allowable values
newState)

Constructs a WindowEvent object with the specified previous and new window states.

public
WindowEvent(Window
The Window object that originated the event
source, int
An integer indicating the type of event. For information on allowable values, see the class description for WindowEvent.
id)

Constructs a WindowEvent object.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

a bitwise mask of the new window state
getNewState()

For WINDOW_STATE_CHANGED events returns the new state of the window.

public int

Returns:

a bitwise mask of the previous window state
getOldState()

For WINDOW_STATE_CHANGED events returns the previous state of the window.

public Window

Returns:

the other Window involved in the focus or activation change, or null
getOppositeWindow()

Returns the other Window involved in this focus or activation change.

public Window

Returns:

the Window object that originated the event
getWindow()

Returns the originator of the event.

public String

Returns:

a string identifying the event and its attributes
paramString()

Overrides java.awt.event.ComponentEvent.paramString.

Returns a parameter string identifying this event.

Inherited from java.awt.event.ComponentEvent:
getComponent

Field Detail

newStateback to summary
pack-priv int newState
oldStateback to summary
pack-priv int oldState
oppositeback to summary
pack-priv transient Window opposite

The other Window involved in this focus or activation change. For a WINDOW_ACTIVATED or WINDOW_GAINED_FOCUS event, this is the Window that lost activation or focus. For a WINDOW_DEACTIVATED or WINDOW_LOST_FOCUS event, this is the Window that gained activation or focus. For any other type of WindowEvent, or if the focus or activation change occurs with a native application, a Java application in a different VM, or with no other Window, null is returned.

Since
1.4
See Also
getOppositeWindow
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.awt.event.ComponentEvent.serialVersionUID.

Use serialVersionUID from JDK 1.1 for interoperability.

Annotations
@Serial
WINDOW_ACTIVATEDback to summary
public static final int WINDOW_ACTIVATED

The window-activated event type. This event is delivered when the Window becomes the active Window. Only a Frame or a Dialog can be the active Window. The native windowing system may denote the active Window or its children with special decorations, such as a highlighted title bar. The active Window is always either the focused Window, or the first Frame or Dialog that is an owner of the focused Window.

Annotations
@Native
WINDOW_CLOSEDback to summary
public static final int WINDOW_CLOSED

The window closed event. This event is delivered after the displayable window has been closed as the result of a call to dispose.

Annotations
@Native
See Also
java.awt.Component#isDisplayable, Window#dispose
WINDOW_CLOSINGback to summary
public static final int WINDOW_CLOSING

The "window is closing" event. This event is delivered when the user attempts to close the window from the window's system menu. If the program does not explicitly hide or dispose the window while processing this event, the window close operation will be cancelled.

Annotations
@Native
WINDOW_DEACTIVATEDback to summary
public static final int WINDOW_DEACTIVATED

The window-deactivated event type. This event is delivered when the Window is no longer the active Window. Only a Frame or a Dialog can be the active Window. The native windowing system may denote the active Window or its children with special decorations, such as a highlighted title bar. The active Window is always either the focused Window, or the first Frame or Dialog that is an owner of the focused Window.

Annotations
@Native
WINDOW_DEICONIFIEDback to summary
public static final int WINDOW_DEICONIFIED

The window deiconified event type. This event is delivered when the window has been changed from a minimized to a normal state.

Annotations
@Native
WINDOW_FIRSTback to summary
public static final int WINDOW_FIRST

The first number in the range of ids used for window events.

WINDOW_GAINED_FOCUSback to summary
public static final int WINDOW_GAINED_FOCUS

The window-gained-focus event type. This event is delivered when the Window becomes the focused Window, which means that the Window, or one of its subcomponents, will receive keyboard events.

Annotations
@Native
WINDOW_ICONIFIEDback to summary
public static final int WINDOW_ICONIFIED

The window iconified event. This event is delivered when the window has been changed from a normal to a minimized state. For many platforms, a minimized window is displayed as the icon specified in the window's iconImage property.

Annotations
@Native
See Also
java.awt.Frame#setIconImage
WINDOW_LASTback to summary
public static final int WINDOW_LAST

The last number in the range of ids used for window events.

WINDOW_LOST_FOCUSback to summary
public static final int WINDOW_LOST_FOCUS

The window-lost-focus event type. This event is delivered when a Window is no longer the focused Window, which means keyboard events will no longer be delivered to the Window or any of its subcomponents.

Annotations
@Native
WINDOW_OPENEDback to summary
public static final int WINDOW_OPENED

The window opened event. This event is delivered only the first time a window is made visible.

Annotations
@Native
WINDOW_STATE_CHANGEDback to summary
public static final int WINDOW_STATE_CHANGED

The window-state-changed event type. This event is delivered when a Window's state is changed by virtue of it being iconified, maximized etc.

Annotations
@Native
Since
1.4

Constructor Detail

WindowEventback to summary
public WindowEvent(Window source, int id, Window opposite, int oldState, int newState)

Constructs a WindowEvent object.

This method throws an IllegalArgumentException if source is null.

Parameters
source:Window

The Window object that originated the event

id:int

An integer indicating the type of event. For information on allowable values, see the class description for WindowEvent

opposite:Window

The other window involved in the focus or activation change, or null

oldState:int

Previous state of the window for window state change event. See #getOldState() for allowable values

newState:int

New state of the window for window state change event. See #getNewState() for allowable values

Exceptions
IllegalArgumentException:
if source is null
Since
1.4
See Also
getWindow(), getID(), getOppositeWindow(), getOldState(), getNewState()
WindowEventback to summary
public WindowEvent(Window source, int id, Window opposite)

Constructs a WindowEvent object with the specified opposite Window. The opposite Window is the other Window involved in this focus or activation change. For a WINDOW_ACTIVATED or WINDOW_GAINED_FOCUS event, this is the Window that lost activation or focus. For a WINDOW_DEACTIVATED or WINDOW_LOST_FOCUS event, this is the Window that gained activation or focus. If this focus change occurs with a native application, with a Java application in a different VM, or with no other Window, then the opposite Window is null.

This method throws an IllegalArgumentException if source is null.

Parameters
source:Window

The Window object that originated the event

id:int

An integer indicating the type of event. For information on allowable values, see the class description for WindowEvent. It is expected that this constructor will not be used for other then WINDOW_ACTIVATED,WINDOW_DEACTIVATED, WINDOW_GAINED_FOCUS, or WINDOW_LOST_FOCUS. WindowEvent types, because the opposite Window of other event types will always be null.

opposite:Window

The other Window involved in the focus or activation change, or null

Exceptions
IllegalArgumentException:
if source is null
Since
1.4
See Also
getWindow(), getID(), getOppositeWindow()
WindowEventback to summary
public WindowEvent(Window source, int id, int oldState, int newState)

Constructs a WindowEvent object with the specified previous and new window states.

This method throws an IllegalArgumentException if source is null.

Parameters
source:Window

The Window object that originated the event

id:int

An integer indicating the type of event. For information on allowable values, see the class description for WindowEvent. It is expected that this constructor will not be used for other then WINDOW_STATE_CHANGED WindowEvent types, because the previous and new window states are meaningless for other event types.

oldState:int

An integer representing the previous window state. See #getOldState() for allowable values

newState:int

An integer representing the new window state. See #getNewState() for allowable values

Exceptions
IllegalArgumentException:
if source is null
Since
1.4
See Also
getWindow(), getID(), getOldState(), getNewState()
WindowEventback to summary
public WindowEvent(Window source, int id)

Constructs a WindowEvent object.

This method throws an IllegalArgumentException if source is null.

Parameters
source:Window

The Window object that originated the event

id:int

An integer indicating the type of event. For information on allowable values, see the class description for WindowEvent.

Exceptions
IllegalArgumentException:
if source is null
See Also
getWindow(), getID()

Method Detail

getNewStateback to summary
public int getNewState()

For WINDOW_STATE_CHANGED events returns the new state of the window. The state is represented as a bitwise mask.

  • NORMAL
    Indicates that no state bits are set.
  • ICONIFIED
  • MAXIMIZED_HORIZ
  • MAXIMIZED_VERT
  • MAXIMIZED_BOTH
    Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.
Returns:int

a bitwise mask of the new window state

Since
1.4
See Also
java.awt.Frame#getExtendedState()
getOldStateback to summary
public int getOldState()

For WINDOW_STATE_CHANGED events returns the previous state of the window. The state is represented as a bitwise mask.

  • NORMAL
    Indicates that no state bits are set.
  • ICONIFIED
  • MAXIMIZED_HORIZ
  • MAXIMIZED_VERT
  • MAXIMIZED_BOTH
    Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.
Returns:int

a bitwise mask of the previous window state

Since
1.4
See Also
java.awt.Frame#getExtendedState()
getOppositeWindowback to summary
public Window getOppositeWindow()

Returns the other Window involved in this focus or activation change. For a WINDOW_ACTIVATED or WINDOW_GAINED_FOCUS event, this is the Window that lost activation or focus. For a WINDOW_DEACTIVATED or WINDOW_LOST_FOCUS event, this is the Window that gained activation or focus. For any other type of WindowEvent, or if the focus or activation change occurs with a native application, with a Java application in a different VM, or with no other Window, null is returned.

Returns:Window

the other Window involved in the focus or activation change, or null

Since
1.4
getWindowback to summary
public Window getWindow()

Returns the originator of the event.

Returns:Window

the Window object that originated the event

paramStringback to summary
public String paramString()

Overrides java.awt.event.ComponentEvent.paramString.

Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Returns:String

a string identifying the event and its attributes