Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding Class Reference

Crossfire JXClient, Trunk

Inheritance diagram for com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding:

Inheritance graph

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

Collaboration graph

Public Member Functions
int	compareTo (@NotNull final KeyBinding o)

boolean	equals (@Nullable final Object obj)

String	getBindingDescription ()

CommandList	getCommands ()

String	getCommandString ()

KeyEvent2	getKeyEvent2 ()

int	hashCode ()

boolean	isDefault ()

	KeyBinding (@NotNull final KeyEvent2 keyEvent, @NotNull final CommandList commands, final boolean isDefault)

boolean	matchesKeyEvent (@NotNull final KeyEvent2 keyEvent)

Private Attributes
final CommandList	commands

final boolean	isDefault

final KeyEvent2	keyEvent

Detailed Description

Abstract base class for key bindings. A key binding consists of information about the bound key and an associated CommandList.

Author: Lauwenmark; Andreas Kirschbaum

Definition at line 37 of file KeyBinding.java.

Constructor & Destructor Documentation

◆ KeyBinding()

com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.KeyBinding	(	@NotNull final KeyEvent2	keyEvent,
		@NotNull final CommandList	commands,
		final boolean	isDefault
	)

Creates a new instance.

Parameters

keyEvent	the key to match
commands	the commands to execute
isDefault	whether the key binding is a "default" binding which should not be saved

Definition at line 64 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.commands, com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.isDefault, and com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.keyEvent.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.equals().

Here is the caller graph for this function:

Member Function Documentation

◆ compareTo()

int com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.compareTo ( @NotNull final KeyBinding o )

Definition at line 113 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.compareTo(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.keyEvent.

Here is the call graph for this function:

◆ equals()

boolean com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.equals ( @Nullable final Object obj )

Definition at line 98 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.equals(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.KeyBinding(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.keyEvent.

Here is the call graph for this function:

◆ getBindingDescription()

String com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getBindingDescription ( )

Return the binding as a human-readable text.

Returns: the human-readable text

Definition at line 122 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.getKeyChar(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.getKeyCode(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.getModifiers(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.keyEvent, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.NONE.

Referenced by com.realtime.crossfire.jxclient.commands.BindingsCommand.execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommands()

CommandList com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getCommands ( )

Returns the associated CommandList.

Returns: the associated command list

Definition at line 84 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.commands.

◆ getCommandString()

String com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getCommandString ( )

Returns the commands as a string.

Returns: the commands as a string

Definition at line 142 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.commands, and com.realtime.crossfire.jxclient.gui.commandlist.CommandList.getCommandString().

Referenced by com.realtime.crossfire.jxclient.commands.BindingsCommand.execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKeyEvent2()

KeyEvent2 com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getKeyEvent2 ( )

Returns the key to match.

Returns: the key to match

Definition at line 75 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.keyEvent.

◆ hashCode()

int com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.hashCode ( )

Definition at line 108 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.hashCode(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.keyEvent.

Here is the call graph for this function:

◆ isDefault()

boolean com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.isDefault ( )

Returns whether the key binding is a "default" binding which should not be saved.

Returns: true

=do not save

Definition at line 151 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.isDefault.

◆ matchesKeyEvent()

boolean com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.matchesKeyEvent ( @NotNull final KeyEvent2 keyEvent )

Checks whether this key binding matches a key event.

Parameters

keyEvent the key to check

Returns: whether the key binding matches the parameters

Definition at line 93 of file KeyBinding.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.keyEvent.

Member Data Documentation

◆ commands

final CommandList com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.commands

private

The associated CommandList.

Definition at line 49 of file KeyBinding.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getCommands(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getCommandString(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.KeyBinding().

◆ isDefault

final boolean com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.isDefault

private

Whether the key binding is a "default" binding which should not be saved.

Definition at line 55 of file KeyBinding.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.isDefault(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.KeyBinding().

◆ keyEvent

final KeyEvent2 com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.keyEvent

private

The key to match.

Definition at line 43 of file KeyBinding.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.compareTo(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.equals(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getBindingDescription(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getKeyEvent2(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.hashCode(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.KeyBinding(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.matchesKeyEvent().

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/keybindings/KeyBinding.java