001 /* TextEvent.java -- event for text changes
002 Copyright (C) 1999, 2002, 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.awt.event;
040
041 import java.awt.AWTEvent;
042 import java.awt.TextComponent;
043
044 /**
045 * This event is generated when a text box changes contents. This is an
046 * abstraction that distills a large number of individual mouse or keyboard
047 * events into a simpler "text changed" event.
048 *
049 * @author Aaron M. Renn (arenn@urbanophile.com)
050 * @see TextComponent
051 * @see TextListener
052 * @since 1.1
053 * @status updated to 1.4
054 */
055 public class TextEvent extends AWTEvent
056 {
057 /**
058 * Compatible with JDK 1.1+.
059 */
060 private static final long serialVersionUID = 6269902291250941179L;
061
062 /** This is the first id in the range of event ids used by this class. */
063 public static final int TEXT_FIRST = 900;
064
065 /** This is the last id in the range of event ids used by this class. */
066 public static final int TEXT_LAST = 900;
067
068 /** This event id indicates that the text of an object has changed. */
069 public static final int TEXT_VALUE_CHANGED = 900;
070
071 /**
072 * Initializes a new instance of <code>TextEvent</code> with the specified
073 * source and id. Note that an invalid id leads to unspecified results.
074 *
075 * @param source the (TextComponent) object that generated this event
076 * @param id the event id
077 * @throws IllegalArgumentException if source is null
078 */
079 public TextEvent(Object source, int id)
080 {
081 super(source, id);
082 }
083
084 /**
085 * Returns a string identifying this event. This is "TEXT_VALUE_CHANGED".
086 *
087 * @return a string identifying this event
088 */
089 public String paramString()
090 {
091 return id == TEXT_VALUE_CHANGED ? "TEXT_VALUE_CHANGED" : "unknown type";
092 }
093 } // class TextEvent