/*
 *  $Id$
 *  IzPack
 *  Copyright (C) 2001-2004 Julien Ponge
 *
 *  File :               InstallPanel.java
 *  Description :        A panel to launch the installation process.
 *  Author's email :     julien@izforge.com
 *  Author's Website :   http://www.izforge.com
 *
 *  This program 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 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.izforge.izpack.panels;

import java.awt.Dimension;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;

import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JProgressBar;
import javax.swing.JSeparator;

import com.izforge.izpack.installer.InstallData;
import com.izforge.izpack.installer.InstallerFrame;
import com.izforge.izpack.installer.IzPanel;
import com.izforge.izpack.util.AbstractUIProgressHandler;

/**
 *  The install panel class. Launches the actual installation job.
 *
 * @author     Julien Ponge
 */
public class InstallPanel extends IzPanel implements AbstractUIProgressHandler
{
  /**  The layout. */
  private GridBagLayout layout;

  /**  The layout constraints. */
  private GridBagConstraints gbConstraints;

  /**  The tip label. */
  protected JLabel tipLabel;

  /**  The operation label . */
  protected JLabel packOpLabel;

  /**  The operation label . */
  protected JLabel overallOpLabel;

  /**  The pack progress bar. */
  protected JProgressBar packProgressBar;

  /**  The progress bar. */
  protected JProgressBar overallProgressBar;

  /**  True if the installation has been done. */
  private volatile boolean validated = false;

  /**  How many packs we are going to install. */
  private int noOfPacks = 0;

  /**
   *  The constructor.
   *
   * @param  parent  The parent window.
   * @param  idata   The installation data.
   */
  public InstallPanel(InstallerFrame parent, InstallData idata)
  {
    super(parent, idata);

    // We initialize our layout
    layout = new GridBagLayout();
    gbConstraints = new GridBagConstraints();
    setLayout(layout);

    int row = 1;

    this.tipLabel =
      new JLabel(
        parent.langpack.getString("InstallPanel.tip"),
        parent.icons.getImageIcon("information"),
        JLabel.TRAILING);
    parent.buildConstraints(gbConstraints, 0, row++, 2, 1, 1.0, 0.0);
    gbConstraints.fill = GridBagConstraints.NONE;
    gbConstraints.anchor = GridBagConstraints.NORTHWEST;
    layout.addLayoutComponent(this.tipLabel, gbConstraints);
    add(this.tipLabel);

    this.packOpLabel = new JLabel(" ", JLabel.TRAILING);
    parent.buildConstraints(gbConstraints, 0, row++, 2, 1, 1.0, 0.0);
    gbConstraints.anchor = GridBagConstraints.SOUTHWEST;
    layout.addLayoutComponent(this.packOpLabel, gbConstraints);
    add(this.packOpLabel);

    this.packProgressBar = new JProgressBar();
    this.packProgressBar.setStringPainted(true);
    this.packProgressBar.setString(
      parent.langpack.getString("InstallPanel.begin"));
    this.packProgressBar.setValue(0);
    parent.buildConstraints(gbConstraints, 0, row++, 2, 1, 1.0, 0.0);
    gbConstraints.anchor = GridBagConstraints.NORTH;
    gbConstraints.fill = GridBagConstraints.HORIZONTAL;
    layout.addLayoutComponent(this.packProgressBar, gbConstraints);
    add(this.packProgressBar);

    // make sure there is some space between the progress bars
    JSeparator sep = new JSeparator();
    Dimension dim = new Dimension(0, 10);
    sep.setPreferredSize(dim);
    sep.setMinimumSize(dim);
    sep.setMaximumSize(dim);
    parent.buildConstraints(gbConstraints, 0, row++, 2, 1, 1.0, 0.0);
    layout.addLayoutComponent(sep, gbConstraints);
    add(sep);

    this.overallOpLabel =
      new JLabel(
        parent.langpack.getString("InstallPanel.progress"),
        parent.icons.getImageIcon("information"),
        JLabel.TRAILING);
    parent.buildConstraints(gbConstraints, 0, row++, 2, 1, 1.0, 0.0);
    gbConstraints.anchor = GridBagConstraints.NORTHWEST;
    gbConstraints.fill = GridBagConstraints.NONE;
    layout.addLayoutComponent(this.overallOpLabel, gbConstraints);
    add(this.overallOpLabel);

    this.overallProgressBar = new JProgressBar();
    this.overallProgressBar.setStringPainted(true);
    this.overallProgressBar.setString("");
    this.overallProgressBar.setValue(0);
    parent.buildConstraints(gbConstraints, 0, row++, 2, 1, 1.0, 0.0);
    gbConstraints.anchor = GridBagConstraints.NORTH;
    gbConstraints.fill = GridBagConstraints.HORIZONTAL;
    layout.addLayoutComponent(this.overallProgressBar, gbConstraints);
    add(this.overallProgressBar);
  }

  /**
   *  Indicates wether the panel has been validated or not.
   *
   * @return    The validation state.
   */
  public boolean isValidated()
  {
    return this.validated;
  }

  /**  The unpacker starts.  */
  public void startAction(String name, int noOfJobs)
  {
    parent.blockGUI();
    // figure out how many packs there are to install
    this.noOfPacks = noOfJobs;
    this.overallProgressBar.setMinimum(0);
    this.overallProgressBar.setMaximum(this.noOfPacks);
    this.overallProgressBar.setString(
      "0 / " + Integer.toString(this.noOfPacks));
  }

  /**
   *  An error was encountered.
   *
   * @param  error  The error text.
   */
  public void errorUnpack(String error)
  {
    this.packOpLabel.setText(error);
    idata.installSuccess = false;
    JOptionPane.showMessageDialog(
      this,
      error.toString(),
      parent.langpack.getString("installer.error"),
      JOptionPane.ERROR_MESSAGE);
  }

  /**  The unpacker stops.  */
  public void stopAction()
  {
    parent.releaseGUI();
    parent.lockPrevButton();
    this.overallProgressBar.setValue(this.overallProgressBar.getValue() + 1);
    this.packProgressBar.setString(
      parent.langpack.getString("InstallPanel.finished"));
    this.packProgressBar.setEnabled(false);
    String no_of_packs = Integer.toString(this.noOfPacks);
    this.overallProgressBar.setString(no_of_packs + " / " + no_of_packs);
    this.overallProgressBar.setEnabled(false);
    this.packOpLabel.setText(" ");
    this.packOpLabel.setEnabled(false);
    idata.installSuccess = true;
    idata.canClose = true;
    this.validated = true;
    if (idata.panels.indexOf(this) != (idata.panels.size() - 1))
      parent.unlockNextButton();
  }

  /**
   *  Normal progress indicator.
   *
   * @param  val  The progression value.
   * @param  msg  The progression message.
   */
  public void progress(int val, String msg)
  {
    this.packProgressBar.setValue(val + 1);
    packOpLabel.setText(msg);
  }

  /**
   *  Pack changing.
   *
   * @param  packName  The pack name.
   * @param  stepno    The number of the pack.
   * @param  max       The new maximum progress.
   */
  public void nextStep(String packName, int stepno, int max)
  {
    this.packProgressBar.setValue(0);
    this.packProgressBar.setMinimum(0);
    this.packProgressBar.setMaximum(max);
    this.packProgressBar.setString(packName);
    this.overallProgressBar.setValue(stepno - 1);
    this.overallProgressBar.setString(
      Integer.toString(stepno) + " / " + Integer.toString(this.noOfPacks));
  }

  /**  Called when the panel becomes active.  */
  public void panelActivate()
  {
    // We clip the panel
    Dimension dim = parent.getPanelsContainerSize();
    dim.width = dim.width - (dim.width / 4);
    dim.height = 150;
    setMinimumSize(dim);
    setMaximumSize(dim);
    setPreferredSize(dim);
    parent.lockNextButton();

    parent.install(this);
  }

}