AttributesPaneBuilder.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.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.FocusListener;
import java.io.File;
import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.regex.Pattern;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.DefaultComboBoxModel;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JFormattedTextField;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTabbedPane;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.filechooser.FileFilter;
import javax.swing.text.DefaultFormatterFactory;
import javax.swing.text.NumberFormatter;
import net.sf.gridarta.gui.map.maptilepane.TilePanel;
import net.sf.gridarta.gui.treasurelist.CFTreasureListTree;
import net.sf.gridarta.gui.utils.AnimationComponent;
import net.sf.gridarta.gui.utils.FaceComponent;
import net.sf.gridarta.model.anim.AnimationObjects;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.archetypetype.AbstractArchetypeAttributeSpell;
import net.sf.gridarta.model.archetypetype.ArchetypeAttribute;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeAnimationName;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeBitmask;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeBool;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeBoolSpec;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeFaceName;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeFixed;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeFloat;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeInt;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeInvSpell;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeList;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeList2;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeLong;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeMapPath;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeScriptFile;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeSection;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeSpell;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeString;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeText;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeTreasure;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeVisitor;
import net.sf.gridarta.model.archetypetype.ArchetypeAttributeZSpell;
import net.sf.gridarta.model.archetypetype.ArchetypeTypeList;
import net.sf.gridarta.model.archetypetype.ArchetypeTypeSet;
import net.sf.gridarta.model.archetypetype.AttributeBitmask;
import net.sf.gridarta.model.baseobject.Attributes;
import net.sf.gridarta.model.baseobject.BaseObject;
import net.sf.gridarta.model.face.FaceObjectProviders;
import net.sf.gridarta.model.face.FaceObjects;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapmodel.MapFile;
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.Spell;
import net.sf.gridarta.model.spells.Spells;
import net.sf.gridarta.model.treasurelist.TreasureTree;
import net.sf.gridarta.textedit.textarea.JEditTextArea;
import net.sf.gridarta.textedit.textarea.SyntaxDocument;
import net.sf.gridarta.textedit.textarea.TextAreaDefaults;
import net.sf.gridarta.textedit.textarea.tokenmarker.TokenMarkerFactory;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

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

    @NotNull
    private static final Color FLOAT_COLOR = new Color(19, 134, 0);

    @NotNull
    private static final Color INT_COLOR = new Color(74, 70, 156);

    @NotNull
    private static final Pattern PARAGRAPH_DELIMITER = Pattern.compile("\n+");

    @NotNull
    private Attributes attributes;

    @NotNull
    private final Component parent;

    @NotNull
    private final ArchetypeTypeSet archetypeTypeSet;

    @NotNull
    private final CFTreasureListTree treasureListTree;

    @NotNull
    private final FaceObjectProviders faceObjectProviders;

    @NotNull
    private final AnimationObjects animationObjects;

    @NotNull
    private final ProjectSettings projectSettings;

    @NotNull
    private final FileFilter mapFileFilter;

    @NotNull
    private final FileFilter scriptFileFilter;

    @NotNull
    private final FaceObjects faceObjects;

    @NotNull
    private final Spells<GameObjectSpell<G, A, R>> gameObjectSpells;

    @NotNull
    private final Spells<NumberSpell> numberSpells;

    private final int undefinedSpellIndex;

    @NotNull
    private final TreasureTree treasureTree;

    @NotNull
    private final ImageIcon noFaceSquareIcon;

    @NotNull
    private final ImageIcon unknownSquareIcon;

    @NotNull
    private final TextAreaDefaults textAreaDefaults;

    @NotNull
    private final JTabbedPane tabbedPane = new JTabbedPane();

    @NotNull
    private final FocusListener focusListener = new ScrollToVisibleFocusListener();

    @NotNull
    private final Collection<DialogAttribute<G, A, R, ?>> dialogAttributes = new ArrayList<>();

    @Nullable
    private GuiInfo<G, A, R, ?> guiInfo;

    @NotNull
    private final ArchetypeAttributeVisitor archetypeAttributeVisitor = new ArchetypeAttributeVisitor() {

        private void adjustTooltip(@Nullable final JComponent component, @NotNull final ArchetypeAttribute attribute) {
            @NotNull final String desc = attribute.getDescription();
            if (component != null && !desc.isEmpty()) {
                final StringBuilder sb = new StringBuilder("<html>");
                for (final String paragraph : PARAGRAPH_DELIMITER.split(desc)) {
                    sb.append("<p>").append(paragraph).append("</p>");
                }
                component.setToolTipText(sb.toString());
            }
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeAnimationName archetypeAttribute) {
            final String attributeName = archetypeAttribute.getArchetypeAttributeName();
            final String defaultText = attributes.getAttributeString(attributeName);
            final AnimationComponent input = new AnimationComponent(defaultText, animationObjects, faceObjectProviders, noFaceSquareIcon, unknownSquareIcon);
            adjustTooltip(input, archetypeAttribute);
            final JLabel cLabel = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(cLabel, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeAnimationName<G, A, R>(archetypeAttribute, input), cLabel, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeBitmask archetypeAttribute) {
            final JTextArea input = new JTextArea();
            final DialogAttributeBitmask<G, A, R> tmpAttribute = new DialogAttributeBitmask<>(archetypeAttribute, input);
            final AttributeBitmask bitmask = archetypeTypeSet.getBitmask(archetypeAttribute.getBitmaskName());
            if (bitmask != null) {
                tmpAttribute.setBitmask(bitmask);
                final JButton label = new JButton(new MaskChangeAL<>(archetypeAttribute.getAttributeName() + ":", tmpAttribute));
                adjustTooltip(label, archetypeAttribute);
                input.setBackground(parent.getBackground());
                input.setEditable(false);
                input.setBorder(BorderFactory.createLineBorder(Color.gray));
                input.setText(bitmask.getText(tmpAttribute.getValue()));
                adjustTooltip(input, archetypeAttribute);
                tmpAttribute.setEncodedValue(attributes.getAttributeString(archetypeAttribute.getArchetypeAttributeName()));
                guiInfo = new GuiInfoTwoColumn<>(tmpAttribute, label, input);
            } else {
                final JLabel row = new JLabel("Error: Undefined Bitmask");
                guiInfo = new GuiInfoRow<>(tmpAttribute, row);
            }
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeBool archetypeAttribute) {
            final JCheckBox input = new JCheckBox(archetypeAttribute.getAttributeName(), attributes.getAttributeInt(archetypeAttribute.getArchetypeAttributeName()) == 1);
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoRow<>(new DialogAttributeBool<G, A, R>(archetypeAttribute, input), input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeBoolSpec archetypeAttribute) {
            final String attributeString = attributes.getAttributeString(archetypeAttribute.getArchetypeAttributeName());
            final boolean defaultValue;
            if (archetypeAttribute.getTrueValue().equals("0")) {
                defaultValue = attributeString.isEmpty() || attributeString.equals("0");
            } else {
                defaultValue = attributeString.equals(archetypeAttribute.getTrueValue());
            }
            final JCheckBox input = new JCheckBox(archetypeAttribute.getAttributeName(), defaultValue);
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoRow<>(new DialogAttributeBoolSpec<G, A, R>(archetypeAttribute, input), input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeFaceName archetypeAttribute) {
            final String attributeName = archetypeAttribute.getArchetypeAttributeName();
            final String defaultText = attributes.getAttributeString(attributeName);
            final FaceComponent input = new FaceComponent(defaultText, faceObjects, faceObjectProviders, noFaceSquareIcon, unknownSquareIcon, archetypeAttribute.getDescription());
            adjustTooltip(input, archetypeAttribute);
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ":");
            adjustTooltip(label, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeFaceName<G, A, R>(archetypeAttribute, input), label, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeFixed archetypeAttribute) {
            throw new AssertionError();
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeFloat archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            label.setForeground(FLOAT_COLOR);
            final int fieldLength = archetypeAttribute.getInputLength() == 0 ? ArchetypeAttribute.TEXTFIELD_COLUMNS : archetypeAttribute.getInputLength();
            final DecimalFormat format = new DecimalFormat("#0.0#");
            format.setMaximumFractionDigits(10);
            format.setGroupingUsed(false);
            final NumberFormatter formatter = new NumberFormatter(format);
            formatter.setValueClass(Double.class);
            final DefaultFormatterFactory factory = new DefaultFormatterFactory(formatter);
            final Number value = attributes.getAttributeDouble(archetypeAttribute.getArchetypeAttributeName());
            final JFormattedTextField input = new JFormattedTextField(factory, value);
            input.setColumns(fieldLength);
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeFloat<G, A, R>(archetypeAttribute, input), label, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeInt archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            label.setForeground(INT_COLOR);
            final int fieldLength = archetypeAttribute.getInputLength() == 0 ? ArchetypeAttribute.TEXTFIELD_COLUMNS : archetypeAttribute.getInputLength();
            final NumberFormat format = NumberFormat.getIntegerInstance();
            format.setGroupingUsed(false);
            final NumberFormatter formatter = new NumberFormatter(format);
            final DefaultFormatterFactory factory = new DefaultFormatterFactory(formatter);
            final Number value = attributes.getAttributeInt(archetypeAttribute.getArchetypeAttributeName());
            final JFormattedTextField input = new JFormattedTextField(factory, value);
            input.setColumns(fieldLength);
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeInt<G, A, R>(archetypeAttribute, input), label, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeInvSpell archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            label.setForeground(INT_COLOR);
            final JComboBox<?> input = buildInvSpellBox(gameObjectSpells, attributes, archetypeAttribute.isOptionalSpell(), archetypeAttribute.getAttributeName());
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeInvSpell<>(archetypeAttribute.isOptionalSpell(), archetypeAttribute, input, gameObjectSpells), label, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeList archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            label.setForeground(INT_COLOR);
            final JComponent component;
            final JComboBox<?> input;
            final ArchetypeTypeList list = archetypeTypeSet.getList(archetypeAttribute.getListName());
            if (list != null) {
                input = buildArrayBox(list, attributes.getAttributeInt(archetypeAttribute.getArchetypeAttributeName()), archetypeAttribute.getAttributeName());
                component = input;
            } else {
                // error: list data is missing or corrupt
                input = new JComboBox<>();
                component = new JLabel("Error: Undefined List");
            }
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeList<G, A, R>(archetypeAttribute, input, archetypeTypeSet), label, component);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeList2 archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            label.setForeground(INT_COLOR);
            final int value = attributes.getAttributeInt(archetypeAttribute.getArchetypeAttributeName());

            final JComponent component1;
            @Nullable final JComboBox<?> input1;
            final ArchetypeTypeList list1 = archetypeTypeSet.getList(archetypeAttribute.getListName1());
            if (list1 != null) {
                input1 = buildArrayBox(list1, value & 0x0F, archetypeAttribute.getAttributeName());
                component1 = input1;
            } else {
                // error: list data is missing or corrupt
                input1 = new JComboBox<>();
                component1 = new JLabel("Error: Undefined List");
            }

            final JComponent component2;
            @Nullable final JComboBox<?> input2;
            final ArchetypeTypeList list2 = archetypeTypeSet.getList(archetypeAttribute.getListName2());
            if (list2 != null) {
                input2 = buildArrayBox(list2, value >> 4, archetypeAttribute.getAttributeName());
                component2 = input2;
            } else {
                // error: list data is missing or corrupt
                input2 = new JComboBox<>();
                component2 = new JLabel("Error: Undefined List");
            }

            adjustTooltip(input1, archetypeAttribute);
            adjustTooltip(input2, archetypeAttribute);
            final JComponent component = new JPanel(new GridBagLayout());
            final GridBagConstraints gbc = new GridBagConstraints();
            gbc.weightx = 1.0;
            gbc.fill = GridBagConstraints.HORIZONTAL;
            component.add(component1, gbc);
            component.add(component2, gbc);
            adjustTooltip(component, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeList2<G, A, R>(archetypeAttribute, input1, input2, archetypeTypeSet), label, component);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeLong archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            label.setForeground(INT_COLOR);
            final int fieldLength = archetypeAttribute.getInputLength() == 0 ? ArchetypeAttribute.TEXTFIELD_COLUMNS : archetypeAttribute.getInputLength();
            final NumberFormat format = NumberFormat.getIntegerInstance();
            format.setGroupingUsed(false);
            final NumberFormatter formatter = new NumberFormatter(format);
            final DefaultFormatterFactory factory = new DefaultFormatterFactory(formatter);
            final Number value = attributes.getAttributeLong(archetypeAttribute.getArchetypeAttributeName());
            final JFormattedTextField input = new JFormattedTextField(factory, value);
            input.setColumns(fieldLength);
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeLong<G, A, R>(archetypeAttribute, input), label, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeMapPath archetypeAttribute) {
            final MapSquare<?, ?, ?> mapSquare = attributes instanceof GameObject ? ((GameObject<?, ?, ?>) attributes).getMapSquare() : null;
            final MapFile mapFile = mapSquare == null ? null : mapSquare.getMapModel().getMapFile();
            final File relativeReference = mapFile == null ? new File(projectSettings.getMapsDirectory(), "dummy") : mapFile.getFile();
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            final TilePanel tilePanel = new TilePanel(mapFileFilter, attributes.getAttributeString(archetypeAttribute.getArchetypeAttributeName()), relativeReference, projectSettings.getMapsDirectory());
            adjustTooltip(tilePanel, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeMapPath<G, A, R>(archetypeAttribute, tilePanel), label, tilePanel);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeScriptFile archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            final File mapsDirectory = projectSettings.getMapsDirectory();
            final TilePanel tilePanel = new TilePanel(scriptFileFilter, attributes.getAttributeString(archetypeAttribute.getArchetypeAttributeName()), new File(mapsDirectory, "dummy"), mapsDirectory);
            adjustTooltip(tilePanel, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeScriptFile<G, A, R>(archetypeAttribute, tilePanel), label, tilePanel);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeSpell archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            label.setForeground(INT_COLOR);
            final JComboBox<?> input = buildSpellBox(attributes, numberSpells, undefinedSpellIndex, false, archetypeAttribute);
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeSpell<G, A, R>(archetypeAttribute, input, numberSpells), label, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeString archetypeAttribute) {
            final String defaultText = attributes.getAttributeString(archetypeAttribute.getArchetypeAttributeName());
            final JTextField input = new JTextField(defaultText, ArchetypeAttribute.TEXTFIELD_COLUMNS);
            adjustTooltip(input, archetypeAttribute);
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeString<G, A, R>(archetypeAttribute, input), label, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeText archetypeAttribute) {
            final String text;
            if (archetypeAttribute.getArchetypeAttributeName().equals("msg") && attributes instanceof GameObject) {
                final GameObject<?, ?, ?> tmp = (GameObject<?, ?, ?>) attributes;
                final String archetypeMsgText = tmp.getArchetype().getMsgText();
                final String gameObjectMsgText = tmp.getMsgText();
                if (archetypeMsgText != null && !archetypeMsgText.isEmpty() && (gameObjectMsgText == null || gameObjectMsgText.isEmpty())) {
                    text = archetypeMsgText;
                } else {
                    text = gameObjectMsgText;
                }
            } else {
                text = "";
            }
            final SyntaxDocument document = new SyntaxDocument();
            document.setTokenMarker(TokenMarkerFactory.createTokenMarker(archetypeAttribute.getFileExtension()));
            final JEditTextArea input = new JEditTextArea(textAreaDefaults, document, false);
            input.setText(text == null ? "" : text);
            input.setCaretPosition(0);
            input.setBorder(BorderFactory.createEmptyBorder(3, 7, 0, 0));
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoGlue<>(new DialogAttributeText<G, A, R>(archetypeAttribute, input), input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeTreasure archetypeAttribute) {
            String treasureName = attributes.getAttributeString(archetypeAttribute.getArchetypeAttributeName());
            if (treasureName.trim().isEmpty() || treasureName.trim().equalsIgnoreCase("none")) {
                treasureName = CFTreasureListTree.NONE_SYM;
            }
            final JTextField input = new JTextField(" " + treasureName, ArchetypeAttribute.TEXTFIELD_COLUMNS);
            adjustTooltip(input, archetypeAttribute);
            input.setEditable(false);
            final DialogAttributeTreasure<G, A, R> tmpAttribute = new DialogAttributeTreasure<>(archetypeAttribute, input, treasureTree);
            final JButton label = new JButton(new ViewTreasurelistAL(input, parent, treasureListTree));
            adjustTooltip(label, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(tmpAttribute, label, input);
        }

        @Override
        public void visit(@NotNull final ArchetypeAttributeZSpell archetypeAttribute) {
            final JLabel label = new JLabel(archetypeAttribute.getAttributeName() + ": ");
            adjustTooltip(label, archetypeAttribute);
            label.setForeground(INT_COLOR);
            final JComboBox<?> input = buildSpellBox(attributes, numberSpells, undefinedSpellIndex, true, archetypeAttribute);
            adjustTooltip(input, archetypeAttribute);
            guiInfo = new GuiInfoTwoColumn<>(new DialogAttributeZSpell<G, A, R>(archetypeAttribute, input, numberSpells, undefinedSpellIndex), label, input);
        }

    };

    public AttributesPaneBuilder(@NotNull final Attributes attributes, @NotNull final Component parent, @NotNull final ArchetypeTypeSet archetypeTypeSet, @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) {
        this.attributes = attributes;
        this.parent = parent;
        this.archetypeTypeSet = archetypeTypeSet;
        this.treasureListTree = treasureListTree;
        this.faceObjectProviders = faceObjectProviders;
        this.animationObjects = animationObjects;
        this.projectSettings = projectSettings;
        this.mapFileFilter = mapFileFilter;
        this.scriptFileFilter = scriptFileFilter;
        this.faceObjects = faceObjects;
        this.gameObjectSpells = gameObjectSpells;
        this.numberSpells = numberSpells;
        this.undefinedSpellIndex = undefinedSpellIndex;
        this.treasureTree = treasureTree;
        this.noFaceSquareIcon = noFaceSquareIcon;
        this.unknownSquareIcon = unknownSquareIcon;
        this.textAreaDefaults = textAreaDefaults;
    }

    @NotNull
    public Component getTabbedPane() {
        return tabbedPane;
    }

    @NotNull
    public Iterable<DialogAttribute<G, A, R, ?>> getDialogAttributes() {
        return Collections.unmodifiableCollection(dialogAttributes);
    }

    public void buildAttribute(@NotNull final Attributes attributes, @NotNull final Iterable<ArchetypeAttributeSection> archetypeType) {
        this.attributes = attributes;
        tabbedPane.removeAll();
        int sectionId = 0;
        for (final ArchetypeAttributeSection archetypeAttributeSection : archetypeType) {
            final Component panel = makeAttributePanel(archetypeAttributeSection);
            if (panel != null) {
                final String sectionName = archetypeAttributeSection.getSectionName();
                final String title;
                if (sectionName.length() <= 1) {
                    title = sectionName;
                } else {
                    title = sectionName.substring(0, 1).toUpperCase() + sectionName.substring(1);
                }
                tabbedPane.addTab(title, null, panel);
                sectionId++;
            }
        }

        tabbedPane.setSelectedIndex(sectionId > 0 ? 0 : -1);
        tabbedPane.validate();
    }

    @Nullable
    private Component makeAttributePanel(@NotNull final Iterable<ArchetypeAttribute> archetypeAttributeSection) {
        int matchingAttributes = 0;   // number of attributes in this section
        boolean hasBitmask = false;  // true if this section contains a bitmask attribute

        // first we check how many attributes this section has
        for (final ArchetypeAttribute archetypeAttribute : archetypeAttributeSection) {
            // count number of attributes
            if (!(archetypeAttribute instanceof ArchetypeAttributeFixed)) {
                matchingAttributes++;
            }
            // check for bitmask attributes
            if (!hasBitmask && archetypeAttribute instanceof ArchetypeAttributeBitmask) {
                hasBitmask = true;
            }
        }
        if (matchingAttributes == 0) {
            return null;
        }

        // All attribute-"lines" go into this panel:
        final JPanel panel = new JPanel(new GridBagLayout());
        final Insets gbcInsets = new Insets(2, 2, 2, 2);

        final GridBagConstraints gbc = new GridBagConstraints();
        gbc.insets = gbcInsets;
        gbc.fill = GridBagConstraints.HORIZONTAL;
        final Object labelGbc = gbc.clone();
        gbc.weightx = 1.0;
        gbc.gridwidth = GridBagConstraints.REMAINDER;
        final Object compGbc = gbc.clone();
        gbc.anchor = GridBagConstraints.WEST;
        final Object rowGbc = gbc.clone();
        gbc.fill = GridBagConstraints.BOTH;
        gbc.gridwidth = 2;
        gbc.weighty = 1.0;
        final Object glueGbc = gbc.clone();

        boolean hasGlue = false;
        // now add the entries, line by line
        for (final ArchetypeAttribute archetypeAttribute : archetypeAttributeSection) {
            if (!(archetypeAttribute instanceof ArchetypeAttributeFixed)) {
                guiInfo = null;
                archetypeAttribute.visit(archetypeAttributeVisitor);
                final GuiInfo<G, A, R, ?> tmpGuiInfo = guiInfo;
                assert tmpGuiInfo != null;

                dialogAttributes.add(tmpGuiInfo.getAttribute());
                addElement(panel, tmpGuiInfo.getLabel(), labelGbc);
                addElement(panel, tmpGuiInfo.getComponent(), compGbc);
                addElement(panel, tmpGuiInfo.getRow(), rowGbc);
                addElement(panel, tmpGuiInfo.getGlue(), glueGbc);
                hasGlue |= tmpGuiInfo.getGlue() != null;
            }
        }

        if (!hasGlue) {
            // if the component does not already have glue, put glue inside to align its contents to the top.
            panel.add(Box.createGlue(), glueGbc);
        }
        final JScrollPane panelReturn = new JScrollPane(panel);
        panelReturn.getVerticalScrollBar().setUnitIncrement(8);
        return panelReturn;
    }

    private void addElement(@NotNull final Container container, @Nullable final Component component, @NotNull final Object constraints) {
        if (component != null) {
            container.add(component, constraints);
            component.addFocusListener(focusListener);
        }
    }

    @NotNull
    private static <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> JComboBox<?> buildInvSpellBox(@NotNull final Spells<GameObjectSpell<G, A, R>> gameObjectSpells, @NotNull final Attributes attributes, final boolean isOptionalSpell, @NotNull final String attributeName) {
        if (!(attributes instanceof BaseObject)) {
            throw new IllegalArgumentException();
        }
        final BaseObject<?, ?, ?, ?> baseObject = (BaseObject<?, ?, ?, ?>) attributes;
        final int selectedIndex;
        @Nullable final String title;
        switch (baseObject.countInvObjects()) {
        case 0:
            selectedIndex = gameObjectSpells.size();
            title = isOptionalSpell ? null : "<none>";
            break;

        default:
            selectedIndex = gameObjectSpells.size() + (isOptionalSpell ? 1 : 0);
            title = "<multiple>";
            break;

        case 1:
            final GameObject<?, ?, ?> invObject = baseObject.iterator().next();
            final String invObjectArchetypeName = invObject.getArchetype().getArchetypeName();
            int index = 0;
            @Nullable String tmpTitle = "<customized spell>";
            for (final GameObjectSpell<?, ?, ?> spellObject : gameObjectSpells) {
                if (invObjectArchetypeName.equals(spellObject.getArchetypeName())) {
                    tmpTitle = invObject.isDefaultGameObject() ? null : spellObject.getName() + " <customized>";
                    break;
                }
                index++;
            }
            selectedIndex = tmpTitle != null ? gameObjectSpells.size() + (isOptionalSpell ? 1 : 0) : index;
            title = tmpTitle;
            break;
        }

        final DefaultComboBoxModel<String> model = new DefaultComboBoxModel<>();
        for (final Spell spell : gameObjectSpells) {
            model.addElement(spell.getName());
        }
        if (isOptionalSpell) {
            model.addElement("<none>");
        }
        if (title != null) {
            model.addElement(title);
        }
        final JComboBox<?> comboBox = new JComboBox<>(model);
        comboBox.setSelectedIndex(selectedIndex);
        comboBox.setMaximumRowCount(10);
        comboBox.setKeySelectionManager(new StringKeyManager(comboBox));
        comboBox.setName(attributeName);
        return comboBox;
    }

    @NotNull
    private static JComboBox<?> buildArrayBox(@NotNull final ArchetypeTypeList listData, final int value, @NotNull final String attributeName) {
        final String[] array = new String[listData.size()];
        boolean hasSelection = false;
        int selectedIndex = 0;
        for (int i = 0; i < array.length; i++) {
            array[i] = listData.get(i).getSecond();
            if (!hasSelection && listData.get(i).getFirst() == value) {
                hasSelection = true;
                selectedIndex = i;
            }
        }
        final JComboBox<?> comboBox = new JComboBox<>(array);
        comboBox.setSelectedIndex(selectedIndex);
        comboBox.setMaximumRowCount(10);
        comboBox.setKeySelectionManager(new StringKeyManager(comboBox));
        comboBox.setName(attributeName);
        return comboBox;
    }

    @NotNull
    private static JComboBox<?> buildSpellBox(@NotNull final Attributes attributes, @NotNull final Spells<NumberSpell> numberSpells, final int undefinedSpellIndex, final boolean isZSpell, @NotNull final ArchetypeAttribute archetypeAttribute) {
        int spellNumber = attributes.getAttributeInt(archetypeAttribute.getArchetypeAttributeName());

        if (spellNumber < 0 || spellNumber >= numberSpells.size()) {
            spellNumber = undefinedSpellIndex;
        }

        final int selectedIndex;
        if (spellNumber == undefinedSpellIndex && isZSpell) {
            selectedIndex = 0;
        } else {
            selectedIndex = 1 + AbstractArchetypeAttributeSpell.findSpellIndex(numberSpells, spellNumber);
        }

        final DefaultComboBoxModel<String> model = new DefaultComboBoxModel<>();
        model.addElement("<none>");
        for (final Spell spell : numberSpells) {
            model.addElement(spell.getName());
        }
        final JComboBox<?> comboBox = new JComboBox<>(model);
        comboBox.setSelectedIndex(selectedIndex);
        comboBox.setMaximumRowCount(10);
        comboBox.setKeySelectionManager(new StringKeyManager(comboBox));
        comboBox.setName(archetypeAttribute.getAttributeName());
        return comboBox;
    }

}