de.gurkenlabs.litiengine.input

Class KeyBoard

java.lang.Object

de.gurkenlabs.litiengine.input.KeyBoard

All Implemented Interfaces:

IKeyboard, IUpdateable, java.awt.KeyEventDispatcher

public class KeyBoard
extends java.lang.Object
implements java.awt.KeyEventDispatcher, IKeyboard

The listener interface for receiving userKey events. The class that is interested in processing a userKey event implements this interface, and the object created with that class is registered with a component using the component's addUserKeyListener method. When the userKey event occurs, that object's appropriate method is invoked.

Constructor Summary

Constructors

Constructor and Description
KeyBoard() Instantiates a new key board.

Method Summary

Modifier and Type	Method and Description
void	addKeyListener(java.awt.event.KeyListener listener) Register for key events.
void	consumeAlt(boolean consume)
boolean	dispatchKeyEvent(java.awt.event.KeyEvent e)
java.lang.String	getText(java.awt.event.KeyEvent e)
boolean	isPressed(int keyCode)
void	onKeyPressed(java.util.function.Consumer<java.awt.event.KeyEvent> consumer)
void	onKeyPressed(int keyCode, java.util.function.Consumer<java.awt.event.KeyEvent> consumer)
void	onKeyReleased(java.util.function.Consumer<java.awt.event.KeyEvent> consumer)
void	onKeyReleased(int keyCode, java.util.function.Consumer<java.awt.event.KeyEvent> consumer)
void	onKeyTyped(java.util.function.Consumer<java.awt.event.KeyEvent> consumer)
void	onKeyTyped(int keyCode, java.util.function.Consumer<java.awt.event.KeyEvent> consumer)
void	removeKeyListener(java.awt.event.KeyListener listener) Unregister from key down events.
void	update() This method is called by the game loop on all objects that need to update their attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyBoard

public KeyBoard()

Instantiates a new key board.

Method Detail

consumeAlt

public void consumeAlt(boolean consume)

Specified by:

consumeAlt in interface IKeyboard

dispatchKeyEvent

public boolean dispatchKeyEvent(java.awt.event.KeyEvent e)

Specified by:

dispatchKeyEvent in interface java.awt.KeyEventDispatcher

getText

public java.lang.String getText(java.awt.event.KeyEvent e)

Specified by:

getText in interface IKeyboard

isPressed

public boolean isPressed(int keyCode)

Specified by:

isPressed in interface IKeyboard

onKeyPressed

public void onKeyPressed(int keyCode,
                         java.util.function.Consumer<java.awt.event.KeyEvent> consumer)

Specified by:

onKeyPressed in interface IKeyboard

onKeyReleased

public void onKeyReleased(int keyCode,
                          java.util.function.Consumer<java.awt.event.KeyEvent> consumer)

Specified by:

onKeyReleased in interface IKeyboard

onKeyTyped

public void onKeyTyped(int keyCode,
                       java.util.function.Consumer<java.awt.event.KeyEvent> consumer)

Specified by:

onKeyTyped in interface IKeyboard

onKeyPressed

public void onKeyPressed(java.util.function.Consumer<java.awt.event.KeyEvent> consumer)

Specified by:

onKeyPressed in interface IKeyboard

onKeyReleased

public void onKeyReleased(java.util.function.Consumer<java.awt.event.KeyEvent> consumer)

Specified by:

onKeyReleased in interface IKeyboard

onKeyTyped

public void onKeyTyped(java.util.function.Consumer<java.awt.event.KeyEvent> consumer)

Specified by:

onKeyTyped in interface IKeyboard

addKeyListener

public void addKeyListener(java.awt.event.KeyListener listener)

Description copied from interface: IKeyboard

Register for key events.

Specified by:

addKeyListener in interface IKeyboard

Parameters:

listener - the observer

removeKeyListener

public void removeKeyListener(java.awt.event.KeyListener listener)

Description copied from interface: IKeyboard

Unregister from key down events.

Specified by:

removeKeyListener in interface IKeyboard

Parameters:

listener - the observer

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that need to update their attributes. It is called on every tick, means, it is called Game.GameLoop.TICKS_PER_SECOND times per second.

Specified by:

update in interface IUpdateable