/*

  * $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.wizard;

 import java.awt.BorderLayout;

 import java.awt.Dimension;

 import java.awt.FlowLayout;

 import java.awt.Frame;

 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.JPanel;

 import javax.swing.JSplitPane;

 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.wizard.Wizard;

 import org.bounce.wizard.WizardPage;

 import org.xmlhammer.gui.help.HelpPanel;

 public abstract class HelpEnabledWizard extends Wizard {

     private static final long serialVersionUID = 7119005231853816073L;

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

     private static final int WIZARD_WIDTH = 500;

     private static final int MINIMUM_WIZARD_HEIGHT = 500;

     private HelpPanel helpPanel = null;

     private JSplitPane helpSplit = null;

     // Initialised by parent.

     private JButton helpButton;

     private JPanel main;

     public HelpEnabledWizard(Frame parent) {

         super(parent);

         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");

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

             public void cardChanged(CardEvent<WizardPage> event) {

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

             }

         });

         pack();

         setSize(new Dimension(WIZARD_WIDTH, Math.max(getSize().height, MINIMUM_WIZARD_HEIGHT)));

         setLocationRelativeTo(getParent());

     }

     protected JPanel createCenterPanel() {

         main = super.createCenterPanel();

         return main;

     }

     @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;

     }

     private JButton getHelpButton() {

         if (helpButton == null) {

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

             helpButton.addActionListener(new ActionListener() {

                 public void actionPerformed(ActionEvent arg0) {

                     showHelpPanel();

                 }

             });

         }

         return helpButton;

     }

     /**

      * 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.removeAll();

             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();

     }

     private void hideHelpPanel() {

         JButton helpButton = getHelpButton();

         helpButton.requestFocusInWindow();

         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;

     }

 }