org.eclipse.swt.events
Class KeyEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--org.eclipse.swt.internal.SWTEventObject
              |
              +--org.eclipse.swt.events.TypedEvent
                    |
                    +--org.eclipse.swt.events.KeyEvent
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
TraverseEvent, VerifyEvent

public class KeyEvent
extends TypedEvent

Unsafe: Instances of this class are sent as a result of keys being pressed and released on the keyboard

See Also:
KeyListener, Serialized Form

Field Summary
 char character
          Enabled: the character represented by the key that was typed.
 int keyCode
          Enabled: the key code of the key that was typed, as defined by the key code constants in class SWT.
 int stateMask
          Enabled: the state of the keyboard modifier keys at the time the event was generated
 
Fields inherited from class org.eclipse.swt.events.TypedEvent
data, display, time, widget
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
KeyEvent(Event e)
          Suppressed: Constructs a new instance of this class based on the information in the given untyped event.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

character

public char character
Enabled: the character represented by the key that was typed. This is the final character that results after all modifiers have been applied. For example, when the user types Ctrl+A, the character value is 0x01 (NUL). It is important that applications do not attempt to modify the character value based on a stateMask (such as SWT.CTRL) or the resulting character will not be correct.


keyCode

public int keyCode
Enabled: the key code of the key that was typed, as defined by the key code constants in class SWT. When the character field of the event is ambiguous, this field contains the unicode value of the original character. For example, typing Ctrl+M or Return both result in the character '\r' but the keyCode field will also contain '\r' when Return was typed.

See Also:
org.eclipse.swt.SWT

stateMask

public int stateMask
Enabled: the state of the keyboard modifier keys at the time the event was generated

Constructor Detail

KeyEvent

public KeyEvent(Event e)
Suppressed: Constructs a new instance of this class based on the information in the given untyped event.

Parameters:
e - the untyped event containing the information


comments?