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

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

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

boolean	equals (@Nullable final Object obj)

char	getKeyChar ()

int	getKeyCode ()

int	getModifiers ()

int	hashCode ()

	KeyEvent2 (final int keyCode, final char keyChar, final int modifiers)

boolean	matchesKeyEvent (@NotNull final KeyEvent2 keyEvent)

String	toString ()

Static Public Member Functions
static int	convertModifiers (final int modifiers)

static String	modifiersToString (final int modifiers)

static int	stringToModifiers (@NotNull final String modifiers)

Static Public Attributes
static final int	ALT = InputEvent.ALT_DOWN_MASK

static final int	ALT_GRAPH = InputEvent.ALT_GRAPH_DOWN_MASK

static final int	CTRL = InputEvent.CTRL_DOWN_MASK

static final int	MASK = ALT\|ALT_GRAPH\|CTRL\|META\|SHIFT

static final int	META = InputEvent.META_DOWN_MASK

static final int	NONE = 0

static final int	SHIFT = InputEvent.SHIFT_DOWN_MASK

Private Attributes
final char	keyChar

final int	keyCode

final int	modifiers

Detailed Description

Represents a pressed or released key.

Author: Andreas Kirschbaum

Definition at line 34 of file KeyEvent2.java.

Constructor & Destructor Documentation

◆ KeyEvent2()

com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.KeyEvent2	(	final int	keyCode,
		final char	keyChar,
		final int	modifiers
	)

Creates a new instance.

Parameters

keyCode	the key code
keyChar	the key as a char
modifiers	the modifiers

Definition at line 93 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyChar, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyCode, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers.

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

Here is the caller graph for this function:

Member Function Documentation

◆ compareTo()

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

Definition at line 159 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyChar, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyCode, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers.

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

Here is the caller graph for this function:

◆ convertModifiers()

static int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.convertModifiers ( final int modifiers )

static

Converts old-style modifiers into the current format.

Parameters

modifiers the old-style modifiers

Returns: the current format

Definition at line 183 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers.

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

Here is the caller graph for this function:

◆ equals()

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

Definition at line 138 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyChar, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyCode, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.KeyEvent2(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKeyChar()

char com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.getKeyChar ( )

Returns the key as a char.

Returns: the key as a char

Definition at line 111 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyChar.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getBindingDescription(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.saveKeyBindings().

Here is the caller graph for this function:

◆ getKeyCode()

int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.getKeyCode ( )

Returns the key code. See VK_xxx constants.

Returns: the key code

Definition at line 103 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyCode.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getBindingDescription(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.saveKeyBindings().

Here is the caller graph for this function:

◆ getModifiers()

int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.getModifiers ( )

Returns the modifiers. A combination of ALT, ALT_GRAPH, CTRL, META, and SHIFT.

Returns: the modifiers

Definition at line 120 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getBindingDescription(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.saveKeyBindings().

Here is the caller graph for this function:

◆ hashCode()

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

Definition at line 154 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyChar, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyCode, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers.

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

Here is the caller graph for this function:

◆ matchesKeyEvent()

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

Returns whether this key event matches the same key code as another key event.

Parameters

keyEvent the other key event

Returns: whether both instances match the same key code

Definition at line 130 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyChar, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyCode, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers.

◆ modifiersToString()

static String com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiersToString ( final int modifiers )

static

Converts modifiers to string representation.

Parameters

modifiers the modifiers

Returns: the string representation

Definition at line 209 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.ALT, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.ALT_GRAPH, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.CTRL, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.META, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.SHIFT.

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

Here is the caller graph for this function:

◆ stringToModifiers()

static int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.stringToModifiers ( @NotNull final String modifiers )

static

Converts a string representation to modifiers. If the string representation is invalid, a warning is printed and the invalid part is ignored.

Parameters

modifiers the string representation

Returns: the modifiers

Definition at line 236 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.ALT, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.ALT_GRAPH, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.CTRL, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.META, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.SHIFT.

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

Here is the caller graph for this function:

◆ toString()

String com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.toString ( )

Definition at line 173 of file KeyEvent2.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyChar, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyCode, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers.

Member Data Documentation

◆ ALT

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.ALT = InputEvent.ALT_DOWN_MASK

static

The mask for "shift".

Definition at line 44 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiersToString(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.stringToModifiers().

◆ ALT_GRAPH

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.ALT_GRAPH = InputEvent.ALT_GRAPH_DOWN_MASK

static

The mask for "alt_graph".

Definition at line 49 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiersToString(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.stringToModifiers().

◆ CTRL

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.CTRL = InputEvent.CTRL_DOWN_MASK

static

The mask for "ctrl".

Definition at line 54 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.textinput.GUIText.keyPressed(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiersToString(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.stringToModifiers(), and com.realtime.crossfire.jxclient.window.KeyHandler.updateModifiers().

◆ keyChar

final char com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyChar

private

The key as a char value.

Definition at line 79 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.compareTo(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.equals(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.getKeyChar(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.hashCode(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.KeyEvent2(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.matchesKeyEvent(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.toString().

◆ keyCode

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.keyCode

private

The key code. See VK_xxx constants.

Definition at line 74 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.compareTo(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.equals(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.getKeyCode(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.hashCode(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.KeyEvent2(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.matchesKeyEvent(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.toString().

◆ MASK

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.MASK = ALT|ALT_GRAPH|CTRL|META|SHIFT

static

The mask for all used modifiers.

Definition at line 69 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress(), and com.realtime.crossfire.jxclient.gui.textinput.GUIText.keyPressed().

◆ META

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.META = InputEvent.META_DOWN_MASK

static

The mask for "meta".

Definition at line 59 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiersToString(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.stringToModifiers().

◆ modifiers

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiers

private

The modifiers. A combination of ALT, ALT_GRAPH, CTRL, META, and SHIFT.

Definition at line 85 of file KeyEvent2.java.

◆ NONE

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.NONE = 0

static

The mask for "no modifier".

Definition at line 39 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding.getBindingDescription(), com.realtime.crossfire.jxclient.window.KeyHandler.handleKeyPress(), and com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress().

◆ SHIFT

final int com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.SHIFT = InputEvent.SHIFT_DOWN_MASK

static

The mask for "shift".

Definition at line 64 of file KeyEvent2.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress(), com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.modifiersToString(), and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.stringToModifiers().

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KeyEvent2()

Member Function Documentation

◆ compareTo()

◆ convertModifiers()

◆ equals()

◆ getKeyChar()

◆ getKeyCode()

◆ getModifiers()

◆ hashCode()

◆ matchesKeyEvent()

◆ modifiersToString()

◆ stringToModifiers()

◆ toString()

Member Data Documentation

◆ ALT

◆ ALT_GRAPH

◆ CTRL

◆ keyChar

◆ keyCode

◆ MASK

◆ META

◆ modifiers

◆ NONE

◆ SHIFT