General Interface is an open source project hosted by the Dojo Foundation

Basic Steps for Implementing Help

About Context-Sensitive Help Chapter 15 Implementing Context-Sensitive Help

Implementing context-sensitive includes the following steps:

  1. Set help IDs for areas of the user interface, such as palettes and dialogs:
    • Set the Help ID property in the Properties Editor palette of General Interface Builder.
    • Set the help ID programmatically using the jsx3.app.Model.setHelpId() method.
  2. Subscribe to the HELP event using jsx3.app.Server.HELP ("event subject_").

For example, the next example demonstrates how to send a message to an alert when a server publishes a HELP event. The JavaScript package is eg.app and the server is eg.app.APP, as shown in the following example.

eg.app.APP.subscribe(jsx3.app.Server.HELP, eg.app.onHelp);

eg.app.onHelp = function(objEvent) {
   objEvent.target.alert("Help", " ")
};
About Context-Sensitive Help Chapter 15 Implementing Context-Sensitive Help

Contents

Searching General Interface Docs

Expand all   Collapse all
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.