Interface HelpHint

    • Method Detail

      • getPreamble

        java.lang.String getPreamble()
        Gets the preamble text that should be included
        Returns:
        Preamble text
      • getFormat

        HelpFormat getFormat()
        Gets the format of the provided help information
        Returns:
        Help format
      • numContentBlocks

        int numContentBlocks()
        Gets the number of content blocks provided

        Help generators should consult the getFormat() return value to determine how to format the content blocks but they are not required to do so

        Returns:
        Number of content blocks
      • getContentBlock

        java.lang.String[] getContentBlock​(int blockNumber)
        Gets the content block with the given number
        Parameters:
        blockNumber - Block number
        Returns:
        Content Block