Shortcut.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-2011 Andreas Kirschbaum.
 */

package com.realtime.crossfire.jxclient.shortcuts;

import com.realtime.crossfire.jxclient.faces.Face;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import org.jetbrains.annotations.NotNull;

public abstract class Shortcut {

    @NotNull
    private final EventListenerList2<ShortcutListener> listeners = new EventListenerList2<>();

    public abstract void dispose();

    public abstract void execute();

    public void addShortcutListener(@NotNull final ShortcutListener listener) {
        listeners.add(listener);
    }

    public void removeShortcutListener(@NotNull final ShortcutListener listener) {
        listeners.add(listener);
    }

    protected void fireModifiedEvent() {
        for (final ShortcutListener listener : listeners) {
            listener.shortcutModified();
        }
    }

    @NotNull
    public abstract String getTooltipText();

    public abstract void visit(@NotNull final ShortcutVisitor visitor);

    public abstract boolean displaysFace(final Face face);

}