/* ----------------------------------------------------------------------------
   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: KQuestionDialog.java,v $
   Revision 1.13  2004/05/05 23:20:24  markl
   comment block updates

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

   Revision 1.11  2004/01/23 00:06:28  markl
   javadoc corrections

   Revision 1.10  2003/01/19 09:38:51  markl
   Added new constructors that take a parent dialog.

   Revision 1.9  2001/09/26 07:05:36  markl
   Version fixes, email address fixes.

   Revision 1.8  2001/03/20 00:54:55  markl
   Fixed deprecated calls.

   Revision 1.7  2001/03/12 09:56:55  markl
   KLabel/KLabelArea changes.

   Revision 1.6  2001/03/12 05:19:59  markl
   Source code cleanup.

   Revision 1.5  1999/07/19 04:10:44  markl
   Recoded to use KLabel to allow multi-line messages.

   Revision 1.4  1999/06/21 06:55:57  markl
   Added yes/no dialog support.

   Revision 1.3  1999/04/19 06:06:16  markl
   I18N changes, new constructor.

   Revision 1.2  1999/01/10 03:22:17  markl
   added GPL header & RCS tag
   ----------------------------------------------------------------------------
*/

package kiwi.ui.dialog;

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

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

/** This class represents a <i>Kiwi</i> question dialog. This dialog displays a
  * message, and has <i>OK</i> and <i>Cancel</i> buttons, which correspond to
  * "yes" and "no" responses.
  *
  * <p><center>
  * <img src="snapshot/KQuestionDialog.gif"><br>
  * <i>An example KQuestionDialog.</i>
  * </center>
  *
  * @author Mark Lindner
  */

public class KQuestionDialog extends ComponentDialog
  {
  private boolean status = false;
  private KLabelArea l_text;
  private String s_ok, s_cancel, s_yes, s_no;
  /** Dialog type. Specifies an ok/cancel dialog. */
  public static final int OK_CANCEL_DIALOG = 0;
  /** Dialog type. Specifies a yes/no dialog. */
  public static final int YES_NO_DIALOG = 1;
  
  /** Construct a new <code>KQuestionDialog</code>. Constructs a new, modal
    * <code>KQuestionDialog</code> with a default window title.
    *
    * @param parent The parent window for this dialog.
    */

  public KQuestionDialog(Frame parent)
    {
    this(parent, "", true);
    }

  /** Construct a new <code>KQuestionDialog</code>. Constructs a new, modal
    * <code>KQuestionDialog</code> with a default window title.
    *
    * @param parent The parent window for this dialog.
    *
    * @since Kiwi 1.4
    */

  public KQuestionDialog(Dialog parent)
    {
    this(parent, "", true);
    }
  
  /** Construct a new <code>KQuestionDialog</code>.
    *
    * @param parent The parent window for the dialog.
    * @param title The title for the dialog.
    * @param modal A flag specifying whether this dialog will be modal.
    */

  public KQuestionDialog(Frame parent, String title, boolean modal)
    {
    super(parent, title, modal);
    setResizable(false);
    }

  /** Construct a new <code>KQuestionDialog</code>.
    *
    * @param parent The parent window for the dialog.
    * @param title The title for the dialog.
    * @param modal A flag specifying whether this dialog will be modal.
    *
    * @since Kiwi 1.4
    */

  public KQuestionDialog(Dialog parent, String title, boolean modal)
    {
    super(parent, title, modal);
    setResizable(false);
    }
  
  /** Set the dialog type. The dialog may either be an ok/cancel dialog or
   * a yes/no dialog; this type merely reflects the labels on the accept and
   * cancel buttons.
   *
   * @param type The new type; one of <code>OK_CANCEL_DIALOG</code> (the
   * default), or <code>YES_NO_DIALOG</code>.
   */

  public void setType(int type)
    {
    switch(type)
      {
      case YES_NO_DIALOG:
        setAcceptButtonText(s_yes);
        setCancelButtonText(s_no);
        break;

      case OK_CANCEL_DIALOG:
      default:
        setAcceptButtonText(s_ok);
        setCancelButtonText(s_cancel);
      }
    }
  
  /** Show or hide the dialog. */

  public void setVisible(boolean flag)
    {
    if(flag)
      {
      status = false;
      b_cancel.requestFocus();
      }
    super.setVisible(flag);
    }

  /** Build the dialog user interface. */

  protected Component buildDialogUI()
    {
    LocaleData loc = LocaleManager.getDefault().getLocaleData("KiwiDialogs");

    l_text = new KLabelArea(loc.getMessage("kiwi.dialog.prompt.question"), 3,
                            30);
    l_text.setForeground(Color.black);

    setIcon(KiwiUtils.getResourceManager().getIcon("question.gif"));
    setComment("");
    if(getTitle().length() == 0)
      setTitle(loc.getMessage("kiwi.dialog.title.message"));

    s_ok = loc.getMessage("kiwi.button.ok");
    s_cancel = loc.getMessage("kiwi.button.cancel");
    s_yes = loc.getMessage("kiwi.button.yes");
    s_no = loc.getMessage("kiwi.button.no");
    
    return(l_text);
    }

  /** Set the prompt. Sets the dialog's message.
    *
    * @param message The text of the message.
    */

  public void setMessage(String message)
    {
    l_text.setText(message);
    pack();
    }

  /** Accept the dialog. Always returns <code>true</code>. */

  protected boolean accept()
    {
    status = true;
    return(true);
    }

  /** Get the status of the dialog.
    *
    * @return <code>true</code> if the dialog was dismissed via the <i>OK</i>
    * button and <code>false</code> if it was cancelled.
    */

  public boolean getStatus()
    {
    return(status);
    }
  
  }

/* end of source file */