com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState Class Reference

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

Public Member Functions
	KeyBindingState (@Nullable final KeyBindings keyBindings, @Nullable final KeyBindings keyBindings2, @Nullable final CommandList commands)
void	keyPressed (@NotNull final KeyEvent2 keyEvent)
boolean	keyReleased ()

Private Attributes
final CommandList	commands
final KeyBindings	keyBindings
final KeyBindings	keyBindings2
KeyEvent2	keyEvent
int	state
int	type = -1

Detailed Description

Manages the state for the key binding dialog.

Author

Andreas Kirschbaum

Definition at line 33 of file KeyBindingState.java.

Constructor & Destructor Documentation

KeyBindingState()

com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.KeyBindingState	(	@Nullable final KeyBindings	keyBindings,
		@Nullable final KeyBindings	keyBindings2,
		@Nullable final CommandList	commands
	)

Creates a new instance.

Parameters

keyBindings	the KeyBindings to modify; may be null when removing bindings
keyBindings2	the KeyBindings to modify; only used when removing bindings; may be null when removing bindings
commands	the commands to bind, or null to unbind

Definition at line 78 of file KeyBindingState.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.commands, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyBindings, and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyBindings2.

Member Function Documentation

keyPressed()

void com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyPressed

(

@NotNull final KeyEvent2

keyEvent

)

Records a binding by key code.

Parameters

keyEvent

the key that was pressed

Definition at line 88 of file KeyBindingState.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyEvent, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.state, and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.type.

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

Here is the caller graph for this function:

keyReleased()

boolean com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyReleased

(

)

Records a key released event.

Returns

true 

if the dialog has finished, or

false 

if the dialog is still active

Definition at line 99 of file KeyBindingState.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.addKeyBinding(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.commands, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.deleteKeyBinding(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyBindings, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyBindings2, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyEvent, com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.state, and com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.type.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

commands

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

private

The commands to bind, or

null 

to unbind.

Definition at line 51 of file KeyBindingState.java.

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

keyBindings

final KeyBindings com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyBindings

private

The KeyBindings to modify.

Definition at line 39 of file KeyBindingState.java.

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

keyBindings2

final KeyBindings com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.keyBindings2

private

The KeyBindings to modify.

Definition at line 45 of file KeyBindingState.java.

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

keyEvent

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

private

The key event. Only valid if

type == 0 

.

Definition at line 68 of file KeyBindingState.java.

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

state

int com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.state

private

The dialog state: 0=waiting for initial key press, 1=waiting for key release.

Definition at line 57 of file KeyBindingState.java.

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

type

int com.realtime.crossfire.jxclient.gui.keybindings.KeyBindingState.type = -1

private

The type of key binding: -1=invalid, 0=key code (keyEvent is valid).

Definition at line 63 of file KeyBindingState.java.

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

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/keybindings/KeyBindingState.java