使用setCurrentID时,在TOC中选择JavaHelp主题

时间:2010-03-15 18:40:24

标签: java documentation javahelp

当我使用HelpBroker.setCurrentID("[some help id]")时,JavaHelp会正确显示我想要的页面,但相关主题不会在目录中自动选中/突出显示。这使得用户难以知道当前页面位于主题树中的哪个位置。

当我使用HelpBroker导航到特定的帮助页面时,有没有办法以编程方式突出显示TOC中的当前主题?

请注意,当用户关注Java帮助系统中的链接时,会在目录中正确选择新主题。

2 个答案:

答案 0 :(得分:1)

你应该能够只调用navigate()函数,其余的都是帮手。 id当然是ID,nodeLabel是您要选择的节点上的可见文本。请注意,此代码不会检查错误,即阻止尝试转到不存在的位置。

import java.awt.Component;
import java.util.Enumeration;
import javax.help.*;
import javax.help.plaf.basic.BasicTOCNavigatorUI;
import javax.swing.JTree;
import javax.swing.JScrollPane;
import javax.swing.tree.TreeModel;
import javax.swing.tree.TreePath;
import javax.swing.tree.DefaultMutableTreeNode;

public class Nav
{
    private static DefaultMutableTreeNode match = null;

    private Nav()
    {
    }

    public static void navigate(HelpSet set, HelpBroker broker, String id, String nodeLabel)
    {
        broker.setCurrentID(id);
        JHelp jhelp = new JHelp(set);
        JHelpNavigator nav = getNavigator(jhelp);
        JTree tree = getTree(nav);
        TreeModel model = tree.getModel();
        Object root = model.getRoot();
        match = null;
        findNode(model, root, nodeLabel);
        TreePath path = new TreePath(match.getPath());
        tree.setSelectionPath(path);
        tree.scrollPathToVisible(path);
    }

    //http://www.google.com/codesearch/p?hl=en#WiboLAWeTd0/xena/ext/src/javahelp/jhMaster/JavaHelp/src/new/javax/help/WindowPresentation.java&t=0&d=30&l=272
    private static JHelpNavigator getNavigator(JHelp jhelp)
    {
        JHelpNavigator nav = null;
        for (Enumeration e = jhelp.getHelpNavigators(); e.hasMoreElements(); ) 
        {
            nav = (JHelpNavigator) e.nextElement();
            if (nav.getNavigatorName().equals("TOC"))
            {
                return nav;
            }
        }
        return null;
    }

    //http://forums.sun.com/thread.jspa?threadID=350180#1459484
    private static JTree getTree(JHelpNavigator nav)
    {
        JTree tree = null;
        Component[] components = nav.getComponents();
        int count = components.length;
        int i = 0;
        while(i < count && !(components[i] instanceof JScrollPane))
        {
            i++;
        }
        if(i < count)
        {
            JScrollPane sp = (JScrollPane) components[i];
            components = sp.getViewport().getComponents();
            count = components.length;
            i = 0;
            while(i < count && !(components[i] instanceof JTree))
            {
                i++;
            }
            tree = (JTree) components[i];
        }
        return tree;
    }

    //http://www.rkcole.com/articles/swing/TraverseJtree-2000-11-17.html
    private static void findNode(TreeModel model, Object o, String search)
    {
        if(match != null)
            return;

        int count = model.getChildCount(o);
        for( int i=0;  i < count;  i++ )
        {
            Object child = model.getChild(o, i );
            if (  model.isLeaf( child ) )
            {
                if(search.equals(((TOCItem)((DefaultMutableTreeNode)child).getUserObject()).getName()))
                {
                    match = (DefaultMutableTreeNode)child;
                    return;
                }
            }
            else
                findNode( model, child, search );
        }
    }
}

答案 1 :(得分:1)

您使用的是合并帮助集吗?如果我使用setCurrentID(“topic”)并且主题不是主帮助集,而是在子帮助集中,我会看到您看到的行为。你想做的是

setCurrentID(javax.help.Map.ID.create("topic",subhelpset))

对我来说,这会使TOC视图选择正确发生。当然,这些可能意味着您需要使用动态合并的帮助集,因为如果在主帮助集的.hs文件中指定了子帮助,我没有看到(手头)一种简单的方法来查找子帮助。

同样,对于上下文相关帮助,您需要在每个Component上设置ID和helpset。