Modal dialog in Java example code

Summary

To implement modal dialogs in Java, developers can extend the JDialog class, which prevents interaction with the parent JFrame until the dialog is closed. A custom dialog class should utilize a JDialog constructor that accepts the parent frame, a title, and a boolean flag to specify modality. Setting this flag to true ensures the dialog blocks the main application flow. The dialog is then instantiated and displayed from an event listener within the main JFrame, effectively pausing operations on the main window until user interaction with the dialog is complete. This pattern is useful for scenarios requiring specific input or confirmation before proceeding with the main application logic.

In Java, we can create modal dialog so that the main JFrame cannot be operated on until the modal dialog is closed. To achieve this, we need to use one class in Java--JDialog. This class can be used to create an modal dialog.

Example code :

import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JPanel;

public class Dialog extends JDialog{
    public Dialog(){
        super();
        JPanel panel=new JPanel();
        panel.add(new JLabel("Hello dialog"));
        this.getContentPane().add(panel);
    }
   
    public Dialog(MainFrame mf,String title,boolean modal){
        super(mf,title,modal);
        this.setSize(300,200);
        JPanel panel=new JPanel();
        panel.add(new JLabel("Hello dialog"));
        this.getContentPane().add(panel);
        this.setVisible(true);
    }
}


In the above code, we define a class Dialog which extends the JDialog class in Java. In the second constructor, there are three parameters. JFrame: parent frame,String-title on the dialog, boolean - whether the dialog is modal or non-modal.

The next java code is to demonstrate how to open the Dialog.

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

import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JPanel;

public class MainFrame extends JFrame{
    public MainFrame(){
        this.setTitle("Dialog demo");
        this.setSize(400,300);
        this.setLocationRelativeTo(null);
       
        JPanel panel=new JPanel();
        JButton btn=new JButton("Open dialog");
        btn.addActionListener(new ActionListener(){
            public void actionPerformed(ActionEvent e) {
                new Dialog(MainFrame.this,"Hello",true);
            }
        });
        panel.add(btn);
        this.getContentPane().add(panel);
        this.setVisible(true);
        this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
    }
   
    public static void main(String[] args){
        new MainFrame().setVisible(true);
    }
}

When click on the button on MainFrame, the Dialog will show up and the MainFrame will become non-operable. This can be used when we want to get some information from the dialog before we can continue our operations on the MainFrame.

JAVA CODE DEMO MODAL JFRAME JDIALOG

  RELATED

  COMMENTS

2
Bill
Jan 10, 2014 at 8:44 pm

Lots of incomplete advice out there.  This worked for me.  Thank you!

BlackMail
Jan 27, 2016 at 3:51 pm

Simple, and clear explanation, how to achieve modality. Thank you!