public class BasicSection extends BasicHint implements HelpSection
Constructor and Description |
---|
BasicSection(String title,
int suggestedOrder,
String preamble,
String postamble,
HelpFormat format,
String[]... blocks) |
Modifier and Type | Method and Description |
---|---|
String |
getPostamble()
Gets the post-amble text that should be included at the end of the
section
|
String |
getTitle()
Gets the title for the section
|
int |
suggestedOrder()
Gets an integer indicating the suggested order that a help generator
should include this section in
|
getContentBlock, getFormat, getPreamble, numContentBlocks
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getContentBlock, getFormat, getPreamble, numContentBlocks
public BasicSection(String title, int suggestedOrder, String preamble, String postamble, HelpFormat format, String[]... blocks)
public String getTitle()
HelpSection
getTitle
in interface HelpSection
public String getPostamble()
HelpSection
getPostamble
in interface HelpSection
public int suggestedOrder()
HelpSection
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.
suggestedOrder
in interface HelpSection
Copyright © 2012–2017. All rights reserved.