Changeset 5521

Timestamp:

2003-09-19T13:47:47+12:00 (21 years ago)

Author:

mdewsnip

Message:

Rewrote to use the new XML help file and construct the contents automatically.

File:

• trunk/gli/src/org/greenstone/gatherer/help/HelpFrame.java (modified) (6 diffs)

trunk/gli/src/org/greenstone/gatherer/help/HelpFrame.java

@@ -8 +8 @@
  * <BR><BR>
  *
- * Author: John Thompson, Greenstone Digital Library, University of Waikato
+ * Principal Author: John Thompson, NZDL Project, University of Waikato
  *
  * <BR><BR>
@@ -36 +36 @@
  */
 
- 
-
-
-
-
 package org.greenstone.gatherer.help;
+
 /**
- * Title:        The Gatherer<br>
- * Description:  The Gatherer: a tool for gathering and enriching digital collections.<br>
- * Copyright:    Copyright (c) 2001<br>
- * Company:      The University of Waikato<br>
- * @author John Thompson, Greenstone Digital Libraries
- * @version 2.1
+ * @author Michael Dewsnip, NZDL Project
  */
 import calpa.html.*; 
-import java.awt.*;
+import java.awt.BorderLayout;
+import java.awt.Dimension;
+import java.awt.Toolkit;
 import java.io.File;
 import java.net.URL;
-import java.util.StringTokenizer;
-import javax.swing.BorderFactory;
+import java.util.Enumeration;
 import javax.swing.JFrame;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.JSplitPane;
-import javax.swing.JTabbedPane;
 import javax.swing.JTree;
 import javax.swing.event.TreeSelectionEvent;
 import javax.swing.event.TreeSelectionListener;
+import javax.swing.tree.DefaultTreeModel;
+import javax.swing.tree.DefaultMutableTreeNode;
+import javax.swing.tree.MutableTreeNode;
 import javax.swing.tree.TreePath;
-import org.greenstone.gatherer.help.ContentModel;
-import org.greenstone.gatherer.help.HelpItem;
-/** This class provides a nice help facility for the Gatherer tool. It
- * is a separate frame that can be positioned as the user wishes, and provides
- * standard help-type functionality such as contents, index and search, 
- * glossary and of course help descriptions. <BR>
+import org.apache.xerces.parsers.DOMParser;
+import org.greenstone.gatherer.util.Utility;
+import org.w3c.dom.*;
+
+
+/**
+ * This class provides a nice help facility. It is a separate frame that can be positioned
+ * as the user wishes, and provides a contents page and the help information.
  */
 public class HelpFrame 
     extends JFrame {
-    /** The html rendering pane. */
+
+    /** The HTML rendering pane */
     private CalHTMLPane view = null;
-    private ContentModel model = null;
-     
+    /** The contents tree model */
+    private ContentsModel model = null;
+    /** A contents tree for the top of the frame */
+    private JTree contents = null;
+
     private JSplitPane split_pane = null;
-    /** A contents tree for the left of the frame. */
-    private JTree contents = null;
-
-    private Observer observer = null;
-
-    /** The size of a button on this pane. */
-    static final Dimension BUTTON_SIZE = new Dimension(100,50);
-    /** The minimum size of any component in this frame. */
-    static final Dimension MIN_SIZE = new Dimension(100,100);
-    /** The size of the frame itself. */
-    static final Dimension SIZE = new Dimension(760,560);
-    /** Constructor.
-     * @param file_name The file name, as a <Strong>String</strong> of the help page to initially show.
-      */
-    public HelpFrame() { 
-    setDefaultCloseOperation(HIDE_ON_CLOSE); 
+
+    /** The size of the frame */
+    static final Dimension SIZE = new Dimension(760, 560);
+
+
+    public HelpFrame()
+    {
+    setDefaultCloseOperation(HIDE_ON_CLOSE);
     setSize(SIZE);
-    model = new ContentModel();
-    contents = new JTree(model);
+
+    view = new CalHTMLPane(new CalHTMLPreferences(), new Observer(), "Help Pages");
+
+    HelpItem rootNode = new HelpItem("Contents", "<null>");
+    model = new ContentsModel(rootNode);
+    contents = new JTree((DefaultTreeModel) model);
     contents.addTreeSelectionListener(new ContentsListener());
     contents.setExpandsSelectedPaths(true);
-    CalHTMLPreferences prefs = new CalHTMLPreferences();
-    observer = new Observer();
-    view = new CalHTMLPane(prefs, observer, "Help Pages");
 
     // Creation
@@ -109 +102 @@
     JScrollPane index_scroll = new JScrollPane(contents);
     JScrollPane view_scroll = new JScrollPane(view);
+
     // Layout
     split_pane.add(index_scroll, JSplitPane.LEFT);
@@ -114 +108 @@
     content_pane.setLayout(new BorderLayout());
     content_pane.add(split_pane, BorderLayout.CENTER);
+
     // Center
     Dimension screen_size = Toolkit.getDefaultToolkit().getScreenSize();
     setLocation((screen_size.width - SIZE.width) / 2, (screen_size.height - SIZE.height) / 2);        
     }
-    /** Destructor. Removes all listeners, closes streams and explicitly sets data members to null. */
-    public void destroy() {
+
+
+    public void destroy()
+    {
     view = null;
     contents = null;
     }
-    public void setView(String index) {
-    try {
-                // Retrieve the node at index
-        HelpItem current = (HelpItem) model.getRoot();
-        StringTokenizer tokenizer = new StringTokenizer(index, ".");
-        while(tokenizer.hasMoreTokens()) {
-        String token = tokenizer.nextToken();
-        int position = Integer.parseInt(token);
-        if(position > 0 && position <= current.getChildCount()) {
-            current = (HelpItem) current.getChildAt(position - 1);
-        }
-        token = null;
-        }
-        tokenizer = null;
-                // Ensure path is selected
-        TreePath path = new TreePath(current.getPath());
-        contents.setSelectionPath(path);
-        contents.scrollPathToVisible(path);
-        path = null;
-                // Build url
-        URL url = current.getURL();
-        current = null;
-                // Show help dialog
-        show();
-        split_pane.setDividerLocation(0.2);
-                // Display help page
-        if(url != null) {
-        view.showHTMLDocument(url);
-        }
-        url = null;
-    }
-    catch (Exception error) {
-        show();
-        split_pane.setDividerLocation(0.2);
-    }
-    }
-
-    /** This listener is used to lister for selection changes in the contents tree, and to show the appropriate page as required.
-      */
-    private class ContentsListener 
+
+
+    public void setView(String sectionName)
+    {
+    // Find the node in the tree with the specified sectionName
+    HelpItem node = model.getHelpItemNamed(sectionName);
+
+    // Ensure the node is selected and visible
+    TreePath path = new TreePath(node.getPath());
+    contents.setSelectionPath(path);
+    contents.scrollPathToVisible(path);
+
+    // Display the selected page
+    URL url = node.getURL();
+    if (url != null) {
+        view.showHTMLDocument(url);
+    }
+
+    // Make the help frame visible
+    show();
+    split_pane.setDividerLocation(0.2);
+    }
+
+
+    private class ContentsModel
+    extends DefaultTreeModel {
+
+    public ContentsModel(MutableTreeNode rootNode) {
+        super(rootNode);
+
+        // Load the XML help file and build the contents structure from it
+        try {
+        DOMParser parser = new DOMParser();
+        parser.parse(Utility.HELP_DIR + "help.xml");
+        Document document = parser.getDocument();
+
+        // Traverse the document hierarchy, building a tree representing its structure
+        Node documentNode = document.getFirstChild();
+        NodeList sections = documentNode.getChildNodes();
+        for (int i = 0; i < sections.getLength(); i++) {
+            Node section = sections.item(i);
+            buildContentsHierarchy(rootNode, section);
+        }
+        }
+        catch (Exception ex) {
+        ex.printStackTrace();
+        }
+    }
+
+
+    public void buildContentsHierarchy(MutableTreeNode parent, Node node)
+    {
+        // We're only interested in the Section nodes
+        if (!node.getNodeName().equals("Section")) {
+        return;
+        }
+
+        // Determine the section name
+        String sectionName = ((Element) node).getAttribute("name");
+
+        // Determine the section title
+        String sectionTitle = "";
+        NodeList children = node.getChildNodes();
+        for (int i = 0; i < children.getLength(); i++) {
+        Node child = children.item(i);
+        if (child.getNodeName().equals("Title")) {
+            sectionTitle = child.getFirstChild().getNodeValue();
+        }
+        }
+
+        // Add the node into the tree
+        HelpItem item = new HelpItem(sectionTitle, sectionName);
+        insertNodeInto(item, parent, parent.getChildCount());
+
+        // Apply recursively to the children of this node
+        for (int i = 0; i < children.getLength(); i++) {
+        Node child = children.item(i);
+        buildContentsHierarchy(item, child);
+        }
+    }
+
+
+    public HelpItem getHelpItemNamed(String sectionName)
+    {
+        // Find the node with name matching sectionName, somewhere in the tree
+        Enumeration descendants = ((DefaultMutableTreeNode) root).preorderEnumeration();
+        while (descendants.hasMoreElements()) {
+        HelpItem node = (HelpItem) descendants.nextElement();
+        if (node.name.equals(sectionName)) {
+            return node;
+        }
+        }
+
+        // Couldn't be found, so just return the root (Contents) node
+        return (HelpItem) root;
+    }
+    }
+
+
+    /** This listener is used to listen for selection changes in the contents tree, and
+     * to show the appropriate page as required.
+     */
+    private class ContentsListener
     implements TreeSelectionListener {
+
     /** Any implementation of <i>TreeSelectionListener</i> must include this method so we can be informed when the tree selection changes.
      * @param event A <strong>TreeSelectionEvent</strong> containing al the relevant information about the event itself.
-            */
-    public void valueChanged(TreeSelectionEvent event) {
+     */
+    public void valueChanged(TreeSelectionEvent event)
+    {
         TreePath path = event.getPath();
-        HelpItem node = (HelpItem)path.getLastPathComponent();
+        HelpItem node = (HelpItem) path.getLastPathComponent();
         URL url = node.getURL();
-        if(url != null) {
+        if (url != null) {
         view.showHTMLDocument(url);
         }
@@ -177 +239 @@
     }
 
+
+    /** This class provides a wrapper around a <strong>DefaultMutableTreeNode</strong> which
+     * provides the ability to set an html page to be loaded when this node is selected.
+     */
+    private class HelpItem 
+    extends DefaultMutableTreeNode {
+
+    /** The unique name of the section (matches the HTML filename) */
+    public String name = null;
+    /** The title to be displayed for this tree node. */
+    public String title = null;
+
+
+    /** Constructor.
+     * @param title The title to be shown for this node as a <strong>String</strong>.
+     * @param name The name of the section as a <strong>String</strong>.
+     */
+    public HelpItem(String title, String name)
+    {
+        this.name = name;
+        this.title = title;
+    }
+
+
+    /** Method to create a url from the file name.
+     * @return A <strong>URL</strong> that points to the file's location.
+     */
+    public URL getURL()
+    {
+        if (name != null && !name.equals("<null>")) {
+        try {
+            File file = new File(Utility.HELP_DIR + name + ".htm");
+            return file.toURL();
+        }
+        catch (Exception e) {
+        }
+        }
+
+        return null;
+    }
+
+
+    public String toString()
+    {
+        return title;
+    }
+    }
+
+
+    /**
+     * @author John Thompson
+     */
     private class Observer
     extends DefaultCalHTMLObserver {
-    public int state = CalCons.DOC_LOADED;
+
+    private int state = CalCons.DOC_LOADED;
+
     public void linkActivatedUpdate(CalHTMLPane pane, URL url, String target_frame, String j_name) {
-        System.err.println("Link clicked: " + url);
+        // System.err.println("Link clicked: " + url);
     }
 
@@ -190 +306 @@
         this.state = state;
         switch(state) {
-        case CalCons.PRE_CONNECT:
-        break;
-        case CalCons.PARSE_FAILED:
-        break;
-        case CalCons.CONNECTED:
-        break;
-        case CalCons.DOC_LENGTH:
-        break;
-        case CalCons.TITLE:
-        break;
-        case CalCons.PARSE_FAILED_POST_CONNECT:
-        break;
-        case CalCons.WAITING_FOR_IMAGES:
-        break;
-        case CalCons.DOC_LOADED:
-        break;
+            case CalCons.PRE_CONNECT:
+            break;
+            case CalCons.PARSE_FAILED:
+            break;
+            case CalCons.CONNECTED:
+            break;
+            case CalCons.DOC_LENGTH:
+            break;
+            case CalCons.TITLE:
+            break;
+            case CalCons.PARSE_FAILED_POST_CONNECT:
+            break;
+            case CalCons.WAITING_FOR_IMAGES:
+            break;
+            case CalCons.DOC_LOADED:
+            break;
         }
     }