java.awt.event: public class: WindowEvent

java.awt.event
public class: WindowEvent [javadoc | source]

java.lang.Object
   java.util.EventObject
      java.awt.AWTEvent
         java.awt.event.ComponentEvent
            java.awt.event.WindowEvent

All Implemented Interfaces:
Serializable

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 the WindowListener interface.) Each such listener object gets this WindowEvent when the event occurs.

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

Also see:

WindowAdapter

WindowListener

Tutorial: Writing a Window Listener

author: Carl - Quinn

author: Amy - Fowler

since: JDK1.1 -

Field Summary
public static final int	WINDOW_FIRST	The first number in the range of ids used for window events.
public static final int	WINDOW_OPENED	The window opened event. This event is delivered only the first time a window is made visible.
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.
public static final int	WINDOW_CLOSED	The window closed event. This event is delivered after the window has been closed as the result of a call to dispose.
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. Also see: java.awt.Frame#setIconImage
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.
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.
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.
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.
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.
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` -
public static final int	WINDOW_LAST	The last number in the range of ids used for window events.
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. Also see: getOppositeWindow since: `1.4` -
int	oldState	TBS
int	newState

Fields inherited from java.awt.event.ComponentEvent:
COMPONENT_FIRST, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN, COMPONENT_HIDDEN

Fields inherited from java.awt.AWTEvent:
id, consumed, focusManagerIsDispatching, isPosted, COMPONENT_EVENT_MASK, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, WINDOW_EVENT_MASK, ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, ITEM_EVENT_MASK, TEXT_EVENT_MASK, INPUT_METHOD_EVENT_MASK, INPUT_METHODS_ENABLED_MASK, PAINT_EVENT_MASK, INVOCATION_EVENT_MASK, HIERARCHY_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, WINDOW_STATE_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, RESERVED_ID_MAX

Fields inherited from java.awt.AWTEvent:

id, consumed, focusManagerIsDispatching, isPosted, COMPONENT_EVENT_MASK, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, WINDOW_EVENT_MASK, ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, ITEM_EVENT_MASK, TEXT_EVENT_MASK, INPUT_METHOD_EVENT_MASK, INPUT_METHODS_ENABLED_MASK, PAINT_EVENT_MASK, INVOCATION_EVENT_MASK, HIERARCHY_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, WINDOW_STATE_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, RESERVED_ID_MAX

Fields inherited from java.util.EventObject:
source

Constructor:

Constructor:
public WindowEvent(Window source, int id) { this(source, id, null, 0, 0); } 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 . Throws: `IllegalArgumentException` - if `source` is null Also see: getWindow() getID()
public WindowEvent(Window source, int id, Window opposite) { this(source, id, opposite, 0, 0); } 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 . It is expected that this constructor will not be used for other then {@code WINDOW_ACTIVATED},{@code WINDOW_DEACTIVATED}, {@code WINDOW_GAINED_FOCUS}, or {@code WINDOW_LOST_FOCUS}. {@code WindowEvent} types, because the opposite `Window` of other event types will always be {@code null}. `opposite` - The other `Window` involved in the focus or activation change, or `null` Throws: `IllegalArgumentException` - if `source` is null Also see: getWindow() getID() getOppositeWindow() since: `1.4` -
public WindowEvent(Window source, int id, int oldState, int newState) { this(source, id, null, oldState, 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 . It is expected that this constructor will not be used for other then {@code WINDOW_STATE_CHANGED} {@code WindowEvent} types, because the previous and new window states are meaningless for other event types. `oldState` - An integer representing the previous window state. See {@code #getOldState()} for allowable values `newState` - An integer representing the new window state. See {@code #getNewState()} for allowable values Throws: `IllegalArgumentException` - if `source` is null Also see: getWindow() getID() getOldState() getNewState() since: `1.4` -
public WindowEvent(Window source, int id, Window opposite, int oldState, int newState) { super(source, id); this.opposite = opposite; this.oldState = oldState; this.newState = 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 `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 {@code #getOldState()} for allowable values `newState` - New state of the window for window state change event. See {@code #getNewState()} for allowable values Throws: `IllegalArgumentException` - if `source` is null Also see: getWindow() getID() getOppositeWindow() getOldState() getNewState() since: `1.4` -

 public WindowEvent(Window source,
    int id) {
        this(source, id, null, 0, 0);
}

WindowEvent

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 .

Throws:

IllegalArgumentException - if source is null

Also see:

getWindow()

getID()

 public WindowEvent(Window source,
    int id,
    Window opposite) {
        this(source, id, opposite, 0, 0);
}

WindowEvent

Window

WINDOW_ACTIVATED

WINDOW_GAINED_FOCUS

Window

WINDOW_DEACTIVATED

WINDOW_LOST_FOCUS

Window

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 . It is expected that this constructor will not be used for other then {@code WINDOW_ACTIVATED},{@code WINDOW_DEACTIVATED}, {@code WINDOW_GAINED_FOCUS}, or {@code WINDOW_LOST_FOCUS}. {@code WindowEvent} types, because the opposite Window of other event types will always be {@code null}.

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

Throws:

IllegalArgumentException - if source is null

Also see:

getWindow()

getID()

getOppositeWindow()

since: 1.4 -

 public WindowEvent(Window source,
    int id,
    int oldState,
    int newState) {
        this(source, id, null, oldState, newState);
}

WindowEvent

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 . It is expected that this constructor will not be used for other then {@code WINDOW_STATE_CHANGED} {@code WindowEvent} types, because the previous and new window states are meaningless for other event types.

oldState - An integer representing the previous window state. See {@code #getOldState()} for allowable values

newState - An integer representing the new window state. See {@code #getNewState()} for allowable values

Throws:

IllegalArgumentException - if source is null

Also see:

since: 1.4 -

 public WindowEvent(Window source,
    int id,
    Window opposite,
    int oldState,
    int newState) {
        super(source, id);
        this.opposite = opposite;
        this.oldState = oldState;
        this.newState = newState;
}

WindowEvent

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

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 {@code #getOldState()} for allowable values

newState - New state of the window for window state change event. See {@code #getNewState()} for allowable values

Throws:

IllegalArgumentException - if source is null

Also see:

since: 1.4 -

Method from java.awt.event.WindowEvent Summary:
getNewState, getOldState, getOppositeWindow, getWindow, paramString

Methods from java.awt.event.ComponentEvent:
getComponent, paramString

Methods from java.awt.AWTEvent:
consume, convertToOld, copyPrivateDataInto, dispatched, getAccessControlContext, getID, isConsumed, paramString, setSource, toString

Methods from java.util.EventObject:
getSource, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.awt.event.WindowEvent Detail:
public int getNewState() { return newState; } 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`.
public int getOldState() { return oldState; } 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`.
public Window getOppositeWindow() { if (opposite == null) { return null; } return (SunToolkit.targetToAppContext(opposite) == AppContext.getAppContext()) ? opposite : null; } 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.
public Window getWindow() { return (source instanceof Window) ? (Window)source : null; } Returns the originator of the event.
public String paramString() { String typeStr; switch(id) { case WINDOW_OPENED: typeStr = "WINDOW_OPENED"; break; case WINDOW_CLOSING: typeStr = "WINDOW_CLOSING"; break; case WINDOW_CLOSED: typeStr = "WINDOW_CLOSED"; break; case WINDOW_ICONIFIED: typeStr = "WINDOW_ICONIFIED"; break; case WINDOW_DEICONIFIED: typeStr = "WINDOW_DEICONIFIED"; break; case WINDOW_ACTIVATED: typeStr = "WINDOW_ACTIVATED"; break; case WINDOW_DEACTIVATED: typeStr = "WINDOW_DEACTIVATED"; break; case WINDOW_GAINED_FOCUS: typeStr = "WINDOW_GAINED_FOCUS"; break; case WINDOW_LOST_FOCUS: typeStr = "WINDOW_LOST_FOCUS"; break; case WINDOW_STATE_CHANGED: typeStr = "WINDOW_STATE_CHANGED"; break; default: typeStr = "unknown type"; } typeStr += ",opposite=" + getOppositeWindow() + ",oldState=" + oldState + ",newState=" + newState; return typeStr; } Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Method from java.awt.event.WindowEvent Detail:

 public int getNewState() {
        return newState;
}

WINDOW_STATE_CHANGED

NORMAL
Indicates that no state bits are set.
ICONIFIED
MAXIMIZED_HORIZ
MAXIMIZED_VERT
MAXIMIZED_BOTH
Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.

 public int getOldState() {
        return oldState;
}

WINDOW_STATE_CHANGED

NORMAL
Indicates that no state bits are set.
ICONIFIED
MAXIMIZED_HORIZ
MAXIMIZED_VERT
MAXIMIZED_BOTH
Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.

 public Window getOppositeWindow() {
        if (opposite == null) {
            return null;
        }
        return (SunToolkit.targetToAppContext(opposite) ==
                AppContext.getAppContext())
            ? opposite
            : null;
}

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.

 public Window getWindow() {
        return (source instanceof Window) ? (Window)source : null;
}

Returns the originator of the event.

 public String paramString() {
        String typeStr;
        switch(id) {
          case WINDOW_OPENED:
              typeStr = "WINDOW_OPENED";
              break;
          case WINDOW_CLOSING:
              typeStr = "WINDOW_CLOSING";
              break;
          case WINDOW_CLOSED:
              typeStr = "WINDOW_CLOSED";
              break;
          case WINDOW_ICONIFIED:
              typeStr = "WINDOW_ICONIFIED";
              break;
          case WINDOW_DEICONIFIED:
              typeStr = "WINDOW_DEICONIFIED";
              break;
          case WINDOW_ACTIVATED:
              typeStr = "WINDOW_ACTIVATED";
              break;
          case WINDOW_DEACTIVATED:
              typeStr = "WINDOW_DEACTIVATED";
              break;
          case WINDOW_GAINED_FOCUS:
              typeStr = "WINDOW_GAINED_FOCUS";
              break;
          case WINDOW_LOST_FOCUS:
              typeStr = "WINDOW_LOST_FOCUS";
              break;
          case WINDOW_STATE_CHANGED:
              typeStr = "WINDOW_STATE_CHANGED";
              break;
          default:
              typeStr = "unknown type";
        }
        typeStr += ",opposite=" + getOppositeWindow()
            + ",oldState=" + oldState + ",newState=" + newState;
        return typeStr;
}

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