java.awt.event.TextEvent 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.AWTEvent;
// import java.awt.Event;
/**
* A semantic event which indicates that an object's text changed.
* This high-level event is generated by an object (such as a TextComponent)
* when its text changes. The event is passed to
* every TextListener
object which registered to receive such
* events using the component's addTextListener
method.
*
* The object that implements the TextListener
interface gets
* this TextEvent
when the event occurs. The listener is
* spared the details of processing individual mouse movements and key strokes
* Instead, it can process a "meaningful" (semantic) event like "text changed".
*
* @author Georges Saab
* @version 1.14 01/23/03
*
*
* @see TextListener
* @see Tutorial: Writing a Text Listener
* @see Reference: The Java Class Libraries (update file)
*
* @since 1.1
*/
public class TextEvent extends AWTEvent
{
/**
* The first number in the range of ids used for text events.
*/
public static final int TEXT_FIRST = 900;
/**
* The last number in the range of ids used for text events.
*/
public static final int TEXT_LAST = 900;
/**
* This event id indicates that object's text changed.
*/
public static final int TEXT_VALUE_CHANGED = TEXT_FIRST;
/*
* JDK 1.1 serialVersionUID
*/
private static final long serialVersionUID = 6269902291250941179L;
// PBP/PP
/**
* Constructs a TextEvent
object.
*
Note that passing in an invalid id
results in
* unspecified behavior.
*
* @param source the object that
* originated the event
* @param id an integer that identifies the event type
*/
public TextEvent(Object source, int id) { super(null,0); }
/**
* Returns a parameter string identifying this text 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; }
}