ToolSelector.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 The Gridarta Developers.
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package net.sf.gridarta.gui.panel.tools;

import java.awt.BorderLayout;
import java.awt.CardLayout;
import java.awt.Component;
import java.awt.Container;
import java.awt.FlowLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.util.HashMap;
import java.util.Map;
import javax.swing.AbstractAction;
import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.ButtonGroup;
import javax.swing.JPanel;
import javax.swing.JToggleButton;
import net.sf.gridarta.gui.map.event.MouseOpListener;
import net.sf.gridarta.gui.panel.objectchooser.ObjectChooser;
import net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapmodel.InsertionModeSet;
import net.sf.gridarta.model.mapviewsettings.MapViewSettings;
import net.sf.gridarta.model.match.GameObjectMatcher;
import net.sf.gridarta.model.pickmapsettings.PickmapSettings;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class ToolSelector<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends JPanel {

    private static final long serialVersionUID = 1L;

    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta.gui.panel.tools");

    @NotNull
    private final Container selectionPane = new JPanel(new FlowLayout());

    @NotNull
    private final CardLayout optionCards = new CardLayout();

    @NotNull
    private final ButtonGroup selectionButtonGroup = new ButtonGroup();

    @NotNull
    private final Container optionsPane = new JPanel(optionCards);

    @NotNull
    private Tool<G, A, R> selectedTool;

    @NotNull
    private final Map<String, Tool<G, A, R>> tools = new HashMap<>();

    private static final Insets EMPTY_MARGIN = new Insets(0, 0, 0, 0);

    public ToolSelector(@NotNull final String defaultTool, @NotNull final MapViewSettings mapViewSettings, @NotNull final SelectedSquareModel<G, A, R> selectedSquareModel, @NotNull final ObjectChooser<G, A, R> objectChooser, @NotNull final PickmapSettings pickmapSettings, @Nullable final GameObjectMatcher floorGameObjectMatcher, @Nullable final GameObjectMatcher wallGameObjectMatcher, @Nullable final GameObjectMatcher monsterGameObjectMatcher, @NotNull final InsertionModeSet<G, A, R> insertionModeSet) {
        createUI();
        addTool(new VoidTool<>(), defaultTool);
        addTool(new SelectionTool<>(objectChooser, insertionModeSet), defaultTool);
        addTool(new DeletionTool<>(mapViewSettings, objectChooser, pickmapSettings, floorGameObjectMatcher, wallGameObjectMatcher, monsterGameObjectMatcher), defaultTool);
        addTool(new InsertionTool<>(selectedSquareModel, objectChooser, pickmapSettings, insertionModeSet, mapViewSettings), defaultTool);
    }

    private void addTool(@NotNull final Tool<G, A, R> tool, @NotNull final String defaultTool) {
        add(tool, tool.getId().equals(defaultTool));
    }

    private void createUI() {
        setLayout(new BorderLayout());
        add(selectionPane, BorderLayout.NORTH);
        add(optionsPane, BorderLayout.CENTER);
    }

    @SuppressWarnings("MethodOverloadsMethodOfSuperclass")
    public void add(@NotNull final Tool<G, A, R> tool) {
        add(tool, false);
    }

    private void add(@NotNull final Tool<G, A, R> tool, final boolean selected) {
        @NotNull final Action selectionAction = new SelectionAction(tool);
        @NotNull final AbstractButton toggleButton = new JToggleButton(selectionAction);
        toggleButton.setMargin(EMPTY_MARGIN);
        @NotNull final Component optionsView = createOptionsView(tool);
        selectionButtonGroup.add(toggleButton);
        selectionPane.add(toggleButton);
        final Container panel = new JPanel(new BorderLayout());
        panel.add(optionsView, BorderLayout.NORTH);
        optionsPane.add(panel, tool.getId());
        toggleButton.setSelected(selected);
        tools.put(tool.getId(), tool);
        if (selected) {
            selectedTool = tool;
            optionCards.show(optionsPane, tool.getId());
        }
    }

    @NotNull
    private static <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> Component createOptionsView(@NotNull final Tool<G, A, R> tool) {
        @Nullable final Component optionsView = tool.createOptionsView();
        return optionsView != null ? optionsView : new JPanel();
    }

    private void setSelectedTool(@NotNull final Tool<G, A, R> tool) {
        selectedTool = tool;
        optionCards.show(optionsPane, tool.getId());
    }

    public void setSelectedTool(@NotNull final String id) {
        setSelectedTool(tools.get(id));
    }

    @NotNull
    public MouseOpListener<G, A, R> getSelectedTool() {
        return selectedTool;
    }

    private class SelectionAction extends AbstractAction {

        private static final long serialVersionUID = 1L;

        @NotNull
        private final Tool<G, A, R> tool;

        private SelectionAction(@NotNull final Tool<G, A, R> tool) {
            this.tool = tool;
            ACTION_BUILDER.initAction(false, this, tool.getId());
        }

        @Override
        public void actionPerformed(@NotNull final ActionEvent e) {
            setSelectedTool(tool);
        }

        @NotNull
        @Override
        public Object clone() throws CloneNotSupportedException {
            return super.clone();
        }

    }

}