java.awt.event.WindowEvent Maven / Gradle / Ivy
/*
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 217: Personal Basis
Profile 1.1. In the event of a discrepency between this work and the
JSR 217 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=217, the latter takes precedence.
*/
package java.awt.event;
import java.awt.Component;
// import java.awt.Event;
import java.awt.Window;
// import sun.awt.AppContext;
// import sun.awt.SunToolkit;
/**
* 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.30, 01/23/03
*
* @see WindowAdapter
* @see WindowListener
* @see Tutorial: Writing a Window Listener
* @see Reference: The Java Class Libraries (update file)
*
* @since JDK1.1
*/
public class WindowEvent extends ComponentEvent
{
/**
* The first number in the range of ids used for window events.
*/
public static final int WINDOW_FIRST = 200;
/**
* The window opened event. This event is delivered only
* the first time a window is made visible.
*/
public static final int WINDOW_OPENED = WINDOW_FIRST;
/**
* 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_CLOSING = 1 + WINDOW_FIRST;
/**
* 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_CLOSED = 2 + WINDOW_FIRST;
/**
* 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 java.awt.Frame#setIconImage
*/
public static final int WINDOW_ICONIFIED = 3 + WINDOW_FIRST;
/**
* 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_DEICONIFIED = 4 + WINDOW_FIRST;
// PBP/PP 6214654
/**
* The window-activated event type. This event is delivered when the Window
* becomes the active Window. Only a Frame 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 that is an owner of the focused Window.
*/
public static final int WINDOW_ACTIVATED = 5 + WINDOW_FIRST;
// PBP/PP 6214654
/**
* The window-deactivated event type. This event is delivered when the
* Window is no longer the active Window. Only a Frame 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 that is an owner of the focused Window.
*/
public static final int WINDOW_DEACTIVATED = 6 + WINDOW_FIRST;
/**
* 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_GAINED_FOCUS = 7 + WINDOW_FIRST;
/**
* 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_LOST_FOCUS = 8 + WINDOW_FIRST;
// /**
// * 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_STATE_CHANGED = 0;
/**
* The last number in the range of ids used for window events.
*/
public static final int WINDOW_LAST = WINDOW_LOST_FOCUS;
/**
* TBS
*/
// int oldState;
// int newState;
/*
* JDK 1.1 serialVersionUID
*/
private static final long serialVersionUID = -1567959133147912127L;
/**
* Constructs a WindowEvent object.
*
* @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
* @since 1.4
*/
// public WindowEvent(Window source, int id, Window opposite, int oldState, int
// newState)
// { super(null, 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.
*
Note that passing in an invalid id results in
* unspecified behavior.
*
* @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
*/
public WindowEvent(Window source, int id, Window opposite) { super(null, 0); }
/**
* Constructs a WindowEvent object with the specified
* previous and new window states.
*
* @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
* @since 1.4
*/
// public WindowEvent(Window source, int id, int oldState, int newState) {super(null, 0); }
/**
* Constructs a WindowEvent object.
*
Note that passing in an invalid id results in
* unspecified behavior.
*
* @param source the Window object that originated the event
* @param id an integer indicating the type of event
*/
public WindowEvent(Window source, int id) { super(null, 0); }
/**
* Returns the originator of the event.
*
* @return the Window object that originated the event
*/
public Window getWindow() { return 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.
*
* @return the other Window involved in the focus or activation change, or
* null
* @since 1.4
*/
public Window getOppositeWindow() {return null; }
// /**
// * 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
// */
// public int getOldState() { }
//
// /**
// * 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
// */
// public int getNewState() { }
/**
* 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
*/
public String paramString() { return null; }
}