GameObjectAttributesDialog.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.dialog.gameobjectattributes;

import java.awt.CardLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.Point;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.util.Set;
import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTextField;
import javax.swing.JTextPane;
import javax.swing.filechooser.FileFilter;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.JTextComponent;
import javax.swing.text.Style;
import javax.swing.text.StyleConstants;
import javax.swing.text.StyleContext;
import net.sf.gridarta.gui.dialog.help.Help;
import net.sf.gridarta.gui.treasurelist.CFTreasureListTree;
import net.sf.gridarta.model.anim.AnimationObjects;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.archetypetype.ArchetypeAttribute;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeFixed;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeSection;
import net.sf.gridarta.model.archetypetype.ArchetypeType;
import net.sf.gridarta.model.archetypetype.ArchetypeTypeSet;
import net.sf.gridarta.model.baseobject.BaseObject;
import net.sf.gridarta.model.face.FaceObjectProviders;
import net.sf.gridarta.model.face.FaceObjectProvidersListener;
import net.sf.gridarta.model.face.FaceObjects;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.gameobject.GameObjectUtils;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapcontrol.MapControl;
import net.sf.gridarta.model.mapmanager.MapManager;
import net.sf.gridarta.model.mapmanager.MapManagerListener;
import net.sf.gridarta.model.mapmodel.MapFile;
import net.sf.gridarta.model.mapmodel.MapModel;
import net.sf.gridarta.model.mapmodel.MapModelListener;
import net.sf.gridarta.model.mapmodel.MapSquare;
import net.sf.gridarta.model.settings.ProjectSettings;
import net.sf.gridarta.model.spells.GameObjectSpell;
import net.sf.gridarta.model.spells.NumberSpell;
import net.sf.gridarta.model.spells.Spells;
import net.sf.gridarta.model.treasurelist.TreasureTree;
import net.sf.gridarta.model.validation.ErrorCollector;
import net.sf.gridarta.textedit.textarea.TextAreaDefaults;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.Size2D;
import net.sf.gridarta.utils.StringUtils;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

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

    @NotNull
    private static final Category LOG = Logger.getLogger(GameObjectAttributesDialog.class);

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

    @NotNull
    private final GameObjectAttributesDialogFactory<G, A, R> gameObjectAttributesDialogFactory;

    @NotNull
    private final ArchetypeTypeSet archetypeTypeSet;

    @NotNull
    private final Frame parent;

    @NotNull
    private final FaceObjectProviders faceObjectProviders;

    @NotNull
    private final MapManager<G, A, R> mapManager;

    @NotNull
    private final JOptionPane optionPane = new JOptionPane() {

        private static final long serialVersionUID = 1;

        @Override
        public void setValue(@Nullable final Object newValue) {
            super.setValue(newValue);
            if (newValue != UNINITIALIZED_VALUE) {
                gameObjectAttributesDialogFactory.hideAttributeDialog(gameObject);
                mapModel.removeMapModelListener(mapModelListener);
                mapManager.removeMapManagerListener(mapManagerListener);
                faceObjectProviders.removeFaceObjectProvidersListener(faceObjectProvidersListener);
            }
        }

    };

    @NotNull
    private final AttributesPaneBuilder<G, A, R> attributesPaneBuilder;

    @NotNull
    private JLabel faceLabel;

    @NotNull
    private final G gameObject;

    @NotNull
    private final MapModel<G, A, R> mapModel;

    @NotNull
    private final Point mapPos;

    @NotNull
    private final Archetype<G, A, R> archetype;

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

    @NotNull
    private final Action summaryAction = ACTION_BUILDER.createAction(false, "attribSummary", this);

    @NotNull
    private final Action editAction = ACTION_BUILDER.createAction(false, "attribEdit", this);

    @NotNull
    private AbstractButton summaryEditButton;

    @NotNull
    private AbstractButton cancelButton;

    @NotNull
    private JButton okButton;

    @NotNull
    private final Container centerPanel;

    @NotNull
    private final JTextPane summaryTextPane;

    @NotNull
    private final Style summaryTextStyle;

    @NotNull
    private ArchetypeType archetypeType;

    @NotNull
    private final MapModelListener<G, A, R> mapModelListener = new MapModelListener<G, A, R>() {

        @Override
        public void mapSizeChanged(@NotNull final Size2D newSize) {
            if (gameObject.getMapSquare() == null) {
                optionPane.setValue(cancelButton);
            }
        }

        @Override
        public void mapSquaresChanged(@NotNull final Set<MapSquare<G, A, R>> mapSquares) {
            if (gameObject.getMapSquare() != mapModel.getMapSquare(mapPos)) {
                optionPane.setValue(cancelButton);
            }
        }

        @Override
        public void mapObjectsChanged(@NotNull final Set<G> gameObjects, @NotNull final Set<G> transientGameObjects) {
            if (gameObject.getMapSquare() == null) {
                optionPane.setValue(cancelButton);
            }
        }

        @Override
        public void errorsChanged(@NotNull final ErrorCollector<G, A, R> errors) {
            // ignore
        }

        @Override
        public void mapFileChanged(@Nullable final MapFile oldMapFile) {
            // ignore
        }

        @Override
        public void modifiedChanged() {
            // ignore
        }

    };

    @NotNull
    private final MapManagerListener<G, A, R> mapManagerListener = new MapManagerListener<G, A, R>() {

        @Override
        public void currentMapChanged(@Nullable final MapControl<G, A, R> mapControl) {
            // ignore
        }

        @Override
        public void mapCreated(@NotNull final MapControl<G, A, R> mapControl, final boolean interactive) {
            // ignore
        }

        @Override
        public void mapClosing(@NotNull final MapControl<G, A, R> mapControl) {
            // ignore
        }

        @Override
        public void mapClosed(@NotNull final MapControl<G, A, R> mapControl) {
            if (mapControl.getMapModel() == mapModel) {
                optionPane.setValue(cancelButton);
            }
        }

    };

    @NotNull
    private final FaceObjectProvidersListener faceObjectProvidersListener = new FaceObjectProvidersListener() {

        @Override
        public void facesReloaded() {
            faceLabel.setIcon(getFace(gameObject));
        }

    };

    @NotNull
    private final ItemListener typesBoxItemListener = new ItemListener() {

        @Nullable
        private ArchetypeType deselected;

        private boolean ignoreEvent;

        @Override
        public void itemStateChanged(@NotNull final ItemEvent e) {
            if (ignoreEvent) {
                return;
            }

            if (e.getStateChange() == ItemEvent.DESELECTED) {
                deselected = (ArchetypeType) e.getItem();
            } else if (e.getStateChange() == ItemEvent.SELECTED && !e.getItem().equals(deselected)) {
                final ArchetypeType newType = (ArchetypeType) e.getItem();

                final JComboBox<?> typeComboBox = (JComboBox<?>) e.getSource();

                typeComboBox.hidePopup();

                if (deselected == null) {
                    deselected = archetypeType;
                }
                if (JOptionPane.showConfirmDialog(optionPane, ActionBuilderUtils.format(ACTION_BUILDER, "attribConfirmTypeChange", deselected.getTypeName(), newType.getTypeName()), ActionBuilderUtils.getString(ACTION_BUILDER, "attribConfirmTypeChangeTitle"), JOptionPane.YES_NO_OPTION, JOptionPane.INFORMATION_MESSAGE) == JOptionPane.YES_OPTION) {
                    archetypeType = newType;

                    final MapModel<G, A, R> mapModel = gameObject.getMapSquare().getMapModel();
                    mapModel.beginTransaction("change type to " + newType.getTypeName());
                    try {
                        gameObject.setAttributeInt(BaseObject.TYPE, newType.getTypeNo());
                    } finally {
                        mapModel.endTransaction();
                    }

                    attributesPaneBuilder.buildAttribute(gameObject, archetypeType);
                } else {
                    ignoreEvent = true;
                    typeComboBox.setSelectedItem(archetypeType);
                    ignoreEvent = false;
                }
            }
        }

    };

    public GameObjectAttributesDialog(@NotNull final GameObjectAttributesDialogFactory<G, A, R> gameObjectAttributesDialogFactory, final ArchetypeTypeSet archetypeTypeSet, @NotNull final G gameObject, @NotNull final Frame parent, @NotNull final CFTreasureListTree treasureListTree, @NotNull final FaceObjectProviders faceObjectProviders, @NotNull final AnimationObjects animationObjects, @NotNull final ProjectSettings projectSettings, @NotNull final FileFilter mapFileFilter, @NotNull final FileFilter scriptFileFilter, @NotNull final FaceObjects faceObjects, @NotNull final Spells<GameObjectSpell<G, A, R>> gameObjectSpells, @NotNull final Spells<NumberSpell> numberSpells, final int undefinedSpellIndex, @NotNull final TreasureTree treasureTree, @NotNull final ImageIcon noFaceSquareIcon, @NotNull final ImageIcon unknownSquareIcon, @NotNull final TextAreaDefaults textAreaDefaults, @NotNull final MapManager<G, A, R> mapManager) {
        this.gameObjectAttributesDialogFactory = gameObjectAttributesDialogFactory;
        this.archetypeTypeSet = archetypeTypeSet;
        this.gameObject = gameObject;
        this.parent = parent;
        this.faceObjectProviders = faceObjectProviders;
        this.mapManager = mapManager;
        archetype = gameObject.getArchetype();

        final MapSquare<G, A, R> mapSquare = gameObject.getMapSquare();
        if (mapSquare == null) {
            throw new IllegalArgumentException();
        }
        mapModel = mapSquare.getMapModel();
        mapPos = mapSquare.getMapLocation();
        mapModel.addMapModelListener(mapModelListener);
        mapManager.addMapManagerListener(mapManagerListener);

        // first split top-left and -right
        archetypeType = archetypeTypeSet.getArchetypeTypeByBaseObject(gameObject);
        final JComponent leftPane = buildHeader();

        // Now split horizontally
        attributesPaneBuilder = new AttributesPaneBuilder<>(gameObject, optionPane, archetypeTypeSet, treasureListTree, faceObjectProviders, animationObjects, projectSettings, mapFileFilter, scriptFileFilter, faceObjects, gameObjectSpells, numberSpells, undefinedSpellIndex, treasureTree, noFaceSquareIcon, unknownSquareIcon, textAreaDefaults);
        attributesPaneBuilder.buildAttribute(gameObject, archetypeType);
        centerPanel = new JPanel(cardLayout);
        centerPanel.add("edit", attributesPaneBuilder.getTabbedPane());
        summaryTextPane = new JTextPane();
        summaryTextPane.setEditable(false);
        summaryTextPane.setBorder(BorderFactory.createEmptyBorder(3, 15, 0, 0));
        centerPanel.add("summary", new JScrollPane(summaryTextPane));
        final Dimension size = centerPanel.getPreferredSize();
        size.height = 256;
        centerPanel.setMinimumSize(size);
        centerPanel.setPreferredSize(size);

        final Container contentPanel = new JPanel(new GridBagLayout());
        final GridBagConstraints gbc = new GridBagConstraints();
        gbc.weightx = 1.0;
        gbc.fill = GridBagConstraints.BOTH;
        gbc.gridwidth = GridBagConstraints.REMAINDER;
        gbc.weighty = 0.0;
        contentPanel.add(leftPane, gbc);
        gbc.weighty = 1.0;
        contentPanel.add(centerPanel, gbc);

        optionPane.setOptions(buildOptions());

        summaryTextStyle = summaryTextPane.getStyle(StyleContext.DEFAULT_STYLE);
        StyleConstants.setForeground(summaryTextStyle, Color.black);

        faceObjectProviders.addFaceObjectProvidersListener(faceObjectProvidersListener);

        optionPane.setMessage(contentPanel);
    }

    @NotNull
    public JDialog createDialog() {
        final JDialog dialog = optionPane.createDialog(parent, ActionBuilderUtils.getString(ACTION_BUILDER, "attribTitle"));
        dialog.getRootPane().setDefaultButton(okButton);
        dialog.setResizable(true);
        dialog.setModal(false);
        dialog.setVisible(true);
        return dialog;
    }

    @NotNull
    private Component buildTypesBox() {
        final ArchetypeType[] model = new ArchetypeType[archetypeTypeSet.getArchetypeTypeCount()];
        int i = 0;
        for (final ArchetypeType tmp : archetypeTypeSet) {
            model[i++] = tmp;
        }

        final JComboBox<?> typeComboBox = new JComboBox<>(model);
        typeComboBox.setSelectedItem(archetypeType);
        typeComboBox.setRenderer(new ArchetypeTypeListCellRenderer());
        typeComboBox.setName("Types");
        typeComboBox.addItemListener(typesBoxItemListener);
        return typeComboBox;
    }

    @NotNull
    private ImageIcon getFace(@NotNull final BaseObject<G, A, R, ?> gameObject) {
        return faceObjectProviders.getFace(gameObject);
    }

    @NotNull
    private JComponent buildHeader() {
        final JComponent header = new JPanel(new GridBagLayout());   // the final thing, in a panel
        final GridBagConstraints gbc = new GridBagConstraints();
        gbc.fill = GridBagConstraints.BOTH;
        gbc.insets = new Insets(2, 2, 2, 2);
        gbc.gridx = 1;
        gbc.gridy = 1;
        gbc.weightx = 0.0;
        gbc.weighty = 3.0;
        gbc.gridheight = 3;
        faceLabel = new JLabel(getFace(gameObject));
        faceLabel.setBorder(BorderFactory.createEmptyBorder(0, 0, 0, 10));
        header.add(faceLabel, gbc);
        gbc.gridheight = 1;
        gbc.weighty = 1.0;
        gbc.fill = GridBagConstraints.HORIZONTAL;

        gbc.weightx = 0.0;
        gbc.gridx = 2;
        gbc.gridy = 1;
        header.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "attribName"), gbc);
        gbc.gridy++;
        header.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "attribType"), gbc);
        gbc.gridy++;
        header.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "attribArchetype"), gbc);

        gbc.gridx = 3;
        gbc.gridy = 1;
        gbc.weightx = 1.0;
        final JTextComponent nameTextField;
        final String objName = gameObject.getObjName();
        if (objName.isEmpty()) {
            final String archObjName = archetype.getObjName();
            final String nameText = !archObjName.isEmpty() ? archObjName : archetype.getArchetypeName();
            nameTextField = new JTextField(nameText, 16);
        } else {
            nameTextField = new JTextField(objName, 16);
        }
        nameTextField.setEditable(false);
        header.add(nameTextField, gbc);
        gbc.gridy++;
        header.add(buildTypesBox(), gbc);   // build type-selection box
        gbc.gridy++;
        final JTextComponent archetypeTextField = new JTextField(archetype.getArchetypeName(), 16);
        archetypeTextField.setEditable(false);
        header.add(archetypeTextField, gbc);

        return header;
    }

    @NotNull
    private Object[] buildOptions() {
        summaryEditButton = new JButton(summaryAction);
        okButton = new JButton(ACTION_BUILDER.createAction(false, "attribOk", this));
        cancelButton = new JButton(ACTION_BUILDER.createAction(false, "attribCancel", this));
        return new Object[] { new JButton(ACTION_BUILDER.createAction(false, "attribHelp", this)), summaryEditButton, Box.createHorizontalStrut(32), okButton, new JButton(ACTION_BUILDER.createAction(false, "attribApply", this)), cancelButton, };
    }

    @ActionMethod
    public void attribHelp() {
        final String helpText = ACTION_BUILDER.format("arcDoc.htmlText", archetypeType.getTypeName(), archetypeType.getDescription(), archetypeType.getUse());
        new Help(/* XXX */ parent, helpText).setVisible(true);
    }

    @ActionMethod
    public void attribOk() {
        if (applySettings()) {
            optionPane.setValue(okButton);
        }
    }

    @ActionMethod
    public void attribApply() {
        applySettings();
    }

    @ActionMethod
    public void attribCancel() {
        optionPane.setValue(cancelButton);
    }

    @ActionMethod
    public void attribSummary() {
        // interface is displayed, switch to summary
        final Document doc = summaryTextPane.getDocument();

        try {
            // clear document
            if (doc.getLength() > 0) {
                doc.remove(0, doc.getLength());
            }

            // now loop through all attributes and write out nonzero ones
            for (final DialogAttribute<?, ?, ?, ?> dialogAttribute : attributesPaneBuilder.getDialogAttributes()) {
                dialogAttribute.appendSummary(doc, summaryTextStyle);
            }
        } catch (final BadLocationException e) {
            LOG.error("toggleSummary: Bad Location in Document!", e);
        }

        summaryTextPane.setCaretPosition(0); // this prevents the document from scrolling down
        summaryEditButton.setAction(editAction);
        cardLayout.show(centerPanel, "summary");
    }

    @ActionMethod
    public void attribEdit() {
        summaryEditButton.setAction(summaryAction);
        cardLayout.show(centerPanel, "edit");
    }

    private boolean applySettings() {
        final MapSquare<G, A, R> mapSquare = gameObject.getMapSquare();
        assert mapSquare != null;
        final MapModel<G, A, R> tmpMapModel = mapSquare.getMapModel();
        tmpMapModel.beginTransaction("Change object attributes");
        try {
            return applySettings2();
        } finally {
            tmpMapModel.endTransaction();
        }
    }

    private boolean applySettings2() {
        final ArchetypeType tmpArchetypeType = archetypeTypeSet.getArchetypeTypeByBaseObject(gameObject); // the type structure for this gameObject

        final StringBuilder newArchText = new StringBuilder();
        final String[] newMsg = new String[1];
        for (final DialogAttribute<G, A, R, ?> dialogAttribute : attributesPaneBuilder.getDialogAttributes()) {
            final String text;
            try {
                text = dialogAttribute.getObjectText(gameObject, archetype, newMsg, tmpArchetypeType);
            } catch (final InvalidAttributeException ex) {
                JOptionPane.showMessageDialog(optionPane, ex.getMessage(), "Input Error", JOptionPane.ERROR_MESSAGE);
                return false;
            }
            if (!text.isEmpty()) {
                newArchText.append(text).append("\n");
            }
        }

        // Also write all the 'fixed' attributes into the archetype text
        for (final ArchetypeAttributeSection archetypeAttributeSection : archetypeType) {
            for (final ArchetypeAttribute archetypeAttribute : archetypeAttributeSection) {
                // ### TODO: for changed types, copy fixed attributes over default arches ###
                if (archetypeAttribute instanceof ArchetypeAttributeFixed) {
                    final String defaultValue = archetype.getAttributeString(archetypeAttribute.getArchetypeAttributeName());
                    if (defaultValue.isEmpty() || (gameObject.getTypeNo() != archetype.getTypeNo() && !defaultValue.equalsIgnoreCase(archetypeAttribute.getAttributeName()))) {
                        // usually, fixed attributes are only applied when *not* defined in the archetype.
                        // the reason behind this is: if the default gameObject violates our fixed attribute,
                        // we assume the default gameObject is "right" and we are "wrong". The typedefs aren't that trustworthy.
                        // BUT - if the gameObject has a changed type, the archetype has lost it's credibility.
                        // So, in this special case, the fixed attribute applies always.
                        newArchText.append(archetypeAttribute.getArchetypeAttributeName()).append(" ").append(archetypeAttribute.getAttributeName()).append("\n");
                    }
                }
            }
        }

        // before we modify the archetype text, we look for errors and save them.
        // later the user must confirm whether to keep or dump those errors
        final String errors = GameObjectUtils.getSyntaxErrors(gameObject, tmpArchetypeType);

        // --- parsing succeeded, now we write it into the gameObject/map ---
        final int typeNo = gameObject.getTypeNo();
        gameObject.setObjectText(newArchText.toString());
        gameObject.setAttributeInt(BaseObject.TYPE, typeNo);

        if (newMsg[0] != null) {
            // set new msg text only when it is not equal to Archetype
            final String msgText = StringUtils.removeTrailingWhitespaceFromLines(newMsg[0]);
            final String archetypeMsgText = archetype.getMsgText();
            gameObject.setMsgText(msgText.equals(archetypeMsgText == null ? "" : archetypeMsgText) ? null : msgText);
        } else {
            final String archetypeMsgText = archetype.getMsgText();
            gameObject.setMsgText(archetypeMsgText != null && !archetypeMsgText.isEmpty() ? "" : null);
        }

        // now lets assign the visible face - perhaps we have still an animation
        faceLabel.setIcon(getFace(gameObject));

        // deal with syntax errors now
        if (errors != null) {
            // For the fallback archetype type, all errors are automatically
            // kept. "Misc" is no real type - it is more a default mask for
            // unknown types. For all other archetype types, a popup dialog is
            // opened and the user may decide what to do with his errors.
            final boolean keepErrors = archetypeTypeSet.isFallbackArchetypeType(tmpArchetypeType) || ConfirmErrorsDialog.askConfirmErrors(errors, optionPane);
            if (keepErrors) {
                gameObject.addObjectText(errors.trim());
            }
        }

        return true; // apply succeeded
    }

}