GUIItemList.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.gui.gui.GUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementChangedListener;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementListener;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import com.realtime.crossfire.jxclient.gui.item.GUIItemItem;
import com.realtime.crossfire.jxclient.gui.label.AbstractLabel;
import com.realtime.crossfire.jxclient.items.CfItem;
import com.realtime.crossfire.jxclient.items.ItemView;
import com.realtime.crossfire.jxclient.items.LocationsListener;
import com.realtime.crossfire.jxclient.skin.skin.GuiFactory;
import java.awt.event.MouseEvent;
import javax.swing.JList;
import javax.swing.SwingUtilities;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public abstract class GUIItemList<T extends GUIItemItem> extends GUIList<T> {
 
    private static final long serialVersionUID = 1;
 
    @NotNull
    private final ItemView itemView;
 
    @Nullable
    private final AbstractLabel currentItem;
 
    @NotNull
    private final LocationsListener locationsListener = changedSlots -> SwingUtilities.invokeLater(() -> rebuildList(changedSlots));
 
    @NotNull
    private final GUIElementChangedListener itemChangedListener = () -> {
        selectionChanged();
        setChanged();
    };
 
    protected GUIItemList(@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 GUIItemItem templateItem, @NotNull final GuiFactory guiFactory) {
        super(tooltipManager, elementListener, name, cellWidth, cellHeight, new ItemItemCellRenderer<>(templateItem), null, guiFactory);
        this.itemView = itemView;
        this.currentItem = currentItem;
        setLayoutOrientation(JList.HORIZONTAL_WRAP, -1);
        this.itemView.addLocationsListener(locationsListener);
        rebuildList(null);
    }
 
    @Override
    public void dispose() {
        super.dispose();
        itemView.removeLocationsListener(locationsListener);
    }
 
    private void rebuildList(@NotNull final Integer @Nullable [] changedSlots) {
        synchronized (getTreeLock()) {
            final int newSize = itemView.getSize();
            final int oldSize = resizeElements(newSize);
            if (oldSize < newSize) {
                for (int i = oldSize; i < newSize; i++) {
                    final T item = newItem(i);
                    addElement(item);
                    item.setChangedListener(itemChangedListener);
                }
                setChanged(changedSlots, oldSize);
            } else {
                setChanged(changedSlots, newSize);
            }
            selectionChanged();
        }
        setChanged();
    }
 
    private void setChanged(@NotNull final Integer @Nullable [] changedSlots, final int limit) {
        if (changedSlots == null) {
            for (int i = 0; i < limit; i++) {
                setChanged(i);
            }
        } else {
            for (int i : changedSlots) {
                if (i < limit) {
                    setChanged(i);
                }
            }
        }
    }
 
    private void setChanged(final int index) {
        getElement(index).setChanged();
    }
 
    @Override
    protected void selectionChanged(final int selectedIndex) {
        if (currentItem != null) {
            final CfItem item = itemView.getItem(selectedIndex);
            if (item == null) {
                currentItem.setText("");
            } else {
                final String tooltipText1 = item.getTooltipText1();
                final String tooltipText2 = item.getTooltipText2();
                final String tooltipText3 = item.getTooltipText3();
                if (tooltipText3.isEmpty()) {
                    currentItem.setText(tooltipText1+" "+tooltipText3);
                } else {
                    currentItem.setText(tooltipText1+" ["+tooltipText2+"] "+tooltipText3);
                }
            }
        }
    }
 
    @Override
    protected void activeChanged() {
    }
 
    @Override
    public void mouseClicked(@NotNull final MouseEvent e) {
        super.mouseClicked(e);
 
        if (!isEnabled()) {
            return;
        }
 
        switch (e.getButton()) {
        case MouseEvent.BUTTON1:
            setActive(true);
            button1Clicked(e.getModifiersEx());
            break;
 
        case MouseEvent.BUTTON2:
            button2Clicked(e.getModifiersEx());
            break;
 
        case MouseEvent.BUTTON3:
            button3Clicked(e.getModifiersEx());
            break;
        }
    }
 
    private void button1Clicked(final int modifiers) {
        final GUIItemItem guiItem = getSelectedItem();
        if (guiItem == null) {
            return;
        }
 
        guiItem.button1Clicked(modifiers);
    }
 
    private void button2Clicked(final int modifiers) {
        final GUIItemItem guiItem = getSelectedItem();
        if (guiItem == null) {
            return;
        }
 
        guiItem.button2Clicked(modifiers);
    }
 
    private void button3Clicked(final int modifiers) {
        final GUIItemItem guiItem = getSelectedItem();
        if (guiItem == null) {
            return;
        }
 
        guiItem.button3Clicked(modifiers);
    }
 
    @Nullable
    public GUIItemItem getSelectedItem() {
        return (GUIItemItem)getSelectedObject();
    }
 
    @NotNull
    protected abstract T newItem(final int index);
 
}