/* ----------------------------------------------------------------------------
   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: KFileChooserDialog.java,v $
   Revision 1.6  2004/05/31 07:43:40  markl
   added setFileSelectionMode()

   Revision 1.5  2004/05/12 18:09:34  markl
   javadoc updates

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

   Revision 1.3  2004/03/18 07:21:57  markl
   javadoc typo fix

   Revision 1.2  2004/03/16 05:46:26  markl
   added support for multiple selection

   Revision 1.1  2003/01/19 09:38:00  markl
   New class.
   ----------------------------------------------------------------------------
*/

package kiwi.ui.dialog;

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

import kiwi.ui.*;
import kiwi.event.*;

/** A standard Kiwi dialog wrapper for the <code>KFileChooser</code>
 * component. This dialog behaves like other Kiwi dialogs and should be used
 * in place of <code>KFileChooser.showDialog()</code>.
 *
 * <p><center>
 * <img src="snapshot/KFileChooserDialog.gif"><br>
 * <i>An example KFileChooserDialog.</i>
 * </center>
 *
 * @author Mark Lindner
 * @see kiwi.ui.KFileChooser
 * @since Kiwi 1.4
 */

public class KFileChooserDialog extends KDialog implements ActionListener
  {
  /** The <code>KFileChooser</code> used by this dialog. */
  protected KFileChooser fileChooser;

  /** Construct a new modal <code>KFileChooserDialog</code> with the specified
   * parent window and title.
   *
   * @param parent The parent window for the dialog.
   * @param title The title for the dialog.
   * @param type The dialog type; one of the constants
   * <code>OPEN_DIALOG</code>, <code>SAVE_DIALOG</code>, or
   * <code>CUSTOM_DIALOG</code>, which are defined in
   * <code>KFileChooser</code>.
   */
  
  public KFileChooserDialog(Frame parent, String title, int type)
    {
    super(parent, title, true);

    _init(type);
    }

  /** Construct a new modal <code>KFileChooserDialog</code> with the specified
   * parent dialog and title.
   *
   * @param parent The parent dialog.
   * @param title The title for the dialog.
   * @param type The dialog type; one of <code>OPEN_DIALOG</code>,
   * <code>SAVE_DIALOG</code>, or <code>CUSTOM_DIALOG</code>.
   */
  
  public KFileChooserDialog(Dialog parent, String title, int type)
    {
    super(parent, title, true);

    _init(type);
    }

  /** Get a reference to the <code>KFileChooser</code> used by this dialog.
   *
   * @return The <code>KFileChooser</code> instance.
   */
  
  public KFileChooser getFileChooser()
    {
    return(fileChooser);
    }

  /*
   */
  
  private void _init(int type)
    {
    fileChooser = new KFileChooser();

    KPanel panel = getMainContainer();
    panel.setLayout(new GridLayout(1, 0));
    panel.add(fileChooser);

    fileChooser.setDialogType(type);
    fileChooser.addActionListener(this);

    pack();
    }

  /** A convenience method to enable or disable multiple selection. Delegates
   * to the embedded <code>KFileChooser</code>.
   *
   * @since Kiwi 2.0
   */

  public void setMultiSelectionEnabled(boolean flag)
    {
    fileChooser.setMultiSelectionEnabled(flag);
    }

  /** A convenience method to set the file selection mode. Delegates to the
   * embedded <code>KFileChooser</code>.
   *
   * @since Kiwi 2.0
   */

  public void setFileSelectionMode(int mode)
    {
    fileChooser.setFileSelectionMode(mode);
    }
  
  /** A convenience method to get the currently selected file. Delegates to
   * the embedded <code>KFileChooser</code>.
   */

  public File getSelectedFile()
    {
    return(fileChooser.getSelectedFile());
    }

  /** A convenience method to get the currently selected files. Delegates to
   * the embedded <code>KFileChooser</code>.
   *
   * @since Kiwi 2.0
   */

  public File[] getSelectedFiles()
    {
    if(fileChooser.isMultiSelectionEnabled())
      return(fileChooser.getSelectedFiles());
    else
      {
      File files[] = new File[1];
      files[0] = fileChooser.getSelectedFile();
      return(files);
      }
    }
  
  /** A convenience method to set the currently selected file. Delegates to
   * the embedded <code>KFileChooser</code>.
   */

  public void setSelectedFile(File file)
    {
    fileChooser.setSelectedFile(file);
    }

  /** This method is public as an implementation side-effect.
   */
  
  public void actionPerformed(ActionEvent evt)
    {
    String command = evt.getActionCommand();

    if(command.equals(KFileChooser.APPROVE_SELECTION))
      doAccept();
    else if(command.equals(KFileChooser.CANCEL_SELECTION))
      doCancel();
    }
  
  }

/* end of source file */