/*
    *  XNap - A P2P framework and client.
    *
    *  See the file AUTHORS for copyright information.
    *
    *  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.
    *
   *  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 org.xnap.gui;
  
  import java.awt.BorderLayout;
  import java.awt.Font;
  import java.util.Iterator;
  import java.util.LinkedList;
  
  import javax.swing.Icon;
  import javax.swing.JComponent;
  import javax.swing.JLabel;
  import javax.swing.JPanel;
  import javax.swing.JScrollPane;
  import javax.swing.JTabbedPane;
  import javax.swing.border.EmptyBorder;
  
  import org.xnap.gui.component.DefaultDialog;
  import org.xnap.gui.component.IconSplitPane;
  import org.xnap.gui.util.GUIHelper;
  import org.xnap.gui.util.IconHelper;
  
  /***
   * Provides an abstract preferences dialog.
   */
  public abstract class AbstractPreferencesDialog extends DefaultDialog {
      
      //--- Data field(s) ---
  
      private IconSplitPane pane;
      private LinkedList panels = new LinkedList();
  
      private boolean canClose;
      private boolean needToRestartXNap = false;
  
      //--- Constructor(s) ---
  
      public AbstractPreferencesDialog(String title) 
      {
  		super(BUTTON_HELP | BUTTON_CONTEXT_HELP| BUTTON_OKAY | BUTTON_APPLY 
  			  | BUTTON_CANCEL);
  	
  		// icon panel
  		pane = new IconSplitPane();
  		pane.setBorder(GUIHelper.createEmptyBorder());
  		pane.setDividerSize(2);
  		pane.setOneTouchExpandable(false);
  
  		// content
          setTitle(title);
  		getMainPanel().setLayout(new BorderLayout());
  		getMainPanel().add(pane, BorderLayout.CENTER);
      }
  
      // --- Methods ---
  
      /***
       * Adds <code>tab</code> to the list. Sets an
       * appropriate border for <code>tab</code> and wraps it into a
       * {@link JScrollPane}.
       */
      public JPanel addPanel(SettingsPanel tab)
      {
  		return addPanel(tab, tab.getTitle(), tab.getIcon(), 
  						tab.getDescription());
      }
  
      /***
       * Adds <code>tab</code> to the list. Sets an
       * appropriate border for <code>tab</code> and wraps it into a
       * {@link JScrollPane}.
       */
      public JPanel addPanel(SettingsPanel tab, String icon)
      {
  		return addPanel(tab, tab.getTitle(), IconHelper.getTabTitleIcon(icon), 
  						tab.getDescription());
      }
  
      /***
       * Adds <code>tab</code> to the list. Sets an
       * appropriate border for <code>tab</code> and wraps it into a
       * {@link JScrollPane}.
      */
     public JPanel addPanel(SettingsPanel tab, String title, Icon icon, 
 						   String info)
     {
 		panels.add(tab.getPanel());
 		tab.getPanel().setBorder(new EmptyBorder(10, 10, 10, 10));
 		JScrollPane jsp = new JScrollPane(tab.getPanel());
 		jsp.setBorder(GUIHelper.createEmptyBorder());
 
 		return addPanel(jsp, title, icon, info);
     }
 
     /***
      * Wraps <code>jc</code> in an info panel and adds it to the list.
      */
     public JPanel addPanel(JComponent jc, String title, String icon, 
 						   String info)
     {
 		return addPanel(jc, title, IconHelper.getTabTitleIcon(icon), info);
     }
 
     /***
      * Wraps <code>jc</code> in an info panel and adds it to the list.
      */
     public JPanel addPanel(JComponent jc, String title, Icon icon, String info)
     {
 		JPanel jp = new JPanel(new BorderLayout());
 		pane.addTab(title, icon, jp);
 
 		JLabel jlInfo = new JLabel(info);
 		jlInfo.setFont(new Font("Dialog", Font.BOLD, 12));
 		jlInfo.setBorder(new EmptyBorder(5, 5, 5, 5));
 		jp.add(jlInfo, BorderLayout.NORTH);
 
 		jp.add(jc, BorderLayout.CENTER);
 
 		return jp;
     }
 
     /***
      * Adds <code>tab</code> to <code>parent</code>. Sets an
      * appropriate border for <code>tab</code> and wraps it into a
      * {@link JScrollPane}.
      */
     public JScrollPane addTab(JTabbedPane parent, SettingsPanel tab)
     {
 		panels.add(tab.getPanel());
 		tab.getPanel().setBorder(new EmptyBorder(10, 10, 10, 10));
 		JScrollPane jsp = new JScrollPane(tab.getPanel());
 		jsp.setBorder(GUIHelper.createEmptyBorder());
 		parent.addTab(tab.getTitle(), jsp);
 
 		return jsp;
     }
 
 
     public boolean apply()
     {
 		// panels
 		boolean canClose = true;
 		for (Iterator i = panels.iterator(); i.hasNext();) {
 			try {
 				((SettingsPanel)i.next()).apply();
 			}
 			catch (Exception e) {
 				canClose = false;
 				Dialogs.error(this, e.getLocalizedMessage());
 			}
 		}
 
 		return canClose;
     }
 
     /***
      * Removes <code>jp</code> from the list.
      */
     public void remove(JPanel jp)
     {
 		pane.remove(jp);
     }
 
     /***
      * Removes <code>tab</code> from the list of {@link SettingsPanel} 
      * objects. After this method has been invoked, <code>tab.apply()</code>
      * is not called when the dialog is closed.
      */
     public void remove(SettingsPanel tab)
     {
 		panels.remove(tab);
     }
 
 }