/*
   Copyright (C) 2000 - 2007 Grid Systems, S.A.
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2, as
   published by the Free Software Foundation.
   
   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
  */
  
  /*
   * Project: KernelConfigurator
   * Created on 25-feb-2004
   *
   * Copyright (c)2003 Grid Systems
   */
  package com.gridsystems.config.tools.swing;
  
  import java.awt.GridBagConstraints;
  import java.awt.GridBagLayout;
  import java.awt.Insets;
  import java.awt.LayoutManager;
  import java.net.URL;
  
  import javax.swing.BorderFactory;
  import javax.swing.Icon;
  import javax.swing.ImageIcon;
  import javax.swing.JComponent;
  import javax.swing.JLabel;
  import javax.swing.JOptionPane;
  import javax.swing.JPanel;
  import javax.swing.border.Border;
  
  import com.gridsystems.config.app.UI;
  
  /**
   * Helper methods for Swing UI construction.
   *
   * @author <a href="mailto:rruiz@gridsystems.com">Rodrigo Ruiz Aguayo</a>
   * @version 1.0
   */
  public final class SwingTools {
  
    /**
     * Border to use around group panels.
     */
    private static final Border ETCHED = BorderFactory.createEtchedBorder();
  
    /**
     * Utility class: should never be instantiated.
     */
    private SwingTools() { }
  
    /**
     * Creates a group panel with the specified caption, and a GridBagLayout.
     *
     * @param caption The panel caption
     * @return A JPanel with an etched titled border
     */
    public static JPanel getGroupPanel(String caption) {
      GridBagLayout layout = new GridBagLayout();
      return getGroupPanel(caption, layout);
    }
  
    /**
     * Creates a group panel with the specified caption, and layout.
     *
     * @param caption The panel caption
     * @param layout  The panel layout
     * @return A JPanel with an etched titled border
     */
    public static JPanel getGroupPanel(String caption, LayoutManager layout) {
      JPanel panel = new JPanel(layout);
      panel.setBorder(BorderFactory.createTitledBorder(ETCHED, caption));
      return panel;
    }
  
    /**
     * Adds a row consisting in a label and a component in a panel.
     * <p>
     * It supposes the panel uses a GridBoxLayout
     *
     * @param panel Where to put the components row
     * @param label The component label
     * @param c     The component
     * @param row   The row index in the GridBoxLayout
     */
    public static void addField(JPanel panel, String label, JComponent c, int row) {
      LayoutManager layout = panel.getLayout();
      if (layout instanceof GridBagLayout) {
        JLabel lbl = new JLabel(label);
        lbl.setHorizontalAlignment(JLabel.RIGHT);
       lbl.setLabelFor(c);
       GridBagConstraints gc =
         new GridBagConstraints(
           GridBagConstraints.RELATIVE, row, 1, 1,
           0.4, 0.0, GridBagConstraints.LINE_END, GridBagConstraints.NONE,
           new Insets(2, 2, 2, 2), 0, 0
         );
 
       panel.add(lbl, gc);
       gc.anchor = GridBagConstraints.LINE_START;
       gc.weightx = 1.0;
       panel.add(c, gc);
     }
   }
 
   /**
    * Loads an icon as a class resource.
    *
    * @param c    The class to use for resource search
    * @param name The name of the resource containing the icon
    * @return     The icon
    */
   public static Icon loadIcon(Class c, String name) {
     URL url = (c == null)
               ? Thread.currentThread().getContextClassLoader().getResource(name)
               : c.getResource(name);
     return new ImageIcon(url);
   }
 
   /**
    * Shows a "standard" error dialog box.
    *
    * @param message The error message. Should be already internationalized
    * @param e       The exception that causes this dialog box to be shown
    */
   public static void showError(String message, Exception e) {
     String title = UI.getString("messages.error");
 
     // If there is a "printable" reason, appends it to the message
     String msg = e.getMessage();
     if (msg == null && e.getCause() != null) {
       msg = e.getCause().getMessage();
     }
     if (msg != null) {
       msg = msg.trim();
       if (!msg.equals("")) {
         message += "\n\n      " + msg;
       }
     }
 
     // Shows the dialog box
     JOptionPane.showMessageDialog(null, message, title, JOptionPane.ERROR_MESSAGE);
   }
 
   /**
    * Shows a warning message.
    *
    * @param message The message key
    * @param e The exception causing this message.
    */
   public static void showWarning(String message, Exception e) {
     String title = UI.getString("messages.warning");
 
     // If there is a "printable" reason, appends it to the message
     String reason = e.getMessage();
     if (reason == null && e.getCause() != null) {
       reason = e.getCause().getMessage();
     }
     if (reason != null) {
       reason = reason.trim();
       if (!reason.equals("")) {
         message += "\n\nReason: " + reason;
       }
     }
 
     // Shows the dialog box
     JOptionPane.showMessageDialog(null, message, title, JOptionPane.WARNING_MESSAGE);
   }
 
   /**
    * Shows a information message.
    *
    * @param message The message key
    *
    */
   public static void showInformation(String message) {
     String title = UI.getString("messages.information");
     // Shows the dialog box
     JOptionPane.showMessageDialog(null, message, title, JOptionPane.INFORMATION_MESSAGE);
   }
 }