HelpContainer (adams-pom 24.4.0-SNAPSHOT API)

java.lang.Object
- adams.gui.help.HelpContainer

public class HelpContainer
extends Object

Container for storing the help.

Field Summary

Fields
Modifier and Type Field Description

protected String m_Help
the help text.

protected boolean m_Html
whether html or plain text.

Constructor Summary

Constructors
Constructor Description

HelpContainer(String help, boolean html)
Initializes the container.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getHelp()`	Returns the help string.
`boolean`	`isHtml()`	Returns whether the help is plain text or html.
`String`	`toString()`	Returns a shortened version of the help string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_Help
```
protected String m_Help
```
    the help text.
  - m_Html
```
protected boolean m_Html
```
    whether html or plain text.
- Constructor Detail
  - HelpContainer
```
public HelpContainer(String help,
                     boolean html)
```
    Initializes the container.
    
    Parameters:
    
    help - the help string
    
    html - true if html
- Method Detail
  - getHelp
```
public String getHelp()
```
    Returns the help string.
    
    Returns:
    
    the help string
  - isHtml
```
public boolean isHtml()
```
    Returns whether the help is plain text or html.
    
    Returns:
    
    true if html
  - toString
```
public String toString()
```
    Returns a shortened version of the help string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the help string