org.grinvin.help

Class HelpManager


public class HelpManager
extends java.lang.Object

Central managing of context-sensitive help

Method Summary

static void
enableHelpKey(Component comp, String id)
static String
getCurrentHelpPage()
returns the id of the current help page, or if no id exists the url of the current page.
static String
getCurrentView()
delegates to HelpBroker
static HelpSet
getHelpSet()
returns the helpset
static ResourceBundle
getResourceBundle()
static Window
getWindow()
returns the help window.
static boolean
isHelpLoaded()
returns true if the help files were loaded without errors
static void
setHelpIDString(Component comp, String id)
add context-sensitive help for a component.
static void
showID(String id)
display the given id in the help window.
static void
startTracking()

Method Details

enableHelpKey

public static void enableHelpKey(Component comp,
                                 String id)

getCurrentHelpPage

public static String getCurrentHelpPage()
returns the id of the current help page, or if no id exists the url of the current page.

getCurrentView

public static String getCurrentView()
delegates to HelpBroker

getHelpSet

public static HelpSet getHelpSet()
returns the helpset

getResourceBundle

public static ResourceBundle getResourceBundle()

getWindow

public static Window getWindow()
returns the help window.

isHelpLoaded

public static boolean isHelpLoaded()
returns true if the help files were loaded without errors

setHelpIDString

public static void setHelpIDString(Component comp,
                                   String id)
add context-sensitive help for a component.

showID

public static void showID(String id)
display the given id in the help window.

startTracking

public static void startTracking()