Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.awt.event

Class WindowEvent

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, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, 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, consumed, id

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, paramString

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, paramString, setSource, toString

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

WINDOW_ACTIVATED

public static final int WINDOW_ACTIVATED
This is the id for a window that is activated.
Field Value:
205

WINDOW_CLOSED

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

WINDOW_CLOSING

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

WINDOW_DEACTIVATED

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

WINDOW_DEICONIFIED

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

WINDOW_FIRST

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

WINDOW_GAINED_FOCUS

public static final int WINDOW_GAINED_FOCUS
This is the id for a window becoming the focused window.
Field Value:
207
Since:
1.4

WINDOW_ICONIFIED

public static final int WINDOW_ICONIFIED
This is the id for a window that is iconified.
Field Value:
203

WINDOW_LAST

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

WINDOW_LOST_FOCUS

public static final int WINDOW_LOST_FOCUS
This is the id for a window losing all focus.
Field Value:
208
Since:
1.4

WINDOW_OPENED

public static final int WINDOW_OPENED
This is the id for a window that is opened.
Field Value:
200

WINDOW_STATE_CHANGED

public static final int WINDOW_STATE_CHANGED
This is the id for a window state change, such as maximization.
Field Value:
209
Since:
1.4

Constructor Details

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

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,
                   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,
                   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

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.
Returns:
the updated state
Since:
1.4
See Also:
Frame.getExtendedState()

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()

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

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

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 interface ComponentEvent
Returns:
a string that identifies this event
WindowEvent.java -- window change event Copyright (C) 1999, 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About