Class WindowEvent

java.lang.Object
java.util.EventObject
java.awt.AWTEvent
java.awt.event.ComponentEvent
java.awt.event.WindowEvent
All Implemented Interfaces:
Serializable
public classWindowEventextendsComponentEvent
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 transferred into or out of the Window.

The event is passed to everyWindowListener orWindowAdapter object which registered to receive such events using the window'saddWindowListener method. (WindowAdapter objects implement theWindowListener interface.) Each such listener object gets thisWindowEvent when the event occurs.

An unspecified behavior will be caused if theid parameter of any particularWindowEvent instance is not in the range fromWINDOW_FIRST toWINDOW_LAST.

Since:
1.1
See Also:

  • Field Details

    • WINDOW_FIRST

      public static final int WINDOW_FIRST
      The first number in the range of ids used for window events.
      See Also:

    • WINDOW_OPENED

      @Nativepublic static final int WINDOW_OPENED
      The window opened event. This event is delivered only the first time a window is made visible.
      See Also:

    • WINDOW_CLOSING

      @Nativepublic 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:

    • WINDOW_CLOSED

      @Nativepublic 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:

    • WINDOW_ICONIFIED

      @Nativepublic 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:

    • WINDOW_DEICONIFIED

      @Nativepublic 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:

    • WINDOW_ACTIVATED

      @Nativepublic 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:

    • WINDOW_DEACTIVATED

      @Nativepublic 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:

    • WINDOW_GAINED_FOCUS

      @Nativepublic 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:

    • WINDOW_LOST_FOCUS

      @Nativepublic 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:

    • WINDOW_STATE_CHANGED

      @Nativepublic 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:

    • WINDOW_LAST

      public static final int WINDOW_LAST
      The last number in the range of ids used for window events.
      See Also:

  • Constructor Details

    • WindowEvent

      public WindowEvent(Window source, int id,Window opposite, int oldState, int newState)
      Constructs aWindowEvent object.

      This method throws anIllegalArgumentException ifsource isnull.

      Parameters:
      source - TheWindow object that originated the event
      id - An integer indicating the type of event. For information on allowable values, see the class description forWindowEvent
      opposite - The other window involved in the focus or activation change, ornull
      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 - ifsource is null
      Since:
      1.4
      See Also:

    • WindowEvent

      public WindowEvent(Window source, int id,Window opposite)
      Constructs aWindowEvent object with the specified oppositeWindow. The oppositeWindow is the otherWindow involved in this focus or activation change. For aWINDOW_ACTIVATED orWINDOW_GAINED_FOCUS event, this is theWindow that lost activation or focus. For aWINDOW_DEACTIVATED orWINDOW_LOST_FOCUS event, this is theWindow 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 otherWindow, then the opposite Window isnull.

      This method throws anIllegalArgumentException ifsource isnull.

      Parameters:
      source - TheWindow object that originated the event
      id - An integer indicating the type of event. For information on allowable values, see the class description forWindowEvent. It is expected that this constructor will not be used for other thenWINDOW_ACTIVATED,WINDOW_DEACTIVATED,WINDOW_GAINED_FOCUS, orWINDOW_LOST_FOCUS.WindowEvent types, because the oppositeWindow of other event types will always benull.
      opposite - The otherWindow involved in the focus or activation change, ornull
      Throws:
      IllegalArgumentException - ifsource is null
      Since:
      1.4
      See Also:

    • WindowEvent

      public WindowEvent(Window source, int id, int oldState, int newState)
      Constructs aWindowEvent object with the specified previous and new window states.

      This method throws anIllegalArgumentException ifsource isnull.

      Parameters:
      source - TheWindow object that originated the event
      id - An integer indicating the type of event. For information on allowable values, see the class description forWindowEvent. It is expected that this constructor will not be used for other thenWINDOW_STATE_CHANGEDWindowEvent 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 - ifsource is null
      Since:
      1.4
      See Also:

    • WindowEvent

      public WindowEvent(Window source, int id)
      Constructs aWindowEvent object.

      This method throws anIllegalArgumentException ifsource isnull.

      Parameters:
      source - TheWindow object that originated the event
      id - An integer indicating the type of event. For information on allowable values, see the class description forWindowEvent.
      Throws:
      IllegalArgumentException - ifsource is null
      See Also:

  • Method Details

    • getWindow

      public Window getWindow()
      Returns the originator of the event.
      Returns:
      the Window object that originated the event

    • getOppositeWindow

      public Window 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()
      ForWINDOW_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
        ConcatenatesMAXIMIZED_HORIZ andMAXIMIZED_VERT.
      Returns:
      a bitwise mask of the previous window state
      Since:
      1.4
      See Also:

    • getNewState

      public int getNewState()
      ForWINDOW_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
        ConcatenatesMAXIMIZED_HORIZ andMAXIMIZED_VERT.
      Returns:
      a bitwise mask of the new window state
      Since:
      1.4
      See Also:

    • paramString

      public String paramString()
      Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.
      Overrides:
      paramString in class ComponentEvent
      Returns:
      a string identifying the event and its attributes