Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt.event

Class WindowEvent

java.lang.Object
|
+--java.util.EventObject
   |
   +--java.awt.AWTEvent
      |
      +--java.awt.event.ComponentEvent
         |
         +--java.awt.event.WindowEvent


public class WindowEvent

extends ComponentEvent

This event is generated when there is a change in a window. This includes creation, closing, iconification, activation, and focus changes. There are three listeners, for three types of events: WindowListeners deal with the lifecycle of a window, WindowStateListeners deal with window state like maximization, and WindowFocusListeners deal with focus switching to or from a window.

Since:Author:See Also:

Field Summary

static intWINDOW_ACTIVATED

This is the id for a window that is activated.
static intWINDOW_CLOSED

This is the id for a window that finished closing.
static intWINDOW_CLOSING

This is the id for a window that is about to close.
static intWINDOW_DEACTIVATED

This is the id for a window that is de-activated.
static intWINDOW_DEICONIFIED

This is the id for a window that is de-iconified.
static intWINDOW_FIRST

This is the first id in the range of event ids used by this class.
static intWINDOW_GAINED_FOCUS

This is the id for a window becoming the focused window.
static intWINDOW_ICONIFIED

This is the id for a window that is iconified.
static intWINDOW_LAST

This is the last id in the range of event ids used by this class.
static intWINDOW_LOST_FOCUS

This is the id for a window losing all focus.
static intWINDOW_OPENED

This is the id for a window that is opened.
static intWINDOW_STATE_CHANGED

This is the id for a window state change, such as maximization.

Constructor Summary

WindowEvent(java.awt.Window source, int id, java.awt.Window opposite, int oldState, int newState)

Initializes a new instance of WindowEvent with the specified parameters.
WindowEvent(java.awt.Window source, int id, java.awt.Window opposite)

Initializes a new instance of WindowEvent with the specified parameters.
WindowEvent(java.awt.Window source, int id, int oldState, int newState)

Initializes a new instance of WindowEvent with the specified parameters.
WindowEvent(java.awt.Window source, int id)

Initializes a new instance of WindowEvent with the specified parameters.

Method Summary

intgetNewState()

Returns the state of this window after the event.
intgetOldState()

Returns the state of this window before the event.
java.awt.WindowgetOppositeWindow()

Returns the opposite window if this window was involved in an activation or focus change.
java.awt.WindowgetWindow()

Returns the event source as a Window.
java.lang.StringparamString()

Returns a string that identifies this event.

Field Details

WINDOW_ACTIVATED

public static final int WINDOW_ACTIVATED

This is the id for a window that is activated.


WINDOW_CLOSED

public static final int WINDOW_CLOSED

This is the id for a window that finished closing.


WINDOW_CLOSING

public static final int WINDOW_CLOSING

This is the id for a window that is about to close.


WINDOW_DEACTIVATED

public static final int WINDOW_DEACTIVATED

This is the id for a window that is de-activated.


WINDOW_DEICONIFIED

public static final int WINDOW_DEICONIFIED

This is the id for a window that is de-iconified.


WINDOW_FIRST

public static final int WINDOW_FIRST

This is the first id in the range of event ids used by this class.


WINDOW_GAINED_FOCUS

public static final int WINDOW_GAINED_FOCUS

This is the id for a window becoming the focused window.

Since:

WINDOW_ICONIFIED

public static final int WINDOW_ICONIFIED

This is the id for a window that is iconified.


WINDOW_LAST

public static final int WINDOW_LAST

This is the last id in the range of event ids used by this class.


WINDOW_LOST_FOCUS

public static final int WINDOW_LOST_FOCUS

This is the id for a window losing all focus.

Since:

WINDOW_OPENED

public static final int WINDOW_OPENED

This is the id for a window that is opened.


WINDOW_STATE_CHANGED

public static final int WINDOW_STATE_CHANGED

This is the id for a window state change, such as maximization.

Since:

Constructor Details

WindowEvent

public WindowEvent(java.awt.Window source, int id)

Initializes a new instance of WindowEvent with the specified parameters. Note that an invalid id leads to unspecified results.

Parameters:

Throws:


WindowEvent

public WindowEvent(java.awt.Window source, int id, int oldState, int newState)

Initializes a new instance of WindowEvent with the specified parameters. Note that an invalid id leads to unspecified results.

Since:Parameters:

Throws:


WindowEvent

public WindowEvent(java.awt.Window source, int id, java.awt.Window opposite)

Initializes a new instance of WindowEvent with the specified parameters. Note that an invalid id leads to unspecified results.

Since:Parameters:

Throws:


WindowEvent

public WindowEvent(java.awt.Window source, int id, java.awt.Window opposite, int oldState, int newState)

Initializes a new instance of WindowEvent with the specified parameters. Note that an invalid id leads to unspecified results.

Since:Parameters:

Throws:


Method Details

getNewState

public int getNewState()

Returns the state of this window after the event. This is the bitwise or of fields in Frame: NORMAL, ICONIFIED, MAXIMIZED_HORIZ, MAXIMIZED_VERT, and MAXIMIZED_BOTH.

Since:Returns:

See Also:


getOldState

public int getOldState()

Returns the state of this window before the event. This is the bitwise or of fields in Frame: NORMAL, ICONIFIED, MAXIMIZED_HORIZ, MAXIMIZED_VERT, and MAXIMIZED_BOTH.

Since:Returns:

See Also:


getOppositeWindow

public Window getOppositeWindow()

Returns the opposite window if this window was involved in an activation or focus change. For WINDOW_ACTIVATED and WINDOW_GAINED_FOCUS events, this is the window that lost focus; for WINDOW_DEACTIVATED and WINDOW_LOST_FOCUS, this is the window that stole focus; and for other events (or when native implementation does not have the data available), this is null.

Since:Returns:


getWindow

public Window getWindow()

Returns the event source as a Window. If the source has subsequently been modified to a non-Window, this returns null.

Returns:


paramString

public String paramString()

Returns a string that identifies this event. This is formatted as the field name of the id, followed by the opposite window, old state, and new state.

Returns: