Collaboration diagram for com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings:

Public Member Functions
void	addKeyBinding (@NotNull final KeyEvent2 keyEvent, @NotNull final CommandList cmdList, final boolean isDefault)

void	deleteKeyBinding (@NotNull final KeyEvent2 keyEvent)

Collection< KeyBinding >	getBindings (@NotNull final Predicate< KeyBinding > predicate)

boolean	handleKeyPress (@NotNull final KeyEvent2 e)

	KeyBindings (@Nullable final Path fileVersion2, @Nullable final Path fileVersion1, @NotNull final GUICommandFactory guiCommandFactory)

void	loadKeyBindings ()

void	parseKeyBinding (@NotNull final String line, final boolean isDefault) throws InvalidKeyBindingException

void	saveKeyBindings ()

Private Member Functions
void	addKeyBinding (@NotNull final KeyBinding keyBinding)

void	deleteKeyBinding (@Nullable final KeyBinding keyBinding)

KeyBinding	getKeyBinding (@NotNull final KeyEvent2 keyEvent)

Static Private Member Functions
static void	executeKeyBinding (@NotNull final KeyBinding keyBinding)

Private Attributes
final Path	fileVersion1

final Path	fileVersion2

final GUICommandFactory	guiCommandFactory

final Collection< KeyBinding >	keybindings = new TreeSet<>()

KeyCodeMap	keyCodeMap

boolean	modified

Detailed Description

Manages a set of key bindings.

Author: Andreas Kirschbaum

Definition at line 47 of file KeyBindings.java.

Constructor & Destructor Documentation

◆ KeyBindings()

com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.KeyBindings	(	@Nullable final Path	fileVersion2,
		@Nullable final Path	fileVersion1,
		@NotNull final GUICommandFactory	guiCommandFactory
	)

Creates a new instance.

Parameters

fileVersion2	the file for loading and saving the bindings; null to not load or save
fileVersion1	the fallback file for loading the bindings if fileVersion2 does not exist; null to not load
guiCommandFactory	the gui command factory for creating commands

Definition at line 94 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.fileVersion1, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.fileVersion2, and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.guiCommandFactory.

Member Function Documentation

◆ addKeyBinding() [1/2]

void com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.addKeyBinding ( @NotNull final KeyBinding keyBinding )

private

Adds (or replace) a key binding.

Parameters

keyBinding the key binding

Definition at line 116 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.keybindings, and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.modified.

◆ addKeyBinding() [2/2]

void com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.addKeyBinding	(	@NotNull final KeyEvent2	keyEvent,
		@NotNull final CommandList	cmdList,
		final boolean	isDefault
	)

Adds a key binding for a key event.

Parameters

keyEvent	the key event for the key binding
cmdList	the commands to associate to the key binding
isDefault	whether the key binding is a "default" binding which should not be saved

Definition at line 107 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.saveKeyBindings().

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyReleased(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.parseKeyBinding().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteKeyBinding() [1/2]

void com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.deleteKeyBinding ( @NotNull final KeyEvent2 keyEvent )

Removes a key binding for a key event.

Parameters

keyEvent the key of the key binding

Definition at line 126 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.getKeyBinding().

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyReleased().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteKeyBinding() [2/2]

void com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.deleteKeyBinding ( @Nullable final KeyBinding keyBinding )

private

Removes a key binding.

Parameters

keyBinding

the key binding; may be

null

Definition at line 134 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.keybindings, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.modified, and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.saveKeyBindings().

Here is the call graph for this function:

◆ executeKeyBinding()

static void com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.executeKeyBinding ( @NotNull final KeyBinding keyBinding )

staticprivate

Executes a KeyBinding instance.

Parameters

keyBinding

the key binding to execute; may be

null

Definition at line 335 of file KeyBindings.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.handleKeyPress().

Here is the caller graph for this function:

◆ getBindings()

Collection<KeyBinding> com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.getBindings ( @NotNull final Predicate< KeyBinding > predicate )

Returns all key bindings matching a given predicate.

Parameters

predicate the predicate for selecting keybindings

Returns: the matching bindings

Definition at line 345 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.keybindings.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.getBindings().

Here is the caller graph for this function:

◆ getKeyBinding()

KeyBinding com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.getKeyBinding ( @NotNull final KeyEvent2 keyEvent )

private

Finds a key binding associated to a key event.

Parameters

keyEvent the key to look up

Returns: the key binding, or
null

if no key binding is associated

Definition at line 244 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.keybindings.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.deleteKeyBinding().

Here is the caller graph for this function:

◆ handleKeyPress()

boolean com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.handleKeyPress ( @NotNull final KeyEvent2 e )

Executes a "key press" event.

Parameters

e	the event to execute

Returns: whether a matching key binding was found

Definition at line 320 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.executeKeyBinding(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.keybindings.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.handleKeyPress(), and com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadKeyBindings()

void com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.loadKeyBindings ( )

Loads the key bindings from the given file. If the file cannot be loaded, a warning message is printed.

Definition at line 146 of file KeyBindings.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.fileVersion1, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.fileVersion2, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.keybindings, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.modified, and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.parseKeyBinding().

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.loadGlobalKeybindings(), and com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.loadPerCharacterBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseKeyBinding()

void com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.parseKeyBinding	(	@NotNull final String	line,
		final boolean	isDefault
	)		throws InvalidKeyBindingException