au.org.ala.delta.ui.MessageDialogHelper.java Source code

Introduction

Here is the source code for au.org.ala.delta.ui.MessageDialogHelper.java

Source

/*******************************************************************************
 * Copyright (C) 2011 Atlas of Living Australia
 * All Rights Reserved.
 * 
 * The contents of this file are subject to the Mozilla Public
 * License Version 1.1 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.mozilla.org/MPL/
 * 
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 ******************************************************************************/
package au.org.ala.delta.ui;

import org.apache.commons.lang.WordUtils;

import javax.swing.*;
import java.awt.*;

/**
 * Helper class for displaying multi-line messages using a JTextArea as the message component for
 * JOptionPane.
 */
public class MessageDialogHelper {

    /**
     * Uses JOptionPane.showInputDialog to display the supplied (multi-line) message and return the
     * user input.
     * @param parent the parent component used to display the JOptionPane.
     * @param title the title for the option pane.
     * @param text the message text to display on the option pane.  Multi-line messages should 
     * use the "\n" character.
     * @param numColumns the column position to wrap the text at.
     * @param initialValue the initial value for the user input.
     * @return the value supplied to the JOptionPane input dialog.
     */
    public static String showInputDialog(Component parent, String title, String text, int numColumns,
            String initialValue) {

        JTextArea messageDisplay = createMessageDisplay(text, numColumns);
        return (String) JOptionPane.showInputDialog(parent, messageDisplay, title, JOptionPane.PLAIN_MESSAGE, null,
                null, initialValue);
    }

    /**
     * Uses JOptionPane.showInputDialog to display the supplied (multi-line) message and return the
     * user selection.
     * @param parent the parent component used to display the JOptionPane.
     * @param title the title for the option pane.
     * @param text the message text to display on the option pane.  Multi-line messages should 
     * use the "\n" character.
     * @param numColumns the column position to wrap the text at.
     * @return the value returned from the JOptionPane showConfirmDialog method (i.e the user selection)
     */
    public static int showConfirmDialog(Component parent, String title, String text, int numColumns) {
        JTextArea messageDisplay = createMessageDisplay(text, numColumns);
        return JOptionPane.showConfirmDialog(parent, messageDisplay, title, JOptionPane.YES_NO_CANCEL_OPTION,
                JOptionPane.QUESTION_MESSAGE);
    }

    /**
     * Creates a text area that looks like a JLabel that has a preferredSize calculated to fit
     * all of the supplied text wrapped at the supplied column. 
     * @param text the text to display in the JTextArea.
     * @param numColumns the column number to wrap text at.
     * @return a new JTextArea configured for the supplied text.
     */
    private static JTextArea createMessageDisplay(String text, int numColumns) {
        JTextArea textArea = new JTextArea();
        textArea.setEditable(false);

        textArea.setBackground(UIManager.getColor("Label.background"));
        textArea.setFont(UIManager.getFont("Label.font"));

        textArea.setWrapStyleWord(true);
        textArea.setLineWrap(true);
        textArea.setColumns(numColumns);

        String wrapped = WordUtils.wrap(text, numColumns);
        textArea.setRows(wrapped.split("\n").length - 1);

        textArea.setText(text);

        // Need to set a preferred size so that under OpenJDK-6 on Linux the JOptionPanes get reasonable bounds 
        textArea.setPreferredSize(new Dimension(0, 0));

        return textArea;

    }
}