Package jmri.util

Class HelpUtil

java.lang.Object

jmri.util.HelpUtil

public class HelpUtil
extends Object

Common utility methods for displaying JMRI help pages.

This class was created to contain common Java Help information but is now changed to use a web browser instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HelpUtil.MenuProvider

Method Summary

Modifier and Type	Method	Description
static void	addHelpToComponent(Component component, String ref)
static String	createStubFile(String helpKey, String locale)
static void	displayHelpRef(String ref)
static void	enableHelpOnButton(Component comp, String id)
static Action	getHelpAction(String name, Icon icon, String id)
static JMenu	helpMenu(JMenuBar menuBar, String ref, boolean direct)	Append a help menu to the menu bar.
static JMenu	makeHelpMenu(String ref, boolean direct)
static JMenuItem	makeHelpMenuItem(String ref)
static void	openWebPage(String url)
static void	openWindowsFile(File file)
static boolean	showWebPage(String ref, String url)

Methods inherited from class java.lang.Object

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

Method Details

helpMenu

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

Append a help menu to the menu bar.

Parameters:

menuBar - the menu bar to add the help menu to

ref - context-sensitive help reference

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 or null if unable to create the help menu

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)

enableHelpOnButton

public static void enableHelpOnButton(Component comp,
 String id)

displayHelpRef

public static void displayHelpRef(String ref)

createStubFile

public static String createStubFile(String helpKey,
 String locale)
                             throws IOException

Throws:

IOException

openWindowsFile

public static void openWindowsFile(File file)
                            throws JmriException

Throws:

JmriException

showWebPage

public static boolean showWebPage(String ref,
 String url)

openWebPage

public static void openWebPage(String url)
                        throws JmriException

Throws:

JmriException

getHelpAction

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