EventsTab.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.panel.gameobjectattributes;
 
import java.awt.BorderLayout;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.GridLayout;
import javax.swing.Action;
import javax.swing.DefaultListModel;
import javax.swing.JButton;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.ListModel;
import javax.swing.ListSelectionModel;
import javax.swing.ScrollPaneConstants;
import javax.swing.border.EtchedBorder;
import javax.swing.event.ListSelectionListener;
import net.sf.gridarta.gui.scripts.ScriptArchDataUtils;
import net.sf.gridarta.gui.scripts.ScriptArchEditor;
import net.sf.gridarta.gui.scripts.ScriptTask;
import net.sf.gridarta.gui.utils.Severity;
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.mapmanager.MapManager;
import net.sf.gridarta.model.mapmodel.MapModel;
import net.sf.gridarta.model.scripts.ScriptArchData;
import net.sf.gridarta.model.scripts.ScriptArchUtils;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class EventsTab<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractGameObjectAttributesTab<G, A, R> {
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final Frame parent;
 
    @NotNull
    private final MapManager<G, A, R> mapManager;
 
    @NotNull
    private final ScriptArchEditor<G, A, R> scriptArchEditor;
 
    @NotNull
    private final ScriptArchData<G, A, R> scriptArchData;
 
    @NotNull
    private final ScriptArchUtils scriptArchUtils;
 
    @NotNull
    private final ScriptArchDataUtils<G, A, R> scriptArchDataUtils;
 
    @NotNull
    private final JPanel panel = new JPanel();
 
    @NotNull
    private final JScrollPane scrollPane;
 
    @NotNull
    private final Action aEventAddNew = ACTION_BUILDER.createAction(false, "eventAddNew", this);
 
    @NotNull
    private final Action aEventEditData = ACTION_BUILDER.createAction(false, "eventEditData", this);
 
    @NotNull
    private final Action aEventEdit = ACTION_BUILDER.createAction(false, "eventEdit", this);
 
    @NotNull
    private final Action aEventRemove = ACTION_BUILDER.createAction(false, "eventRemove", this);
 
    @NotNull
    private final JList<String> eventList = new JList<>();
 
    @Nullable
    private GameObject<G, A, R> selectedGameObject;
 
    public EventsTab(@NotNull final Frame parent, @NotNull final MapManager<G, A, R> mapManager, @NotNull final GameObjectAttributesModel<G, A, R> gameObjectAttributesModel, @NotNull final ScriptArchEditor<G, A, R> scriptArchEditor, @NotNull final ScriptArchData<G, A, R> scriptArchData, @NotNull final ScriptArchDataUtils<G, A, R> scriptArchDataUtils, @NotNull final ScriptArchUtils scriptArchUtils) {
        super(gameObjectAttributesModel);
        this.parent = parent;
        this.mapManager = mapManager;
        this.scriptArchEditor = scriptArchEditor;
        this.scriptArchData = scriptArchData;
        this.scriptArchDataUtils = scriptArchDataUtils;
        this.scriptArchUtils = scriptArchUtils;
 
        scrollPane = new JScrollPane(eventList);
        scrollPane.setBorder(new EtchedBorder());
        scrollPane.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);
        scrollPane.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
        scrollPane.setPreferredSize(new Dimension(80, 40));
 
        final Container buttons = new JPanel(new GridLayout(4, 1));
        buttons.add(new JButton(aEventAddNew));
        buttons.add(new JButton(aEventEditData));
        buttons.add(new JButton(aEventEdit));
        buttons.add(new JButton(aEventRemove));
 
        panel.setLayout(new BorderLayout());
        panel.add(scrollPane, BorderLayout.CENTER);
        panel.add(buttons, BorderLayout.EAST);
        panel.setPreferredSize(new Dimension(100, 40));
 
        eventList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
        final ListSelectionListener listSelectionListener = e -> updateActions();
        eventList.addListSelectionListener(listSelectionListener);
        refresh(gameObjectAttributesModel.getSelectedGameObject());
    }
 
    @NotNull
    @Override
    public JPanel getPanel() {
        return panel;
    }
 
    @Override
    public boolean canApply() {
        return false;
    }
 
    @Override
    public void activate() {
        scrollPane.requestFocusInWindow();
    }
 
    @Override
    protected final void refresh(@Nullable final G gameObject) {
        selectedGameObject = gameObject;
        if (gameObject == null || !gameObject.isScripted()) {
            setTabSeverity(Severity.DEFAULT);
            final ListModel<?> listModel = eventList.getModel();
            if (listModel != null && listModel.getSize() > 0) {
                eventList.setModel(new DefaultListModel<>());
            }
        } else {
            setTabSeverity(Severity.MODIFIED);
            eventList.removeAll();
            scriptArchUtils.addEventsToJList(eventList, gameObject);
        }
        updateActions();
    }
 
    private void updateActions() {
        aEventAddNew.setEnabled(doAddNewEvent(false));
        aEventEditData.setEnabled(doEditEvent(ScriptTask.EVENT_EDIT_PATH, false));
        aEventEdit.setEnabled(doEditEvent(ScriptTask.EVENT_OPEN, false));
        aEventRemove.setEnabled(doEditEvent(ScriptTask.EVENT_REMOVE, false));
    }
 
    @Override
    protected void apply(@NotNull final G gameObject) {
    }
 
    @ActionMethod
    public void eventAddNew() {
        doAddNewEvent(true);
    }
 
    @ActionMethod
    public void eventEditData() {
        doEditEvent(ScriptTask.EVENT_EDIT_PATH, true);
    }
 
    @ActionMethod
    public void eventEdit() {
        doEditEvent(ScriptTask.EVENT_OPEN, true);
    }
 
    @ActionMethod
    public void eventRemove() {
        doEditEvent(ScriptTask.EVENT_REMOVE, true);
    }
 
    private boolean doAddNewEvent(final boolean performAction) {
        final GameObject<G, A, R> gameObject = selectedGameObject;
        if (gameObject == null) {
            return false;
        }
 
        if (performAction) {
            final G selectedHead = gameObject.getHead();
            final MapModel<G, A, R> mapModel = selectedHead.getMapSquare().getMapModel();
            mapModel.beginTransaction("Add event");
            try {
                scriptArchEditor.addEventScript(selectedHead, scriptArchData, parent);
 
                if (scriptArchData.isEmpty(selectedHead)) {
                    setEventPanelButtonState(true, false, false, false);
                } else {
                    setEventPanelButtonState(true, true, true, true);
                    scriptArchUtils.addEventsToJList(eventList, selectedHead);
                }
            } finally {
                mapModel.endTransaction();
            }
        }
 
        return true;
    }
 
    private boolean doEditEvent(@NotNull final ScriptTask task, final boolean performAction) {
        final GameObject<G, A, R> gameObject = selectedGameObject;
        if (gameObject == null) {
            return false;
        }
 
        final ListModel<?> listModel = eventList.getModel();
        if (listModel == null || listModel.getSize() <= 0) {
            return false;
        }
 
        final int index = eventList.getSelectedIndex();
        if (index < 0) {
            return false;
        }
 
        if (performAction) {
            final G selectedHead = gameObject.getHead();
            final MapModel<G, A, R> mapModel = selectedHead.getMapSquare().getMapModel();
            mapModel.beginTransaction("Modify event");
            try {
                scriptArchDataUtils.modifyEventScript(index, task, eventList, mapManager, parent, selectedHead);
                if (scriptArchData.isEmpty(selectedHead)) {
                    setEventPanelButtonState(true, false, false, false);
                }
            } finally {
                mapModel.endTransaction();
            }
        }
 
        return true;
    }
 
    private void setEventPanelButtonState(final boolean newButton, final boolean modifyButton, final boolean pathButton, final boolean removeButton) {
        aEventAddNew.setEnabled(newButton);
        aEventEditData.setEnabled(pathButton);
        aEventEdit.setEnabled(modifyButton);
        aEventRemove.setEnabled(removeButton);
    }
 
}