com.sssw.rt.form
Interface AgiHelpInfo

All Known Subinterfaces:

AgiControl

All Known Implementing Classes:

AgcTextField, AgcTreeControl, AgcJComboBox, AgcJRadioButton, AgcJTabbedPane, AgcJToggleButton, AgcJTextField, AgcJTree, AgcJSlider, AgcJLabel, AgcJList, AgcJEditorPane, AgcJTextArea, AgcJTable, AgcJCheckBox, AgcJButton

public interface AgiHelpInfo

Interface for providing context-sensitive help when the user presses the F1 key. When a control implements this interface, you can call these methods to specify help information that the application will display when the user presses F1.

Many SilverStream form controls implement this interface.

For more information, see Providing context-sensitive help for forms.

Method Summary

String	getHelpInfo() Gets the help information associated with the control.
void	setHelpInfo(String helpInfo) Specifies the help information (typically an URL) associated with the control.

Method Detail

getHelpInfo

public String getHelpInfo()

Gets the help information associated with the control.

Returns:

a String that is the URL of the help page.

Usage:

See Also:

AgiHelpInfo.setHelpInfo(String helpInfo), AgiHelpProcessor.processHelp(Object, String)

setHelpInfo

public void setHelpInfo(String helpInfo)

Specifies the help information (typically an URL) associated with the control.

Parameters:

helpInfo - help information associated with the control. When you are using default help processing, helpInfo is the URL of an HTML page.

Usage:

For default help processing, you can use relative or absolute URLs. The URL that refers To refer to an HTML page in the same database as the form, the URL only needs to specify the file name.

   HelpForTextField.html

To refer to an HTML page in the SilverMaster database or another database on the same server, specify a relative URL with the database name.

   SilverMaster35:HelpForTextField.html

   otherdatabase:HelpForTextField.html

To refer to an HTML page on another server or anywhere on the Web, specify an absolute URL; include the path to the Pages directory.

   http://myserver/SilverMaster35/Pages/HelpForTextField.html

   http://myserver/otherdatabase/Pages/HelpForTextField.html

You can use setHelpInfo() to change the help information for a control as conditions change. For example, you can have help information for individual list items or individual tab panes by calling setHelpInfo() in the itemStateChanged, stateChanged, or paneChanged events.

If the control or one of its containers implements the AgiHelpProcessor interface to provide custom help processing, then you can use setHelpInfo() to specify help information in any form that is appropriate to the application. The help manager will pass the information to the processHelp() method, which you can program to handle the help in an appropriate way.

See Also:

AgiHelpInfo.getHelpInfo(), AgiHelpProcessor.processHelp(Object, String)