/*

  * $Id$

  *

  * The contents of this file are subject to the Mozilla Public License 

  * Version 1.1 (the "License"); you may not use this file except in 

  * compliance with the License. You may obtain a copy of the License at 

  * http://www.mozilla.org/MPL/ 

  *

  * Software distributed under the License is distributed on an "AS IS" basis, 

  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 

  * for the specific language governing rights and limitations under the License.

  *

  * The Original Code is XML Hammer code. (org.xmlhammer.*)

  *

  * The Initial Developer of the Original Code is Edwin Dankert. Portions created 

  * by the Initial Developer are Copyright (C) 2005 - 2006 the Initial Developer. 

  * All Rights Reserved.

  *

  * Contributor(s): Edwin Dankert <edankert@gmail.com>

  */

 package org.xmlhammer.gui.util.preferences;

 import java.awt.BorderLayout;

 import java.awt.Component;

 import java.awt.Dimension;

 import java.awt.FlowLayout;

 import java.awt.Frame;

 import java.awt.Point;

 import java.awt.event.ActionEvent;

 import java.awt.event.ActionListener;

 import java.awt.event.KeyEvent;

 import javax.swing.AbstractAction;

 import javax.swing.ImageIcon;

 import javax.swing.JButton;

 import javax.swing.JComponent;

 import javax.swing.JOptionPane;

 import javax.swing.JPanel;

 import javax.swing.JSplitPane;

 import javax.swing.JTable;

 import javax.swing.KeyStroke;

 import javax.swing.UIManager;

 import javax.swing.border.CompoundBorder;

 import javax.swing.border.MatteBorder;

 import javax.swing.plaf.basic.BasicSplitPaneUI;

 import org.bounce.event.CardEvent;

 import org.bounce.event.CardPanelAdapter;

 import org.bounce.image.ImageLoader;

 import org.bounce.preferences.PreferencesDialog;

 import org.bounce.preferences.PreferencesPage;

 import org.xmlhammer.gui.help.HelpPanel;

 /**

  * JAXP Properties ...

  * 

  * @version $Revision$, $Date$

  * @author Edwin Dankert <edankert@gmail.com>

  */

 public class HelpEnabledPreferencesDialog extends PreferencesDialog {

         private static final long serialVersionUID = -7403432397234000652L;

     public static final int OK_OPTION = JOptionPane.OK_OPTION;

     public static final int CANCEL_OPTION = JOptionPane.CANCEL_OPTION;

     private static final ImageIcon HELP_ICON = ImageLoader.get().getImage("/org/xmlhammer/gui/icons/etool16/help.gif");

     private static Dimension size = null;

     private static Point position = null;

     private JSplitPane helpSplit = null;

     private HelpPanel helpPanel = null;

     // initialised

     private JButton helpButton;

     private JPanel main;

         /**

          * @param parent

          * @throws java.awt.HeadlessException

          */

         public HelpEnabledPreferencesDialog(Frame parent, String title) {

                 super(parent, title);

         getCards().addCardPanelListener(new CardPanelAdapter<PreferencesPage>() {

             public void cardChanged(CardEvent<PreferencesPage> event) {

                 getHelpPanel().showID(((HelpEnabledPreferencesPage)event.getCard()).getHelpID());

             }

         });

         getRootPane().getActionMap().put("helpAction", new AbstractAction() {

             private static final long serialVersionUID = -6931927193561857562L;

             public void actionPerformed(ActionEvent e) {

                 showHelpPanel();

             }

         });

         getRootPane().getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(KeyStroke.getKeyStroke(KeyEvent.VK_F1, 0, false), "helpAction");

         size = new Dimension( 674, 534);

         }

     private JButton getHelpButton() {

         if (helpButton == null) {

             helpButton = new JButton("Help", HELP_ICON);

             helpButton.addActionListener(new ActionListener() {

                 public void actionPerformed(ActionEvent arg0) {

                     showHelpPanel();

                 }

             });

         }

         return helpButton;

     }

     @Override

     protected JPanel createSouthPanel() {

         JPanel helpButtonPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));

         helpButtonPanel.add(getHelpButton());

         JPanel southPanel = super.createSouthPanel();

         southPanel.add(helpButtonPanel, BorderLayout.WEST);

         return southPanel;

     }

     protected JPanel createCenterPanel() {

         main = super.createCenterPanel();

         return main;

     }

     /**

      * Show the help panel (preferred-size) if not already shown.

      */

     public void showHelpPanel() {

         HelpPanel helpPanel = getHelpPanel();

         if (helpSplit == null) {

             this.setSize(new Dimension(getSize().width + helpPanel.getPreferredSize().width, getSize().height));

             helpSplit = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT, main, helpPanel);

             helpSplit.setResizeWeight(1);

             helpSplit.setOneTouchExpandable(true);

             Object ui = helpSplit.getUI();

             if (ui instanceof BasicSplitPaneUI) {

                 ((BasicSplitPaneUI)ui).getDivider().setBorder(

                         new CompoundBorder(

                             new CompoundBorder(

                                   new MatteBorder(0, 1, 0, 0, UIManager.getColor("controlDkShadow")),

                                   new MatteBorder( 0, 0, 0, 1, UIManager.getColor("controlLtHighlight"))),

                             new CompoundBorder(

                                   new MatteBorder(0, 0, 0, 1, UIManager.getColor("controlDkShadow")),

                                   new MatteBorder( 0, 1, 0, 0, UIManager.getColor("controlLtHighlight")))));

             }

             helpSplit.setBorder(null);

             JPanel contentPane = (JPanel)getContentPane();

             contentPane.add(helpSplit, BorderLayout.CENTER);

             helpSplit.revalidate();

             helpSplit.repaint();

             contentPane.revalidate();

             contentPane.repaint();

             validate();

             repaint();

         }

         if (!helpPanel.isVisible() || helpPanel.getSize().width < 10) { // let's use a number a little bigger than 0

             helpSplit.setDividerLocation(helpSplit.getDividerLocation() - helpPanel.getPreferredSize().width);

         }

         helpPanel.showContext();

     }

     public void hideHelpPanel() {

         helpSplit = null;

         this.setSize(new Dimension(getSize().width - getHelpPanel().getPreferredSize().width, getSize().height));

         JPanel contentPane = (JPanel)getContentPane();

         contentPane.removeAll();

         contentPane.add(main, BorderLayout.CENTER);

         contentPane.revalidate();

         contentPane.repaint();

         validate();

         repaint();

         helpButton.requestFocusInWindow();

     }

     private HelpPanel getHelpPanel() {

         if (helpPanel == null) {

             helpPanel = new HelpPanel();

             helpPanel.setBorder(null);

             helpPanel.addCloseActionListener(new ActionListener() {

                 public void actionPerformed(ActionEvent arg0) {

                     hideHelpPanel();

                 }

             });

         }

         return helpPanel;

     }

     public void close() {

         size = getSize();

         position = getLocation();

         super.close();

     }

     public void cancel() {

         // Just to make sure the table is no longer edited. 

         // Causing bug 1552429

         Component comp = getFocusOwner();

         if (comp instanceof JTable && ((JTable)comp).getCellEditor() != null) {

             ((JTable)comp).getCellEditor().stopCellEditing();

         }

         size = getSize();

         position = getLocation();

         super.cancel();

     }

     public int getSelectedOption() {

         if (isCancelled()) {

             return JOptionPane.CANCEL_OPTION;

         }

         return JOptionPane.OK_OPTION;

     }

     /**

      * @return whether the properties should be stored.

      */

     public int open() { 

         restore();

         setVisible(true);

         return getSelectedOption();

     }

     /**

      * Restores to previous position and size.

      */

     public void restore() { 

         this.setSize(size);

         if (position == null) {

             setLocationRelativeTo(getParent());

         } else {

             setLocation(position);

         }

     }

 }