HelpSupporter (adams-pom 25.11.0-SNAPSHOT API)

All Known Implementing Classes:

AbstractClassifierBasedGeneticAlgorithmWizard.PerformancePlot, AbstractDataContainerZoomOverviewPanel, BoxPlotGraph, ContentPanel, DataContainerPanel, DataContainerPanelWithContainerList, DataContainerPanelWithSidePanel, HistogramPanel, InstancePanel, InstanceZoomOverviewPanel, PlotPanel, ProbabilityPlotPanel, ScatterPlotPanel, SequencePlotterPanel, SpreadSheetRowPanel, SpreadSheetRowZoomOverviewPanel, TimeseriesPanel, TimeseriesZoomOverviewPanel, VersusFitPanel, VersusOrderPanel, XYSequencePanel, ZScorePanel
```
public interface HelpSupporter
```
Interface for classes that support help information and the display of it.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearHelp()`	Clears any help information.
`String`	`getHelp()`	Returns the help information if any.
`boolean`	`hasHelp()`	Returns whether any help information is available.
`boolean`	`isHelpHtml()`	Returns whether the help is html or plain text.
`void`	`setHelp(String help, boolean isHtml)`	Sets the help information to offer.
`void`	`showHelp()`	Displays the help.

- Method Detail
  - clearHelp
```
void clearHelp()
```
    Clears any help information.
  - hasHelp
```
boolean hasHelp()
```
    Returns whether any help information is available.
    
    Returns:
    
    true if help available
  - setHelp
```
void setHelp(String help,
             boolean isHtml)
```
    Sets the help information to offer.
    
    Parameters:
    
    help - the help
    
    isHtml - whether html or plain text
  - getHelp
```
String getHelp()
```
    Returns the help information if any.
    
    Returns:
    
    the help information
  - isHelpHtml
```
boolean isHelpHtml()
```
    Returns whether the help is html or plain text.
    
    Returns:
    
    true if html
  - showHelp
```
void showHelp()
```
    Displays the help.