| gvSIG desktop 1

/*

 *  $Id: PacksPanelBase.java,v 1.1 2006/06/14 07:29:07 cesar Exp $

 *  IzPack

 *  Copyright (C) 2001-2004 Julien Ponge

 *

 *  File :               PacksPanel.java

 *  Description :        Base panel to select the packs to install.

 *  Author's email :     julien@izforge.com

 *  Author's Website :   http://www.izforge.com

 *

 *  Portions are Copyright (C) 2002 Marcus Wolschon

 *  Portions are Copyright (C) 2002 Jan Blok (jblok@profdata.nl - PDM - www.profdata.nl)

 *  Portions are Copyright (C) 2004 Klaus Bartz

 *

 *  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.Color;

import java.awt.Component;

import java.awt.Dimension;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.io.File;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import javax.swing.AbstractCellEditor;

import javax.swing.BorderFactory;

import javax.swing.Box;

import javax.swing.BoxLayout;

import javax.swing.JCheckBox;

import javax.swing.JLabel;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JTable;

import javax.swing.JTextArea;

import javax.swing.ListSelectionModel;

import javax.swing.border.Border;

import javax.swing.event.ListSelectionEvent;

import javax.swing.event.ListSelectionListener;

import javax.swing.table.DefaultTableCellRenderer;

import javax.swing.table.TableCellEditor;

import javax.swing.table.TableCellRenderer;

import net.n3.nanoxml.XMLElement;

import com.izforge.izpack.LocaleDatabase;

import com.izforge.izpack.Pack;

import com.izforge.izpack.gui.LabelFactory;

import com.izforge.izpack.installer.InstallData;

import com.izforge.izpack.installer.InstallerFrame;

import com.izforge.izpack.installer.IzPanel;

import com.izforge.izpack.installer.ResourceManager;

import com.izforge.izpack.util.IoHelper;

/**

 * The base class for Packs panels. It brings the common

 * member and methods of the different packs panels together.

 * This class handles the common logic of pack selection.

 * The derived class should be create the layout

 * and other specific actions.

 * There are some helper methods to simplify layout creation

 * in the derived class.

 *

 * @author     Julien Ponge

 * @author     Klaus Bartz

 */

public abstract class PacksPanelBase extends IzPanel implements PacksPanelInterface, ListSelectionListener

{

  // Common used Swing fields

  /**  The free space label. */

  protected JLabel freeSpaceLabel;

  /**  The space label. */

  protected JLabel spaceLabel;

  /**  The tip label. */

  protected JTextArea descriptionArea;

  /**  The dependencies label. */

  protected JTextArea dependencyArea;

  /**  The packs table. */

  protected JTable packsTable;

  /**  The tablescroll. */

  protected JScrollPane tableScroller;

 // Non-GUI fields

  /** Map that connects names with pack objects */

  private Map names;

  /**  The bytes of the current pack. */

  protected int bytes = 0;

  /**  The free bytes of the current selected disk. */

  protected long freeBytes = 0;

  /** Are there dependencies in the packs */

  protected boolean dependenciesExist = false;

  /** The packs locale database. */

  private LocaleDatabase langpack = null;

  /** The name of the XML file that specifies the panel langpack */

  private static final String LANG_FILE_NAME = "packsLang.xml";

  /**

   *  The constructor.

   *

   * @param  parent  The parent window.

   * @param  idata   The installation data.

   */

  public PacksPanelBase(InstallerFrame parent, InstallData idata)

  {

    super(parent, idata);

    // Load langpack.

    try

    {

      String resource = LANG_FILE_NAME + "_" + idata.localeISO3;

      this.langpack =

        new LocaleDatabase(ResourceManager.getInstance().getInputStream(resource));

    }

    catch (Throwable exception)

    {}

    //init the map

    computePacks(idata.availablePacks);

    createNormalLayout();

  }

  /**

   * The Implementation of this method should create the layout

   * for the current class.

   */

  abstract protected void createNormalLayout();

  /* (non-Javadoc)

   * @see com.izforge.izpack.panels.PacksPanelInterface#getLangpack()

   */

  public LocaleDatabase getLangpack()

  {

    return( langpack);

  }

  /* (non-Javadoc)

   * @see com.izforge.izpack.panels.PacksPanelInterface#getBytes()

   */

  public int getBytes()

  {

    return(bytes);

  }

  /* (non-Javadoc)

   * @see com.izforge.izpack.panels.PacksPanelInterface#setBytes(int)

   */

  public void setBytes(int bytes)

  {

    this.bytes = bytes;

  }

  /* (non-Javadoc)

   * @see com.izforge.izpack.panels.PacksPanelInterface#showSpaceRequired()

   */

  public void showSpaceRequired()

  {

    if( spaceLabel != null )

      spaceLabel.setText(Pack.toByteUnitsString(bytes));

  }

  /* (non-Javadoc)

   * @see com.izforge.izpack.panels.PacksPanelInterface#showFreeSpace()

   */

  public void showFreeSpace()

  {

    if( IoHelper.supported( "getFreeSpace") &&

    freeSpaceLabel != null )

    {

      String msg = null;

      freeBytes = IoHelper.getFreeSpace( IoHelper.existingParent(

      new File( idata.getInstallPath())).getAbsolutePath());

      if( freeBytes > 0x000000007fffffff )

        msg = " > 2 GB";

      else if( freeBytes < 0 )

        msg = parent.langpack.getString("PacksPanel.notAscertainable");

      else

        msg = Pack.toByteUnitsString((int) freeBytes);

      freeSpaceLabel.setText( msg );

    }

  }

  /**

   * Indicates wether the panel has been validated or not.

   *

   * @return    true if the needed space is less than the free space,

   * else false

   */

  public boolean isValidated()

  {

    if( IoHelper.supported("getFreeSpace") &&

       freeBytes >= 0 && freeBytes <= bytes )

    {

      JOptionPane.showMessageDialog(

          this,

          parent.langpack.getString("PacksPanel.notEnoughSpace"),

          parent.langpack.getString("installer.error"),

          JOptionPane.ERROR_MESSAGE);

      return(false);

    }

    return(true);

  }

  /**

   *  Asks to make the XML panel data.

   *

   * @param  panelRoot  The XML tree to write the data in.

   */

  public void makeXMLData(XMLElement panelRoot)

  {

    new ImgPacksPanelAutomationHelper().makeXMLData(idata, panelRoot);

  }

  /* (non-Javadoc)

   * @see javax.swing.event.ListSelectionListener#valueChanged(javax.swing.event.ListSelectionEvent)

   */

  public void valueChanged(ListSelectionEvent e)

  {

    int i = packsTable.getSelectedRow();

    if( i < 0 )

      return;

    //Operations for the description

    if( descriptionArea != null)

    {

     Pack pack = (Pack) idata.availablePacks.get(i);

     String desc = "";

     String key = pack.id+".description";

     if (langpack != null && pack.id != null && !pack.id.equals(""))

     {

       desc = langpack.getString(key);

     }

     if (desc.equals("") || key.equals(desc))

     {

       desc = pack.description;

     }

     descriptionArea.setText(desc);

   }

     //Operation for the dependency listing

    if(dependencyArea != null)

    {

      Pack pack = (Pack) idata.availablePacks.get(i);

      List dep = pack.dependencies;

      String list="";

      for (int j = 0; dep != null && j < dep.size(); j++)

      {

        String name = (String)dep.get(j);

        //Internationalization code

        Pack childPack = (Pack)names.get(name);

        String childName = "";

        String key = childPack.id;

        if (langpack != null && childPack.id != null && !childPack.id.equals(""))

        {

          childName = langpack.getString(key);

        }

        if  (childName.equals("") || key.equals(childName))

        {

          childName = childPack.name;

        }

        //End internationalization

        list += childName;

        if(j != dep.size()-1)

          list +=", ";

      }

      dependencyArea.setText(list);

    }

  }

  /**

   * Layout helper method:<br>

   * Creates an label with a message given by msgId and an

   * icon given by the iconId. If layout and constraints

   * are not null, the label will be added to layout

   * with the given constraints.

   * The label will be added to this object.

   * @param msgId identifier for the IzPack langpack

   * @param iconId identifier for the IzPack icons

   * @param layout layout to be used

   * @param constraints constraints to be used

   * @return the created label

   */

  protected JLabel createLabel( String msgId, String iconId,

    GridBagLayout layout,GridBagConstraints constraints )

  {

    JLabel label =

      LabelFactory.create(

        parent.langpack.getString(msgId),

        parent.icons.getImageIcon(iconId),

        JLabel.TRAILING);

    if( layout != null && constraints != null)

      layout.addLayoutComponent(label, constraints);

    add(label);

    return( label );

  }

  /**

   * Creates a panel containing a anonymous label on

   * the left with the message for the given msgId and

   * a label on the right side with initial no text.

   * The right label will be returned.

   * If layout and constraints are not null, the label

   * will be added to layout with the given constraints.

   * The panel will be added to this object.

   * @param msgId identifier for the IzPack langpack

   * @param layout layout to be used

   * @param constraints constraints to be used

   * @return the created (right) label

   */

  protected JLabel createPanelWithLabel(String msgId,

    GridBagLayout layout,GridBagConstraints constraints )

  {

    JPanel panel = new JPanel();

    JLabel label = new JLabel();

    if( label == null )

      label = new JLabel("");

    panel.setAlignmentX(LEFT_ALIGNMENT);

    panel.setLayout(new BoxLayout(panel, BoxLayout.X_AXIS));

    panel.add(LabelFactory.create(parent.langpack.getString(msgId)));

    panel.add(Box.createHorizontalGlue());

    panel.add(label);

    if( layout != null && constraints != null)

      layout.addLayoutComponent(panel, constraints);

    add(panel);

    return( label);

  }

  /**

   * Creates a text area with standard settings and the

   * title given by the msgId.

   * If scroller is not null, the create text area will be

   * added to the scroller and the scroller to this object,

   * else the text area will be added directly to this object.

   * If layout and constraints are not null, the text area

   * or scroller will be added to layout with the given constraints.

   * The text area will be returned.

   * @param msgId identifier for the IzPack langpack

   * @param scroller the scroller to be used

   * @param layout layout to be used

   * @param constraints constraints to be used

   * @return the created text area

   */

  protected JTextArea createTextArea( String msgId, JScrollPane scroller,

    GridBagLayout layout,GridBagConstraints constraints )

  {

    JTextArea area = new JTextArea();

    area.setMargin(new Insets(2, 2, 2, 2));

    area.setAlignmentX(LEFT_ALIGNMENT);

    area.setCaretPosition(0);

    area.setEditable(false);

    area.setEditable(false);

    area.setOpaque(false);

    area.setLineWrap(true);

    area.setWrapStyleWord(true);

    area.setBorder(

      BorderFactory.createTitledBorder(

        parent.langpack.getString(msgId)));

    if(layout != null && constraints != null)

    {

      if( scroller != null )

      {

        layout.addLayoutComponent(scroller, constraints);

      }

      else

        layout.addLayoutComponent(area, constraints);

    }

    if( scroller != null )

    {

      scroller.setViewportView(area);

      add(scroller);

    }

    else

      add(area);

    return(area);

  }

  /**

   * Creates the table for the packs. All

   * parameters are required.

   * The table will be returned.

   * @param width of the table

   * @param scroller the scroller to be used

   * @param layout layout to be used

   * @param constraints constraints to be used

   * @return the created table

   */

  protected JTable createPacksTable(int width, JScrollPane scroller,

    GridBagLayout layout,GridBagConstraints constraints)

  {

    JTable table = new JTable();

    table.setBorder(BorderFactory.createEmptyBorder(0, 2, 0, 2));

    table.setIntercellSpacing(new Dimension(0, 0));

    table.setBackground(Color.white);

    table.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);

    table.getSelectionModel().addListSelectionListener(this);

    table.setShowGrid(false);

    scroller.setViewportView(table);

    scroller.setAlignmentX(LEFT_ALIGNMENT);

    scroller.getViewport().setBackground(Color.white);

    scroller.setPreferredSize(

      new Dimension(width, (idata.guiPrefs.height / 3 + 30)));

    if( layout != null && constraints != null)

      layout.addLayoutComponent(scroller, constraints);

    add(scroller);

    return( table);

  }

  /**

   * Computes pack related data like the

   * names or the dependencies state.

   * @param packs

   */

  private void computePacks(List packs)

  {

    names = new HashMap();

    dependenciesExist = false;

    for (int i = 0; i < packs.size(); i++)

    {

      Pack pack = (Pack) packs.get(i);

      names.put(pack.name,pack);

      if( pack.dependencies != null)

        dependenciesExist = true;

    }

  }

  /**

   * Called when the panel becomes active.

   * If a derived class implements this method also, it

   * is recomanded to call this method with the super operator

   * first.

   *

   */

  public void panelActivate()

  {

    try

    {

      packsTable.setModel(

        new PacksModel(idata.availablePacks, idata.selectedPacks,this));

      CheckBoxEditorRenderer packSelectedRenderer =

        new CheckBoxEditorRenderer(false);

      packsTable.getColumnModel().getColumn(0).setCellRenderer(

        packSelectedRenderer);

      CheckBoxEditorRenderer packSelectedEditor =

        new CheckBoxEditorRenderer(true);

      packsTable.getColumnModel().getColumn(0).setCellEditor(

        packSelectedEditor);

      packsTable.getColumnModel().getColumn(0).setMaxWidth(40);

      DefaultTableCellRenderer renderer1 = new DefaultTableCellRenderer()

      {

        public void setBorder(Border b)

        {

        }

      };

      packsTable.getColumnModel().getColumn(1).setCellRenderer(renderer1);

      DefaultTableCellRenderer renderer2 = new DefaultTableCellRenderer()

      {

        public void setBorder(Border b)

        {

        }

          //          public void setFont(Font f)

    //          {

    //              super.setFont(new Font("Monospaced",Font.PLAIN,11));

    //          }

  };

      renderer2.setHorizontalAlignment(JLabel.RIGHT);

      packsTable.getColumnModel().getColumn(2).setCellRenderer(renderer2);

      packsTable.getColumnModel().getColumn(2).setMaxWidth(100);

      //remove header,so we don't need more strings

      tableScroller.remove(packsTable.getTableHeader());

      tableScroller.setColumnHeaderView(null);

      tableScroller.setColumnHeader(null);

      // set the JCheckBoxes to the currently selected panels. The selection might have changed in another panel

      java.util.Iterator iter = idata.availablePacks.iterator();

      bytes = 0;

      while (iter.hasNext())

      {

        Pack p = (Pack) iter.next();

        if (p.required)

        {

          bytes += p.nbytes;

          continue;

        }

        if (idata.selectedPacks.contains(p))

          bytes += p.nbytes;

      }

    } catch (Exception e)

    {

      e.printStackTrace();

    }

    showSpaceRequired();

    showFreeSpace();

  }

  static class CheckBoxEditorRenderer

    extends AbstractCellEditor

    implements TableCellRenderer, TableCellEditor, ActionListener

  {

    private JCheckBox display;

    public CheckBoxEditorRenderer(boolean useAsEditor)

    {

      display = new JCheckBox();

      display.setHorizontalAlignment(JLabel.CENTER);

      if (useAsEditor)

        display.addActionListener(this);

    }

    public Component getTableCellRendererComponent(

      JTable table,

      Object value,

      boolean isSelected,

      boolean hasFocus,

      int row,

      int column)

    {

      if (isSelected)

      {

        display.setForeground(table.getSelectionForeground());

        display.setBackground(table.getSelectionBackground());

      } else

      {

        display.setForeground(table.getForeground());

        display.setBackground(table.getBackground());

      }

      int state = ((Integer) value).intValue();

      display.setSelected((value != null && Math.abs(state) == 1));

      display.setEnabled(state >= 0);

      return display;

    }

    /**

     * @see javax.swing.table.TableCellEditor#getTableCellEditorComponent(javax.swing.JTable, java.lang.Object, boolean, int, int)

     */

    public Component getTableCellEditorComponent(

      JTable table,

      Object value,

      boolean isSelected,

      int row,

      int column)

    {

      return getTableCellRendererComponent(

        table,

        value,

        isSelected,

        false,

        row,

        column);

    }

    public Object getCellEditorValue()

    {

      return new Integer(display.isSelected() ? 1 : 0);

    }

    public void actionPerformed(ActionEvent e)

    {

      stopCellEditing();

    }

  }

}