org.jsfml.window.event

Class KeyEvent

java.lang.Object

org.jsfml.window.event.Event

org.jsfml.window.event.KeyEvent

public final class KeyEvent
extends Event

Represents keyboard key events.

Objects of this class are created for events of type Event.Type.KEY_PRESSED or Event.Type.KEY_RELEASED.

Nested Class Summary

Nested classes/interfaces inherited from class org.jsfml.window.event.Event

Event.Type

Field Summary

Fields

Modifier and Type	Field and Description
boolean	alt true if an ALT key (left or right) was pressed when the event occured, false if not.
boolean	control true if a CTRL key (left or right) was pressed when the event occured, false if not.
Keyboard.Key	key The code of the key that was pressed or released.
boolean	shift true if a SHIFT key (left or right) was pressed when the event occured, false if not.
boolean	system true if a system key was pressed when the event occured, false if not.

Fields inherited from class org.jsfml.window.event.Event

type

Constructor Summary

Constructors

Constructor and Description
KeyEvent(int type, int keyCode, boolean alt, boolean shift, boolean control, boolean system) Constructs a new key event.

Method Summary

Methods

Modifier and Type	Method and Description
KeyEvent	asKeyEvent() Attempts to cast this event to a KeyEvent.

Methods inherited from class org.jsfml.window.event.Event

asJoystickButtonEvent, asJoystickEvent, asJoystickMoveEvent, asMouseButtonEvent, asMouseEvent, asMouseWheelEvent, asSizeEvent, asTextEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

key

public final Keyboard.Key key

The code of the key that was pressed or released.

alt

public final boolean alt

true if an ALT key (left or right) was pressed when the event occured, false if not.

shift

public final boolean shift

true if a SHIFT key (left or right) was pressed when the event occured, false if not.

control

public final boolean control

true if a CTRL key (left or right) was pressed when the event occured, false if not.

system

public final boolean system

true if a system key was pressed when the event occured, false if not.

Constructor Detail

KeyEvent

public KeyEvent(int type,
        int keyCode,
        boolean alt,
        boolean shift,
        boolean control,
        boolean system)

Constructs a new key event.

Parameters:

type - the type of the event. This must be a valid ordinal in the Event.Type enumeration.

keyCode - the code of the key that was pressed. This must be a valid ordinal in the Keyboard.Key enumeration.

alt - true to indicate that an ALT key was pressed.

shift - true to indicate that a SHIFT key was pressed.

control - true to indicate that a CTRL key was pressed.

system - true to indicate that a system key was pressed.

Method Detail

asKeyEvent

public KeyEvent asKeyEvent()

Description copied from class: Event

Attempts to cast this event to a KeyEvent.

Overrides:

asKeyEvent in class Event

Returns:

the event cast to a KeyEvent if its type is either Event.Type.KEY_PRESSED or Event.Type.KEY_RELEASED, null otherwise.