Class HelpSettings


  • public final class HelpSettings
    extends java.lang.Object
    The installer help settings, like the help text format and whether or not to support contextual help.
    • Method Detail

      • setHtmlHelp

        public void setHtmlHelp​(boolean html)
        Whether or not to use HTML help. HTML allows greater formatting control of the help text.
        See Also:
        getHtmlHelp()
      • getHtmlHelp

        public boolean getHtmlHelp()
        Whether or not to use HTML help. HTML allows greater formatting control of the help text.
        See Also:
        setHtmlHelp(boolean)
      • setGenericHelp

        public void setGenericHelp​(Help help)
        The help context information. This help is only used when the installer is configured to use the same help text for all panels, otherwise each panel should defines its own help context.
        See Also:
        setContextualHelp(boolean)
      • getGenericHelp

        public Help getGenericHelp()
        The help context information. This help is only used when the installer is configured to use the same help text for all panels, otherwise each panel should defines its own help context.
        See Also:
        getContextualHelp()
      • setEnableInstallerHelp

        public void setEnableInstallerHelp​(boolean enable)
        Whether or not the installer should provide help.
        See Also:
        HelpSettings
      • getEnableInstallerHelp

        public boolean getEnableInstallerHelp()
        Whether or not the installer should provide help.
        See Also:
        HelpSettings
      • setContextualHelp

        public void setContextualHelp​(boolean contextualHelp)
        Whether or not to use different help text for each panel.
      • getContextualHelp

        public boolean getContextualHelp()
        Whether or not to use different help text for each panel.