Class AbstractHelpGenerator

    • Field Detail

      • LOGGER

        protected static Logger LOGGER
        for logging in static context.
      • m_ClassCrossRefLinks

        protected boolean m_ClassCrossRefLinks
        whether to generate "fake" class cross reference links.
    • Constructor Detail

      • AbstractHelpGenerator

        public AbstractHelpGenerator()
    • Method Detail

      • setClassCrossRefLinks

        public void setClassCrossRefLinks​(boolean value)
        Sets whether to generate class cross-reference links for the help user interface.
        Parameters:
        value - true if to generate
      • getClassCrossRefLinks

        public boolean getClassCrossRefLinks()
        Returns whether to generate class cross-reference links for the help user interface.
        Returns:
        true if to generate
      • classCrossRefLinksTipText

        public String classCrossRefLinksTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • handles

        public boolean handles​(Object obj)
        Checks whether the generator handles this object.
        Parameters:
        obj - the object to check
        Returns:
        true if it can handle the object
      • handles

        public abstract boolean handles​(Class cls)
        Checks whether the generator handles this class.
        Parameters:
        cls - the class to check
        Returns:
        true if it can handle the class
      • toHTML

        protected String toHTML​(String s)
        Turns the string into HTML. Line feeds are automatically converted into <br>.
        Parameters:
        s - the string to convert to HTML
        Returns:
        the HTML string
        See Also:
        HtmlUtils.markUpURLs(String, boolean)
      • toHTML

        protected String toHTML​(String s,
                                boolean nbsp)
        Turns the string into HTML. Line feeds are automatically converted into <br>.
        Parameters:
        s - the string to convert to HTML
        nbsp - whether to convert leading blanks to non-breaking spaces
        Returns:
        the HTML string
        See Also:
        HtmlUtils.markUpURLs(String, boolean)
      • generate

        public abstract String generate​(Object obj,
                                        HelpFormat format)
        Generates the help for the object in the requested format.
        Parameters:
        obj - the object to generate the help for
        format - the format of the output
        Returns:
        the generated help
      • generateAll

        public static String generateAll​(Object obj,
                                         HelpFormat format)
        Generates the combined help using all generators.
        Parameters:
        obj - the object to generate the help for
        format - the format of the output
        Returns:
        the generated help