java.awt.event
Class WindowEvent

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

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:
1.1
See Also:
WindowAdapter, WindowListener, WindowFocusListener, WindowStateListener, Serialized Form

Field Summary
static int WINDOW_ACTIVATED
          This is the id for a window that is activated.
static int WINDOW_CLOSED
          This is the id for a window that finished closing.
static int WINDOW_CLOSING
          This is the id for a window that is about to close.
static int WINDOW_DEACTIVATED
          This is the id for a window that is de-activated.
static int WINDOW_DEICONIFIED
          This is the id for a window that is de-iconified.
static int WINDOW_FIRST
          This is the first id in the range of event ids used by this class.
static int WINDOW_GAINED_FOCUS
          This is the id for a window becoming the focused window.
static int WINDOW_ICONIFIED
          This is the id for a window that is iconified.
static int WINDOW_LAST
          This is the last id in the range of event ids used by this class.
static int WINDOW_LOST_FOCUS
          This is the id for a window losing all focus.
static int WINDOW_OPENED
          This is the id for a window that is opened.
static int WINDOW_STATE_CHANGED
          This is the id for a window state change, such as maximization.
 
Fields inherited from class java.awt.event.ComponentEvent
COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN
 
Fields inherited from class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
WindowEvent(Window source, int id)
          Initializes a new instance of WindowEvent with the specified parameters.
WindowEvent(Window source, int id, int oldState, int newState)
          Initializes a new instance of WindowEvent with the specified parameters.
WindowEvent(Window source, int id, Window opposite)
          Initializes a new instance of WindowEvent with the specified parameters.
WindowEvent(Window source, int id, Window opposite, int oldState, int newState)
          Initializes a new instance of WindowEvent with the specified parameters.
 
Method Summary
 int getNewState()
          Returns the state of this window after the event.
 int getOldState()
          Returns the state of this window before the event.
 Window getOppositeWindow()
          Returns the opposite window if this window was involved in an activation or focus change.
 Window getWindow()
          Returns the event source as a Window.
 String paramString()
          Returns a string that identifies this event.
 
Methods inherited from class java.awt.event.ComponentEvent
getComponent
 
Methods inherited from class java.awt.AWTEvent
consume, getID, isConsumed, setSource, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

WINDOW_FIRST

public static final int WINDOW_FIRST
This is the first id in the range of event ids used by this class.

See Also:
Constant Field Values

WINDOW_OPENED

public static final int WINDOW_OPENED
This is the id for a window that is opened.

See Also:
Constant Field Values

WINDOW_CLOSING

public static final int WINDOW_CLOSING
This is the id for a window that is about to close.

See Also:
Constant Field Values

WINDOW_CLOSED

public static final int WINDOW_CLOSED
This is the id for a window that finished closing.

See Also:
Constant Field Values

WINDOW_ICONIFIED

public static final int WINDOW_ICONIFIED
This is the id for a window that is iconified.

See Also:
Constant Field Values

WINDOW_DEICONIFIED

public static final int WINDOW_DEICONIFIED
This is the id for a window that is de-iconified.

See Also:
Constant Field Values

WINDOW_ACTIVATED

public static final int WINDOW_ACTIVATED
This is the id for a window that is activated.

See Also:
Constant Field Values

WINDOW_DEACTIVATED

public static final int WINDOW_DEACTIVATED
This is the id for a window that is de-activated.

See Also:
Constant Field Values

WINDOW_GAINED_FOCUS

public static final int WINDOW_GAINED_FOCUS
This is the id for a window becoming the focused window.

Since:
1.4
See Also:
Constant Field Values

WINDOW_LOST_FOCUS

public static final int WINDOW_LOST_FOCUS
This is the id for a window losing all focus.

Since:
1.4
See Also:
Constant Field Values

WINDOW_STATE_CHANGED

public static final int WINDOW_STATE_CHANGED
This is the id for a window state change, such as maximization.

Since:
1.4
See Also:
Constant Field Values

WINDOW_LAST

public static final int WINDOW_LAST
This is the last id in the range of event ids used by this class.

See Also:
Constant Field Values
Constructor Detail

WindowEvent

public WindowEvent(Window source,
                   int id,
                   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.

Parameters:
source - the window that generated this event
id - the event id
opposite - the window that received the opposite event, or null
oldState - the previous state of this window
newState - the new state of this window
Throws:
IllegalArgumentException - if source is null
Since:
1.4

WindowEvent

public WindowEvent(Window source,
                   int id,
                   Window opposite)
Initializes a new instance of WindowEvent with the specified parameters. Note that an invalid id leads to unspecified results.

Parameters:
source - the window that generated this event
id - the event id
opposite - the window that received the opposite event, or null
Throws:
IllegalArgumentException - if source is null
Since:
1.4

WindowEvent

public WindowEvent(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.

Parameters:
source - the window that generated this event
id - the event id
oldState - the previous state of this window
newState - the new state of this window
Throws:
IllegalArgumentException - if source is null
Since:
1.4

WindowEvent

public WindowEvent(Window source,
                   int id)
Initializes a new instance of WindowEvent with the specified parameters. Note that an invalid id leads to unspecified results.

Parameters:
source - the window that generated this event
id - the event id
Throws:
IllegalArgumentException - if source is null
Method Detail

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:
the event source as a Window

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.

Returns:
the opposite window, or null
Since:
1.4

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.

Returns:
the former state
Since:
1.4
See Also:
Frame.getExtendedState()

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.

Returns:
the updated state
Since:
1.4
See Also:
Frame.getExtendedState()

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.

Overrides:
paramString in class ComponentEvent
Returns:
a string that identifies this event