Interface HelpSection

    • Method Detail

      • getTitle

        java.lang.String getTitle()
        Gets the title for the section
        Returns:
        Section title
      • getPostamble

        java.lang.String getPostamble()
        Gets the post-amble text that should be included at the end of the section
        Returns:
      • suggestedOrder

        int suggestedOrder()
        Gets an integer indicating the suggested order that a help generator should include this section in

        A value of zero indicates that the help generator can decide where to place this section, a positive value indicates it should be placed after the default sections while a negative value indicates it should be placed before the default sections. There is however no guarantee that a help generator will honour the order given.

        Returns:
        Suggested order