JOptionPane y diálogos modales

De ChuWiki
Saltar a: navegación, buscar

Introducción JOptionPane y Diálogos modales

En nuestras aplicaciones Java Swing es bastante habitual que tengamos que pedir al usuario la confirmación de una acción (por ejemplo, salir de la aplicación o borrar unos datos), pedirle algún dato sencillo, darle a elegir entre varias acciones o simplemente mostrarle un aviso. A veces es necesario para estas acciones abrir una ventana secundaria donde el usuario debe realizar la acción que sea y cerrarla. Por ejemplo, podemos mostrarle una ventana preguntando algo como "¿Estás seguro que quieres borrar todos esos datos?" y que tenga un par de botones de "Sí, estoy seguro" y "No, no creo".

Afortunadamente, en java no tenemos que hacer esas ventanas. Para las acciones más habituales, ya tenemos la clase JOptionPane que muestra esas ventanas por nosotros y nos devuelven la elección hecha por el usuario. En otras ocasiones, nos tendremos que hacer una ventana a nuestra medida, pero si usamos un JDialog modal, al menos tendremos la ventaja de que el código esperará a que el usuario introduzca los datos en dicha ventana.

Vamos a ver en este artículo ejemplos con JOptionPane y Diálogos modales. En el siguiente enlace puedes ver todo el código detallado de estos ejemplos con JOptionPane y Diálogos modales.

JOptionPane

JOptionPane tiene dos juegos repetidos de ventanas de aviso/confirmación. Una para ventanas normales y otra para JInternalFrame. Puesto que son lo mismo, vamos a ver aquí sólo los de ventanas normales. Las distintas posibilidades que tenemos de JOptionPane son:

JOptionPane.showOptionDialog()

Tenemos un método JOptionPane.showOptionDialog() que nos muestra la ventana más configurable de todas, en ella debemos definir todos los botones que lleva. De hecho, las demás ventanas disponibles con JOptionPane se construyen a partir de esta. Por ello, al método debemos pasarle muchos parámetros:

  • parentComponent: A partir de este componente, se intentará determinar cual es la ventana que debe hacer de padre del JOptionPane. Se puede pasar null, pero conviene pasar, por ejemplo, el botón desde el cual se lanza la acción que provoca que se visualice el JOptionPane. De esta manera, la ventana de aviso se visualizará sobre el botón y no se podrá ir detrás del mismo si hacemos click en otro sitio.
  • message: El mensaje a mostrar, habitualmente un String, aunque vale cualquier Object cuyo método toString() devuelva algo con sentido.
  • title: El título para la ventana.
  • optionType: Un entero indicando qué opciones queremos que tenga la ventana. Los posibles valores son las constantes definidas en JOptionPane: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, o OK_CANCEL_OPTION.
  • messageType: Un entero para indicar qué tipo de mensaje estamos mostrando. Este tipo servirá para que se determine qué icono mostrar. Los posibles valores son constantes definidas en JOptionPane: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, o PLAIN_MESSAGE
  • icon: Un icono para mostrar. Si ponemos null, saldrá el icono adecuado según el parámetro messageType.
  • options: Un array de objects que determinan las posibles opciones. Si los objetos son componentes visuales, aparecerán tal cual como opciones. Si son String, el JOptionPane pondrá tantos botones como String. Si son cualquier otra cosa, se les tratará como String llamando al método toString(). Si se pasa null, saldrán los botones por defecto que se hayan indicado en optionType.
  • initialValue: Selección por defecto. Debe ser uno de los Object que hayamos pasado en el parámetro options. Se puede pasar null.

La llamada a JOptionPane.showOptionDialog() devuelve un entero que representa la opción que ha seleccionado el usuario. La primera de las opciones del array es la posición cero. Si se cierra la ventana con la cruz de la esquina superior derecha, el método devolverá -1.

Aquí un ejemplo de cómo llamar a este método

int seleccion = JOptionPane.showOptionDialog(
   unComponentePadre,
   "Seleccione opcion", 
   "Selector de opciones",
   JOptionPane.YES_NO_CANCEL_OPTION,
   JOptionPane.QUESTION_MESSAGE,
   unIcono,    // null para icono por defecto.
   new Object[] { "opcion 1", "opcion 2", "opcion 3" },   // null para YES, NO y CANCEL
   "opcion 1");

if (seleccion != -1)
   System.out.println("seleccionada opcion " + (seleccion + 1));

y la ventana que se obtiene con el código anterior

ShowOptionDialog.jpg

JOptionPane.showInputDialog()

Tenemos varios métodos JOptionPane.showInputDialog() y la diferencia entre ellos es que tienen más o menos parámetros, según queramos aceptar o no las opciones por defecto. Los parámetros y sus significados son muy similares a los del método showOptionDialog(), pero hay una diferencia.

Si usamos los métodos que no tienen array de opciones, la ventana mostrará una caja de texto para que el usuario escriba la opción que desee (un texto libre). Si usamos un método que tenga un array de opciones, entonces aparecerá en la ventana un JComboBox en vez de una caja de texto, donde estarán las opciones que hemos pasado.

Aquí un par de trozos de código, el primero para conseguir una caja de texto,

// Con caja de texto
String seleccion = JOptionPane.showInputDialog(
   unComponentePadre,
   "Input dialog",
   JOptionPane.QUESTION_MESSAGE);  // el icono sera un iterrogante
        
System.out.println("El usuario ha escrito "+seleccion);

y la imagen que obtenemos con este código

ShowInputDialog.jpg

En este segundo ejemplo, damos todas las opciones que queremos, obteniendo un JComboBox

// Con JCombobox
Object seleccion = JOptionPane.showInputDialog(
   unComponentePadre,
   "Seleccione opcion",
   "Selector de opciones",
   JOptionPane.QUESTION_MESSAGE,
   unIcono,  // null para icono defecto
   new Object[] { "opcion 1", "opcion 2", "opcion 3" }, 
   "opcion 1");

System.out.println("El usuario ha elegido "+seleccion);

y esta es la imagen que se obtiene.

ShowInputDialog2.jpg

JOptionPane.showMessageDialog()

Esta es la más sencilla de todas, sólo muestra una ventana de aviso al usuario. La ejecución se detiene hasta que el usuario cierra la ventana. Hay varios métodos con el mismo nombre y más o menos parámetros, en función de si aceptamos las opciones por defecto (icono, por ejemplo) o queremos cambiar alguna cosa. Un trozo de código para llamarlo

JOptionPane.showMessageDialog(
   componentePadre,
   "Un aviso puñetero");

System.out.println("ya estas avisado");

y la imagen que muestra este código

ShowMessageDialog.jpg

JOptionPane.showConfirmDialog()

Este método muestra una ventana pidiendo una confirmación al usuario, estilo "¿Seguro que lo quieres borrar todo?" y da al usuario opción de aceptar o cancelar ese borrado masivo que está a punto de hacer. El método devuelve un entero indicando la respuesta del usuario. Los valores de ese entero puede ser alguna de las constantes definidas en JOptionPane: YES_OPTION, NO_OPTION, CANCEL_OPTION, OK_OPTION, CLOSED_OPTION. Por supuesto, hay metodos iguales con más o menos parámetros para configurar las cosas más o menos.

El siguiente ejemplo de codigo

int confirmado = JOptionPane.showConfirmDialog(
   componentePadre,
   "¿Lo confirmas?");

if (JOptionPane.OK_OPTION == confirmado)
   System.out.println("confirmado");
else
   System.out.println("vale... no borro nada...");

muestra la siguiente imagen

ShowConfirmDialog.jpg

JOptionPane con timeout

La llamada a cualquiera de los métodos anteriores para la ejecución de nuestro programa hasta que el usuario cierre la ventana seleccionando alguna de las opciones. A veces no nos interesa quedarnos bloqueados indefinidamente esperando la respuesta del usuario, por ejemplo, podemos mostrarle un mensaje para informarle de algo con un showMessageDialog() y si en 30 segundos no lo ha cerrado, cerrarlo nosotros automáticamente desde nuestro código y continuar con lo que estábamos haciendo.

Desgraciadamente, JOptionPane no tiene ninguna opción con timeout, por lo que hacer esto no es inmediato. Debemos lanzar un Timer o un hilo para cerrar la ventana desde ese hilo.

Y desgraciadamente, los métodos que hemos visto de JOptionPane no nos devuelven una referencia a la ventana que acabamos de visualizar, por lo que tampoco podremos ocultarla desde código. La solución es que creemos nosotros la ventana y nos guardemos una referencia a ella. Afortunadamente, no debemos hacernos la ventana desde cero. Podemos hacer un new de JOptionPane para obtener el panel de dicha ventana y llamar al método createDialog() para obtener y visualizar el JDialog correspondiente. El códígo completo para esto puede ser como el del ejemplo

package com.chuidiang.ejemplos;

import java.awt.Component;

import javax.swing.JDialog;
import javax.swing.JOptionPane;

/**
 * Muestra un JOptionPane con un timeout para que se cierre automaticamente.
 * 
 * @author chuidiang
 * 
 */
public class JOptionPaneConTimeOut
{
    private static JOptionPane option = new JOptionPane("",
            JOptionPane.INFORMATION_MESSAGE);

    private static JDialog dialogo = null;

    /**
     * Solo hace caso a padre la primera vez que se llama a este método. La
     * llamada a este metodo se queda bloqueada hasta que el usuario cierra el
     * JOptionPane o pasa el timeout.
     * 
     * @param padre
     * @param texto
     * @param titulo
     * @param timeout
     *            En mili segundos
     */
    public static void visualizaDialogo( Component padre, String texto,
            String titulo, final long timeout)
    {
        option.setMessage(texto);
        if ( null == dialogo )
        {
            dialogo = option.createDialog(padre, titulo);
        }
        else
        {
            dialogo.setTitle(titulo);
        }

        Thread hilo = new Thread()
        {
            public void run()
            {
                try
                {
                    Thread.sleep(timeout);
                    if ( dialogo.isVisible() )
                    {
                        dialogo.setVisible(false);
                    }
                }
                catch ( InterruptedException e )
                {
                    e.printStackTrace();
                }
            }
        };
        hilo.start();

        dialogo.setVisible(true);
    }
}

La clase del ejemplo tiene un método estático visualizaDialogo() al que podemos llamar para mostrar un aviso que se cierre automáticamente si el usuario no lo cierra antes. Esta clase/método es sólo de ejemplo y no permite configurar todo lo que se puede configurar en el JOptionPane, no queremos complicar la clase en exceso para esta explicación. Vamos viendo algunos detalles.

Creamos el JOptionPane de esta forma

private static JOptionPane option = new JOptionPane("",JOptionPane.INFORMATION_MESSAGE);

es decir, sin texto concreto "", y sólo para un mensaje de tipo información. Podríamos aquí usar cualquiera de los constructores que tiene JOptionPane y poner los parámetros que queramos. En sucesivas llamadas se pueden cambiar estos parámetros usando los métodos set al efecto

option.setMessage(texto);

Creamos el diálogo sólo la primera vez que se llama al método con

dialogo = option.createDialog(padre, titulo);

El título es el de la ventana (del JDialog) y podemos cambiarlo cuando queramos con

dialogo.setTitle(titulo);

Lo que no podemos cambiar es el padre, por eso el comentario que aparece de que sólo se hará caso al parámetro parent en la primera llamada.

Una vez configurada la ventana con el título y tal, creamos un hilo con una espera del tiempo indicado y pasado ese tiempo cerramos la ventana. Se comprueba antes si sigue visible, no sea que la haya cerrado el usuario antes de pasar el tiempo indicado. Recordamos arrancar el hilo con hilo.start() y nos aseguramos de hacer esto antes de hacer el diálogo visible, ya que al ser el diálogo modal, la llamada a setVisible(true) quedará bloqueada hasta que se cierre la ventana. Y después de arrancar el hilo, sólo queda hacer visible el diálogo

hilo.start();
dialogo.setVisible(true);

Si el diálogo tuviera opciones que nos interesan, despues de dialogo.setVisible(), podemos obtener la opcion seleccionada con

Object valor = option.getValue();

Este valor será un JOption.UNINITIALIZED_VALUE si el dialogo se ha cerrado por timeout, o bien el valor seleccionado JOptionPane.YES_OPTION, JOptionPane.CANCEL_OPTION, etc, o bien alguno de los Object[] que hayamos usado uno de los constructores que admite Object[] options como parámetro.

JDialog modal

A veces las ventanas de JOptionPane no son suficientes para lo que necesitamos. Por ejemplo, podemos querer pedir un dato más complejo que una simple selección de una opción. Y a veces mientras el usuario introduce ese dato complejo en la ventana y pulsa "Aceptar", queremos que nuestro código se pare en espera de la respuesta. Para estas situaciones tenemos los JDialog modales. En un JDialog podemos poner todos los componentes que queramos, haciendo la ventana todo lo compleja que queramos. Si ese JDialog es además modal, en el momento de hacerla visible llamando a setVisible(true), el código se quedará parado en esa llamada hasta que la ventana se cierre. Podemos, por tanto, justo después del setVisible(true), pedirle a la ventana los datos que ha introducido el operador.

Vamos a hacer aquí un ejemplo para ver todo esto. Como no quiero complicar demasiado el JDialog por claridad del ejemplo, el JDialog sólo tendrá un JTextField dentro de él y al pulsar <intro> en ese JTextField, después de haber escrito algo, el JDialog se cerrará. El código para conseguir esto es el siguiente:

package com.chuidiang.ejemplos.option_pane_dialog_modal;

import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JDialog;
import javax.swing.JTextField;

/**
 * Dialogo modal que sirve de ventana de captura de datos.<br>
 * Contiene un JTextField en el que escribimos un texto y pulsando enter después
 * de escribir en el, la ventana se cierra.
 * 
 * @author Chuidiang
 * 
 */
public class DialogoModal extends JDialog {
    private JTextField textField;

    /**
     * Constructor que pone titulo al dialogo, construye la ventana y la hace
     * modal.
     * 
     * @param padre
     *            Frame que hace de padre de esta dialogo.
     */
    public DialogoModal(Frame padre) {

        // padre y modal
        super(padre, true);
        setTitle("Mete un dato");
        textField = new JTextField(20);
        getContentPane().add(textField);

        // Se oculta la ventana al pulsar <enter> sobre el textfield
        textField.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(ActionEvent arg0) {
                setVisible(false);
            }
        });
    }

    /**
     * Deveulve el texto en el jtextfield
     * 
     * @return el texto
     */
    public String getText() {
        return textField.getText();
    }
}

Le hemos añadido además un método getText() que devuelve el texto del JTextField. Será este al método al que llamemos para conseguir el texto introducido por el usuario después de que se cierre la ventana.

Para hacer la llamada a este diálogo y recoger los resultados, usaremos el siguiente código

DialogoModal dialogoModal = new DialogoModal((Frame) ventanaPadre);
dialogoModal.pack();  // para darle tamaño automático a la ventana.
dialogoModal.setVisible(true);

// Al ser modal, la llamada a setVisible(true) se queda bloqueada hasta
// que el dialogo modal se oculte. Por ello, a continuación tenemos
// la seguridad de que el texto ya esta disponible.
System.out.println("El usuario ha escrito "+dialogoModal.getText());

Enlaces relacionados