jmri.util
Class HelpUtil

java.lang.Object
  jmri.util.HelpUtil

public class HelpUtil
extends Object

Common utility methods for working with Java Help.

This class was created to contain common Java Help information.

It assumes that Java Help 1.1.8 is in use

Author:

Bob Jacobsen Copyright 2007

Constructor Summary

HelpUtil()

Method Summary

static void	addHelpToComponent(Component component, String ref)
static void	displayHelpRef(String ref)
static javax.help.HelpBroker	getGlobalHelpBroker()
static Action	getHelpAction(String name, Icon icon, String id)
static JMenu	helpMenu(JMenuBar menuBar, String ref, boolean direct)
static boolean	initOK()
static JMenu	makeHelpMenu(String ref, boolean direct)
static JMenuItem	makeHelpMenuItem(String ref)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HelpUtil

public HelpUtil()

Method Detail

helpMenu

public static JMenu helpMenu(JMenuBar menuBar,
                             String ref,
                             boolean direct)

Parameters:

direct - true if this call should complete the help menu by adding the general help

Returns:

new Help menu, in case user wants to add more items

makeHelpMenu

public static JMenu makeHelpMenu(String ref,
                                 boolean direct)

makeHelpMenuItem

public static JMenuItem makeHelpMenuItem(String ref)

addHelpToComponent

public static void addHelpToComponent(Component component,
                                      String ref)

displayHelpRef

public static void displayHelpRef(String ref)

initOK

public static boolean initOK()

getGlobalHelpBroker

public static javax.help.HelpBroker getGlobalHelpBroker()

getHelpAction

public static Action getHelpAction(String name,
                                   Icon icon,
                                   String id)