Class BasicSection

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int order  
      private java.lang.String postamble  
      private java.lang.String title  
    • Constructor Summary

      Constructors 
      Constructor Description
      BasicSection​(java.lang.String title, int suggestedOrder, java.lang.String preamble, java.lang.String postamble, HelpFormat format, java.lang.String[]... blocks)  
    • Field Detail

      • title

        private final java.lang.String title
      • postamble

        private final java.lang.String postamble
      • order

        private final int order
    • Constructor Detail

      • BasicSection

        public BasicSection​(java.lang.String title,
                            int suggestedOrder,
                            java.lang.String preamble,
                            java.lang.String postamble,
                            HelpFormat format,
                            java.lang.String[]... blocks)
    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Description copied from interface: HelpSection
        Gets the title for the section
        Specified by:
        getTitle in interface HelpSection
        Returns:
        Section title
      • getPostamble

        public java.lang.String getPostamble()
        Description copied from interface: HelpSection
        Gets the post-amble text that should be included at the end of the section
        Specified by:
        getPostamble in interface HelpSection
        Returns:
      • suggestedOrder

        public int suggestedOrder()
        Description copied from interface: HelpSection
        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.

        Specified by:
        suggestedOrder in interface HelpSection
        Returns:
        Suggested order