GUIModalDialog.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2020 Marco Foscato <marco.foscato@uib.no>
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published
 *   by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.gui;
 
 
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowEvent;
 
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JPanel;
 
public class GUIModalDialog extends JDialog
{
    
    private static final long serialVersionUID = 8562693062507200623L;
    
    protected JButton btnDone;
    
    protected JButton btnCanc;
    
    protected JButton btnExtra;
    
    private JPanel pnlControls;
    
    protected Object result = null;
    
//------------------------------------------------------------------------------
    
    public GUIModalDialog(Component refForPlacement)
    {
        this(refForPlacement,false);
    }
    
//------------------------------------------------------------------------------
    
    public GUIModalDialog(Component refForPlacement, boolean useExtraButton)
    {
        //To avoid conflict when having multiple modal dialogs open.
        super(new Frame()); 
        setLocationRelativeTo(refForPlacement);
        initialize(useExtraButton);
    }
    
//------------------------------------------------------------------------------
    
    private void initialize(boolean useExtraButton)
    {
        this.setModal(true);
        this.setLayout(new BorderLayout());
        setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
        
        btnDone = new JButton("Done");
        btnDone.setToolTipText("Processes data and closes dialog");
        btnDone.addActionListener(new ActionListener() {
                
            @Override
            public void actionPerformed(ActionEvent e) {
                close();
            }
        });
        
        btnCanc = new JButton("Cancel");
        btnCanc.setToolTipText("Exit dialog.");
        btnCanc.addActionListener(new ActionListener() {
            
            @Override
            public void actionPerformed(ActionEvent e) {
                result = null;
                close();
            }
        });
        
        pnlControls = new JPanel();
        if (useExtraButton)
        {
            btnExtra = new JButton("Extra");
            pnlControls.add(btnExtra);
        }
        pnlControls.add(btnDone);
        pnlControls.add(btnCanc);
        this.add(pnlControls, BorderLayout.SOUTH);
    }
 
//-------------------------------------------------------------------------
 
    public Object showDialog()
    {
        pack();
        setVisible(true);
        return result;
    }
 
//-------------------------------------------------------------------------
 
    public void addToNorthPane(JComponent comp)
    {
        this.add(comp, BorderLayout.NORTH);
    }
    
//-------------------------------------------------------------------------
 
    public void addToCentralPane(JComponent comp)
    {
        this.add(comp, BorderLayout.CENTER);
    }
    
//-------------------------------------------------------------------------
    
    protected void close()
    {
        GUIModalDialog.this.setVisible(false);
        GUIModalDialog.this.dispatchEvent(new WindowEvent(
                GUIModalDialog.this, WindowEvent.WINDOW_CLOSING));
        dispose();
    }
 
//-------------------------------------------------------------------------
}