/*
 * Jalview - A Sequence Alignment Editor and Viewer (2.11.2.6)
 * Copyright (C) 2023 The Jalview Authors
 * 
 * This file is part of Jalview.
 * 
 * Jalview is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License 
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *  
 * Jalview 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
 * The Jalview Authors are detailed in the 'AUTHORS' file.
 */
package jalview.gui;

import jalview.util.MessageManager;

import java.awt.Container;
import java.awt.Dimension;
import java.awt.Rectangle;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;

import javax.swing.JButton;
import javax.swing.JDialog;
import javax.swing.JPanel;

/**
 * Boilerplate dialog class. Implements basic functionality necessary for model
 * blocking/non-blocking dialogs with an OK and Cancel button ready to add to
 * the content pane.
 * 
 * @author jimp
 * 
 */
public abstract class JalviewDialog extends JPanel
{

  protected JDialog frame;

  protected JButton ok = new JButton();

  protected JButton cancel = new JButton();

  boolean block = false;

  public void waitForInput()
  {
    if (!block)
    {
      new Thread(new Runnable()
      {

        @Override
        public void run()
        {
          frame.setVisible(true);
        }

      }).start();
    }
    else
    {
      frame.setVisible(true);
    }
  }

  protected void initDialogFrame(Container content, boolean modal,
          boolean block, String title, int width, int height)
  {

    frame = new JDialog(Desktop.instance, modal);
    frame.setTitle(title);
    if (Desktop.instance != null)
    {
      Rectangle deskr = Desktop.instance.getBounds();
      frame.setBounds(new Rectangle((int) (deskr.getCenterX() - width / 2),
              (int) (deskr.getCenterY() - height / 2), width, height));
    }
    else
    {
      frame.setSize(width, height);
    }
    int minWidth = width - 100;
    int minHeight = height - 100;
    frame.setMinimumSize(new Dimension(minWidth, minHeight));
    frame.setContentPane(content);
    this.block = block;

    ok.setOpaque(false);
    ok.setText(MessageManager.getString("action.ok"));
    ok.addActionListener(new ActionListener()
    {
      @Override
      public void actionPerformed(ActionEvent e)
      {
        okPressed();
        closeDialog();
      }
    });
    cancel.setOpaque(false);
    cancel.setText(MessageManager.getString("action.cancel"));
    cancel.addActionListener(new ActionListener()
    {
      @Override
      public void actionPerformed(ActionEvent e)
      {
        cancelPressed();
        closeDialog();
      }
    });
    frame.addWindowListener(new WindowAdapter()
    {
      @Override
      public void windowClosing(WindowEvent e)
      {
        // user has cancelled the dialog
        closeDialog();
      }
    });
  }

  /**
   * clean up and raise the 'dialog closed' event by calling raiseClosed
   */
  protected void closeDialog()
  {
    try
    {
      raiseClosed();
      frame.dispose();
    } catch (Exception ex)
    {
    }
  }

  protected abstract void raiseClosed();

  protected abstract void okPressed();

  protected abstract void cancelPressed();

}
