/*

  * $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 - 2007 the Initial Developer. 

  * All Rights Reserved.

  *

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

  */

 package org.xmlhammer.gui.help;

 import java.awt.BorderLayout;

 import java.awt.Dimension;

 import java.awt.FlowLayout;

 import java.awt.Font;

 import java.awt.event.ActionEvent;

 import java.awt.event.ActionListener;

 import java.awt.event.MouseEvent;

 import java.net.URISyntaxException;

 import java.net.URL;

 import javax.help.DefaultHelpModel;

 import javax.help.HelpSet;

 import javax.help.IndexItem;

 import javax.help.InvalidHelpSetContextException;

 import javax.help.JHelpContentViewer;

 import javax.help.JHelpIndexNavigator;

 import javax.help.JHelpSearchNavigator;

 import javax.help.JHelpTOCNavigator;

 import javax.help.Map;

 import javax.help.SearchTOCItem;

 import javax.help.TOCItem;

 import javax.help.TOCView;

 import javax.help.Map.ID;

 import javax.help.event.HelpModelEvent;

 import javax.help.event.HelpModelListener;

 import javax.help.plaf.basic.BasicContentViewerUI;

 import javax.help.plaf.basic.BasicSearchCellRenderer;

 import javax.help.plaf.basic.BasicTOCCellRenderer;

 import javax.swing.Box;

 import javax.swing.DefaultButtonModel;

 import javax.swing.Icon;

 import javax.swing.ImageIcon;

 import javax.swing.JButton;

 import javax.swing.JComponent;

 import javax.swing.JLabel;

 import javax.swing.JPanel;

 import javax.swing.JToolBar;

 import javax.swing.JTree;

 import javax.swing.border.EmptyBorder;

 import javax.swing.border.EtchedBorder;

 import javax.swing.event.AncestorEvent;

 import javax.swing.event.AncestorListener;

 import javax.swing.tree.DefaultMutableTreeNode;

 import javax.swing.tree.TreePath;

 import org.apache.log4j.Logger;

 import org.bounce.CardPanel;

 import org.bounce.ResizingFlowLayout;

 import org.bounce.RunnableAction;

 import org.bounce.event.DoubleClickListener;

 import org.bounce.image.ImageLoader;

 import org.xmlhammer.gui.util.ExternalApplicationLauncher;

 import org.xmlhammer.gui.util.HistoryList;

 public class HelpPanel extends JPanel {

     private static final long serialVersionUID = -2000362072449326907L;

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

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

     private static final ImageIcon TOC_LEAF_ICON = ImageLoader.get().getImage("/org/xmlhammer/gui/icons/obj16/searchhit_obj.gif");

     private static final ImageIcon TOC_TOPIC_ICON = ImageLoader.get().getImage("/org/xmlhammer/gui/icons/obj16/container_obj.gif");

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

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

     private static final ImageIcon HELP_VIEW_ICON = ImageLoader.get().getImage("/org/xmlhammer/gui/icons/view16/help_view.gif");

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

     private HistoryList<HistoryItem> historyList = null;

     private HelpSet helpset = null;

     private JHelpContentViewer contextViewer = null;

     private JHelpContentViewer basicViewer = null;

     private JHelpSearchNavigator searchNavigator = null;

     private JHelpTOCNavigator tocNavigator = null;

     private JHelpIndexNavigator indexNavigator = null;

     private CardPanel<JComponent> cardPanel = null;

     private PreviousAction previousAction = null;

     private NextAction nextAction = null;

     private JButton closeButton = null;

     public HelpPanel() {

         super(new BorderLayout());

         setMinimumSize(new Dimension(0, 0));

         historyList = new HistoryList<HistoryItem>();

         cardPanel = new CardPanel<JComponent>();

         JToolBar toolbar = new JToolBar();

         toolbar.setRollover( true);

         toolbar.setFloatable( false);

         JLabel label = new JLabel("Help", HELP_VIEW_ICON, JLabel.HORIZONTAL);

         label.setFont(label.getFont().deriveFont(Font.PLAIN));

         toolbar.add(label);

         toolbar.add(Box.createHorizontalGlue());

         nextAction = new NextAction();

         previousAction = new PreviousAction();

         toolbar.add(new HomeAction());

         toolbar.addSeparator();

         toolbar.add(previousAction);

         toolbar.add(nextAction);

         toolbar.addSeparator();

         closeButton = toolbar.add(new CloseAction());

         closeButton.setRolloverIcon(CLOSE_OVER_ICON);

         HelpSet set = getHelpSet();

         if (getHelpSet() != null) {

             try {

                 contextViewer = new JHelpContentViewer(set);

                 contextViewer.setUI(new ContentViewerUI(contextViewer));

                 contextViewer.getModel().addHelpModelListener(new HelpModelListener() {

                     public void idChanged(HelpModelEvent event) {

                         putHistory(event.getID(), contextViewer);

                     }

                 });

                 cardPanel.add(contextViewer);

                 basicViewer = new JHelpContentViewer(set);

                 basicViewer.setUI(new ContentViewerUI(basicViewer));

                 basicViewer.getModel().addHelpModelListener(new HelpModelListener() {

                     public void idChanged(HelpModelEvent event) {

                         putHistory(event.getID(), basicViewer);

                     }

                 });

                 cardPanel.add(basicViewer);

                 searchNavigator = (JHelpSearchNavigator)set.getNavigatorView("Search").createNavigator(new DefaultHelpModel(set));

                 searchNavigator.updateUI();

                 JTree tree = getTree(searchNavigator);

                 tree.setCellRenderer(new BasicSearchCellRenderer(set.getCombinedMap()));

                 tree.updateUI();

                 tree.addMouseListener(new DoubleClickListener() {

                     public void doubleClicked(MouseEvent event) {

                         TreePath path = ((JTree)event.getSource()).getSelectionPath();

                         if (path != null) {

                             SearchTOCItem item = (SearchTOCItem)((DefaultMutableTreeNode)path.getLastPathComponent()).getUserObject();

                             ID id = item.getID();

                             if (item.getID() == null && item.getURL() != null) {

                                 Map map = getHelpSet().getLocalMap();

                                 id = map.getClosestID(item.getURL());

                             }

                             if (id != null) {

                                 putHistory(id, basicViewer);

                                 historyList.setEnabled(false);

                                 try {

                                     basicViewer.setCurrentID(id);

                                     cardPanel.show(basicViewer);

                                 } catch (InvalidHelpSetContextException e) {

                                     Logger.getLogger(getClass()).debug(null, e);

                                 } finally {

                                     historyList.setEnabled(true);

                                 }

                                 cardPanel.show(basicViewer);

                             }

                         }

                     }

                 });

                 cardPanel.add(searchNavigator);

                 indexNavigator = (JHelpIndexNavigator)set.getNavigatorView("Index").createNavigator(new DefaultHelpModel(set));

                 tree = getTree(indexNavigator);

                 tree.addMouseListener(new DoubleClickListener() {

                     public void doubleClicked(MouseEvent event) {

                         TreePath path = ((JTree)event.getSource()).getSelectionPath();

                         if (path != null) {

                             IndexItem item = (IndexItem)((DefaultMutableTreeNode)path.getLastPathComponent()).getUserObject();

                             ID id = item.getID();

                             if (item.getID() == null && item.getURL() != null) {

                                 Map map = getHelpSet().getLocalMap();

                                 id = map.getClosestID(item.getURL());

                             }

                             if (id != null) {

                                 putHistory(id, basicViewer);

                                 historyList.setEnabled(false);

                                 try {

                                     basicViewer.setCurrentID(id);

                                 } catch (InvalidHelpSetContextException e) {

                                     Logger.getLogger(getClass()).debug(null, e);

                                 } finally {

                                     historyList.setEnabled(true);

                                 }

                                 cardPanel.show(basicViewer);

                             }

                         }

                     }

                 });

                 cardPanel.add(indexNavigator);

                 tocNavigator = (JHelpTOCNavigator)set.getNavigatorView("TOC").createNavigator(new DefaultHelpModel(set));

                 tree = getTree(tocNavigator);

                 tree.setCellRenderer(new TOCCellRenderer(getHelpSet().getCombinedMap()));

                 tree.addMouseListener(new DoubleClickListener() {

                     public void doubleClicked(MouseEvent event) {

                         TreePath path = ((JTree)event.getSource()).getSelectionPath();

                         if (path != null) {

                             TOCItem item = (TOCItem)((DefaultMutableTreeNode)path.getLastPathComponent()).getUserObject();

                             putHistory(item.getID(), basicViewer);

                             historyList.setEnabled(false);

                             try {

                                 basicViewer.setCurrentID(item.getID());

                             } catch (InvalidHelpSetContextException e) {

                                 Logger.getLogger(getClass()).debug(null, e);

                             } finally {

                                 historyList.setEnabled(true);

                             }

                             cardPanel.show(basicViewer);

                         }

                     }

                 });

                 cardPanel.add(tocNavigator);

     //            JTabbedPane tabs = new JTabbedPane();

     //            tabs.setFont(tabs.getFont().deriveFont(Font.PLAIN));

                 JPanel main = new JPanel(new BorderLayout());

                 main.setBorder(new EmptyBorder(2, 5, 0, 5));

                 main.add(cardPanel, BorderLayout.CENTER);

                 JPanel panel = new JPanel(new BorderLayout());

                 setBorder(new EtchedBorder());

     //                    new CompoundBorder(

     //                            new MatteBorder(0, 0, 1, 1, SystemColor.controlDkShadow),

     //                            new MatteBorder( 1, 1, 0, 0, SystemColor.controlLtHighlight)));

                 panel.add(main, BorderLayout.CENTER);

                 JPanel buttonPanel = new JPanel();

                 buttonPanel.setLayout(new ResizingFlowLayout(FlowLayout.LEFT));

                 buttonPanel.setBorder(new EmptyBorder(5, 0, 5, 0));

                 JButton tocButton = new JButton("TOC", ALL_TOPICS_ICON);

                 tocButton.addActionListener(new ActionListener() {

                     public void actionPerformed(ActionEvent event) {

                         showTOC();

                     }

                 });

                 tocButton.setFont(tocButton.getFont().deriveFont(Font.PLAIN));

                 buttonPanel.add(tocButton);

                 JButton searchButton = new JButton("Search", SEARCH_ICON);

                 searchButton.addActionListener(new ActionListener() {

                     public void actionPerformed(ActionEvent event) {

                         showSearch();

                     }

                 });

                 searchButton.setFont(searchButton.getFont().deriveFont(Font.PLAIN));

                 buttonPanel.add(searchButton);

                 JButton indexButton = new JButton("Index", INDEX_ICON);

                 indexButton.addActionListener(new ActionListener() {

                     public void actionPerformed(ActionEvent event) {

                         showIndex();

                     }

                 });

                 indexButton.setFont(indexButton.getFont().deriveFont(Font.PLAIN));

                 buttonPanel.add(indexButton);

                 panel.add(buttonPanel, BorderLayout.SOUTH);

                 main.add(toolbar, BorderLayout.NORTH);

     //            tabs.addTab("Help", HELP_VIEW_ICON, panel);

                 add(panel, BorderLayout.CENTER);

                 historyList.reset();

                 // Set the initial item.

                 putHistory(null, cardPanel.selected());

             } catch (Exception e) {

                 Logger.getLogger(getClass()).debug(null, e);

             }

         }

         this.addAncestorListener(new AncestorListener() {

             public void ancestorAdded(AncestorEvent event) {}

             public void ancestorMoved(AncestorEvent event) {}

             public void ancestorRemoved(AncestorEvent event) {

                 ((DefaultButtonModel)closeButton.getModel()).setRollover(false);

             }

         });

     }

     public void showID(String id) {

         showID(id, false);

     }

     public void addCloseActionListener(ActionListener listener) {

         closeButton.addActionListener(listener);

     }

     public void removeCloseActionListener(ActionListener listener) {

         closeButton.removeActionListener(listener);

     }

     public void showContext() {

         if (!contextViewer.isVisible()) {

             putHistory(contextViewer.getModel().getCurrentID(), contextViewer);

             cardPanel.show(contextViewer);

         }

     }

     public void showContents() {

         Map.ID id = getHelpSet().getHomeID();

         if (basicViewer.getModel().getCurrentID() == null || !basicViewer.getModel().getCurrentID().equals(id)) {

             putHistory(id, basicViewer);

             historyList.setEnabled(false);

             try {

                 basicViewer.setCurrentID(id);

             } catch (InvalidHelpSetContextException e) {

                 Logger.getLogger(getClass()).debug(null, e);

             } finally {

                 historyList.setEnabled(true);

             }

         }

         cardPanel.show(basicViewer);

     }

     public void showQuickStart() {

         Map.ID id = Map.ID.create("quick-start", getHelpSet());

         if (basicViewer.getModel().getCurrentID() == null || !basicViewer.getModel().getCurrentID().equals(id)) {

             putHistory(id, basicViewer);

             historyList.setEnabled(false);

             try {

                 basicViewer.setCurrentID(id);

             } catch (InvalidHelpSetContextException e) {

                 Logger.getLogger(getClass()).debug(null, e);

             } finally {

                 historyList.setEnabled(true);

             }

         }

         cardPanel.show(basicViewer);

     }

     public void showSearch() {

         if (cardPanel.selected() != searchNavigator) {

             putHistory(null, searchNavigator);

             cardPanel.show(searchNavigator);

         }

     }

     public void showIndex() {

         if (cardPanel.selected() != indexNavigator) {

             putHistory(null, indexNavigator);

             cardPanel.show(indexNavigator);

         }

     }

     public void showTOC() {

         if (cardPanel.selected() != tocNavigator) {

             putHistory(null, tocNavigator);

             cardPanel.show(tocNavigator);

         }

     }

     public void show(HistoryItem item) {

         cardPanel.show(item.getCard());

         historyList.setEnabled(false);

         try {

             if (item.getCard() == contextViewer) {

                 contextViewer.setCurrentID(item.getID());

             } else if (item.getCard() == basicViewer) {

                 basicViewer.setCurrentID(item.getID());

             }

         } catch (InvalidHelpSetContextException e) {

             Logger.getLogger(getClass()).debug(null, e);

         } finally {

             historyList.setEnabled(true);

         }

     }

     private void updateActions() {

         previousAction.setEnabled(historyList.hasPrevious());

         nextAction.setEnabled(historyList.hasNext());

     }

     /**

      * @param id the id for the 

      * @param showViewer

      */

     public void showID(String idString, boolean showViewer) {

         ID id = Map.ID.create(idString, getHelpSet());

         if (contextViewer != null) {

             try {

                 historyList.setEnabled(false);

                 contextViewer.setCurrentID(id);

                 if (contextViewer.isVisible() && contextViewer.getModel().getCurrentID().equals(id)) {

                     putHistory(id, contextViewer);

                 }

                 if (showViewer) {

                     showContext();

                 }

             } catch (InvalidHelpSetContextException e) {

                 Logger.getLogger(getClass()).debug("Cannot set ID", e);

             } finally {

                 historyList.setEnabled(true);

             }

         }

     }

     private HelpSet getHelpSet() {

         if (helpset == null) {

             try {

                 URL url = getClass().getResource("/help/jhelpset.hs"); 

                 Logger.getLogger(getClass()).debug("HelpSet URL: " + url);

                 if (url != null) {

                     helpset = new HelpSet(getClass().getClassLoader(), url);

                 }

             } catch (Exception e) {

                 Logger.getLogger(getClass()).debug(null, e);

             }

         }

         return helpset;

     }

     private JTree getTree(JComponent comp) {

         JTree tree = null;

         if (comp instanceof JTree) {

             tree = (JTree)comp;

         }

         for (int i = 0; i < comp.getComponentCount() && tree == null; i++) {

             if (comp.getComponent(i) instanceof JComponent) {

                 tree = getTree((JComponent)comp.getComponent(i));

             }

         }

         return tree;

     }

     private void putHistory(ID id, JComponent card) {

         if (card != null && id != null) {

             historyList.put(new HistoryItem(id, card));

             updateActions();

         }

     }

     private class HistoryItem {

         private ID id = null;

         private JComponent card = null;

         public HistoryItem(ID id, JComponent card) {

             this.id = id;

             this.card = card;

         }

         public ID getID() {

             return id;

         }

         public JComponent getCard() {

             return card;

         }

         public String toString() {

             return "["+card.getClass().getName()+"] "+id;

         }

     }

     private class NextAction extends RunnableAction {

         private static final long serialVersionUID = 3258134648029526321L;

         public NextAction() {

             super("Next");

             putValue(SHORT_DESCRIPTION, "Next Help Item");

             putValue(SMALL_ICON, new ImageIcon( getClass().getResource( "/org/xmlhammer/gui/icons/elcl16/forward_nav.gif")));

         }

         public void run() {

             show(historyList.next());

             updateActions();

         }

     }

     private class PreviousAction extends RunnableAction {

         private static final long serialVersionUID = 3258134648029526321L;

         public PreviousAction() {

             super("Previous");

             putValue(SHORT_DESCRIPTION, "Next Help Item");

             putValue(SMALL_ICON, new ImageIcon( getClass().getResource( "/org/xmlhammer/gui/icons/elcl16/backward_nav.gif")));

         }

         public void run() {

             show(historyList.previous());

             updateActions();

         }

     }

     private class HomeAction extends RunnableAction {

         private static final long serialVersionUID = 3258134648029526321L;

         public HomeAction() {

             super("Home");

             putValue(SHORT_DESCRIPTION, "Index Page");

             putValue(SMALL_ICON, new ImageIcon( getClass().getResource( "/org/xmlhammer/gui/icons/elcl16/home_nav.gif")));

         }

         public void run() {

             showContents();

         }

     }

     private class CloseAction extends RunnableAction {

         private static final long serialVersionUID = 3258134648029526321L;

         public CloseAction() {

             super("Close");

             putValue(SHORT_DESCRIPTION, "Close Help View");

             putValue(SMALL_ICON, CLOSE_ICON);

         }

         public void run() {

             // handled by external action listeners ...

         }

     }

     private class TOCCellRenderer extends BasicTOCCellRenderer {

         private static final long serialVersionUID = 6850877407883209757L;

         public TOCCellRenderer(Map map1, TOCView tocview) {

             super(map1, tocview);

         }

         public TOCCellRenderer(Map map1) {

             super(map1);

         }

         public Icon getLeafIcon() {

             return TOC_LEAF_ICON;

         }

         public Icon getOpenIcon() {

             return TOC_TOPIC_ICON;

         }

         public Icon getClosedIcon() {

             return TOC_TOPIC_ICON;

         }

     }