HelpSupporterUtils (adams-pom 25.9.0-SNAPSHOT API)

java.lang.Object
- adams.gui.core.HelpSupporterUtils

```
public class HelpSupporterUtils
extends Object
```
Utility functions for dealing with HelpSupporter objects.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HelpSupporterUtils.HelpSupporterObserver
For locating HelpSupporter instances.

Constructor Summary

Constructors
Constructor Description

HelpSupporterUtils()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`clearHelp(Object obj)`	Clears any help information.
`static String`	`getHelp(Object obj)`	Returns the help information if any.
`static boolean`	`hasHelp(Object obj)`	Returns whether any help information is available.
`static boolean`	`isHelpHtml(Object obj)`	Returns whether the help is html or plain text.
`protected static HelpSupporter`	`locate(Object obj)`	Locates the first help supporter in the property tree.
`static void`	`setHelp(Object obj, String help, boolean isHtml)`	Sets the help information to offer.
`static void`	`showHelp(Object obj)`	Displays the help.

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

- Constructor Detail
  - HelpSupporterUtils
```
public HelpSupporterUtils()
```
- Method Detail
  - locate
```
protected static HelpSupporter locate(Object obj)
```
    Locates the first help supporter in the property tree.
    
    Parameters:
    
    obj - the object to traverse
    
    Returns:
    
    the helper supporter, if any
  - clearHelp
```
public static void clearHelp(Object obj)
```
    Clears any help information.
    
    Parameters:
    
    obj - traverses the
  - hasHelp
```
public static boolean hasHelp(Object obj)
```
    Returns whether any help information is available.
    
    Returns:
    
    true if help available
  - setHelp
```
public static void setHelp(Object obj,
                           String help,
                           boolean isHtml)
```
    Sets the help information to offer.
    
    Parameters:
    
    help - the help
    
    isHtml - whether html or plain text
  - getHelp
```
public static String getHelp(Object obj)
```
    Returns the help information if any.
    
    Returns:
    
    the help information
  - isHelpHtml
```
public static boolean isHelpHtml(Object obj)
```
    Returns whether the help is html or plain text.
    
    Returns:
    
    true if supporter available and help is html
  - showHelp
```
public static void showHelp(Object obj)
```
    Displays the help.