DMDirc-Plugins/ui_swing/src/main/java/com/dmdirc/addons/ui_swing/dialogs/StandardInputDialog.java

/*
 * Copyright (c) 2006-2017 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 * OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.dmdirc.addons.ui_swing.dialogs;

import com.dmdirc.addons.ui_swing.components.text.TextLabel;
import com.dmdirc.addons.ui_swing.components.validating.ValidatingJTextField;
import com.dmdirc.addons.ui_swing.components.IconManager;
import com.dmdirc.util.validators.PermissiveValidator;
import com.dmdirc.util.validators.Validator;

import com.google.common.util.concurrent.Runnables;

import java.awt.Window;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
import java.util.function.Function;

import javax.swing.JButton;
import javax.swing.WindowConstants;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.text.AbstractDocument;
import javax.swing.text.DocumentFilter;

import net.miginfocom.swing.MigLayout;

/**
 * Standard input dialog.
 */
public class StandardInputDialog extends StandardDialog {

    /** Serial version UID. */
    private static final long serialVersionUID = 1;
    /** Validator. */
    private final Validator<String> validator;
    /** Text field. */
    private ValidatingJTextField textField;
    /** Blurb label. */
    private TextLabel blurb;
    /** Message. */
    private final String message;
    /** The icon manager to use for validating text fields. */
    private final IconManager iconManager;
    /** Are we saving? */
    protected final AtomicBoolean saving = new AtomicBoolean(false);
    /** Function to call when the dialog is saved. */
    private final Function<String, Boolean> save;
    /** Function to call when the dialog is cancelled. */
    private final Runnable cancel;

    /**
     * Instantiates a new standard input dialog.
     *
     * @param owner       Dialog owner
     * @param modal       modality type
     * @param iconManager The icon manager to use for validating text fields.
     * @param title       Dialog title
     * @param message     Dialog message
     */
    public StandardInputDialog(
            final Window owner, final ModalityType modal, final IconManager iconManager,
            final String title, final String message,
            final Consumer<String> save) {
        this(owner, modal, iconManager, title, message,
                s -> { save.accept(s); return true; }, Runnables.doNothing());
    }

    /**
     * Instantiates a new standard input dialog.
     *
     * @param owner       Dialog owner
     * @param modal       modality type
     * @param iconManager The icon manager to use for validating text fields.
     * @param title       Dialog title
     * @param message     Dialog message
     */
    public StandardInputDialog(
            final Window owner, final ModalityType modal, final IconManager iconManager,
            final String title, final String message,
            final Function<String, Boolean> save) {
        this(owner, modal, iconManager, title, message, save, Runnables.doNothing());
    }

    /**
     * Instantiates a new standard input dialog.
     *
     * @param owner       Dialog owner
     * @param modal       modality type
     * @param iconManager The icon manager to use for validating text fields.
     * @param title       Dialog title
     * @param message     Dialog message
     */
    public StandardInputDialog(
            final Window owner, final ModalityType modal, final IconManager iconManager,
            final String title, final String message,
            final Function<String, Boolean> save,
            final Runnable cancel) {
        this(owner, modal, iconManager, title, message, new PermissiveValidator<>(), save, cancel);
    }

    /**
     * Instantiates a new standard input dialog.
     *
     * @param owner       Dialog owner
     * @param modal       modality type
     * @param iconManager The icon manager to use for validating text fields.
     * @param validator   Textfield validator
     * @param title       Dialog title
     * @param message     Dialog message
     */
    public StandardInputDialog(
            final Window owner, final ModalityType modal, final IconManager iconManager,
            final String title, final String message,
            final Validator<String> validator,
            final Consumer<String> save) {
        this(owner, modal, iconManager, title, message, validator,
                (final String s) -> { save.accept(s); return true; }, Runnables.doNothing());
    }

    /**
     * Instantiates a new standard input dialog.
     *
     * @param owner       Dialog owner
     * @param modal       modality type
     * @param iconManager The icon manager to use for validating text fields.
     * @param validator   Textfield validator
     * @param title       Dialog title
     * @param message     Dialog message
     */
    public StandardInputDialog(
            final Window owner, final ModalityType modal, final IconManager iconManager,
            final String title, final String message,
            final Validator<String> validator,
            final Function<String, Boolean> save) {
        this(owner, modal, iconManager, title, message, validator, save, Runnables.doNothing());
    }
    /**
     * Instantiates a new standard input dialog.
     *
     * @param owner       Dialog owner
     * @param modal       modality type
     * @param iconManager The icon manager to use for validating text fields.
     * @param validator   Textfield validator
     * @param title       Dialog title
     * @param message     Dialog message
     */
    public StandardInputDialog(
            final Window owner, final ModalityType modal, final IconManager iconManager,
            final String title, final String message,
            final Validator<String> validator,
            final Consumer<String> save,
            final Runnable cancel) {
        this(owner, modal, iconManager, title, message, validator,
                (final String s) -> { save.accept(s); return true; }, cancel);
    }

    /**
     * Instantiates a new standard input dialog.
     *
     * @param owner       Dialog owner
     * @param modal       modality type
     * @param iconManager The icon manager to use for validating text fields.
     * @param validator   Textfield validator
     * @param title       Dialog title
     * @param message     Dialog message
     */
    public StandardInputDialog(
            final Window owner, final ModalityType modal, final IconManager iconManager,
            final String title, final String message,
            final Validator<String> validator,
            final Function<String, Boolean> save,
            final Runnable cancel) {
        super(owner, modal);

        this.validator = validator;
        this.message = message;
        this.iconManager = iconManager;
        this.save = save;
        this.cancel = cancel;

        setTitle(title);
        setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);

        initComponents();
        addListeners();
        layoutComponents();
    }

    /**
     * Initialises the components.
     */
    private void initComponents() {
        orderButtons(new JButton(), new JButton());
        textField = new ValidatingJTextField(iconManager, validator);
        blurb = new TextLabel(message);
        validateText();
    }

    /**
     * Adds the listeners.
     */
    private void addListeners() {
        getOkButton().addActionListener(e -> {
            if (save.apply(getText())) {
                dispose();
            }
        });
        getCancelButton().addActionListener(e -> {
            cancel.run();
            dispose();
        });
        addWindowListener(new WindowAdapter() {

            @Override
            public void windowOpened(final WindowEvent e) {
                textField.requestFocusInWindow();
            }

            @Override
            public void windowClosed(final WindowEvent e) {
                cancel.run();
                //dispose();
            }
        });
        textField.getDocument().addDocumentListener(new DocumentListener() {

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

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

            @Override
            public void changedUpdate(final DocumentEvent e) {
                //Ignore
            }
        });
    }

    @Override
    public boolean enterPressed() {
        executeAction(getOkButton());
        return true;
    }

    /**
     * Validates the change.
     */
    private void validateText() {
        getOkButton().setEnabled(!validator.validate(getText()).isFailure());
    }

    /**
     * Lays out the components.
     */
    private void layoutComponents() {
        setLayout(new MigLayout("fill, wrap 1"));

        add(blurb, "growx");
        add(textField, "growx");
        add(getLeftButton(), "split 2, right");
        add(getRightButton(), "right");
    }

    /**
     * Returns the text in the input field.
     *
     * @return Input text
     */
    public final String getText() {
        return textField.getText();
    }

    /**
     * Sets the dialogs text to the specified text.
     *
     * @param text New test
     */
    public final void setText(final String text) {
        textField.setText(text);
    }

    /**
     * Sets a document filter for this dialog's textfield.
     *
     * @param filter Document filter to add
     */
    public void setDocumentFilter(final DocumentFilter filter) {
        ((AbstractDocument) textField.getDocument()).setDocumentFilter(filter);
    }

}