KeyBinding.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.gui.keybindings;
 
import com.realtime.crossfire.jxclient.gui.commandlist.CommandList;
import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class KeyBinding implements Comparable<KeyBinding> {
 
    @NotNull
    private final KeyEvent2 keyEvent;
 
    @NotNull
    private final CommandList commands;
 
    private final boolean isDefault;
 
    public KeyBinding(@NotNull final KeyEvent2 keyEvent, @NotNull final CommandList commands, final boolean isDefault) {
        this.keyEvent = keyEvent;
        this.commands = commands;
        this.isDefault = isDefault;
    }
 
    @NotNull
    public KeyEvent2 getKeyEvent2() {
        return keyEvent;
    }
 
    @NotNull
    public CommandList getCommands() {
        return commands;
    }
 
    public boolean matchesKeyEvent(@NotNull final KeyEvent2 keyEvent) {
        return this.keyEvent.matchesKeyEvent(keyEvent);
    }
 
    @Override
    public boolean equals(@Nullable final Object obj) {
        if (!(obj instanceof KeyBinding)) {
            return false;
        }
 
        final KeyBinding keyBinding = (KeyBinding)obj;
        return keyBinding.keyEvent.equals(keyEvent);
    }
 
    @Override
    public int hashCode() {
        return keyEvent.hashCode();
    }
 
    @Override
    public int compareTo(@NotNull final KeyBinding o) {
        return keyEvent.compareTo(o.keyEvent);
    }
 
    @NotNull
    public String getBindingDescription() {
        final StringBuilder sb = new StringBuilder();
        final int keyCode = keyEvent.getKeyCode();
        if (keyCode == KeyEvent.VK_UNDEFINED) {
            sb.append(keyEvent.getKeyChar());
        } else {
            final int modifiers = keyEvent.getModifiers();
            if (modifiers != KeyEvent2.NONE) {
                sb.append(InputEvent.getModifiersExText(modifiers)).append("+");
            }
            sb.append(KeyEvent.getKeyText(keyCode));
        }
        return sb.toString();
    }
 
    @NotNull
    public String getCommandString() {
        return commands.getCommandString();
    }
 
    public boolean isDefault() {
        return isDefault;
    }
 
}