Please consult the Bean Information and Bean class documentation for full details.
In addition to the standard Hi HelpIndex functionality, bean developers will want to consider these topics. Click on Details for programmer details of how to perform each task.
new HelpIndex()to construct a new HelpIndex object. (Or you can use
Beans.instantiate(cls,"COM.phdcc.hi.HelpIndex").) Please read the notes about specify filenames.
Do this either using hiEvents, or by listening for displayPage property changes.
When HelpIndex wants to display a page, first it sets its displayTarget and displayPage properties. Then it sends a hiEvent to all registered hiListeners.
It is easiest to use hiEvents. If using Hi Brow, simply make Hi Brow listen for HelpIndex hiEvents, and vice versa.
If using properties, link displayTarget and displayPage to the browser bean, and vice versa. So you will typically need an intermediary (adaptor) class to listen for changes in these two properties. The intermediary should note any changes in displayTarget and then act on any changes to displayPage.
Help+Topics(or similar menu item) throw up a dialog box which simply contains an instance of the HelpIndex bean, ie it shows its Contents, Index and other tabs.
You can set it up either always to synchronise itself, or just when needed.
Forwardbuttons can usually be linked directly to the browser bean history list.
Previous in Contents,
Next in Contents,
Parent in Contents and
Home in Contents
can be implemented by listenening for hiEvents.
Your browser bean control panel could also have a
Sync with Content button, to synchronise the Hi HelpIndex
Contents on demand.
Alternatively, if running on the web, use the Hi Jump applet to provide this functionality.
This means being able to press F1 (or similar, eg Help button) to get help on the current window, dialog or control within a dialog. In some situations (eg development environments) when within a text editor, pressing F1 will request help on the current word under the cursor.
Further, some applications might need What's This? style help, eg once Shift+F1 is pressed, help is shown on the control where the user next clicks.
Details The HelpIndex bean can assist in these situations. For example, the current word under the cursor can be passed to the HelpIndex bean Index of keywords. If it has just one match then the corresponding page is shown straight away. Otherwise the HelpIndex Index pane is made visible and the list of matches is displayed, for the user to refine the query.
If all these scenarios are used, then several copies of Hi HelpIndex may be
running at the same time (eg once in your tab Contents, once in your tab Index
and once in the Help Dialog).
??? Instantiate a single invisible copy of the HelpIndex bean at start up and let it load its index file(s). Clone any copies you need and make these visible when appropriate.
You may want to use this approach even if you use HelpIndex once, as it is good to get HelpIndex loading its index files straight away at startup.
??? How to cope with different locale selection.
The Hi HelpIndex software comes with a basic but useful Hi Brow browser bean.
Here is a list of known browser beans.