Top Description Fields Constructors Methods
org.eclipse.swt.events

public Class KeyEvent

extends TypedEvent
Class Inheritance
Known Direct Subclasses
org.eclipse.swt.events.TraverseEvent, org.eclipse.swt.events.VerifyEvent
Imports
org.eclipse.swt.widgets.Event

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

When a key listener is added to a control, the control will take part in widget traversal. By default, all traversal keys (such as the tab key and so on) are delivered to the control. In order for a control to take part in traversal, it should listen for traversal events. Otherwise, the user can traverse into a control but not out. Note that native controls such as table and tree implement key traversal in the operating system. It is not necessary to add traversal listeners for these controls, unless you want to override the default traversal.

See Also
KeyListener, TraverseListener, Sample code and further information

Field Summary

Modifier and TypeField and Description
public char
public boolean
doit

A flag indicating whether the operation should be allowed.

public int
public int
keyLocation

depending on the event, the location of key specified by the keyCode or character.

pack-priv static final long
public int
stateMask

the state of the keyboard modifier keys and mouse masks at the time the event was generated.

Inherited from org.eclipse.swt.events.TypedEvent:
datadisplaytimewidget

Constructor Summary

AccessConstructor and Description
public
KeyEvent(Event
the untyped event containing the information
e
)

Constructs a new instance of this class based on the information in the given untyped event.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a string representation of the event
toString
()

Overrides org.eclipse.swt.events.TypedEvent.toString.

Returns a string containing a concise, human-readable description of the receiver.
Inherited from org.eclipse.swt.events.TypedEvent:
getName

Field Detail

characterback to summary
public char character
See Also
Event#character
doitback to summary
public boolean doit

A flag indicating whether the operation should be allowed. Setting this field to false will cancel the operation.

keyCodeback to summary
public int keyCode
See Also
Event#keyCode
keyLocationback to summary
public int keyLocation

depending on the event, the location of key specified by the keyCode or character. The possible values for this field are SWT.LEFT, SWT.RIGHT, SWT.KEYPAD, or SWT.NONE representing the main keyboard area.

The location field can be used to differentiate key events that have the same key code and character but are generated by different keys on the keyboard. For example, a key down event with the key code equal to SWT.SHIFT can be generated by the left and the right shift keys on the keyboard.

The location field can only be used to determine the location of the key code or character in the current event. It does not include information about the location of modifiers in the state mask.

Since
3.6
See Also
org.eclipse.swt.SWT#LEFT, org.eclipse.swt.SWT#RIGHT, org.eclipse.swt.SWT#KEYPAD
serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides org.eclipse.swt.events.TypedEvent.serialVersionUID.

stateMaskback to summary
public int stateMask

the state of the keyboard modifier keys and mouse masks at the time the event was generated.

See Also
org.eclipse.swt.SWT#MODIFIER_MASK, org.eclipse.swt.SWT#BUTTON_MASK

Constructor Detail

KeyEventback to summary
public KeyEvent(Event e)

Constructs a new instance of this class based on the information in the given untyped event.

Parameters
e:Event

the untyped event containing the information

Method Detail

toStringback to summary
public String toString()

Overrides org.eclipse.swt.events.TypedEvent.toString.

Returns a string containing a concise, human-readable description of the receiver.

Returns:String

a string representation of the event

Annotations
@Override