| java.awt.event.ComponentEvent
 java.awt.event.WindowEvent
| WindowEvent | | public class WindowEvent extends ComponentEvent (Code) | | 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.45, 06/05/07
See Also: WindowAdapter
See Also: WindowListener
See Also: Tutorial: Writing a Window Listener
since:
JDK1.1 |
| Constructor 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. | | public | WindowEvent(Window source, int id, Window opposite)
Constructs a WindowEvent object with the
specified opposite Window. | | 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. | | public | WindowEvent(Window source, int id)
Constructs a WindowEvent object.
Note that passing in an invalid id results in
unspecified behavior. |
| Method Summary | |
| public int | getNewState()
For WINDOW_STATE_CHANGED events returns the
new state of the window. | | public int | getOldState()
For WINDOW_STATE_CHANGED events returns the
previous state of the window. | | 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. | | public Window | getWindow()
Returns the originator of the event. | | public String | paramString()
Returns a parameter string identifying this event. |
| WINDOW_ACTIVATED | | final public static int WINDOW_ACTIVATED(Code) | | 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.
|
| WINDOW_CLOSED | | final public static int WINDOW_CLOSED(Code) | | The window closed event. This event is delivered after
the window has been closed as the result of a call to dispose.
|
| WINDOW_CLOSING | | final public static int WINDOW_CLOSING(Code) | | 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.
|
| WINDOW_DEACTIVATED | | final public static int WINDOW_DEACTIVATED(Code) | | 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.
|
| WINDOW_DEICONIFIED | | final public static int WINDOW_DEICONIFIED(Code) | | The window deiconified event type. This event is delivered when
the window has been changed from a minimized to a normal state.
|
| WINDOW_FIRST | | final public static int WINDOW_FIRST(Code) | | The first number in the range of ids used for window events.
|
| WINDOW_GAINED_FOCUS | | final public static int WINDOW_GAINED_FOCUS(Code) | | 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.
|
| WINDOW_ICONIFIED | | final public static int WINDOW_ICONIFIED(Code) | | 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: java.awt.Frame.setIconImage |
| WINDOW_LAST | | final public static int WINDOW_LAST(Code) | | The last number in the range of ids used for window events.
|
| WINDOW_LOST_FOCUS | | final public static int WINDOW_LOST_FOCUS(Code) | | 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.
|
| WINDOW_OPENED | | final public static int WINDOW_OPENED(Code) | | The window opened event. This event is delivered only
the first time a window is made visible.
|
| WINDOW_STATE_CHANGED | | final public static int WINDOW_STATE_CHANGED(Code) | | 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 |
| oldState | | int oldState(Code) | | TBS
|
| opposite | | transient Window opposite(Code) | | 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.
See Also: WindowEvent.getOppositeWindow
since:
1.4 |
| WindowEvent | | public WindowEvent(Window source, int id, Window opposite, int oldState, int newState)(Code) | | Constructs a WindowEvent object.
Note that passing in an invalid id results in
unspecified behavior. This method throws an
IllegalArgumentException if source
is null.
Parameters:
source - the Window objectthat originated the event
Parameters:
id - an integer indicating the type of event.
Parameters:
opposite - the other window involved in the focus or activationchange, or null
Parameters:
oldState - previous state of the window for window statechange event
Parameters:
newState - new state of the window for window state change event
throws:
IllegalArgumentException - if source is null
since:
1.4 |
| WindowEvent | | public WindowEvent(Window source, int id, Window opposite)(Code) | | 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.
Parameters:
source - the Window object thatoriginated the event
Parameters:
id - WINDOW_ACTIVATED,WINDOW_DEACTIVATED,WINDOW_GAINED_FOCUS,or WINDOW_LOST_FOCUS. It isexpected that this constructor will not be used forother WindowEvent types because theopposite Window of such eventswill always be null
Parameters:
opposite - the other Window involved in thefocus or activation change, or null
throws:
IllegalArgumentException - if source is null
since:
1.4 |
| WindowEvent | | public WindowEvent(Window source, int id, int oldState, int newState)(Code) | | 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.
Parameters:
source - the Window objectthat originated the event
Parameters:
id - WINDOW_STATE_CHANGED event type.It is expected that this constructor will notbe used for other WindowEventtypes, because the previous and new windowstates are meaningless for other event types.
Parameters:
oldState - an integer representing the previous window state
Parameters:
newState - an integer representing the new window state
throws:
IllegalArgumentException - if source is null
since:
1.4 |
| WindowEvent | | public WindowEvent(Window source, int id)(Code) | | Constructs a WindowEvent object.
Note that passing in an invalid id results in
unspecified behavior. This method throws an
IllegalArgumentException if source
is null.
Parameters:
source - the Window object that originated the event
Parameters:
id - an integer indicating the type of event
throws:
IllegalArgumentException - if source is null |
| getNewState | | public int getNewState()(Code) | | 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.
a bitwise mask of the new window state
See Also: java.awt.Frame.getExtendedState
since:
1.4 |
| getOldState | | public int getOldState()(Code) | | 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.
a bitwise mask of the previous window state
See Also: java.awt.Frame.getExtendedState
since:
1.4 |
| getOppositeWindow | | public Window getOppositeWindow()(Code) | | 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.
the other Window involved in the focus or activation change, ornull
since:
1.4 |
| getWindow | | public Window getWindow()(Code) | | Returns the originator of the event.
the Window object that originated the event |
| paramString | | public String paramString()(Code) | | Returns a parameter string identifying this event.
This method is useful for event-logging and for debugging.
a string identifying the event and its attributes |
|
|