com.realtime.crossfire.jxclient.gui.keybindings

Class KeyEvent2

java.lang.Object

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

public class KeyEvent2
extends java.lang.Object

Represents a pressed or released key.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALT The mask for "shift".
static int	ALT_GRAPH The mask for "alt_graph".
static int	CTRL The mask for "ctrl".
private char	keyChar The key as a char value.
private int	keyCode The key code.
static int	MASK The mask for all used modifiers.
static int	META The mask for "meta".
private int	modifiers The modifiers.
static int	NONE The mask for "no modifier".
static int	SHIFT The mask for "shift".

Constructor Summary

Constructors

Constructor and Description
KeyEvent2(int keyCode, char keyChar, int modifiers) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	equalsKeyCode(KeyEvent2 keyEvent) Returns whether this key event matches the same key code as another key event.
char	getKeyChar() Returns the key as a char.
int	getKeyCode() Returns the key code.
int	getModifiers() Returns the modifiers.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALT

public static final int ALT

The mask for "shift".

See Also:

Constant Field Values

ALT_GRAPH

public static final int ALT_GRAPH

The mask for "alt_graph".

See Also:

Constant Field Values

CTRL

public static final int CTRL

The mask for "ctrl".

See Also:

Constant Field Values

keyChar

private final char keyChar

The key as a char value.

keyCode

private final int keyCode

The key code. See VK_xxx constants.

MASK

public static final int MASK

The mask for all used modifiers.

See Also:

Constant Field Values

META

public static final int META

The mask for "meta".

See Also:

Constant Field Values

modifiers

private final int modifiers

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

NONE

public static final int NONE

The mask for "no modifier".

See Also:

Constant Field Values

SHIFT

public static final int SHIFT

The mask for "shift".

See Also:

Constant Field Values

Constructor Detail

KeyEvent2

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

Creates a new instance.

Parameters:

keyCode - the key code

keyChar - the key as a char

modifiers - the modifiers

Method Detail

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsKeyCode

public boolean equalsKeyCode(@NotNull
                             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

getKeyChar

public char getKeyChar()

Returns the key as a char.

Returns:

the key as a char

getKeyCode

public int getKeyCode()

Returns the key code. See VK_xxx constants.

Returns:

the key code

getModifiers

public int getModifiers()

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

Returns:

the modifiers

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object