/* ----------------------------------------------------------------------------
   The Kiwi Toolkit - A Java Class Library
   Copyright (C) 1998-2004 Mark A. Lindner

   This library 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 2 of the
   License, or (at your option) any later version.

   This library 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 this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.
 
   The author may be contacted at: mark_a_lindner@yahoo.com
   ----------------------------------------------------------------------------
   $Log: ExceptionDialog.java,v $
   Revision 1.5  2004/05/12 18:12:03  markl
   javadoc updates

   Revision 1.4  2004/05/05 23:20:24  markl
   comment block updates

   Revision 1.3  2004/03/20 05:16:26  markl
   layout enhancements

   Revision 1.2  2004/03/16 06:43:39  markl
   LocaleManager method change

   Revision 1.1  2004/03/16 05:45:15  markl
   new class
   ----------------------------------------------------------------------------
*/

package kiwi.ui.dialog;

import java.awt.*;
import java.awt.event.*;
import java.io.*;
import javax.swing.*;
import javax.swing.border.*;

import kiwi.ui.*;
import kiwi.util.*;

/** A dialog for presenting an exception to the user. The dialog displays a
 * message as well as the detail of the exception, including its stack trace.
 *
 * <p><center>
 * <img src="snapshot/ExceptionDialog.gif"><br>
 * <i>An example ExceptionDialog.</i>
 * </center>
 *
 * <p><center>
 * <img src="snapshot/ExceptionDialog_2.gif"><br>
 * <i>An example ExceptionDialog with the detail expanded.</i>
 * </center>
 * 
 * @author Mark Lindner
 * @since Kiwi 2.0
 */

public class ExceptionDialog extends ComponentDialog
  {
  private KButton b_detail;
  private JList l_trace;
  private KPanel p_main, p_detail;
  private JTextField t_exception;
  private KLabelArea l_message;
  private boolean detailShown = false;
  private KScrollPane scroll;
  private static Dimension listSize = new Dimension(350, 150);
  private boolean expandable = true;
  
  /** Construct a new modal <code>ExceptionDialog</code> with the specified
   * parent window.
   *
   * @param parent The parent window for the dialog.
   * @param title The title for the dialog window.
   */
  
  public ExceptionDialog(Frame parent, String title)
    {
    super(parent, title, true, false);
    }

  /** Set the "expandable" mode of the dialog. If the mode is enabled, the
   * dialog will include a "detail" button, which, when clicked, will
   * expand the dialog to display the exception type and stack trace.
   * This mode is enabled by default.
   */

  public void setExpandable(boolean expandable)
    {
    this.expandable = expandable;
    
    b_detail.setVisible(expandable);
    }
  
  /** Build the dialog user interface. */
  
  protected Component buildDialogUI()
    {
    setComment(null);

    ResourceManager resmgr = KiwiUtils.getResourceManager();
    
    setIcon(resmgr.getIcon("alert.gif"));

    LocaleData loc = LocaleManager.getDefault().getLocaleData("KiwiDialogs");
    
    b_detail = new KButton(loc.getMessage("kiwi.button.detail"),
                           resmgr.getIcon("down.gif"));
    b_detail.addActionListener(new ActionListener()
        {
        public void actionPerformed(ActionEvent evt)
          {
          Object o = evt.getSource();
          
          if(o == b_detail)
            {
            detailShown = !detailShown;
            
            if(detailShown)
              p_main.add("Center", p_detail);
            else
              p_main.remove(p_detail);
            
            pack();
            
            if(detailShown)
              b_detail.setVisible(false);
            }
          }
        });
    addButton(b_detail);
    
    p_main = new KPanel();
    p_main.setLayout(new BorderLayout(5, 5));
    
    l_message = new KLabelArea(1, 30);
    p_main.add("North", l_message);
    
    p_detail = new KPanel();
    p_detail.setLayout(new BorderLayout(5, 5));
    
    t_exception = new JTextField();
    t_exception.setFont(KiwiUtils.boldFont);
    t_exception.setOpaque(false);
    t_exception.setEditable(false);
    
    p_detail.add("North", t_exception);
    
    l_trace = new JList();
    l_trace.setFont(KiwiUtils.plainFont);
    scroll = new KScrollPane(l_trace);
    scroll.setSize(listSize);
    scroll.setPreferredSize(listSize);
    
    p_detail.add("Center", scroll);
    
    return(p_main);
    }
    
  /** Set a textual error message and the throwable object to be displayed in
   *  the dialog.
   *
   * @param message The message.
   * @param throwable The throwable.
   */
  
  public void setException(String message, Throwable throwable)
    {
    String tmsg = throwable.getMessage();
    if(tmsg != null)
      message += "\n" + tmsg;
    else
      message += "\n(no message)";

    l_message.setText(message);
    
    l_trace.setListData(throwable.getStackTrace());
    t_exception.setText(throwable.getClass().getName());
    }
  
  /** Show or hide the dialog. */
  
  public void setVisible(boolean flag)
    {
    if(flag)
      {
      detailShown = false;
      p_main.remove(p_detail);
      b_detail.setVisible(expandable);
      pack();

      b_ok.requestFocus();
      }
    
    super.setVisible(flag);
    }
  
  }

/* end of source file */