EditBookmarkDialog.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.bookmarks;
 
import java.awt.Component;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JDialog;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.WindowConstants;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.text.JTextComponent;
import net.sf.gridarta.gui.utils.GUIConstants;
import net.sf.gridarta.gui.utils.TextComponentUtils;
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;
 
public class EditBookmarkDialog extends JOptionPane {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final JDialog dialog;
 
    @NotNull
    private final JTextComponent descriptionField = new JTextField();
 
    @NotNull
    private final JButton okButton = new JButton(ACTION_BUILDER.createAction(false, "editBookmarkOkay", this));
 
    @NotNull
    private final JButton cancelButton = new JButton(ACTION_BUILDER.createAction(false, "editBookmarkCancel", this));
 
    public EditBookmarkDialog(@NotNull final Component parentComponent, @NotNull final String defaultDescription) {
        okButton.setDefaultCapable(true);
        setOptions(new Object[] { okButton, cancelButton });
 
        setMessage(createPanel());
 
        TextComponentUtils.setAutoSelectOnFocus(descriptionField);
        descriptionField.setText(defaultDescription);
 
        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();
            }
 
        };
        descriptionField.getDocument().addDocumentListener(documentListener);
        updateOkButton();
 
        dialog = createDialog(parentComponent, ActionBuilderUtils.getString(ACTION_BUILDER, "editBookmark.title"));
        dialog.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
        dialog.getRootPane().setDefaultButton(okButton);
        dialog.pack();
        dialog.setLocationRelativeTo(parentComponent);
    }
 
    public boolean showDialog() {
        dialog.setVisible(true);
        return getValue() == okButton;
    }
 
    @NotNull
    private JPanel createPanel() {
        final JPanel mainPanel = new JPanel();
        mainPanel.setLayout(new BoxLayout(mainPanel, BoxLayout.Y_AXIS));
 
        mainPanel.setBorder(GUIConstants.DIALOG_BORDER);
 
        mainPanel.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "editBookmark.description"));
        mainPanel.add(Box.createVerticalStrut(5));
 
        mainPanel.add(descriptionField);
        mainPanel.add(Box.createVerticalStrut(5));
 
        return mainPanel;
    }
 
    @ActionMethod
    public void editBookmarkOkay() {
        if (isOkEnabled()) {
            setValue(okButton);
        }
    }
 
    @ActionMethod
    public void editBookmarkCancel() {
        setValue(cancelButton);
    }
 
    @NotNull
    public String getDescription() {
        return descriptionField.getText().trim();
    }
 
    private void updateOkButton() {
        okButton.setEnabled(isOkEnabled());
    }
 
    private boolean isOkEnabled() {
        return !getDescription().isEmpty();
    }
 
}