AbstractAnnotationsDisplayGenerator (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.visualization.object.annotationsdisplay.AbstractAnnotationsDisplayGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

DefaultAnnotationsDisplayGenerator
```
public abstract class AbstractAnnotationsDisplayGenerator
extends AbstractOptionHandler
```
Ancestor for classes that create AbstractAnnotationsPanel implementations.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String m_Prefix
the prefix to use.

static String PREFIX_DEFAULT
the default prefix.
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractAnnotationsDisplayGenerator()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`abstract AbstractAnnotationsDisplayPanel`	`generate()`	Generates the panel.
`String`	`getPrefix()`	Returns the prefix to use for the objects in the report.
`String`	`prefixTipText()`	Returns the tip text for this property.
`void`	`setPrefix(String value)`	Sets the prefix to use for the objects in the report.

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - PREFIX_DEFAULT
```
public static final String PREFIX_DEFAULT
```
    the default prefix.
    
    See Also:
    
    Constant Field Values
  - m_Prefix
```
protected String m_Prefix
```
    the prefix to use.
- Constructor Detail
  - AbstractAnnotationsDisplayGenerator
```
public AbstractAnnotationsDisplayGenerator()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setPrefix
```
public void setPrefix(String value)
```
    Sets the prefix to use for the objects in the report.
    
    Parameters:
    
    value - the prefix
  - getPrefix
```
public String getPrefix()
```
    Returns the prefix to use for the objects in the report.
    
    Returns:
    
    the prefix
  - prefixTipText
```
public String prefixTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - generate
```
public abstract AbstractAnnotationsDisplayPanel generate()
```
    Generates the panel.
    
    Returns:
    
    the panel