com.realtime.crossfire.jxclient.gui.keybindings

Class KeyBinding

java.lang.Object

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

All Implemented Interfaces:

java.lang.Comparable<KeyBinding>

public class KeyBinding
extends java.lang.Object
implements java.lang.Comparable<KeyBinding>

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

Constructor Summary

Constructors

Constructor and Description
KeyBinding(@NotNull KeyEvent2 keyEvent, @NotNull CommandList commands, boolean isDefault) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(@NotNull KeyBinding o)
boolean	equals(@Nullable java.lang.Object obj)
@NotNull java.lang.String	getBindingDescription() Return the binding as a human-readable text.
@NotNull CommandList	getCommands() Returns the associated CommandList.
@NotNull java.lang.String	getCommandString() Returns the commands as a string.
@NotNull KeyEvent2	getKeyEvent2() Returns the key to match.
int	hashCode()
boolean	isDefault() Returns whether the key binding is a "default" binding which should not be saved.
boolean	matchesKeyEvent(@NotNull KeyEvent2 keyEvent) Checks whether this key binding matches a key event.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyBinding

public KeyBinding(@NotNull
                  @NotNull KeyEvent2 keyEvent,
                  @NotNull
                  @NotNull CommandList commands,
                  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

Method Detail

getKeyEvent2

@NotNull
public @NotNull KeyEvent2 getKeyEvent2()

Returns the key to match.

Returns:

the key to match

getCommands

@NotNull
public @NotNull CommandList getCommands()

Returns the associated CommandList.

Returns:

the associated command list

matchesKeyEvent

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

equals

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

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(@NotNull
                     @NotNull KeyBinding o)

Specified by:

compareTo in interface java.lang.Comparable<KeyBinding>

getBindingDescription

@NotNull
public @NotNull java.lang.String getBindingDescription()

Return the binding as a human-readable text.

Returns:

the human-readable text

getCommandString

@NotNull
public @NotNull java.lang.String getCommandString()

Returns the commands as a string.

Returns:

the commands as a string

isDefault

public boolean isDefault()

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

Returns:

true=do not save