GUISpellList.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.list;
 
import com.realtime.crossfire.jxclient.faces.FacesManager;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementListener;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import com.realtime.crossfire.jxclient.gui.item.GUIItemSpell;
import com.realtime.crossfire.jxclient.gui.item.ItemPainter;
import com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding;
import com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager;
import com.realtime.crossfire.jxclient.gui.label.AbstractLabel;
import com.realtime.crossfire.jxclient.items.ItemView;
import com.realtime.crossfire.jxclient.queue.CommandQueue;
import com.realtime.crossfire.jxclient.skin.skin.GuiFactory;
import com.realtime.crossfire.jxclient.spells.Spell;
import com.realtime.crossfire.jxclient.spells.SpellsManager;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class GUISpellList extends GUIItemList<GUIItemSpell> {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private final TooltipManager tooltipManager;
 
    @NotNull
    private final GUIElementListener elementListener;
 
    @NotNull
    private final String name;
 
    @NotNull
    private final ItemView itemView;
 
    @NotNull
    private final SpellsManager spellsManager;
 
    @NotNull
    private final KeybindingsManager keybindingsManager;
 
    @NotNull
    private final CommandQueue commandQueue;
 
    @NotNull
    private final ItemPainter itemPainter;
 
    @NotNull
    private final FacesManager facesManager;
 
    @NotNull
    private final GuiFactory guiFactory;
 
    public GUISpellList(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final int cellWidth, final int cellHeight, @NotNull final ItemView itemView, @Nullable final AbstractLabel currentItem, @NotNull final SpellsManager spellsManager, @NotNull final KeybindingsManager keybindingsManager, @NotNull final CommandQueue commandQueue, @NotNull final ItemPainter itemPainter, @NotNull final FacesManager facesManager, @NotNull final GuiFactory guiFactory) {
        super(tooltipManager, elementListener, name, cellWidth, cellHeight, itemView, currentItem, new GUIItemSpell(tooltipManager, elementListener, commandQueue, name+"_template", itemPainter, -1, facesManager, spellsManager, itemView, cellHeight, guiFactory), guiFactory);
        this.tooltipManager = tooltipManager;
        this.elementListener = elementListener;
        this.name = name;
        this.itemView = itemView;
        this.spellsManager = spellsManager;
        this.keybindingsManager = keybindingsManager;
        this.commandQueue = commandQueue;
        this.itemPainter = itemPainter;
        this.facesManager = facesManager;
        this.guiFactory = guiFactory;
    }
 
    @NotNull
    private String getBindings(@NotNull final Spell spell, @NotNull final String prefix, @NotNull final String legend) {
        final String search = prefix+spell.getName().charAt(0);
        final String match = prefix+spell.getName();
 
        // because key bindings can specify partial names, we search in 2 steps:
        // - search all bindings with the first spell letter
        // - from those bindings only keep the ones the spell's command matches
        final Iterable<KeyBinding> bindings = keybindingsManager.getBindings(binding -> binding.getCommandString().startsWith(search)).keySet();
        boolean first = true;
        final StringBuilder sb = new StringBuilder();
 
        for (KeyBinding binding : bindings) {
            if (match.startsWith(binding.getCommandString())) {
                if (first) {
                    sb.append(legend);
                    first = false;
                } else {
                    sb.append(" ; ");
                }
 
                sb.append(binding.getBindingDescription());
            }
        }
 
        return sb.toString();
    }
 
    @Nullable
    @Override
    protected String getTooltip(final int index) {
        final Spell spell = spellsManager.getFilteredSpell(index);
        if (spell == null) {
            return null;
        }
 
        //noinspection StringBufferReplaceableByString
        final StringBuilder sb = new StringBuilder(spell.getTooltipText());
 
        // find bindings to cast or invoke the spell
        sb.append(getBindings(spell, "cast ", "<br>Cast shortcut: "));
        sb.append(getBindings(spell, "invoke ", "<br>Invoke shortcut:"));
 
        return sb.toString();
    }
 
    @NotNull
    @Override
    protected GUIItemSpell newItem(final int index) {
        return new GUIItemSpell(tooltipManager, elementListener, commandQueue, name+index, itemPainter, index, facesManager, spellsManager, itemView, 0, guiFactory);
    }
 
    @Override
    public void notifyOpen() {
    }
 
}