AbstractNewMapDialog.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.newmap;

import java.awt.Component;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.util.prefs.Preferences;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JDialog;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.WindowConstants;
import javax.swing.border.CompoundBorder;
import javax.swing.border.EtchedBorder;
import javax.swing.border.TitledBorder;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.text.JTextComponent;
import net.sf.gridarta.MainControl;
import net.sf.gridarta.gui.utils.GUIConstants;
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.utils.ActionBuilderUtils;
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 abstract class AbstractNewMapDialog<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends JOptionPane {

    private static final long serialVersionUID = 1L;

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

    @NotNull
    protected static final Preferences PREFERENCES = Preferences.userNodeForPackage(MainControl.class);

    @NotNull
    private final JButton okButton = new JButton(ACTION_BUILDER.createAction(false, "mapOkay", this));

    @NotNull
    private final JButton cancelButton = new JButton(ACTION_BUILDER.createAction(false, "mapCancel", this));

    @Nullable
    private JDialog dialog;

    @NotNull
    private final DocumentListener documentListener = new DocumentListener() {

        @Override
        public void insertUpdate(@NotNull final DocumentEvent e) {
            updateOkButton();
        }

        @Override
        public void removeUpdate(@NotNull final DocumentEvent e) {
            updateOkButton();
        }

        @Override
        public void changedUpdate(@NotNull final DocumentEvent e) {
            updateOkButton();
        }

    };

    protected AbstractNewMapDialog() {
    }

    protected void init1(@NotNull final Component parentComponent, @NotNull final String dialogTitle) {
        okButton.setDefaultCapable(true);
        setOptions(new Object[] { okButton, cancelButton });
        setMessage(createPanel());

        dialog = createDialog(parentComponent, dialogTitle);
        assert dialog != null;
        dialog.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
        assert dialog != null;
        dialog.getRootPane().setDefaultButton(okButton);
        assert dialog != null;
        dialog.setModal(false);
    }

    protected void init2() {
        assert dialog != null;
        dialog.setVisible(true);
    }

    @NotNull
    private JPanel createPanel() {
        final JPanel panel = new JPanel();
        panel.setLayout(new BoxLayout(panel, BoxLayout.Y_AXIS));
        panel.setBorder(GUIConstants.DIALOG_BORDER);
        panel.add(createMapNamePanel());
        final Component parametersPanel = createMapParametersPanel();
        if (parametersPanel != null) {
            panel.add(parametersPanel);
        }
        return panel;
    }

    @NotNull
    protected abstract JPanel createMapNamePanel();

    @Nullable
    protected JPanel createMapParametersPanel() {
        final JPanel panel = new JPanel(new GridBagLayout());

        final GridBagConstraints gbcLabel = new GridBagConstraints();
        gbcLabel.insets = new Insets(2, 2, 2, 2);
        gbcLabel.anchor = GridBagConstraints.EAST;

        final GridBagConstraints gbcField = new GridBagConstraints();
        gbcField.insets = new Insets(2, 2, 2, 2);
        gbcField.gridwidth = GridBagConstraints.REMAINDER;

        panel.setBorder(new CompoundBorder(new TitledBorder(new EtchedBorder(), ActionBuilderUtils.getString(ACTION_BUILDER, "newMapParameters")), GUIConstants.DIALOG_BORDER));
        addFields(panel, gbcLabel, gbcField);
        return panel;
    }

    protected abstract void addFields(@NotNull JPanel panel, @NotNull GridBagConstraints gbcLabel, @NotNull GridBagConstraints gbcField);

    @ActionMethod
    public void mapOkay() {
        if (isOkButtonEnabled() && createNew()) {
            setValue(okButton);
        }
    }

    @ActionMethod
    public void mapCancel() {
        setValue(cancelButton);
    }

    @Override
    public void setValue(@Nullable final Object newValue) {
        super.setValue(newValue);
        if (dialog != null && newValue != UNINITIALIZED_VALUE) {
            dialog.dispose();
        }
    }

    protected abstract boolean createNew();

    protected void updateOkButton() {
        okButton.setEnabled(isOkButtonEnabled());
    }

    protected boolean isOkButtonEnabled() {
        return true;
    }

    protected void addDocumentListener(@NotNull final JTextComponent textComponent) {
        textComponent.getDocument().addDocumentListener(documentListener);
        textComponent.addFocusListener(new FocusListener() {

            @Override
            public void focusGained(@NotNull final FocusEvent e) {
                textComponent.selectAll();
            }

            @Override
            public void focusLost(@NotNull final FocusEvent e) {
                textComponent.select(0, 0);
            }

        });
        textComponent.selectAll();
    }

}