Collaboration diagram for com.realtime.crossfire.jxclient.window.KeyHandler:

Public Member Functions
boolean	isRunningUsingCtrl ()

	KeyHandler (@Nullable final Writer debugKeyboard, @NotNull final KeybindingsManager keybindingsManager, @NotNull final CommandQueue commandQueue, @NotNull final JXCWindowRenderer windowRenderer, @NotNull final KeyHandlerListener keyHandlerListener)

void	keyPressed (@NotNull final KeyEvent e)

void	keyReleased (@NotNull final KeyEvent e)

void	setDefaultKeyBindings (@NotNull final KeyBindings defaultKeyBindings)

Private Member Functions
void	debugKeyboardWrite (@NotNull final CharSequence message)

void	debugKeyboardWrite (@NotNull final String type, @NotNull final KeyEvent keyEvent, @NotNull final KeyEvent2 keyEvent2)

void	handleKeyPress (@NotNull final KeyEvent2 e)

void	handleKeyRelease (@NotNull final KeyEvent2 e)

void	updateModifiers (@NotNull final KeyEvent2 keyEvent)

Private Attributes
final CommandQueue	commandQueue

final Writer	debugKeyboard

boolean	isRunningUsingCtrl

final KeybindingsManager	keybindingsManager

final KeyHandlerListener	keyHandlerListener

final JXCWindowRenderer	windowRenderer

Static Private Attributes
static final DateTimeFormatter	FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss,SSS ", Locale.ENGLISH)

Detailed Description

Handles keyboard input processing.

Author: Lauwenmark; Andreas Kirschbaum

Definition at line 45 of file KeyHandler.java.

Constructor & Destructor Documentation

◆ KeyHandler()

com.realtime.crossfire.jxclient.window.KeyHandler.KeyHandler	(	@Nullable final Writer	debugKeyboard,
		@NotNull final KeybindingsManager	keybindingsManager,
		@NotNull final CommandQueue	commandQueue,
		@NotNull final JXCWindowRenderer	windowRenderer,
		@NotNull final KeyHandlerListener	keyHandlerListener
	)

Creates a new instance.

Parameters

debugKeyboard	the writer for logging keyboard debug output; may
keybindingsManager	the keybindings manager to use
commandQueue	the command queue to use
windowRenderer	the window renderer to use
keyHandlerListener	the key handler listener to notify

Definition at line 97 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.commandQueue, com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboard, com.realtime.crossfire.jxclient.window.KeyHandler.keybindingsManager, com.realtime.crossfire.jxclient.window.KeyHandler.keyHandlerListener, and com.realtime.crossfire.jxclient.window.KeyHandler.windowRenderer.

Member Function Documentation

◆ debugKeyboardWrite() [1/2]

void com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboardWrite ( @NotNull final CharSequence message )

private

Writes a message to the keyboard debug.

Parameters

message the message to write

Definition at line 316 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboard, and com.realtime.crossfire.jxclient.window.KeyHandler.FORMATTER.

◆ debugKeyboardWrite() [2/2]

void com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboardWrite	(	@NotNull final String	type,
		@NotNull final KeyEvent	keyEvent,
		@NotNull final KeyEvent2	keyEvent2
	)

private

Writes a KeyEvent to the keyboard debug.

Parameters

type	the event type
keyEvent	the key event to write
keyEvent2	the key event to write

Definition at line 304 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboard.

Referenced by com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyPress(), com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyRelease(), com.realtime.crossfire.jxclient.window.KeyHandler.keyPressed(), com.realtime.crossfire.jxclient.window.KeyHandler.keyReleased(), and com.realtime.crossfire.jxclient.window.KeyHandler.updateModifiers().

Here is the caller graph for this function:

◆ handleKeyPress()

void com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyPress ( @NotNull final KeyEvent2 e )

private

Handles a "key pressed" event.

Parameters

e	the key event to handle

Definition at line 117 of file KeyHandler.java.

Referenced by com.realtime.crossfire.jxclient.window.KeyHandler.keyPressed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleKeyRelease()

void com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyRelease ( @NotNull final KeyEvent2 e )

private

Handles a "key released" event.

Parameters

e	the key event to handle

Definition at line 230 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboardWrite(), com.realtime.crossfire.jxclient.window.KeyHandler.keybindingsManager, com.realtime.crossfire.jxclient.window.KeyHandler.keyHandlerListener, com.realtime.crossfire.jxclient.window.KeyHandlerListener.keyReleased(), com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.keyReleased(), and com.realtime.crossfire.jxclient.window.KeyHandler.updateModifiers().

Referenced by com.realtime.crossfire.jxclient.window.KeyHandler.keyReleased().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRunningUsingCtrl()

boolean com.realtime.crossfire.jxclient.window.KeyHandler.isRunningUsingCtrl ( )

Returns whether the player is running because of the Ctrl key or not.

Returns: true if the Ctrl key is pressed, false else.

Definition at line 337 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.isRunningUsingCtrl.

◆ keyPressed()

void com.realtime.crossfire.jxclient.window.KeyHandler.keyPressed ( @NotNull final KeyEvent e )

Handles a "key pressed" event.

Parameters

e	the key event to handle

Definition at line 260 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboardWrite(), and com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyPress().

Here is the call graph for this function:

◆ keyReleased()

void com.realtime.crossfire.jxclient.window.KeyHandler.keyReleased ( @NotNull final KeyEvent e )

Handles a "key released" event.

Parameters

e	the key event to handle

Definition at line 274 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboardWrite(), and com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyRelease().

Here is the call graph for this function:

◆ setDefaultKeyBindings()

void com.realtime.crossfire.jxclient.window.KeyHandler.setDefaultKeyBindings ( @NotNull final KeyBindings defaultKeyBindings )

Sets the default KeyBindings of the currently active skin.

Parameters

defaultKeyBindings the default key bindings

Definition at line 109 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.keybindingsManager, and com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.setDefaultKeyBindings().

Referenced by com.realtime.crossfire.jxclient.main.JXCWindow.JXCWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateModifiers()

void com.realtime.crossfire.jxclient.window.KeyHandler.updateModifiers ( @NotNull final KeyEvent2 keyEvent )

private

Updates the saved modifier state from a key event.

Parameters

keyEvent the key event to process

Definition at line 288 of file KeyHandler.java.

References com.realtime.crossfire.jxclient.window.KeyHandler.commandQueue, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.CTRL, com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboardWrite(), com.realtime.crossfire.jxclient.window.KeyHandler.isRunningUsingCtrl, and com.realtime.crossfire.jxclient.queue.CommandQueue.stopRunning().

Referenced by com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyPress(), and com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyRelease().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ commandQueue

final CommandQueue com.realtime.crossfire.jxclient.window.KeyHandler.commandQueue

private

The CommandQueue to use.

Definition at line 64 of file KeyHandler.java.

Referenced by com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyPress(), com.realtime.crossfire.jxclient.window.KeyHandler.KeyHandler(), and com.realtime.crossfire.jxclient.window.KeyHandler.updateModifiers().

◆ debugKeyboard

final Writer com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboard

private

The Writer for logging keyboard debug output. Log nothing if

null

.

Definition at line 52 of file KeyHandler.java.

Referenced by com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboardWrite(), and com.realtime.crossfire.jxclient.window.KeyHandler.KeyHandler().

◆ FORMATTER

final DateTimeFormatter com.realtime.crossfire.jxclient.window.KeyHandler.FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss,SSS ", Locale.ENGLISH)

staticprivate

A formatter for timestamps.

Definition at line 82 of file KeyHandler.java.

Referenced by com.realtime.crossfire.jxclient.window.KeyHandler.debugKeyboardWrite().