FileDocCategorySizeDatePackage
InternalFrameEvent.javaAPI DocJava SE 5 API5914Fri Aug 26 14:58:00 BST 2005javax.swing.event

InternalFrameEvent

public class InternalFrameEvent extends AWTEvent
An AWTEvent that adds support for JInternalFrame objects as the event source. This class has the same event types as WindowEvent, although different IDs are used. Help on handling internal frame events is in How to Write an Internal Frame Listener, a section in The Java Tutorial.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

see
java.awt.event.WindowEvent
see
java.awt.event.WindowListener
see
JInternalFrame
see
InternalFrameListener
version
1.16 12/19/03
author
Thomas Ball

Fields Summary
public static final int
INTERNAL_FRAME_FIRST
The first number in the range of IDs used for internal frame events.
public static final int
INTERNAL_FRAME_LAST
The last number in the range of IDs used for internal frame events.
public static final int
INTERNAL_FRAME_OPENED
The "window opened" event. This event is delivered only the first time the internal frame is made visible.
public static final int
INTERNAL_FRAME_CLOSING
The "window is closing" event. This event is delivered when the user attempts to close the internal frame, such as by clicking the internal frame's close button, or when a program attempts to close the internal frame by invoking the setClosed method.
public static final int
INTERNAL_FRAME_CLOSED
The "window closed" event. This event is delivered after the internal frame has been closed as the result of a call to the setClosed or dispose method.
public static final int
INTERNAL_FRAME_ICONIFIED
The "window iconified" event. This event indicates that the internal frame was shrunk down to a small icon.
public static final int
INTERNAL_FRAME_DEICONIFIED
The "window deiconified" event type. This event indicates that the internal frame has been restored to its normal size.
public static final int
INTERNAL_FRAME_ACTIVATED
The "window activated" event type. This event indicates that keystrokes and mouse clicks are directed towards this internal frame.
public static final int
INTERNAL_FRAME_DEACTIVATED
The "window deactivated" event type. This event indicates that keystrokes and mouse clicks are no longer directed to the internal frame.
Constructors Summary
public InternalFrameEvent(JInternalFrame source, int id)
Constructs an InternalFrameEvent object.

param
source the JInternalFrame object that originated the event
param
id an integer indicating the type of event


                                   
         
        super(source, id);
Methods Summary
public javax.swing.JInternalFramegetInternalFrame()
Returns the originator of the event.

return
the JInternalFrame object that originated the event
since
1.3

      return (source instanceof JInternalFrame)? (JInternalFrame)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 INTERNAL_FRAME_OPENED:
              typeStr = "INTERNAL_FRAME_OPENED";
              break;
          case INTERNAL_FRAME_CLOSING:
              typeStr = "INTERNAL_FRAME_CLOSING";
              break;
          case INTERNAL_FRAME_CLOSED:
              typeStr = "INTERNAL_FRAME_CLOSED";
              break;
          case INTERNAL_FRAME_ICONIFIED:
              typeStr = "INTERNAL_FRAME_ICONIFIED";
              break;
          case INTERNAL_FRAME_DEICONIFIED:
              typeStr = "INTERNAL_FRAME_DEICONIFIED";
              break;
          case INTERNAL_FRAME_ACTIVATED:
              typeStr = "INTERNAL_FRAME_ACTIVATED";
              break;
          case INTERNAL_FRAME_DEACTIVATED:
              typeStr = "INTERNAL_FRAME_DEACTIVATED";
              break;
          default:
              typeStr = "unknown type";
        }
        return typeStr;