WindowEvent (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.util.EventObject
- - java.awt.AWTEvent
    - - java.awt.event.ComponentEvent
        * * java.awt.event.WindowEvent
All Implemented Interfaces:
Serializable

public class WindowEvent
extends ComponentEvent
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 transfered 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 theWindowListener 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.
Since:
JDK1.1
See Also:
WindowAdapter, WindowListener, Tutorial: Writing a Window Listener, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	WINDOW_ACTIVATED	The window-activated event type.
static int	WINDOW_CLOSED	The window closed event.
static int	WINDOW_CLOSING	The "window is closing" event.
static int	WINDOW_DEACTIVATED	The window-deactivated event type.
static int	WINDOW_DEICONIFIED	The window deiconified event type.
static int	WINDOW_FIRST	The first number in the range of ids used for window events.
static int	WINDOW_GAINED_FOCUS	The window-gained-focus event type.
static int	WINDOW_ICONIFIED	The window iconified event.
static int	WINDOW_LAST	The last number in the range of ids used for window events.
static int	WINDOW_LOST_FOCUS	The window-lost-focus event type.
static int	WINDOW_OPENED	The window opened event.
static int	WINDOW_STATE_CHANGED	The window-state-changed event type.

   * ### Fields inherited from class java.awt.event.[ComponentEvent](../../../java/awt/event/ComponentEvent.html "class in java.awt.event")  
   `[COMPONENT_FIRST](../../../java/awt/event/ComponentEvent.html#COMPONENT%5FFIRST), [COMPONENT_HIDDEN](../../../java/awt/event/ComponentEvent.html#COMPONENT%5FHIDDEN), [COMPONENT_LAST](../../../java/awt/event/ComponentEvent.html#COMPONENT%5FLAST), [COMPONENT_MOVED](../../../java/awt/event/ComponentEvent.html#COMPONENT%5FMOVED), [COMPONENT_RESIZED](../../../java/awt/event/ComponentEvent.html#COMPONENT%5FRESIZED), [COMPONENT_SHOWN](../../../java/awt/event/ComponentEvent.html#COMPONENT%5FSHOWN)`  
   * ### Fields inherited from class java.awt.[AWTEvent](../../../java/awt/AWTEvent.html "class in java.awt")  
   `[ACTION_EVENT_MASK](../../../java/awt/AWTEvent.html#ACTION%5FEVENT%5FMASK), [ADJUSTMENT_EVENT_MASK](../../../java/awt/AWTEvent.html#ADJUSTMENT%5FEVENT%5FMASK), [COMPONENT_EVENT_MASK](../../../java/awt/AWTEvent.html#COMPONENT%5FEVENT%5FMASK), [consumed](../../../java/awt/AWTEvent.html#consumed), [CONTAINER_EVENT_MASK](../../../java/awt/AWTEvent.html#CONTAINER%5FEVENT%5FMASK), [FOCUS_EVENT_MASK](../../../java/awt/AWTEvent.html#FOCUS%5FEVENT%5FMASK), [HIERARCHY_BOUNDS_EVENT_MASK](../../../java/awt/AWTEvent.html#HIERARCHY%5FBOUNDS%5FEVENT%5FMASK), [HIERARCHY_EVENT_MASK](../../../java/awt/AWTEvent.html#HIERARCHY%5FEVENT%5FMASK), [id](../../../java/awt/AWTEvent.html#id), [INPUT_METHOD_EVENT_MASK](../../../java/awt/AWTEvent.html#INPUT%5FMETHOD%5FEVENT%5FMASK), [INVOCATION_EVENT_MASK](../../../java/awt/AWTEvent.html#INVOCATION%5FEVENT%5FMASK), [ITEM_EVENT_MASK](../../../java/awt/AWTEvent.html#ITEM%5FEVENT%5FMASK), [KEY_EVENT_MASK](../../../java/awt/AWTEvent.html#KEY%5FEVENT%5FMASK), [MOUSE_EVENT_MASK](../../../java/awt/AWTEvent.html#MOUSE%5FEVENT%5FMASK), [MOUSE_MOTION_EVENT_MASK](../../../java/awt/AWTEvent.html#MOUSE%5FMOTION%5FEVENT%5FMASK), [MOUSE_WHEEL_EVENT_MASK](../../../java/awt/AWTEvent.html#MOUSE%5FWHEEL%5FEVENT%5FMASK), [PAINT_EVENT_MASK](../../../java/awt/AWTEvent.html#PAINT%5FEVENT%5FMASK), [RESERVED_ID_MAX](../../../java/awt/AWTEvent.html#RESERVED%5FID%5FMAX), [TEXT_EVENT_MASK](../../../java/awt/AWTEvent.html#TEXT%5FEVENT%5FMASK), [WINDOW_EVENT_MASK](../../../java/awt/AWTEvent.html#WINDOW%5FEVENT%5FMASK), [WINDOW_FOCUS_EVENT_MASK](../../../java/awt/AWTEvent.html#WINDOW%5FFOCUS%5FEVENT%5FMASK), [WINDOW_STATE_EVENT_MASK](../../../java/awt/AWTEvent.html#WINDOW%5FSTATE%5FEVENT%5FMASK)`  
   * ### Fields inherited from class java.util.[EventObject](../../../java/util/EventObject.html "class in java.util")  
   `[source](../../../java/util/EventObject.html#source)`

Constructor Summary

Constructors

Constructor	Description
WindowEvent(Window source, int id)	Constructs a WindowEvent object.
WindowEvent(Window source, int id, int oldState, int newState)	Constructs a WindowEvent object with the specified previous and new window states.
WindowEvent(Window source, int id,Window opposite)	Constructs a WindowEvent object with the specified opposite Window.
WindowEvent(Window source, int id,Window opposite, int oldState, int newState)	Constructs a WindowEvent object.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
int	getNewState()	For WINDOW_STATE_CHANGED events returns the new state of the window.
int	getOldState()	For WINDOW_STATE_CHANGED events returns the previous state of the window.
Window	getOppositeWindow()	Returns the other Window involved in this focus or activation change.
Window	getWindow()	Returns the originator of the event.
String	paramString()	Returns a parameter string identifying this event.

   * ### Methods inherited from class java.awt.event.[ComponentEvent](../../../java/awt/event/ComponentEvent.html "class in java.awt.event")  
   `[getComponent](../../../java/awt/event/ComponentEvent.html#getComponent--)`  
   * ### Methods inherited from class java.awt.[AWTEvent](../../../java/awt/AWTEvent.html "class in java.awt")  
   `[consume](../../../java/awt/AWTEvent.html#consume--), [getID](../../../java/awt/AWTEvent.html#getID--), [isConsumed](../../../java/awt/AWTEvent.html#isConsumed--), [setSource](../../../java/awt/AWTEvent.html#setSource-java.lang.Object-), [toString](../../../java/awt/AWTEvent.html#toString--)`  
   * ### Methods inherited from class java.util.[EventObject](../../../java/util/EventObject.html "class in java.util")  
   `[getSource](../../../java/util/EventObject.html#getSource--)`  
   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

Field Detail

 * #### WINDOW\_FIRST  
 public static final int WINDOW_FIRST  
 The first number in the range of ids used for window events.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FFIRST)  
 * #### WINDOW\_OPENED  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 public static final int WINDOW_OPENED  
 The window opened event. This event is delivered only the first time a window is made visible.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FOPENED)  
 * #### WINDOW\_CLOSING  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FCLOSING)  
 * #### WINDOW\_CLOSED  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 See Also:  
 [Component.isDisplayable()](../../../java/awt/Component.html#isDisplayable--), [Window.dispose()](../../../java/awt/Window.html#dispose--), [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FCLOSED)  
 * #### WINDOW\_ICONIFIED  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 See Also:  
 [Frame.setIconImage(java.awt.Image)](../../../java/awt/Frame.html#setIconImage-java.awt.Image-), [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FICONIFIED)  
 * #### WINDOW\_DEICONIFIED  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FDEICONIFIED)  
 * #### WINDOW\_ACTIVATED  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FACTIVATED)  
 * #### WINDOW\_DEACTIVATED  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FDEACTIVATED)  
 * #### WINDOW\_GAINED\_FOCUS  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FGAINED%5FFOCUS)  
 * #### WINDOW\_LOST\_FOCUS  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FLOST%5FFOCUS)  
 * #### WINDOW\_STATE\_CHANGED  
 [@Native](../../../java/lang/annotation/Native.html "annotation in java.lang.annotation")  
 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.  
 Since:  
 1.4  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FSTATE%5FCHANGED)  
 * #### WINDOW\_LAST  
 public static final int WINDOW_LAST  
 The last number in the range of ids used for window events.  
 See Also:  
 [Constant Field Values](../../../constant-values.html#java.awt.event.WindowEvent.WINDOW%5FLAST)

Constructor Detail

* #### WindowEvent  
public WindowEvent([Window](../../../java/awt/Window.html "class in java.awt") source,  
                   int id,  
                   [Window](../../../java/awt/Window.html "class in java.awt") opposite,  
                   int oldState,  
                   int newState)  
Constructs a `WindowEvent` object.  
This method throws an`IllegalArgumentException` if `source` is `null`.  
Parameters:  
`source` \- The `Window` object that originated the event  
`id` \- An integer indicating the type of event. For information on allowable values, see the class description for [WindowEvent](../../../java/awt/event/WindowEvent.html "class in java.awt.event")  
`opposite` \- The other window involved in the focus or activation change, or `null`  
`oldState` \- Previous state of the window for window state change event. See `#getOldState()` for allowable values  
`newState` \- New state of the window for window state change event. See `#getNewState()` for allowable values  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `source` is null  
Since:  
1.4  
See Also:  
[getWindow()](../../../java/awt/event/WindowEvent.html#getWindow--), [AWTEvent.getID()](../../../java/awt/AWTEvent.html#getID--), [getOppositeWindow()](../../../java/awt/event/WindowEvent.html#getOppositeWindow--), [getOldState()](../../../java/awt/event/WindowEvent.html#getOldState--), [getNewState()](../../../java/awt/event/WindowEvent.html#getNewState--)  
* #### WindowEvent  
public WindowEvent([Window](../../../java/awt/Window.html "class in java.awt") source,  
                   int id,  
                   [Window](../../../java/awt/Window.html "class in java.awt") 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` \- The `Window` object that originated the event  
`id` \- An integer indicating the type of event. For information on allowable values, see the class description for [WindowEvent](../../../java/awt/event/WindowEvent.html "class in java.awt.event"). 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` \- The other `Window` involved in the focus or activation change, or `null`  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `source` is null  
Since:  
1.4  
See Also:  
[getWindow()](../../../java/awt/event/WindowEvent.html#getWindow--), [AWTEvent.getID()](../../../java/awt/AWTEvent.html#getID--), [getOppositeWindow()](../../../java/awt/event/WindowEvent.html#getOppositeWindow--)  
* #### WindowEvent  
public WindowEvent([Window](../../../java/awt/Window.html "class in java.awt") 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` \- The `Window` object that originated the event  
`id` \- An integer indicating the type of event. For information on allowable values, see the class description for [WindowEvent](../../../java/awt/event/WindowEvent.html "class in java.awt.event"). 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` \- An integer representing the previous window state. See `#getOldState()` for allowable values  
`newState` \- An integer representing the new window state. See `#getNewState()` for allowable values  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `source` is null  
Since:  
1.4  
See Also:  
[getWindow()](../../../java/awt/event/WindowEvent.html#getWindow--), [AWTEvent.getID()](../../../java/awt/AWTEvent.html#getID--), [getOldState()](../../../java/awt/event/WindowEvent.html#getOldState--), [getNewState()](../../../java/awt/event/WindowEvent.html#getNewState--)  
* #### WindowEvent  
public WindowEvent([Window](../../../java/awt/Window.html "class in java.awt") source,  
                   int id)  
Constructs a `WindowEvent` object.  
This method throws an`IllegalArgumentException` if `source` is `null`.  
Parameters:  
`source` \- The `Window` object that originated the event  
`id` \- An integer indicating the type of event. For information on allowable values, see the class description for [WindowEvent](../../../java/awt/event/WindowEvent.html "class in java.awt.event").  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `source` is null  
See Also:  
[getWindow()](../../../java/awt/event/WindowEvent.html#getWindow--), [AWTEvent.getID()](../../../java/awt/AWTEvent.html#getID--)

Method Detail

* #### getWindow  
public [Window](../../../java/awt/Window.html "class in java.awt") getWindow()  
Returns the originator of the event.  
Returns:  
the Window object that originated the event  
* #### getOppositeWindow  
public [Window](../../../java/awt/Window.html "class in java.awt") 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 context, or with no other Window, null is returned.  
Returns:  
the other Window involved in the focus or activation change, or null  
Since:  
1.4  
* #### getOldState  
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:  
a bitwise mask of the previous window state  
Since:  
1.4  
See Also:  
[Frame.getExtendedState()](../../../java/awt/Frame.html#getExtendedState--)  
* #### getNewState  
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:  
a bitwise mask of the new window state  
Since:  
1.4  
See Also:  
[Frame.getExtendedState()](../../../java/awt/Frame.html#getExtendedState--)  
* #### paramString  
public [String](../../../java/lang/String.html "class in java.lang") paramString()  
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.  
Overrides:  
`[paramString](../../../java/awt/event/ComponentEvent.html#paramString--)` in class `[ComponentEvent](../../../java/awt/event/ComponentEvent.html "class in java.awt.event")`  
Returns:  
a string identifying the event and its attributes

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

WindowEvent (Java Platform SE 8 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail