DefaultJXCSkin.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.skin.skin;
 
import com.realtime.crossfire.jxclient.gui.commandlist.CommandList;
import com.realtime.crossfire.jxclient.gui.commandlist.CommandListType;
import com.realtime.crossfire.jxclient.gui.gui.GUIElement;
import com.realtime.crossfire.jxclient.gui.gui.Gui;
import com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings;
import com.realtime.crossfire.jxclient.gui.label.AbstractLabel;
import com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl;
import com.realtime.crossfire.jxclient.settings.options.Option;
import com.realtime.crossfire.jxclient.settings.options.OptionException;
import com.realtime.crossfire.jxclient.settings.options.OptionManager;
import com.realtime.crossfire.jxclient.skin.events.SkinEvent;
import com.realtime.crossfire.jxclient.util.Resolution;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class DefaultJXCSkin implements JXCSkin {
 
    @NotNull
    private String skinName = "unknown";
 
    @NotNull
    private Resolution minResolution = new Resolution(1, 1);
 
    @NotNull
    private Resolution maxResolution = new Resolution(1, 1);
 
    @NotNull
    private final Collection<CommandList> initEvents = new ArrayList<>();
 
    @NotNull
    private final JXCSkinCache<CommandList> definedCommandLists = new JXCSkinCache<>("command list");
 
    @NotNull
    private final Collection<GUIElement> guiElements = new HashSet<>();
 
    @NotNull
    private final Collection<SkinEvent> skinEvents = new HashSet<>();
 
    @NotNull
    private final Dialogs dialogs;
 
    @NotNull
    private final KeyBindings defaultKeyBindings;
 
    @NotNull
    private final OptionManager optionManager;
 
    @NotNull
    private final Collection<String> optionNames = new HashSet<>();
 
    @Nullable
    private AbstractLabel tooltipLabel;
 
    @Nullable
    private TooltipManagerImpl tooltipManager;
 
    public DefaultJXCSkin(@NotNull final KeyBindings defaultKeyBindings, @NotNull final OptionManager optionManager, @NotNull final Dialogs dialogs) {
        this.defaultKeyBindings = defaultKeyBindings;
        this.optionManager = optionManager;
        this.dialogs = dialogs;
    }
 
    @NotNull
    @Override
    public String getSkinName() {
        return skinName;
    }
 
    public void setSkinName(@NotNull final String skinName, @NotNull final Resolution minResolution, @NotNull final Resolution maxResolution) {
        if (minResolution.getWidth() > maxResolution.getWidth()) {
            throw new IllegalArgumentException("minimum width must not exceed maximum width");
        }
        if (minResolution.getHeight() > maxResolution.getHeight()) {
            throw new IllegalArgumentException("minimum height must not exceed maximum height");
        }
 
        this.skinName = skinName;
        this.minResolution = minResolution;
        this.maxResolution = maxResolution;
    }
 
    @NotNull
    @Override
    public Resolution getMinResolution() {
        return minResolution;
    }
 
    @NotNull
    @Override
    public Resolution getMaxResolution() {
        return maxResolution;
    }
 
    @Nullable
    @Override
    public Gui getDialogQuit() {
        try {
            return getDialog("quit");
        } catch (final JXCSkinException ignored) {
            return null;
        }
    }
 
    @Nullable
    @Override
    public Gui getDialogDisconnect() {
        try {
            return getDialog("disconnect");
        } catch (final JXCSkinException ignored) {
            return null;
        }
    }
 
    @Nullable
    @Override
    public Gui getDialogConnect() {
        try {
            return getDialog("connect");
        } catch (final JXCSkinException ignored) {
            return null;
        }
    }
 
    @NotNull
    @Override
    public Gui getDialogKeyBind() {
        try {
            return getDialog("keybind");
        } catch (final JXCSkinException ex) {
            final AssertionError error = new AssertionError("keybind dialog does not exist");
            error.initCause(ex);
            throw error;
        }
    }
 
    @NotNull
    @Override
    public Gui getDialogQuery() {
        try {
            return getDialog("query");
        } catch (final JXCSkinException ex) {
            final AssertionError error = new AssertionError("query dialog does not exist");
            error.initCause(ex);
            throw error;
        }
    }
 
    @NotNull
    @Override
    public Gui getDialogBook(final int bookNo) {
        try {
            return getDialog("book");
        } catch (final JXCSkinException ex) {
            final AssertionError error = new AssertionError("book dialog does not exist");
            error.initCause(ex);
            throw error;
        }
    }
 
    @NotNull
    @Override
    public Gui getMainInterface() {
        try {
            return getDialog("main");
        } catch (final JXCSkinException ex) {
            final AssertionError error = new AssertionError("main dialog does not exist");
            error.initCause(ex);
            throw error;
        }
    }
 
    @NotNull
    @Override
    public Gui getMetaInterface() {
        try {
            return getDialog("meta");
        } catch (final JXCSkinException ex) {
            final AssertionError error = new AssertionError("meta dialog does not exist");
            error.initCause(ex);
            throw error;
        }
    }
 
    @NotNull
    @Override
    public Gui getStartInterface() {
        try {
            return getDialog("start");
        } catch (final JXCSkinException ex) {
            final AssertionError error = new AssertionError("start dialog does not exist");
            error.initCause(ex);
            throw error;
        }
    }
 
    @NotNull
    @Override
    public Gui getDialog(@NotNull final String name) throws JXCSkinException {
        return dialogs.lookup(name);
    }
 
    @NotNull
    @Override
    public Iterator<Gui> iterator() {
        return dialogs.iterator();
    }
 
    @NotNull
    @Override
    public CommandList getCommandList(@NotNull final String name) throws JXCSkinException {
        return definedCommandLists.lookup(name);
    }
 
    @NotNull
    @Override
    public Collection<String> getCommandListNames() {
        return definedCommandLists.getNames();
    }
 
    @NotNull
    @Override
    public KeyBindings getDefaultKeyBindings() {
        return defaultKeyBindings;
    }
 
    @Override
    public void attach(@NotNull final TooltipManagerImpl tooltipManager) {
        //noinspection VariableNotUsedInsideIf
        if (this.tooltipManager != null) {
            throw new IllegalStateException("skin is already attached");
        }
 
        this.tooltipManager = tooltipManager;
        tooltipManager.setTooltip(tooltipLabel);
 
        initEvents.forEach(CommandList::execute);
    }
 
    @Override
    public void detach() {
        final TooltipManagerImpl tmpTooltipManager = tooltipManager;
        tooltipManager = null;
        if (tmpTooltipManager != null) {
            tmpTooltipManager.setTooltip(null);
        }
 
        optionNames.forEach(optionManager::removeOption);
        optionNames.clear();
        guiElements.forEach(GUIElement::dispose);
        skinEvents.forEach(SkinEvent::dispose);
        guiElements.clear();
    }
 
    public void insertGuiElement(@NotNull final GUIElement guiElement) {
        guiElements.add(guiElement);
    }
 
    public void addDialog(@NotNull final String dialogName) {
        dialogs.addDialog(dialogName);
    }
 
    @Nullable
    public String getDialogToLoad() {
        return dialogs.getDialogToLoad();
    }
 
    public void addCommandList(@NotNull final String commandListName, @NotNull final CommandListType commandListType) throws JXCSkinException {
        final CommandList commandList = new CommandList(commandListType);
        definedCommandLists.insert(commandListName, commandList);
    }
 
    public void addInitEvent(@NotNull final CommandList commandList) {
        initEvents.add(commandList);
    }
 
    public void addOption(@NotNull final String optionName, @NotNull final String documentation, @NotNull final Option commandCheckBoxOption) throws JXCSkinException {
        try {
            optionManager.addOption(optionName, documentation, commandCheckBoxOption);
        } catch (final OptionException ex) {
            throw new JXCSkinException(ex.getMessage(), ex);
        }
        optionNames.add(optionName);
    }
 
    public void setTooltipLabel(@Nullable final AbstractLabel tooltipLabel) {
        this.tooltipLabel = tooltipLabel;
    }
 
    @Nullable
    @Override
    public AbstractLabel getTooltipLabel() {
        return tooltipLabel;
    }
 
    public void addSkinEvent(@NotNull final SkinEvent skinEvent) {
        skinEvents.add(skinEvent);
    }
 
}