All Known Implementing Classes:: NFHelpSystem

public interface HelpSystem

The HelpSystem is used to integrate a set of HelpContexts. HelpSystem manages accessing the help resource bundle and launching help content in a browser. Each HelpContext is usually associated with a java.awt.Window (although it only requires a java.awt.Container). The HelpContext allows the association of each of the Window's Components with a topic identifier. The combination of the HelpSystem id (name) with the context id,

The help resource bundle contains a set of key value pairs. The keys are hierarchical keys which which are used to either identify a display string or a URL. The display strings are used directly on the frame to show things such as tool tips. URL's are used to launch a context sensitive help browser.

The following is an example of a help resource bundle:

public class HelpResources extends ListResourceBundle { public Object[][] getContents() { return contents; } static final Object[][] contents = { // LOCALIZE THIS {"Contents/HelpDesk", "HelpDeskContents.html"}, // Contents URL for appl HelpDesk {"Help/HelpDesk", "HelpDeskHelp.html"}, // Help URL for HelpDesk {"Desc/HelpDesk", "Press F1 for help." }, // Description URL. {"Help/HelpDesk/Login", "Login/help.html"}, // Help URL for login. {"Desc/HelpDesk/Login", "Press F1 for help."}, // Description for login. {"Help/HelpDesk/Login/OKButton", "Login/OKButton/help.html"},// URL Help for login OK button. {"Tip/HelpDesk/Login/OKButton", "Press OK to login." }, // Tool tip for login OK button. {"Desc/HelpDesk/Login/OKButton", "This is Description11" } // Descriptoin for login OK button. // END OF MATERIAL TO LOCALIZE }; // Object[][] contents } // class HelpURLMap

Supported API: true
Extendable: false

Interface HelpSystem