FileDocCategorySizeDatePackage
WindowEvent.javaAPI DocJava SE 5 API14683Fri Aug 26 14:56:50 BST 2005java.awt.event

WindowEvent

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

author
Carl Quinn
author
Amy Fowler
version
1.34, 12/19/03
see
WindowAdapter
see
WindowListener
see
Tutorial: Writing a Window Listener
see
Reference: The Java Class Libraries (update file)
since
JDK1.1

Fields 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.
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.
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.
int
oldState
TBS
int
newState
private static final long
serialVersionUID
Constructors Summary
public WindowEvent(Window source, int id, Window opposite, int oldState, int newState)
Constructs a WindowEvent object.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

param
source the Window object that originated the event
param
id an integer indicating the type of event.
param
opposite the other window involved in the focus or activation change, or null
param
oldState previous state of the window for window state change event
param
newState new state of the window for window state change event
throws
IllegalArgumentException if source is null
since
1.4



                              	                                                                                                                                         
          
		          
    
        super(source, id);
	this.opposite = opposite;
	this.oldState = oldState;
	this.newState = newState;
    
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.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

param
source the Window object that originated the event
param
id WINDOW_ACTIVATED, WINDOW_DEACTIVATED, WINDOW_GAINED_FOCUS, or WINDOW_LOST_FOCUS. It is expected that this constructor will not be used for other WindowEvent types because the opposite Window of such events will always be null
param
opposite the other Window involved in the focus or activation change, or null
throws
IllegalArgumentException if source is null

        this(source, id, opposite, 0, 0);
    
public WindowEvent(Window source, int id, int oldState, int newState)
Constructs a WindowEvent object with the specified previous and new window states.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

param
source the Window object that originated the event
param
id WINDOW_STATE_CHANGED event type. It is expected that this constructor will not be used for other WindowEvent types, because the previous and new window states are meaningless for other event types.
param
oldState an integer representing the previous window state
param
newState an integer representing the new window state
throws
IllegalArgumentException if source is null
since
1.4

	this(source, id, null, oldState, newState);
    
public WindowEvent(Window source, int id)
Constructs a WindowEvent object.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.

param
source the Window object that originated the event
param
id an integer indicating the type of event
throws
IllegalArgumentException if source is null

        this(source, id, null, 0, 0);
    
Methods Summary
public intgetNewState()
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.

return
a bitwise mask of the new window state
see
java.awt.Frame#getExtendedState()
since
1.4

	return newState;
    
public intgetOldState()
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.

return
a bitwise mask of the previous window state
see
java.awt.Frame#getExtendedState()
since
1.4

	return oldState;
    
public java.awt.WindowgetOppositeWindow()
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.

return
the other Window involved in the focus or activation change, or null
since
1.4

        if (opposite == null) {
	    return null;
	}

        return (SunToolkit.targetToAppContext(opposite) ==
		AppContext.getAppContext())
	    ? opposite
	    : null;
    
public java.awt.WindowgetWindow()
Returns the originator of the event.

return
the Window object that originated the event

        return (source instanceof Window) ? (Window)source : null;
    
public java.lang.StringparamString()
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

return
a string identifying the event and its attributes

        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;