libjava/java/awt/event/TextEvent.java

   1 /* TextEvent.java -- event for text changes
   2    Copyright (C) 1999, 2002, 2005  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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 java.awt.event;
  40
  41 import java.awt.AWTEvent;
  42
  43 /**
  44  * This event is generated when a text box changes contents. This is an
  45  * abstraction that distills a large number of individual mouse or keyboard
  46  * events into a simpler "text changed" event.
  47  *
  48  * @author Aaron M. Renn (arenn@urbanophile.com)
  49  * @see TextComponent
  50  * @see TextListener
  51  * @since 1.1
  52  * @status updated to 1.4
  53  */
  54 public class TextEvent extends AWTEvent
  55 {
  56   /**
  57    * Compatible with JDK 1.1+.
  58    */
  59   private static final long serialVersionUID = 6269902291250941179L;
  60
  61   /** This is the first id in the range of event ids used by this class. */
  62   public static final int TEXT_FIRST = 900;
  63
  64   /** This is the last id in the range of event ids used by this class. */
  65   public static final int TEXT_LAST = 900;
  66
  67   /** This event id indicates that the text of an object has changed. */
  68   public static final int TEXT_VALUE_CHANGED = 900;
  69
  70   /**
  71    * Initializes a new instance of <code>TextEvent</code> with the specified
  72    * source and id. Note that an invalid id leads to unspecified results.
  73    *
  74    * @param source the (TextComponent) object that generated this event
  75    * @param id the event id
  76    * @throws IllegalArgumentException if source is null
  77    */
  78   public TextEvent(Object source, int id)
  79   {
  80     super(source, id);
  81   }
  82
  83   /**
  84    * Returns a string identifying this event. This is "TEXT_VALUE_CHANGED".
  85    *
  86    * @return a string identifying this event
  87    */
  88   public String paramString()
  89   {
  90     return id == TEXT_VALUE_CHANGED ? "TEXT_VALUE_CHANGED" : "unknown type";
  91   }
  92 } // class TextEvent