PluginEditorRow.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 java.awt.Component;
import java.awt.event.FocusListener;
import java.awt.event.ItemEvent;
import java.awt.event.MouseListener;
import javax.swing.JComboBox;
import javax.swing.JTextField;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.text.JTextComponent;
import net.sf.gridarta.gui.dialog.plugin.parameter.PluginParameterView;
import net.sf.gridarta.gui.dialog.plugin.parameter.PluginParameterViewFactory;
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.parameter.NoSuchParameterException;
import net.sf.gridarta.plugin.parameter.PluginParameter;
import net.sf.gridarta.plugin.parameter.PluginParameterFactory;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
 
public class PluginEditorRow {
 
    @NotNull
    private static final Category LOG = Logger.getLogger(PluginEditorRow.class);
 
    @NotNull
    private final MouseListener mouseListener;
 
    @NotNull
    private final FocusListener focusListener;
 
    @NotNull
    private final Component parameterNameEditor;
 
    @NotNull
    private final Component parameterDescriptionEditor;
 
    @NotNull
    private final Component parameterTypeEditor;
 
    @NotNull
    private final PluginParameterView pluginParameterView;
 
    public <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> PluginEditorRow(@NotNull final Plugin<G, A, R> plugin, @NotNull final PluginParameter<G, A, R, ?> parameter, @NotNull final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory, @NotNull final MouseListener mouseListener, @NotNull final FocusListener focusListener, @NotNull final Component parent) {
        this.mouseListener = mouseListener;
        this.focusListener = focusListener;
 
        parameterNameEditor = createNameEditor(parameter);
        parameterDescriptionEditor = createDescriptionEditor(parameter);
        parameterTypeEditor = createTypeEditor(plugin, parameter);
        pluginParameterView = createView(parameter, pluginParameterViewFactory, parent);
    }
 
    @NotNull
    private <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> Component createNameEditor(final PluginParameter<G, A, R, ?> parameter) {
        final JTextComponent textField = new JTextField(parameter.getName());
        textField.getDocument().addDocumentListener(new DocumentListener() {
 
            @Override
            public void insertUpdate(@NotNull final DocumentEvent e) {
                change();
            }
 
            @Override
            public void removeUpdate(@NotNull final DocumentEvent e) {
                change();
            }
 
            @Override
            public void changedUpdate(@NotNull final DocumentEvent e) {
                change();
            }
 
            private void change() {
                parameter.setName(textField.getText());
            }
 
        });
        attachListeners(textField);
        return textField;
    }
 
    @NotNull
    private <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> Component createDescriptionEditor(final PluginParameter<G, A, R, ?> parameter) {
        final JTextComponent textField = new JTextField(parameter.getDescription());
        textField.getDocument().addDocumentListener(new DocumentListener() {
 
            @Override
            public void changedUpdate(@NotNull final DocumentEvent e) {
                change();
            }
 
            @Override
            public void insertUpdate(@NotNull final DocumentEvent e) {
                change();
            }
 
            @Override
            public void removeUpdate(@NotNull final DocumentEvent e) {
                change();
            }
 
            private void change() {
                parameter.setDescription(textField.getText());
            }
        });
        attachListeners(textField);
        return textField;
    }
 
    @NotNull
    private <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> Component createTypeEditor(final Plugin<G, A, R> plugin, final PluginParameter<G, A, R, ?> parameter) {
        final JComboBox<?> comboBox = new JComboBox<>(PluginParameterFactory.getTypes());
        comboBox.setSelectedItem(parameter.getParameterType());
        comboBox.addItemListener(e -> {
            if (e.getStateChange() != ItemEvent.SELECTED) {
                return;
            }
 
            final String newParameterType = (String) e.getItem();
            if (parameter.getParameterType().equals(newParameterType)) {
                return;
            }
 
            try {
                plugin.convertType(parameter, newParameterType);
            } catch (final NoSuchParameterException ex) {
                LOG.warn("Cannot create parameter for " + ex.getMessage());
            }
        });
        attachListeners(comboBox);
        return comboBox;
    }
 
    @NotNull
    private <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> PluginParameterView createView(final PluginParameter<G, A, R, ?> parameter, final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory, final Component parent) {
        final PluginParameterView pluginParameterView = pluginParameterViewFactory.newPluginParameterView(parent, parameter);
        attachListeners(pluginParameterView.getConfigComponent());
        attachListeners(pluginParameterView.getValueComponent());
        return pluginParameterView;
    }
 
    @NotNull
    public Component getParameterNameEditor() {
        return parameterNameEditor;
    }
 
    @NotNull
    public Component getParameterDescriptionEditor() {
        return parameterDescriptionEditor;
    }
 
    @NotNull
    public Component getParameterTypeEditor() {
        return parameterTypeEditor;
    }
 
    @NotNull
    public Component getConfigComponent() {
        return pluginParameterView.getConfigComponent();
    }
 
    @NotNull
    public Component getValueComponent() {
        return pluginParameterView.getValueComponent();
    }
 
    private void attachListeners(@NotNull final Component component) {
        component.addFocusListener(focusListener);
        component.addMouseListener(mouseListener);
    }
 
}