libjava/classpath/javax/swing/event/InternalFrameEvent.java

   1 /* InternalFrameEvent.java --
   2    Copyright (C) 2002, 2004, 2006,  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.swing.event;
  40
  41 import java.awt.AWTEvent;
  42
  43 import javax.swing.JInternalFrame;
  44
  45 /**
  46  * An event that indicates a change to a {@link JInternalFrame} component.
  47  *
  48  * @author Andrew Selkirk
  49  */
  50 public class InternalFrameEvent extends AWTEvent
  51 {
  52   private static final long serialVersionUID = -5204823611874873183L;
  53
  54   /**
  55    * Internal frame activated event.
  56    */
  57   public static final int INTERNAL_FRAME_ACTIVATED = 25554;
  58
  59   /**
  60    * Internal frame closed event.
  61    */
  62   public static final int INTERNAL_FRAME_CLOSED = 25551;
  63
  64   /**
  65    * Internal frame closing event.
  66    */
  67   public static final int INTERNAL_FRAME_CLOSING = 25550;
  68
  69   /**
  70    * Internal frame deactivated event.
  71    */
  72   public static final int INTERNAL_FRAME_DEACTIVATED = 25555;
  73
  74   /**
  75    * Internal frame deiconifed event.
  76    */
  77   public static final int INTERNAL_FRAME_DEICONIFIED = 25553;
  78
  79   /**
  80    * Internal frame frame first event.
  81    */
  82   public static final int INTERNAL_FRAME_FIRST = 25549;
  83
  84   /**
  85    * Internal frame iconified event.
  86    */
  87   public static final int INTERNAL_FRAME_ICONIFIED = 25552;
  88
  89   /**
  90    * Internal frame last event.
  91    */
  92   public static final int INTERNAL_FRAME_LAST = 25555;
  93
  94   /**
  95    * Internal frame opened event.
  96    */
  97   public static final int INTERNAL_FRAME_OPENED = 25549;
  98
  99   /**
 100    * Creates a new <code>JInternalFrameEvent</code> instance.
 101    *
 102    * @param source  the source of this event (<code>null</code> not permitted).
 103    * @param id  the event ID of this event (see the constants defined by this
 104    *     class).
 105    *
 106    * @throws IllegalArgumentException if <code>source</code> is
 107    *     <code>null</code>.
 108    */
 109   public InternalFrameEvent(JInternalFrame source, int id)
 110   {
 111     super(source, id);
 112   }
 113
 114   /**
 115    * Returns the <code>JInternalFrame</code> component that is the source for
 116    * this event.
 117    *
 118    * @return The source.
 119    *
 120    * @since 1.3
 121    */
 122   public JInternalFrame getInternalFrame()
 123   {
 124     return (JInternalFrame) source;
 125   }
 126
 127   /**
 128    * Returns a string that indicates the event id.  This is used by the
 129    * {@link #toString()} method.
 130    *
 131    * @return A string that indicates the event id.
 132    */
 133   public String paramString()
 134   {
 135     switch (id) {
 136       case INTERNAL_FRAME_ACTIVATED:
 137         return "INTERNAL_FRAME_ACTIVATED";
 138       case INTERNAL_FRAME_CLOSED:
 139         return "INTERNAL_FRAME_CLOSED";
 140       case INTERNAL_FRAME_CLOSING:
 141         return "INTERNAL_FRAME_CLOSING";
 142       case INTERNAL_FRAME_DEACTIVATED:
 143         return "INTERNAL_FRAME_DEACTIVATED";
 144       case INTERNAL_FRAME_DEICONIFIED:
 145         return "INTERNAL_FRAME_DEICONIFIED";
 146       case INTERNAL_FRAME_ICONIFIED:
 147         return "INTERNAL_FRAME_ICONIFIED";
 148       case INTERNAL_FRAME_OPENED:
 149         return "INTERNAL_FRAME_OPENED";
 150       default:
 151         return "unknown type";
 152     }
 153   }
 154 }