PluginView.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 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.dialog.plugin;
 
import bsh.ConsoleInterface;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Container;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import net.sf.gridarta.gui.dialog.plugin.parameter.PluginParameterView;
import net.sf.gridarta.gui.dialog.plugin.parameter.PluginParameterViewFactory;
import net.sf.gridarta.gui.utils.MenuUtils;
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.plugin.Plugin;
import net.sf.gridarta.plugin.PluginConsole;
import net.sf.gridarta.plugin.PluginModel;
import net.sf.gridarta.plugin.PluginModelListener;
import net.sf.gridarta.plugin.parameter.InvalidValueException;
import net.sf.gridarta.plugin.parameter.PluginParameter;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.ResourceIcons;
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 PluginView<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final PluginController<G, A, R> pluginController;
 
    @NotNull
    private final Iterable<Plugin<G, A, R>> pluginModel;
 
    @NotNull
    private final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory;
 
    @NotNull
    private final ResourceIcons resourceIcons;
 
    @Nullable
    private JMenu menuScripts;
 
    @Nullable
    private JFrame console;
 
    @Nullable
    private CloseableTabbedPane consolePane;
 
    @NotNull
    private final Object sync = new Object();
 
    @NotNull
    private final PluginModelListener<G, A, R> pluginModelListener = new PluginModelListener<G, A, R>() {
 
        @Override
        public void pluginCreated(@NotNull final Plugin<G, A, R> plugin) {
            updateMenuEntries();
        }
 
        @Override
        public void pluginDeleted(@NotNull final Plugin<G, A, R> plugin) {
            updateMenuEntries();
        }
 
        @Override
        public void pluginRegistered(@NotNull final Plugin<G, A, R> plugin) {
            updateMenuEntries();
        }
 
        @Override
        public void pluginUnregistered(@NotNull final Plugin<G, A, R> plugin) {
            updateMenuEntries();
        }
 
    };
 
    public PluginView(@NotNull final PluginController<G, A, R> pluginController, @NotNull final PluginModel<G, A, R> pluginModel, @NotNull final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory, @NotNull final ResourceIcons resourceIcons) {
        this.pluginController = pluginController;
        this.pluginModel = pluginModel;
        this.pluginParameterViewFactory = pluginParameterViewFactory;
        this.resourceIcons = resourceIcons;
        pluginModel.addPluginModelListener(pluginModelListener);
    }
 
    public void setMenu(@Nullable final JMenu menuScripts) {
        synchronized (sync) {
            this.menuScripts = menuScripts;
            updateMenuEntries();
        }
    }
 
    private void updateMenuEntries() {
        synchronized (sync) {
            final JMenu tmpMenuScripts = menuScripts;
            if (tmpMenuScripts == null) {
                return;
            }
 
            MenuUtils.removeAllToSeparator(tmpMenuScripts);
 
            int index = 0;
            for (final Plugin<G, A, R> plugin : pluginModel) {
                if (!plugin.isScript()) {
                    continue;
                }
 
                final Action action = pluginController.createRunAction(plugin);
                final AbstractButton item = new JMenuItem(action);
                item.setActionCommand(plugin.getName());
                tmpMenuScripts.add(item, index++);
            }
            if (index == 0) {
                final Component def = new JMenuItem(ActionBuilderUtils.getString(ACTION_BUILDER, "pluginViewNoScripts"));
                def.setEnabled(false);
                tmpMenuScripts.add(def, 0);
            }
        }
    }
 
    private void showConsoleFrame() {
        synchronized (sync) {
            if (console == null) {
                console = new JFrame(ActionBuilderUtils.getString(ACTION_BUILDER, "pluginViewConsoleTitle"));
                console.setSize(400, 200);
                consolePane = new CloseableTabbedPane(resourceIcons.getResourceIcon(ResourceIcons.CLOSE_TAB_SMALL_ICON));
                console.getContentPane().add(consolePane);
            }
            console.setVisible(true);
        }
    }
 
    @NotNull
    public ConsoleInterface createConsole(@NotNull final String name) {
        showConsoleFrame();
        final PluginConsole pluginConsole = new PluginConsole();
        consolePane.addTab(name, pluginConsole);
        return pluginConsole;
    }
 
    @Nullable
    public Map<String, Object> getRunValues(@NotNull final Plugin<G, A, R> plugin, @NotNull final Component parent) {
        if (!plugin.hasParameters()) {
            return Collections.emptyMap();
        }
 
        final JOptionPane p = new PluginViewPane();
        p.setOptionType(JOptionPane.OK_CANCEL_OPTION);
        p.setMessageType(JOptionPane.QUESTION_MESSAGE);
        p.setMessage(ActionBuilderUtils.format(ACTION_BUILDER, "pluginViewProvideParameters", plugin.getName()));
        final GridBagLayout layout = new GridBagLayout();
        final Container panel = new JPanel(layout);
        final JDialog dialog = p.createDialog(parent, plugin.getName());
        dialog.setModal(true);
        dialog.getContentPane().removeAll();
        int i = 0;
        for (final PluginParameter<G, A, R, ?> parameter : plugin) {
            final Component name = new JLabel(parameter.getName());
            final PluginParameterView view = pluginParameterViewFactory.newPluginParameterView(panel, parameter);
            final JComponent val = view.getValueComponent();
            val.setToolTipText(parameter.getDescription());
            final GridBagConstraints gn = new GridBagConstraints(0, i, 1, 1, 0.0, 0.0, GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 5, 5);
            final GridBagConstraints gf = new GridBagConstraints(1, i, 1, 1, 1.0, 0.0, GridBagConstraints.EAST, GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 5, 5);
            panel.add(name, gn);
            panel.add(val, gf);
            i++;
        }
 
        dialog.getContentPane().setLayout(new BorderLayout());
        dialog.getContentPane().add(panel, BorderLayout.CENTER);
        dialog.getContentPane().add(p, BorderLayout.SOUTH);
        dialog.pack();
        dialog.setVisible(true);
        final Object result = p.getValue();
        if (!(result instanceof Integer) || (Integer) result != JOptionPane.YES_OPTION) {
            return null;
        }
        final Map<String, Object> parameterValues = new HashMap<>();
        for (final PluginParameter<G, A, R, ?> parameter : plugin) {
            final String parameterName = parameter.getName();
            final Object parameterValue;
            try {
                parameterValue = parameter.getValue();
            } catch (final InvalidValueException ex) {
                JOptionPane.showMessageDialog(parent, "Invalid value for parameter " + parameterName + ": " + ex.getMessage());
                return null;
            }
            parameterValues.put(parameterName, parameterValue);
        }
        return parameterValues;
    }
 
}