public class VersionSection extends Object implements HelpSection
Constructor and Description |
---|
VersionSection(String[] dataSources,
String componentProperty,
String versionProperty,
String buildProperty,
String dateProperty,
String[] additionalProperties,
String[] additionalTitles,
boolean suppressErrors,
boolean tabular) |
Modifier and Type | Method and Description |
---|---|
String[] |
getContentBlock(int blockNumber)
Gets the content block with the given number
|
HelpFormat |
getFormat()
Gets the format of the provided help information
|
String |
getPostamble()
Gets the post-amble text that should be included at the end of the
section
|
String |
getPreamble()
Gets the preamble text that should be included
|
String |
getTitle()
Gets the title for the section
|
int |
numContentBlocks()
Gets the number of content blocks provided
|
int |
suggestedOrder()
Gets an integer indicating the suggested order that a help generator
should include this section in
|
public String getPreamble()
HelpHint
getPreamble
in interface HelpHint
public HelpFormat getFormat()
HelpHint
public int numContentBlocks()
HelpHint
Help generators should consult the HelpHint.getFormat()
return value to
determine how to format the content blocks but they are not required to
do so
numContentBlocks
in interface HelpHint
public String[] getContentBlock(int blockNumber)
HelpHint
getContentBlock
in interface HelpHint
blockNumber
- Block numberpublic 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.